docs(i18n): Finish translating documentation in Japanese (#433)

This last wave of translations has been completed on Crowdin.
This commit is contained in:
Matan Kushner 2019-09-28 20:31:56 +09:00 committed by GitHub
parent c49e54b16b
commit 85956c7f94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 480 additions and 357 deletions

View File

@ -3,8 +3,7 @@
<img <img
width="400" width="400"
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png" src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
alt="Starship Cross-shell prompt" alt="Starship Cross-shell prompt" />
/>
</p> </p>
<p align="center"> <p align="center">
<a href="https://crates.io/crates/starship"> <a href="https://crates.io/crates/starship">
@ -13,40 +12,34 @@
<a href="https://dev.azure.com/starship-control/starship/_build"> <a href="https://dev.azure.com/starship-control/starship/_build">
<img <img
src="https://badgen.net/azure-pipelines/starship-control/starship/Starship%20Test%20Suite" src="https://badgen.net/azure-pipelines/starship-control/starship/Starship%20Test%20Suite"
alt="Azure Pipelines Build Status" alt="Azure Pipelines Build Status" />
/>
</a> </a>
<a href="https://repology.org/project/starship/versions"> <a href="https://repology.org/project/starship/versions">
<img src="https://repology.org/badge/tiny-repos/starship.svg" alt="Packaging status"> <img src="https://repology.org/badge/tiny-repos/starship.svg" alt="Packaging status">
</a><br> </a><br>
<a href="#contributors"> <a href="#-貢献">
<img <img
src="https://badgen.net/badge/all%20contributors/20/orange" src="https://badgen.net/badge/all%20contributors/20/orange"
alt="All Contributors" alt="All Contributors" />
/>
</a> </a>
<a href="https://discord.gg/8Jzqu3T"> <a href="https://discord.gg/8Jzqu3T">
<img <img
src="https://badgen.net/badge/chat/on%20discord/7289da" src="https://badgen.net/badge/chat/on%20discord/7289da"
alt="Chat on Discord" alt="Chat on Discord" />
/>
</a> </a>
</p> </p>
<h4 align="center"> <h4 align="center">
<br /> <br />
<a href="https://starship.rs">Website</a> <a href="https://starship.rs">ウェブサイト</a>
· ·
<a href="#-installation">Installation</a> <a href="#-installation">インストール</a>
· ·
<a href="https://starship.rs/config/">Configuration</a> <a href="https://starship.rs/config/">設定</a>
</h4> </h4>
<h1></h1> <h1></h1>
<p align="center"> <p align="center"> Starship は小さく、とても高速に動作し、非常にカスタマイズ可能なすべてのシェルに対応したプロンプトです!<br /> プロンプトには、作業中に必要な情報が表示されます。 <p>
Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!<br>
The prompt shows information you need while you're working, while staying sleek and out of the way.
<p>
<p align="center"> <p align="center">
<br> <br>
@ -55,46 +48,49 @@ The prompt shows information you need while you're working, while staying sleek
<br> <br>
</p> </p>
## 🍬 Features ## 🍬 機能
- Prompt character turns red if the last command exits with non-zero code - 最後のコマンドがゼロ以外のコードで終了すると、プロンプト文字が赤に変わります
- Current username if not the same as the logged-in user - ログインユーザーと異なる場合にユーザー名を表示する
- Current Node.js version(`⬢`) - 現在の Java のバージョン (`☕`)
- Current Rust version (`🦀`) - 現在の Node.js のバージョン (`⬢`)
- Current Ruby version (`💎`) - 現在の Rust のバージョン (`🦀`)
- Current Python version (`🐍`) - 現在の Ruby のバージョン (`💎`)
- Current Go version (`🐹`) - 現在の Python のバージョン (`🐍`)
- Nix-shell environment detection - 現在の Go バージョン (`🐹`)
- Current version of package in current directory (`📦`) - Nix-shell の環境検出
- 指定した1つの環境変数の表示
- カレントディレクトリにある現在のパッケージバージョン(`📦`)
- npm (Node.js) - npm (Node.js)
- cargo (Rust) - cargo (Rust)
- poetry (Python) - poetry (Python)
- Current battery level and status - 現在のバッテリー残量と状態
- Current Git branch and rich repo status: - 現在の Git ブランチとリッチなリポジトリの状態
- `=`conflicting changes - `=`競合している変更
- `⇡`ahead of remote branch - `⇡`リモートブランチより進んでいる変更
- `⇣` behind of remote branch - `⇣`リモートブランチに追いついていない変更
- `⇕`diverged changes - `⇕`分岐した変更
- `?`untracked changes - `?`追跡されていない変更
- `$` — stashed changes - `$` — stashされた変更
- `!`modified files - `!`変更されたファイル
- `+`added files - `+`追加されたファイル
- `»`renamed files - `»`名前が変更されたファイル
- `✘`deleted files - `✘`削除されたファイル
- Execution time of the last command if it exceeds the set threshold - 閾値を超えた際の、コマンドの実行時間
- Indicator for jobs in the background (`✦`) - バックグラウンドジョブのインジケーター (`✦`)
## 🚀 Installation ## 🚀 インストール
### Prerequisites ### 必要なもの
- A [Powerline font](https://github.com/powerline/fonts) installed and enabled in your terminal (for example, try [Fira Code](https://github.com/tonsky/FiraCode)). - [Powerline フォント](https://github.com/powerline/fonts) がターミナルにインストールされて有効になっている必要があります(例えば [Fira Code](https://github.com/tonsky/FiraCode) を試してみてください)。
### Getting Started ### 入門
1. Install the **starship** binary: 1. **Starship** のバイナリをインストール
もし以下のプラットフォームを使用していない場合は **[コンパイル済みのバイナリファイルをダウンロード](https://github.com/starship/starship/releases)** してください。
**[Download archives of precompiled binaries](https://github.com/starship/starship/releases)** if you don't use the platforms below.
#### Homebrew #### Homebrew
@ -102,37 +98,42 @@ The prompt shows information you need while you're working, while staying sleek
$ brew install starship $ brew install starship
``` ```
#### Rust (v1.33 or higher)
#### Rust (v1.33 もしくはそれ以上)
```sh ```sh
$ cargo install starship $ cargo install starship
``` ```
#### Arch Linux (AUR) #### Arch Linux (AUR)
Starship is available on the AUR under the name `starship`. Install it with `yay` or your favorite AUR helper. Starship は AUR 上の `starship` というパッケージ名で利用可能です。 `yay` またはお好きな AUR ヘルパーでインストールしてください。
```sh ```sh
$ yay -S starship $ yay -S starship
``` ```
#### Nix (unstable) #### Nix (unstable)
```sh ```sh
$ nix-env --install starship $ nix-env --install starship
``` ```
#### Termux #### Termux
```sh ```sh
$ pkg install starship $ pkg install starship
``` ```
1. Add the init script to your shell's config file: 1. 初期化のためのスクリプトをシェルの設定ファイルに追加
#### Bash #### Bash
Add the following to the end of `~/.bashrc`: `~/.bashrc` の最後に以下を追記してください
```sh ```sh
# ~/.bashrc # ~/.bashrc
@ -140,9 +141,10 @@ The prompt shows information you need while you're working, while staying sleek
eval "$(starship init bash)" eval "$(starship init bash)"
``` ```
#### Fish #### Fish
Add the following to the end of `~/.config/fish/config.fish`: `~/.config/fish/config.fish` の最後に以下を追記してください
```sh ```sh
# ~/.config/fish/config.fish # ~/.config/fish/config.fish
@ -150,9 +152,10 @@ The prompt shows information you need while you're working, while staying sleek
eval (starship init fish) eval (starship init fish)
``` ```
#### Zsh #### Zsh
Add the following to the end of `~/.zshrc`: `~/.zshrc` の最後に以下を追記してください
```sh ```sh
# ~/.zshrc # ~/.zshrc
@ -160,89 +163,96 @@ The prompt shows information you need while you're working, while staying sleek
eval "$(starship init zsh)" eval "$(starship init zsh)"
``` ```
## 🔧 Configuration ## 🔧 設定
For details on how to configure Starship, check out our [documentation](https://starship.rs/config/). Starship の設定方法の詳細に関しては、[ドキュメント](https://starship.rs/config/)をチェックしてください。
## 🤝 Contributing ## 🤝 貢献
We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). 私たちは常に**すべてのスキルレベル**の貢献者を探しています! もし簡単にプロジェクトへ参加する方法をお探しなら、 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) に取り組んでみてください。
### High Priority Needs ### 特に必要としています
- 👩‍💼 **Product Manager** - 👩‍💼 **プロダクトマネージャー**
- We have a GitHub Project and many unorganized/unprioritized features, as well as ideas that haven't yet been made into issues. Starship needs someone to own the product direction! - GitHub のプロジェクトには、整理/優先度付けがされていない機能や、Issue になっていないアイデアが多くあります。 プロダクトの方針を持っていただける方が Starship には必要です!
- 👩‍🎨 **Designer** - 👩‍🎨 **デザイナー**
- Like making eye-catching websites? Excellent! We are looking to create a beautiful landing page showing off Starship in all its glory. Helping design for Starship's brand is a great opportunity to try out new ideas! - 目を引く Web サイトを作りたいですか? 素晴らしい! 我々は Starship の栄光を際立てる美しい Web サイトを作成したいと考えています。 Starship ブランドのデザインを手助けすることは、新しいアイデアを試す絶好の機会です!
- 👩‍💻 **Rust Developer** - 👩‍💻 **Rust デベロッパー**
- There is _a lot_ of low-hanging fruit when it comes to writing idiomatic Rust, designing effective Rust architecture, performance optimizations, cross-platform build optimizations, and more! I ([@matchai](https://github.com/matchai)) am a beginner to Rust. Come point us in the right direction! - 慣用的な Rust の作成、効果的な Rust アーキテクチャの設計、パフォーマンスの最適化、クロスプラットフォームビルドの最適化などに関しては、_多く_の簡単な成果があります。 私([@matchai](https://github.com/matchai))は Rust の初心者です。 私たちを正しい方向に向けてください!
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 もしあなたが Starship への貢献に興味がある場合は、我々の[貢献ガイド](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)をご覧ください。 また、気軽に我々の[Discord サーバー](https://discord.gg/8Jzqu3T)へ顔を出してください。 👋
### Contributors ### 貢献者
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): これらの素晴らしい方々に感謝します ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore --> <!-- prettier-ignore -->
<table> <table>
<tr> <tr>
<td align="center"><a href="https://twitter.com/matchai"><img src="https://avatars0.githubusercontent.com/u/4658208?v=4" width="100px;" alt="Matan Kushner"/><br /><sub><b>Matan Kushner</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=matchai" title="Code">💻</a> <a href="#design-matchai" title="Design">🎨</a> <a href="#ideas-matchai" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-matchai" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-matchai" title="Maintenance">🚧</a> <a href="#review-matchai" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=matchai" title="Tests">⚠️</a></td> <td align="center"><a href="https://twitter.com/matchai"><img src="https://avatars0.githubusercontent.com/u/4658208?v=4" width="100px;" alt="Matan Kushner" /><br /><sub><b>Matan Kushner</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=matchai" title="Code">💻</a> <a href="#design-matchai" title="Design">🎨</a> <a href="#ideas-matchai" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-matchai" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-matchai" title="Maintenance">🚧</a> <a href="#review-matchai" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=matchai" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/johnletey"><img src="https://avatars0.githubusercontent.com/u/30328854?v=4" width="100px;" alt="John Letey"/><br /><sub><b>John Letey</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=johnletey" title="Code">💻</a> <a href="#ideas-johnletey" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-johnletey" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=johnletey" title="Tests">⚠️</a></td> <td align="center"><a href="https://github.com/johnletey"><img src="https://avatars0.githubusercontent.com/u/30328854?v=4" width="100px;" alt="John Letey" /><br /><sub><b>John Letey</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=johnletey" title="Code">💻</a> <a href="#ideas-johnletey" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-johnletey" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=johnletey" title="Tests">⚠️</a></td>
<td align="center"><a href="http://timmulqueen.com"><img src="https://avatars1.githubusercontent.com/u/6132021?v=4" width="100px;" alt="Tim Mulqueen"/><br /><sub><b>Tim Mulqueen</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=Multimo" title="Code">💻</a> <a href="#ideas-Multimo" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-Multimo" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=Multimo" title="Tests">⚠️</a></td> <td align="center"><a href="http://timmulqueen.com"><img src="https://avatars1.githubusercontent.com/u/6132021?v=4" width="100px;" alt="Tim Mulqueen" /><br /><sub><b>Tim Mulqueen</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=Multimo" title="Code">💻</a> <a href="#ideas-Multimo" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-Multimo" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=Multimo" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/sirMerr"><img src="https://avatars2.githubusercontent.com/u/11183523?v=4" width="100px;" alt="Tiffany Le-Nguyen"/><br /><sub><b>Tiffany Le-Nguyen</b></sub></a><br /><a href="#ideas-sirMerr" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-sirMerr" title="Maintenance">🚧</a> <a href="#review-sirMerr" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=sirMerr" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/sirMerr"><img src="https://avatars2.githubusercontent.com/u/11183523?v=4" width="100px;" alt="Tiffany Le-Nguyen" /><br /><sub><b>Tiffany Le-Nguyen</b></sub></a><br /><a href="#ideas-sirMerr" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-sirMerr" title="Maintenance">🚧</a> <a href="#review-sirMerr" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=sirMerr" title="Documentation">📖</a></td>
<td align="center"><a href="https://about.snuggi.es"><img src="https://avatars0.githubusercontent.com/u/26250962?v=4" width="100px;" alt="Snuggle"/><br /><sub><b>Snuggle</b></sub></a><br /><a href="#design-Snuggle" title="Design">🎨</a> <a href="#ideas-Snuggle" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-Snuggle" title="Maintenance">🚧</a> <a href="#review-Snuggle" title="Reviewed Pull Requests">👀</a></td> <td align="center"><a href="https://about.snuggi.es"><img src="https://avatars0.githubusercontent.com/u/26250962?v=4" width="100px;" alt="Snuggle" /><br /><sub><b>Snuggle</b></sub></a><br /><a href="#design-Snuggle" title="Design">🎨</a> <a href="#ideas-Snuggle" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-Snuggle" title="Maintenance">🚧</a> <a href="#review-Snuggle" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/mehcode"><img src="https://avatars1.githubusercontent.com/u/753919?v=4" width="100px;" alt="Ryan Leckey"/><br /><sub><b>Ryan Leckey</b></sub></a><br /><a href="#review-mehcode" title="Reviewed Pull Requests">👀</a></td> <td align="center"><a href="https://github.com/mehcode"><img src="https://avatars1.githubusercontent.com/u/753919?v=4" width="100px;" alt="Ryan Leckey" /><br /><sub><b>Ryan Leckey</b></sub></a><br /><a href="#review-mehcode" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/youssefhabri"><img src="https://avatars3.githubusercontent.com/u/1578005?v=4" width="100px;" alt="Youssef Habri"/><br /><sub><b>Youssef Habri</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=youssefhabri" title="Code">💻</a></td> <td align="center"><a href="https://github.com/youssefhabri"><img src="https://avatars3.githubusercontent.com/u/1578005?v=4" width="100px;" alt="Youssef Habri" /><br /><sub><b>Youssef Habri</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=youssefhabri" title="Code">💻</a></td>
</tr> </tr>
<tr> <tr>
<td align="center"><a href="https://github.com/chipbuster"><img src="https://avatars2.githubusercontent.com/u/4605384?v=4" width="100px;" alt="Kevin Song"/><br /><sub><b>Kevin Song</b></sub></a><br /><a href="https://github.com/starship/starship/issues?q=author%3Achipbuster" title="Bug reports">🐛</a> <a href="https://github.com/starship/starship/commits?author=chipbuster" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=chipbuster" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=chipbuster" title="Tests">⚠️</a></td> <td align="center"><a href="https://github.com/chipbuster"><img src="https://avatars2.githubusercontent.com/u/4605384?v=4" width="100px;" alt="Kevin Song" /><br /><sub><b>Kevin Song</b></sub></a><br /><a href="https://github.com/starship/starship/issues?q=author%3Achipbuster" title="Bug reports">🐛</a> <a href="https://github.com/starship/starship/commits?author=chipbuster" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=chipbuster" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=chipbuster" title="Tests">⚠️</a></td>
<td align="center"><a href="https://andrewda.me"><img src="https://avatars1.githubusercontent.com/u/10191084?v=4" width="100px;" alt="Andrew Dassonville"/><br /><sub><b>Andrew Dassonville</b></sub></a><br /><a href="https://github.com/starship/starship/issues?q=author%3Aandrewda" title="Bug reports">🐛</a> <a href="https://github.com/starship/starship/commits?author=andrewda" title="Code">💻</a></td> <td align="center"><a href="https://andrewda.me"><img src="https://avatars1.githubusercontent.com/u/10191084?v=4" width="100px;" alt="Andrew Dassonville" /><br /><sub><b>Andrew Dassonville</b></sub></a><br /><a href="https://github.com/starship/starship/issues?q=author%3Aandrewda" title="Bug reports">🐛</a> <a href="https://github.com/starship/starship/commits?author=andrewda" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/MaT1g3R"><img src="https://avatars1.githubusercontent.com/u/15258494?v=4" width="100px;" alt="MaT1g3R"/><br /><sub><b>MaT1g3R</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=MaT1g3R" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=MaT1g3R" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=MaT1g3R" title="Tests">⚠️</a></td> <td align="center"><a href="https://github.com/MaT1g3R"><img src="https://avatars1.githubusercontent.com/u/15258494?v=4" width="100px;" alt="MaT1g3R" /><br /><sub><b>MaT1g3R</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=MaT1g3R" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=MaT1g3R" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=MaT1g3R" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/AZanellato"><img src="https://avatars3.githubusercontent.com/u/30451287?v=4" width="100px;" alt="André Zanellato"/><br /><sub><b>André Zanellato</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=AZanellato" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=AZanellato" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=AZanellato" title="Tests">⚠️</a></td> <td align="center"><a href="https://github.com/AZanellato"><img src="https://avatars3.githubusercontent.com/u/30451287?v=4" width="100px;" alt="André Zanellato" /><br /><sub><b>André Zanellato</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=AZanellato" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=AZanellato" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=AZanellato" title="Tests">⚠️</a></td>
<td align="center"><a href="https://saghm.com"><img src="https://avatars2.githubusercontent.com/u/5875560?v=4" width="100px;" alt="Saghm Rossi"/><br /><sub><b>Saghm Rossi</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=saghm" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=saghm" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=saghm" title="Tests">⚠️</a></td> <td align="center"><a href="https://saghm.com"><img src="https://avatars2.githubusercontent.com/u/5875560?v=4" width="100px;" alt="Saghm Rossi" /><br /><sub><b>Saghm Rossi</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=saghm" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=saghm" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=saghm" title="Tests">⚠️</a></td>
<td align="center"><a href="https://medium.com/@cappyzawa"><img src="https://avatars3.githubusercontent.com/u/12455284?v=4" width="100px;" alt="Shu Kutsuzawa"/><br /><sub><b>Shu Kutsuzawa</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=cappyzawa" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=cappyzawa" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=cappyzawa" title="Tests">⚠️</a> <a href="#translation-cappyzawa" title="Translation">🌍</a></td> <td align="center"><a href="https://medium.com/@cappyzawa"><img src="https://avatars3.githubusercontent.com/u/12455284?v=4" width="100px;" alt="Shu Kutsuzawa" /><br /><sub><b>Shu Kutsuzawa</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=cappyzawa" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=cappyzawa" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=cappyzawa" title="Tests">⚠️</a> <a href="#translation-cappyzawa" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/iamsauravsharma"><img src="https://avatars0.githubusercontent.com/u/38726015?v=4" width="100px;" alt="Saurav Sharma"/><br /><sub><b>Saurav Sharma</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=iamsauravsharma" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=iamsauravsharma" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/iamsauravsharma"><img src="https://avatars0.githubusercontent.com/u/38726015?v=4" width="100px;" alt="Saurav Sharma" /><br /><sub><b>Saurav Sharma</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=iamsauravsharma" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=iamsauravsharma" title="Documentation">📖</a></td>
</tr> </tr>
<tr> <tr>
<td align="center"><a href="https://github.com/andytom"><img src="https://avatars1.githubusercontent.com/u/108836?v=4" width="100px;" alt="Thomas O'Donnell"/><br /><sub><b>Thomas O'Donnell</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=andytom" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=andytom" title="Tests">⚠️</a></td> <td align="center"><a href="https://github.com/andytom"><img src="https://avatars1.githubusercontent.com/u/108836?v=4" width="100px;" alt="Thomas O'Donnell" /><br /><sub><b>Thomas O'Donnell</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=andytom" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=andytom" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/bbigras"><img src="https://avatars1.githubusercontent.com/u/24027?v=4" width="100px;" alt="Bruno Bigras"/><br /><sub><b>Bruno Bigras</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=bbigras" title="Code">💻</a> <a href="#review-bbigras" title="Reviewed Pull Requests">👀</a></td> <td align="center"><a href="https://github.com/bbigras"><img src="https://avatars1.githubusercontent.com/u/24027?v=4" width="100px;" alt="Bruno Bigras" /><br /><sub><b>Bruno Bigras</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=bbigras" title="Code">💻</a> <a href="#review-bbigras" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://neilkistner.com/"><img src="https://avatars1.githubusercontent.com/u/186971?v=4" width="100px;" alt="Neil Kistner"/><br /><sub><b>Neil Kistner</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=wyze" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=wyze" title="Tests">⚠️</a> <a href="#review-wyze" title="Reviewed Pull Requests">👀</a></td> <td align="center"><a href="https://neilkistner.com/"><img src="https://avatars1.githubusercontent.com/u/186971?v=4" width="100px;" alt="Neil Kistner" /><br /><sub><b>Neil Kistner</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=wyze" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=wyze" title="Tests">⚠️</a> <a href="#review-wyze" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="http://ca.linkedin.com/in/qstrahl"><img src="https://avatars3.githubusercontent.com/u/2235277?v=4" width="100px;" alt="Quinn Strahl"/><br /><sub><b>Quinn Strahl</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=qstrahl" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=qstrahl" title="Tests">⚠️</a></td> <td align="center"><a href="http://ca.linkedin.com/in/qstrahl"><img src="https://avatars3.githubusercontent.com/u/2235277?v=4" width="100px;" alt="Quinn Strahl" /><br /><sub><b>Quinn Strahl</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=qstrahl" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=qstrahl" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/tivervac"><img src="https://avatars2.githubusercontent.com/u/3389524?v=4" width="100px;" alt="Titouan Vervack"/><br /><sub><b>Titouan Vervack</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=tivervac" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=tivervac" title="Tests">⚠️</a></td> <td align="center"><a href="https://github.com/tivervac"><img src="https://avatars2.githubusercontent.com/u/3389524?v=4" width="100px;" alt="Titouan Vervack" /><br /><sub><b>Titouan Vervack</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=tivervac" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=tivervac" title="Tests">⚠️</a></td>
<td align="center"><a href="http://nosubstance.me"><img src="https://avatars1.githubusercontent.com/u/1269815?v=4" width="100px;" alt="Francisco Lopes"/><br /><sub><b>Francisco Lopes</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=oblitum" title="Code">💻</a></td> <td align="center"><a href="http://nosubstance.me"><img src="https://avatars1.githubusercontent.com/u/1269815?v=4" width="100px;" alt="Francisco Lopes" /><br /><sub><b>Francisco Lopes</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=oblitum" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/ahouts"><img src="https://avatars1.githubusercontent.com/u/16907671?v=4" width="100px;" alt="Andrew Houts"/><br /><sub><b>Andrew Houts</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=ahouts" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=ahouts" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=ahouts" title="Tests">⚠️</a></td> <td align="center"><a href="https://github.com/ahouts"><img src="https://avatars1.githubusercontent.com/u/16907671?v=4" width="100px;" alt="Andrew Houts" /><br /><sub><b>Andrew Houts</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=ahouts" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=ahouts" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=ahouts" title="Tests">⚠️</a></td>
</tr> </tr>
<tr> <tr>
<td align="center"><a href="https://github.com/nickwb"><img src="https://avatars2.githubusercontent.com/u/594211?v=4" width="100px;" alt="Nick Young"/><br /><sub><b>Nick Young</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=nickwb" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=nickwb" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=nickwb" title="Tests">⚠️</a> <a href="#review-nickwb" title="Reviewed Pull Requests">👀</a></td> <td align="center"><a href="https://github.com/nickwb"><img src="https://avatars2.githubusercontent.com/u/594211?v=4" width="100px;" alt="Nick Young" /><br /><sub><b>Nick Young</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=nickwb" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=nickwb" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=nickwb" title="Tests">⚠️</a> <a href="#review-nickwb" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/g2p"><img src="https://avatars1.githubusercontent.com/u/61678?v=4" width="100px;" alt="Gabriel de Perthuis"/><br /><sub><b>Gabriel de Perthuis</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=g2p" title="Code">💻</a></td> <td align="center"><a href="https://github.com/g2p"><img src="https://avatars1.githubusercontent.com/u/61678?v=4" width="100px;" alt="Gabriel de Perthuis" /><br /><sub><b>Gabriel de Perthuis</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=g2p" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/Hofer-Julian"><img src="https://avatars1.githubusercontent.com/u/30049909?v=4" width="100px;" alt="Hofer-Julian"/><br /><sub><b>Hofer-Julian</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=Hofer-Julian" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/Hofer-Julian"><img src="https://avatars1.githubusercontent.com/u/30049909?v=4" width="100px;" alt="Hofer-Julian" /><br /><sub><b>Hofer-Julian</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=Hofer-Julian" title="Documentation">📖</a></td>
<td align="center"><a href="http://blog.unhappychoice.com"><img src="https://avatars3.githubusercontent.com/u/5608948?v=4" width="100px;" alt="Yuji Ueki"/><br /><sub><b>Yuji Ueki</b></sub></a><br /><a href="#content-unhappychoice" title="Content">🖋</a> <a href="#translation-unhappychoice" title="Translation">🌍</a></td> <td align="center"><a href="http://blog.unhappychoice.com"><img src="https://avatars3.githubusercontent.com/u/5608948?v=4" width="100px;" alt="Yuji Ueki" /><br /><sub><b>Yuji Ueki</b></sub></a><br /><a href="#content-unhappychoice" title="Content">🖋</a> <a href="#translation-unhappychoice" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/heyrict"><img src="https://avatars3.githubusercontent.com/u/25698503?v=4" width="100px;" alt="谢祯晖"/><br /><sub><b>谢祯晖</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=heyrict" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=heyrict" title="Documentation">📖</a> <a href="#translation-heyrict" title="Translation">🌍</a> <a href="#review-heyrict" title="Reviewed Pull Requests">👀</a></td> <td align="center"><a href="https://github.com/heyrict"><img src="https://avatars3.githubusercontent.com/u/25698503?v=4" width="100px;" alt="谢祯晖" /><br /><sub><b>谢祯晖</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=heyrict" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=heyrict" title="Documentation">📖</a> <a href="#translation-heyrict" title="Translation">🌍</a> <a href="#review-heyrict" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://twitter.com/bookun2851"><img src="https://avatars2.githubusercontent.com/u/10346162?v=4" width="100px;" alt="Kutsuzawa Ryo"/><br /><sub><b>Kutsuzawa Ryo</b></sub></a><br /><a href="#review-bookun" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=bookun" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=bookun" title="Tests">⚠️</a> <a href="#translation-bookun" title="Translation">🌍</a></td> <td align="center"><a href="https://twitter.com/bookun2851"><img src="https://avatars2.githubusercontent.com/u/10346162?v=4" width="100px;" alt="Kutsuzawa Ryo" /><br /><sub><b>Kutsuzawa Ryo</b></sub></a><br /><a href="#review-bookun" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=bookun" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=bookun" title="Tests">⚠️</a> <a href="#translation-bookun" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/hdevalke"><img src="https://avatars1.githubusercontent.com/u/2261239?v=4" width="100px;" alt="hdevalke" /><br /><sub><b>hdevalke</b></sub></a><br /><a href="#ideas-hdevalke" title="Ideas, Planning, & Feedback">🤔</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/jakubclark"><img src="https://avatars0.githubusercontent.com/u/19486495?v=4" width="100px;" alt="Kuba Clark" /><br /><sub><b>Kuba Clark</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=jakubclark" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=jakubclark" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=jakubclark" title="Tests">⚠️</a></td>
<td align="center"><a href="http://breax.org"><img src="https://avatars2.githubusercontent.com/u/862483?v=4" width="100px;" alt="Gimbar" /><br /><sub><b>Gimbar</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=gimbar" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=gimbar" title="Tests">⚠️</a> <a href="https://github.com/starship/starship/commits?author=gimbar" title="Documentation">📖</a></td>
<td align="center"><a href="http://tomhotston.net"><img src="https://avatars0.githubusercontent.com/u/22729355?v=4" width="100px;" alt="Tom Hotston" /><br /><sub><b>Tom Hotston</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=TomHotston" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=TomHotston" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/bijancn"><img src="https://avatars3.githubusercontent.com/u/2117164?v=4" width="100px;" alt="Bijan Chokoufe Nejad" /><br /><sub><b>Bijan Chokoufe Nejad</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=bijancn" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=bijancn" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/yuri1969"><img src="https://avatars3.githubusercontent.com/u/13468636?v=4" width="100px;" alt="yuri" /><br /><sub><b>yuri</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=yuri1969" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=yuri1969" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=yuri1969" title="Tests">⚠️</a></td>
</tr> </tr>
</table> </table>
<!-- ALL-CONTRIBUTORS-LIST:END --> <!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! このプロジェクトは [all-contributors](https://github.com/all-contributors/all-contributors) の仕様に従っています。 どんな種類の貢献でもお待ちしています!
## 💭 Inspired By ## 影響を受けたプロダクト
Please check out these previous works that helped inspire the creation of starship. 🙏 よければStarship の作成に影響を与えた、これまでのプロジェクトをチェックしてください 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts. - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - 宇宙飛行士のための ZSH プロンプト。
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - Cross-shell robbyrussell theme written in JavaScript. - **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - 多くの shell に対応した JavaScript で書かれた robbyrussell テーマ。
- **[reujab/silver](https://github.com/reujab/silver)** - A cross-shell customizable powerline-like prompt with icons. - **[reujab/silver](https://github.com/reujab/silver)** - 多くの shell に対応しているカスタマイズ可能でアイコンを表示できる powerline のようなプロンプト。
<p align="center"> <p align="center">
<br> <br>
<img width="100" src="media/icon.png" alt="Starship rocket icon"> <img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon">
</p> </p>
## 📝 License ## 📝 ライセンス
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br> Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br /> このプロジェクトは [ISC](https://github.com/starship/starship/blob/master/LICENSE) でライセンスされています。
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.

View File

@ -52,7 +52,7 @@ module.exports = {
// Custom sidebar values // Custom sidebar values
sidebar: [ sidebar: [
"/ja/", "/ja/",
["/guide/", "ガイド"], ["/ja/guide/", "ガイド"],
["/ja/config/", "設定"], ["/ja/config/", "設定"],
["/ja/advanced-config/", "高度な設定"] ["/ja/advanced-config/", "高度な設定"]
], ],

View File

@ -1,15 +1,15 @@
--- ---
home: 'true' home: true
heroImage: "/logo.svg" heroImage: /logo.svg
actionText: Get Started → actionText: Get Started →
actionLink: "/guide/" actionLink: /ja/guide/
footer: ISC Licensed | Copyright © 2019-present Starship Contributors footer: ISC Licensed | Copyright © 2019-present Starship Contributors
--- ---
<div class="features"> <div class="features">
<div class="feature"> <div class="feature">
<h2>互換性優先</h2> <h2>互換性優先</h2>
<p>一般的なほとんどのOSの一般的なほとんどのシェル上で動作します。あらゆるところで使用してください</p> <p>一般的なほとんどのOSの一般的なほとんどのシェル上で動作します。 あらゆるところで使用してください!</p>
</div> </div>
<div class="feature"> <div class="feature">
<h2>Rust 製</h2> <h2>Rust 製</h2>
@ -25,75 +25,83 @@ footer: ISC Licensed | Copyright © 2019-present Starship Contributors
<video class="demo-video" autoplay muted loop> <video class="demo-video" autoplay muted loop>
<source src="/demo.webm" type="video/webm"> <source src="/demo.webm" type="video/webm">
<source src="/demo.mp4" type="video/mp4"> <source src="/demo.mp4" type="video/mp4">
</source></source></video> </video>
</div> </div>
### クイックインストール ### クイックインストール
1. **Starship** のバイナリをインストール 1. **Starship** のバイナリをインストール
もし以下のプラットフォームを使用していない場合は **[コンパイル済みのバイナリファイルをダウンロード](https://github.com/starship/starship/releases)** してください。 もし以下のプラットフォームを使用していない場合は **[コンパイル済みのバイナリファイルをダウンロード](https://github.com/starship/starship/releases)** してください。
#### Homebrew
```sh #### Homebrew
$ brew install starship
```
#### Rust (v1.33 もしくはそれ以上) ```sh
$ brew install starship
```
```sh
$ cargo install starship
```
#### Arch Linux (AUR) #### Rust (v1.33 もしくはそれ以上)
Starship は AUR 上の `starship` というパッケージ名で利用可能です。`yay` またはお好きな AUR ヘルパーでインストールしてください。 ```sh
$ cargo install starship
```
```sh
$ yay -S starship
```
#### Nix (unstable) #### Arch Linux (AUR)
```sh Starship は AUR 上の `starship` というパッケージ名で利用可能です。 `yay` またはお好きな AUR ヘルパーでインストールしてください。
$ nix-env --install starship
```
#### Termux ```sh
$ yay -S starship
```
```sh
$ pkg install starship
```
2. 初期化のためのスクリプトをシェルの設定ファイルに追加 #### Nix (unstable)
#### Bash ```sh
$ nix-env --install starship
```
`~/.bashrc` の最後に以下を追記してください
```sh #### Termux
# ~/.bashrc
eval "$(starship init bash)" ```sh
``` $ pkg install starship
```
#### Fish 1. 初期化のためのスクリプトをシェルの設定ファイルに追加
`~/.config/fish/config.fish` の最後に以下を追記してください
```sh #### Bash
# ~/.config/fish/config.fish
eval (starship init fish) `~/.bashrc` の最後に以下を追記してください
```
#### Zsh ```sh
# ~/.bashrc
`~/.zshrc` の最後に以下を追記してください eval "$(starship init bash)"
```
```sh
# ~/.zshrc
eval "$(starship init zsh)" #### Fish
```
`~/.config/fish/config.fish` の最後に以下を追記してください
```sh
# ~/.config/fish/config.fish
eval (starship init fish)
```
#### Zsh
`~/.zshrc` の最後に以下を追記してください
```sh
# ~/.zshrc
eval "$(starship init zsh)"
```

View File

@ -1,16 +1,18 @@
# 高度な設定 # 高度な設定
Starship は汎用性の高いシェルですが、時には特定の処理を行うために `starship.toml` を編集する以上のことをする必要があります。このページでは starship で使用される、より高度な設定の一部を詳しく説明していきます。 Starship は汎用性の高いシェルですが、時には特定の処理を行うために `starship.toml` を編集する以上のことをする必要があります。 このページでは starship で使用される、より高度な設定の一部を詳しく説明していきます。
::: warning ::: warning
ここに載せられた設定は、Starship の将来のリリースで変更される可能性があります。 ここに載せられた設定は、Starship の将来のリリースで変更される可能性があります。
:::
:::
## Bashのカスタムの事前プロンプトおよび事前実行コマンド ## Bashのカスタムの事前プロンプトおよび事前実行コマンド
Bashには、他のほとんどのシェルとは違い、正式な preexec / precmd フレームワークを持っていません。そのため、 `bash`で完全にカスタマイズ可能なフックを提供することは困難です。ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。 Bashには、他のほとんどのシェルとは違い、正式な preexec / precmd フレームワークを持っていません。 そのため、 `bash`で完全にカスタマイズ可能なフックを提供することは困難です。 ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。
- 関数をプロンプトが描画される直前に実行するためには、新しい関数を定義して `starship_precmd_user_func` に割り当ててください。例として、ロケットをプロンプトの前に表示させたければ、 - 関数をプロンプトが描画される直前に実行するためには、新しい関数を定義して `starship_precmd_user_func` に割り当ててください。 例として、ロケットをプロンプトの前に表示させたければ、下記のようにしてください。
```bash ```bash
function blastoff(){ function blastoff(){
@ -19,20 +21,19 @@ function blastoff(){
starship_precmd_user_func="blastoff" starship_precmd_user_func="blastoff"
``` ```
- コマンドの直前に関数を実行するために、[`DEBUG` トラップの仕組み](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/)を使うことができます。しかし、Starship を初期化する前に DEBUG シグナルをトラップ**しなければいけません**Starship は DEBUGトラップの値を保護できますが、 starship の起動後にトラップが上書きされると、いくつかの機能は壊れてしまうでしょう。 - コマンドの直前に関数を実行するために、[`DEBUG` トラップの仕組み](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/)を使うことができます。 しかし、Starship を初期化する前に DEBUG シグナルをトラップ*しなければいけません* Starship は DEBUGトラップの値を保護できますが、 starship の起動後にトラップが上書きされると、いくつかの機能は壊れてしまうでしょう。
```bash ```bash
function blastoff(){ function blastoff(){
echo "🚀" echo "🚀"
} }
trap blastoff DEBUG # Trap DEBUG *before* running starship trap blastoff DEBUG # starshipを起動する前にDEBUGをトラップする
eval $(starship init bash) eval $(starship init bash)
``` ```
## ウィンドウのタイトルの変更 ## ウィンドウのタイトルの変更
いくつかのシェルプロンプトはあなたのためにウィンドウのタイトルを自動的に変更します(例えば、カレントディレクトリを反映するために)。特に Fish はデフォルトで変更を行います。 いくつかのシェルプロンプトはあなたのためにウィンドウのタイトルを自動的に変更します(例えば、カレントディレクトリを反映するために)。 特に Fish はデフォルトで変更を行います。 Starship はこれをしませんが、この機能を `bash``zsh` に追加することは簡単にできます。
Starship はこれをしませんが、この機能を `bash``zsh` に追加することは簡単にできます。
まず、ウィンドウのタイトルを変更する関数を定義してください( bash も zsh も同様に) まず、ウィンドウのタイトルを変更する関数を定義してください( bash も zsh も同様に)
@ -56,29 +57,28 @@ starship_precmd_user_func="set_win_title"
precmd_functions+=(set_win_title) precmd_functions+=(set_win_title)
``` ```
もし結果に満足したら、永続化のためそれぞれの行を もし結果に満足したら、永続化のためそれぞれの行を (`~/.bashrc` もしくは `~/.zsrhc`) に追加してください。
(`~/.bashrc` もしくは `~/.zsrhc`) に追加してください。
## 文字の装飾 ## スタイルの設定
スタイル文字列は空白で区切られた単語のリストです。大文字小文字を区別しません(例えば、 `bold` と`BoLd` は同じだとみなされます)。それぞれ以下のいずれか一つが該当します。 スタイル文字列は空白で区切られた単語のリストです。 大文字小文字を区別しません(例えば、 `bold` と`BoLd` は同じだとみなされます)。 それぞれ以下のいずれか一つが該当します。
- `bold` - `bold`
- `underline` - `underline`
- `dimmed` - `dimmed`
- `bg:<color>` - `bg:<color>`
- `fg:<color>` - `fg:<color>`
- `<color>` - `<color>`
- `none` - `none`
ここで、 `<color>` は色を指定します(以下で述べます)。 `fg:<color>``<color>` は現在同様の動作ですが、将来変更される可能性があります。文字列中の単語の順序は関係ありません。 ここで、 `<color>` は色を指定します(以下で述べます)。 `fg:<color>``<color>` は現在同様の動作ですが、将来変更される可能性があります。 文字列中の単語の順序は関係ありません。
例えば `fg:red none fg:blue` は依然としてスタイルのない文字列となるように、 `none` は他の文字列中の他の単語すべてを上書きします。将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。 例えば `fg:red none fg:blue` は依然としてスタイルのない文字列となるように、 `none` は他の文字列中の他の単語すべてを上書きします。 将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。
色は以下のいずれか1つを指定できます。 色は以下のいずれか1つを指定できます。
- 標準的なターミナルカラーの `black``red``green``blue`、`yellow`、 `purple``cyan``white`。必要に応じて、より明るい色を得るために `bright-` を前につけることができます。(例えば、 `bright-white` - 標準的なターミナルカラーの `black``red``green``blue` `yellow``purple``cyan``white` 必要に応じて、より明るい色を得るために `bright-` を前につけることができます。(例えば、 `bright-white`
- `#` に続く16進数。[RGB の16進数カラーコード](https://www.w3schools.com/colors/colors_hexadecimal.asp)を表します。 - `#` に続く16進数。 [RGB の16進数カラーコード](https://www.w3schools.com/colors/colors_hexadecimal.asp)を表します。
- 0-255 までの間の数字。[8-bit ANSI カラーコード](https://i.stack.imgur.com/KTSQa.png) を表します。 - 0-255 までの間の数字。 [8-bit ANSI カラーコード](https://i.stack.imgur.com/KTSQa.png) を表します。
複数の色が文字色/背景色に指定された際には、最後の指定が優先して選ばれます。 複数の色が文字色/背景色に指定された際には、最後の指定が優先して選ばれます。

View File

@ -1,37 +1,39 @@
# 設定 # 設定
::: tip ::: tip
🔥Starshipの開発は現在も進んでいます。多くの新しいオプションが今後のリリースで利用可能になります。
🔥Starshipの開発は現在も進んでいます。 多くの新しいオプションが今後のリリースで利用可能になります。
::: :::
starshipの設定を開始するには、`~/.config/starship.toml` ファイルを作成します。 Starshipの設定を開始するには、`~/.config/starship.toml` ファイルを作成します。
```shell ```shell
$ touch ~/.config/starship.toml $ touch ~/.config/starship.toml
``` ```
starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。 Starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。
```toml ```toml
# プロンプト表示時に改行しない # Don't print a new line at the start of the prompt
add_newline = false add_newline = false
# "" から "➜" に表示を変更 # Replace the "" symbol in the prompt with "➜"
[character] # The name of the module we are confguring is "character" [character] # The name of the module we are configuring is "character"
symbol = "➜" # The "symbol" segment is being set to "➜" symbol = "➜" # The "symbol" segment is being set to "➜"
# packageモジュールを無効にする # Disable the package module, hiding it from the prompt completely
[package] [package]
disabled = true disabled = true
``` ```
### 用語 ### 用語
**モジュール**: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。たとえば、現在のディレクトリがNodeJSプロジェクトである場合、「nodejs」モジュールは、現在コンピューターにインストールされているNodeJSのバージョンを表示します。 **モジュール**: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。 たとえば、現在のディレクトリがNodeJSプロジェクトである場合、「nodejs」モジュールは、現在コンピューターにインストールされているNodeJSのバージョンを表示します。
**セグメント**: モジュールを構成する小さなサブコンポーネントです。たとえば、「nodejs」モジュールの「symbol」セグメントには、バージョン番号の前に表示される文字が含まれていますデフォルト: ⬢)。 **セグメント**: モジュールを構成する小さなサブコンポーネントです。 たとえば、「nodejs」モジュールの「symbol」セグメントには、バージョン番号の前に表示される文字が含まれていますデフォルト: ⬢)。
以下はNode モジュールの表現です。次の例では、「シンボル」と「バージョン」はその中のセグメントです。すべてのモジュールには、デフォルトの端末色であるprefixとsuffixもあります。 以下はNode モジュールの表現です。 次の例では、「シンボル」と「バージョン」はその中のセグメントです。 すべてのモジュールには、デフォルトの端末色であるprefixとsuffixもあります。
``` ```
[prefix] [symbol] [version] [suffix] [prefix] [symbol] [version] [suffix]
@ -40,16 +42,16 @@ disabled = true
### スタイルの設定 ### スタイルの設定
starshipのほとんどのモジュールでは、表示スタイルを設定できます。これは、設定を指定する文字列であるエントリ`style`)で行われます。スタイル文字列の例とその機能を次に示します。完全な構文の詳細については、詳細は [高度な設定](/advanced-config/)を参照してください 。 Starshipのほとんどのモジュールでは、表示スタイルを設定できます。 これは、設定を指定する文字列であるエントリ(`style`)で行われます。 スタイル文字列の例とその機能を次に示します。 完全な構文の詳細については、詳細は [高度な設定](/advanced-config/)を参照してください 。
- `"fg:green bg:blue"`は、青色の背景に緑色のテキストを設定します - `"fg:green bg:blue"` は、青色の背景に緑色のテキストを設定します
- `"bg:blue fg:bright-green"`は、青色の背景に明るい緑色のテキストを設定します - `"bg:blue fg:bright-green"` は、青色の背景に明るい緑色のテキストを設定します
- `"bold fg:27"`は、 [ANSIカラー](https://i.stack.imgur.com/KTSQa.png) 27の太字テキストを設定します - `"bold fg:27"` は、 [ANSIカラー](https://i.stack.imgur.com/KTSQa.png) 27の太字テキストを設定します
- `"underline bg:#bf5700"`は、焦げたオレンジ色の背景に下線付きのテキストを設定します - `"underline bg:#bf5700"` は、焦げたオレンジ色の背景に下線付きのテキストを設定します
- `"bold italic fg:purple"`は、紫色の太字斜体のテキストを設定します - `"bold italic fg:purple"`は、紫色の太字斜体のテキストを設定します
- `""`はすべてのスタイルを明示的に無効にします - `""` はすべてのスタイルを明示的に無効にします
スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。 スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。 たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。 また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。
## プロンプト ## プロンプト
@ -57,10 +59,10 @@ starshipのほとんどのモジュールでは、表示スタイルを設定で
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | -------------- | ----------------------- | ------------------------ |
`add_newline` | `true` | プロンプトの開始前に新しい行を追加します。 | `add_newline` | `true` | プロンプトの開始前に新しい行を追加します。 |
`prompt_order` | [link](#デフォルトのプロンプト表示順) | プロンプトモジュールを出力する順序を設定します。 | `prompt_order` | [link](#デフォルトのプロンプト表示順) | プロンプトモジュールを出力する順序を設定します。 |
### 設定例 ### 設定例
@ -75,7 +77,7 @@ prompt_order=["rust","line_break","package","line_break","character"]
### デフォルトのプロンプト表示順 ### デフォルトのプロンプト表示順
デフォルトの`prompt_order`は、空の場合、または`prompt_order`が指定されていない場合に、プロンプトにモジュールが表示される順序を定義するために使用されます。デフォルトは次のとおりです。 デフォルトの`prompt_order`は、空の場合、または`prompt_order`が指定されていない場合に、プロンプトにモジュールが表示される順序を定義するために使用されます。 デフォルトは次のとおりです。
```toml ```toml
prompt_order = [ prompt_order = [
@ -91,29 +93,66 @@ prompt_order = [
"rust", "rust",
"python", "python",
"golang", "golang",
"java",
"nix_shell", "nix_shell",
"aws",
"env_var",
"cmd_duration", "cmd_duration",
"line_break", "line_break",
"jobs", "jobs",
"time",
"battery", "battery",
"time",
"character", "character",
] ]
``` ```
## バッテリー ## AWS
`battery`モジュールは、デバイスのバッテリー残量と現在の充電状態を示します。モジュールは、デバイスのバッテリー残量が10未満の場合にのみ表示されます。 `aws` モジュールは現在のAWSプロファイルが表示されます。 これは`AWS_PROFILE`環境変数に基づいています。
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | --------------- | ----------------------------- |
`full_symbol` | `"•"` | バッテリーが満タンのときに表示される記号です。 | `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
`charging_symbol` | `"⇡"` | バッテリーの充電中に表示される記号です。 | `style` | `"bold yellow"` | モジュールのスタイルです。 |
`discharging_symbol` | `"⇣"` | バッテリーが放電しているときに表示される記号です。 | `disabled` | `false` | `aws`モジュールを無効にします。 |
`display` | [link](#バッテリーの表示) | モジュールの閾値とスタイルを表示します。
`disabled` | `false` | `battery`モジュールを無効にします。 ### 設定例
```toml
# ~/.config/starship.toml
[aws]
style = "bold blue"
symbol = "🅰 "
```
## バッテリー
`battery`モジュールは、デバイスのバッテリー残量と現在の充電状態を示します。 モジュールは、デバイスのバッテリー残量が10未満の場合にのみ表示されます。
### オプション
| 変数 | デフォルト | 説明 |
| -------------------- | ------------------------ | ------------------------- |
| `full_symbol` | `"•"` | バッテリーが満タンのときに表示される記号です。 |
| `charging_symbol` | `"⇡"` | バッテリーの充電中に表示される記号です。 |
| `discharging_symbol` | `"⇣"` | バッテリーが放電しているときに表示される記号です。 |
| `display` | [link](#battery-display) | モジュールの閾値とスタイルを表示します。 |
| `disabled` | `false` | `battery`モジュールを無効にします。 |
<details>
<summary>いくつかのまれなバッテリー状態のオプションもあります。</summary>
| 変数 | 説明 |
| ---------------- | ------------------------ |
| `unknown_symbol` | バッテリー状態が不明なときに表示される記号です。 |
| `empty_symbol` | バッテリーが空のときに表示される記号です。 |
オプションを指定しない限り、バッテリーの状態が`unknown`もしくは`empty`になった場合にインジケーターは非表示になります。
</details>
### 設定例 ### 設定例
@ -128,8 +167,8 @@ discharging_symbol = "💀"
### バッテリーの表示 ### バッテリーの表示
`display` 設定オプションは、バッテリーインジケーターを表示するタイミングthresholdと見た目styleを定義するために使用されます。 `display</ 0> オプションを使用して、バッテリーインジケーターを表示するタイミング(閾値)と外観(スタイル)を定義します。
`display` が設定されていない場合のデフォルトは次のとおりです: <code>display` が提供されない場合、 デフォルトは次のとおりです。
```toml ```toml
[[battery.display]] [[battery.display]]
@ -141,10 +180,10 @@ style = "bold red"
`display`オプションは、次の表の通りです。 `display`オプションは、次の表の通りです。
変数 | 説明 | 変数 | 説明 |
--- | --- | ----------- | ------------------------------ |
`threshold` | バッテリーが表示される上限です。 | `threshold` | バッテリーが表示される上限です。 |
`style` | displayオプションが使用されている場合のスタイルです。 | `style` | displayオプションが使用されている場合のスタイルです。 |
#### 設定例 #### 設定例
@ -165,19 +204,19 @@ style = "bold yellow"
`character`モジュールは、端末でテキストが入力される場所の横に文字(通常は矢印)を表示します。 `character`モジュールは、端末でテキストが入力される場所の横に文字(通常は矢印)を表示します。
文字は、最後のコマンドが成功したかどうかを示します。これは、色の変更(赤/緑)またはその形状の変更(/✖)の2つの方法で行うことができます。後者は`use_symbol_for_status`に`true`設定されている場合にのみ行われます。 文字は、最後のコマンドが成功したかどうかを示します。 これは、色の変更(赤/緑)またはその形状の変更(/✖) の2つの方法で行うことができます。 後者は`use_symbol_for_status`に`true`設定されている場合にのみ行われます。
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ----------------------- | -------------- | -------------------------------------------- |
`symbol` | `""` | プロンプトでテキストを入力する前に使用される記号です。 | `symbol` | `""` | プロンプトでテキストを入力する前に使用される記号です。 |
`error_symbol` | `"✖"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される記号です。 | `error_symbol` | `"✖"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される記号です。 |
`use_symbol_for_status` | `false` | シンボルを変更してエラーステータスを示します。 | `use_symbol_for_status` | `false` | シンボルを変更してエラーステータスを示します。 |
`vicmd_symbol` | `""` | シェルがvimの通常モードである場合、プロンプトのテキスト入力の前に使用される記号です。 | `vicmd_symbol` | `""` | シェルがvimの通常モードである場合、プロンプトのテキスト入力の前に使用される記号です。 |
`style_success` | `"bold green"` | 最後のコマンドが成功した場合に使用されるスタイルです。 | `style_success` | `"bold green"` | 最後のコマンドが成功した場合に使用されるスタイルです。 |
`style_failure` | `"bold red"` | 最後のコマンドが失敗した場合に使用されるスタイルです。 | `style_failure` | `"bold red"` | 最後のコマンドが失敗した場合に使用されるスタイルです。 |
`disabled` | `false` | `character`モジュールを無効にします。 | `disabled` | `false` | `character`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -192,21 +231,23 @@ use_symbol_for_status = true
## コマンド実行時間 ## コマンド実行時間
`cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。 `cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。 モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。
::: warning BashでDEBUGトラップをhookしない ::: warning BashでDEBUGトラップをhookしない
`bash`でStarshipを実行している場合、 `eval $(starship init $0)`実行した後に`DEBUG`トラップをフックしないでください。そうしないと、このモジュールが**おそらくですが**壊れます。 `bash`でStarshipを実行している場合、 `eval $(starship init $0)`実行した後に`DEBUG`トラップをフックしないでください。そうしないと、このモジュールが**おそらくですが**壊れます。
::: :::
preexecのような機能を必要とするBashユーザーは、 [rcalorasのbash_preexecフレームワーク](https://github.com/rcaloras/bash-preexec)を使用できます。 `eval $(starship init $0)` を実行する前に、`preexec_functions` 、および`precmd_functions`定義するだけで、通常どおり続行します。 preexecのような機能を必要とするBashユーザーは、 [rcalorasのbash_preexecフレームワーク](https://github.com/rcaloras/bash-preexec)を使用できます。 `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定義するだけで、通常どおり続行します。
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | --------------- | --------------------------- |
`min_time` | `2` | 時間を表示する最短期間です。 | `min_time` | `2` | 時間を表示する最短期間です。 |
`style` | `"bold yellow"` | モジュールのスタイルです。 | `style` | `"bold yellow"` | モジュールのスタイルです。 |
`disabled` | `false` | `cmd_duration`モジュールを無効にします。 | `disabled` | `false` | `cmd_duration`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -219,21 +260,30 @@ min_time = 4
## ディレクトリ ## ディレクトリ
`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。ディレクトリは、現在のgitリポジトリであるとルートとなります。 `directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。 ディレクトリは、現在のgitリポジトリであるとルートとなります。
fishスタイルのpwdオプションを使用すると、切り捨てられたパスを非表示にする代わりに、オプションで有効にした番号に基づいて各ディレクトリの短縮名が表示されます。 fishスタイルのpwdオプションを使用すると、切り捨てられたパスを非表示にする代わりに、オプションで有効にした番号に基づいて各ディレクトリの短縮名が表示されます。
たとえば、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合、`~/D/N/nixpkgs/pkgsが表示されますが、以前はnixpkgs/pkgs`でした 例として、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合を挙げます。 以前は`nixpkgs/pkgs`でしたが、`~/D/N/nixpkgs/pkgs`が表示されます
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ------------------- | ------------- | ----------------------------- |
`truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 | `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 |
`truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 | `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 |
`fish_style_pwd_dir_length` | `0` | fish shellのpwdパスロジックを適用するときに使用する文字数です。 | `style` | `"bold cyan"` | モジュールのスタイルです。 |
`style` | `"bold cyan"` | モジュールのスタイルです。 | `disabled` | `false` | `directory`モジュールを無効にします。 |
`disabled` | `false` | `directory`モジュールを無効にします。
<details>
<summary>このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。</summary>
| 変数 | デフォルト | 説明 |
| --------------------------- | ------ | -------------------------------------------- |
| `fish_style_pwd_dir_length` | `0` | fish shellのpwdパスロジックを適用するときに使用する文字数です。 |
| `use_logical_path` | `true` | OSからのパスの代わりに、シェル(`PWD`) によって提供される論理パスを表示します。 |
</details>
### 設定例 ### 設定例
@ -244,19 +294,48 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた
truncation_length = 8 truncation_length = 8
``` ```
## 環境変数
`env_var`モジュールは、選択された環境変数の現在の値を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- `variable`オプションが、既存の環境変数と一致する
- `variable`オプションが定義されておらず、`default`オプションが定義されている
### オプション
| 変数 | デフォルト | 説明 |
| ---------- | ---------------- | ------------------------------------- |
| `symbol` | | 環境変数を表示する前に使用される記号です。 |
| `variable` | | 表示される環境変数です。 |
| `default` | | 上のvariableが定義されていない場合に表示されるデフォルトの値です。 |
| `prefix` | `""` | 変数の直前に表示するprefixです。 |
| `suffix` | `""` | 変数の直後に表示するsuffixです。 |
| `style` | `"dimmed black"` | モジュールのスタイルです。 |
| `disabled` | `false` | `env_var`モジュールを無効にします。 |
### 設定例
```toml
# ~/.config/starship.toml
[env_var]
variable = "SHELL"
default = "unknown shell"
```
## Git ブランチ ## Git ブランチ
`git_branch`モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。 `git_branch`モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ------------------- | --------------- | ------------------------------------------- |
`symbol` | `" "` | 現在のディレクトリのリポジトリのブランチ名の前に使用されるシンボルです。 | `symbol` | `" "` | 現在のディレクトリのリポジトリのブランチ名の前に使用されるシンボルです。 |
`truncation_length` | `2^63 - 1` | gitブランチをX書記素に切り捨てます | `truncation_length` | `2^63 - 1` | gitブランチをX書記素に切り捨てます。 |
`truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。記号なしに「」も使用できます。 | `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 記号なしに「」も使用できます。 |
`style` | `"bold purple"` | モジュールのスタイルです。 | `style` | `"bold purple"` | モジュールのスタイルです。 |
`disabled` | `false` | `git_branch`モジュールを無効にします。 | `disabled` | `false` | `git_branch`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -271,25 +350,22 @@ truncation_symbol = ""
## Git の進行状態 ## Git の進行状態
`git_state`モジュールはgitディレクトリの進行状態を表します。 `git_state`モジュールはgitディレクトリの進行状態を表します。 (例: _REBASING_, _BISECTING_, その他) 進捗情報がある場合(例: REBASING 3/10)はその情報も表示されます。
例: *REBASING*, *BISECTING*, その他
進捗情報がある場合(例: REBASING 3/10)はその情報も表示されます。
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ------------------ | ------------------ | -------------------------------------------------------- |
`rebase` | `"REBASING"` | `rebase`進行中に表示されるテキストです。 | `rebase` | `"REBASING"` | `rebase`進行中に表示されるテキストです。 |
`merge` | `"MERGING"` | `merge`進行中に表示されるテキストです。 | `merge` | `"MERGING"` | `merge`進行中に表示されるテキストです。 |
`revert` | `"REVERTING"` | `revert`進行中に表示されるテキストです。 | `revert` | `"REVERTING"` | `revert`進行中に表示されるテキストです。 |
`cherry_pick` | `"CHERRY-PICKING"` | `cherry-pick`進行中に表示されるテキストです。 | `cherry_pick` | `"CHERRY-PICKING"` | `cherry-pick`進行中に表示されるテキストです。 |
`bisect` | `"BISECTING"` | `bisect`進行中に表示されるテキストです。 | `bisect` | `"BISECTING"` | `disect`進行中に表示されるテキストです。 |
`am` | `"AM"` | `apply-mailbox` `git am` の進行中に表示されるテキストです。 | `am` | `"AM"` | `apply-mailbox` (`git am`) の進行中に表示されるテキストです。 |
`am_or_rebase` | `"AM/REBASE"` | あいまいな`apply-mailbox`または`rebase`が進行中のときに表示されるテキストです。 | `am_or_rebase` | `"AM/REBASE"` | あいまいな`apply-mailbox`または`rebase`が進行中のときに表示されるテキストです。 |
`progress_divider` | `"/"` | 現在の進行量と合計進行量を分ける記号またはテキスト(例えば、 `" of "``"3 of 10"` )です。 | `progress_divider` | `"/"` | 現在の進行量と合計進行量を分ける記号またはテキストです。 (例: `" of "``"3 of 10"`) |
`style` | `"bold yellow"` | モジュールのスタイルです。 | `style` | `"bold yellow"` | モジュールのスタイルです。 |
`disabled` | `false` | `git_state`モジュールを無効にします。 | `disabled` | `false` | `git_state`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -307,23 +383,23 @@ cherry_pick = "🍒 PICKING"
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ----------------- | ------------ | ------------------------------ |
`conflicted` | `"="` | このブランチにはマージの競合があります。 | `conflicted` | `"="` | このブランチにはマージの競合があります。 |
`ahead` | `"⇡"` | このブランチは、追跡されるブランチよりも先にあります。 | `ahead` | `"⇡"` | このブランチは、追跡されるブランチよりも先にあります。 |
`behind` | `"⇣"` | このブランチは、追跡されているブランチの背後にあります。 | `behind` | `"⇣"` | このブランチは、追跡されているブランチの背後にあります。 |
`diverged` | `"⇕"` | このブランチは、追跡されているブランチから分岐しています。 | `diverged` | `"⇕"` | このブランチは、追跡されているブランチから分岐しています。 |
`untracked` | `"?"` | 作業ディレクトリに追跡されていないファイルがあります。 | `untracked` | `"?"` | 作業ディレクトリに追跡されていないファイルがあります。 |
`stashed` | `"$"` | ローカルリポジトリ用のスタッシュが存在します。 | `stashed` | `"$"` | ローカルリポジトリ用のスタッシュが存在します。 |
`modified` | `"!"` | 作業ディレクトリにファイルの変更があります。 | `modified` | `"!"` | 作業ディレクトリにファイルの変更があります。 |
`staged` | `"+"` | 新しいファイルがステージング領域に追加されました。 | `staged` | `"+"` | 新しいファイルがステージング領域に追加されました。 |
`renamed` | `"»"` | 名前が変更されたファイルがステージング領域に追加されました。 | `renamed` | `"»"` | 名前が変更されたファイルがステージング領域に追加されました。 |
`deleted` | `"✘"` | ファイルの削除がステージング領域に追加されました。 | `deleted` | `"✘"` | ファイルの削除がステージング領域に追加されました。 |
`show_sync_count` | `false` | 追跡されているブランチの先行/後方カウントを表示します。 | `show_sync_count` | `false` | 追跡されているブランチの先行/後方カウントを表示します。 |
`prefix` | `[` | このモジュールの先頭に表示される文字列です。 | `prefix` | `[` | このモジュールの先頭に表示される文字列です。 |
`suffix` | `]` | このモジュールの末尾に表示される文字列です。 | `suffix` | `]` | このモジュールの末尾に表示される文字列です。 |
`style` | `"bold red"` | モジュールのスタイルです。 | `style` | `"bold red"` | モジュールのスタイルです。 |
`disabled` | `false` | `git_status`モジュールを無効にします。 | `disabled` | `false` | `git_status`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -345,7 +421,7 @@ deleted = "🗑"
## Golang ## Golang
`golang`モジュールは、現在インストールされているGolangのバージョンを示します。次の条件のいずれかが満たされると、モジュールが表示されます。 `golang`モジュールは、現在インストールされているGolangのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`go.mod`ファイルが含まれている - カレントディレクトリに`go.mod`ファイルが含まれている
- カレントディレクトリに`go.sum`ファイルが含まれている - カレントディレクトリに`go.sum`ファイルが含まれている
@ -357,11 +433,11 @@ deleted = "🗑"
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | ------------- | ----------------------------- |
`symbol` | `"🐹 "` | Golangのバージョンを表示する前に使用される記号です。 | `symbol` | `"🐹 "` | Golangのバージョンを表示する前に使用される記号です。 |
`style` | `"bold cyan"` | モジュールのスタイルです。 | `style` | `"bold cyan"` | モジュールのスタイルです。 |
`disabled` | `false` | `golang`モジュールを無効にします。 | `disabled` | `false` | `golang`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -378,13 +454,13 @@ symbol = "🏎💨 "
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | --------------------- | -------------------------------- |
`ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 | `ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 |
`prefix` | `""` | ホスト名の直前に表示するprefixです。 | `prefix` | `""` | ホスト名の直前に表示するprefixです。 |
`suffix` | `""` | ホスト名の直後に表示するsuffixです。 | `suffix` | `""` | ホスト名の直後に表示するsuffixです。 |
`style` | `"bold dimmed green"` | モジュールのスタイルです。 | `style` | `"bold dimmed green"` | モジュールのスタイルです。 |
`disabled` | `false` | `hostname`モジュールを無効にします。 | `disabled` | `false` | `hostname`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -400,16 +476,16 @@ disabled = false
## ジョブ ## ジョブ
`jobs`モジュールには、実行中のジョブの現在の数が表示されます。このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。1つ以上のジョブがある、または`threshold`に指定した値以上にジョブがある場合は実行中のジョブの数を表示します。 `jobs`モジュールには、実行中のジョブの現在の数が表示されます。 このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。 1つ以上のジョブがある、または`threshold`に指定した値以上にジョブがある場合は実行中のジョブの数を表示します。
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ----------- | ------------- | ---------------------- |
`symbol` | `"✦ "` | ジョブの数を表示する前に使用される記号です。 | `symbol` | `"✦ "` | ジョブの数を表示する前に使用される記号です。 |
`threshold` | `1` | 超過した場合、ジョブの数を表示します。 | `threshold` | `1` | 超過した場合、ジョブの数を表示します。 |
`style` | `"bold blue"` | モジュールのスタイルです。 | `style` | `"bold blue"` | モジュールのスタイルです。 |
`disabled` | `false` | `jobs`モジュールを無効にします。 | `disabled` | `false` | `jobs`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -427,9 +503,9 @@ threshold = 4
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | ------- | ------------------------------------- |
`disabled` | `false` | `line_break`モジュールを無効にして、プロンプトを1行にします。 | `disabled` | `false` | `line_break`モジュールを無効にして、プロンプトを1行にします。 |
### 設定例 ### 設定例
@ -442,17 +518,17 @@ disabled = true
## Nix-shell ## Nix-shell
`nix_shell`モジュールは、nix-shell環境を示しています。このモジュールは、nixシェル環境内にあるときに表示されます。 `nix_shell`モジュールは、nix-shell環境を示しています。 このモジュールは、nixシェル環境内にあるときに表示されます。
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ------------ | ------------ | ------------------------ |
`use_name` | `false` | nix-shellの名前を表示します。 | `use_name` | `false` | nix-shellの名前を表示します。 |
`impure_msg` | `impure` | impureメッセージをカスタマイズします。 | `impure_msg` | `impure` | impureメッセージをカスタマイズします。 |
`pure_msg` | `pure` | pureメッセージをカスタマイズします。 | `pure_msg` | `pure` | pureメッセージをカスタマイズします。 |
`style` | `"bold red"` | モジュールのスタイルです。 | `style` | `"bold red"` | モジュールのスタイルです。 |
`disabled` | `false` | `nix_shell`モジュールを無効にします。 | `disabled` | `false` | `nix_shell`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -466,9 +542,33 @@ impure_msg = "impure shell"
pure_msg = "pure shell" pure_msg = "pure shell"
``` ```
## Java
`java`モジュールは、現在インストールされているJavaのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`pom.xml`, もしくは`build.gradle`ファイルが含まれている
- カレントディレクトリに拡張子が`.java`, `.class`, もしくは`.jar`のファイルが含まれている
### オプション
| 変数 | デフォルト | 説明 |
| ---------- | -------------- | --------------------------- |
| `symbol` | `"☕ "` | Javaのバージョンを表示する前に使用される記号です。 |
| `style` | `"dimmed red"` | モジュールのスタイルです。 |
| `disabled` | `false` | `Java`モジュールを無効にします。 |
### 設定例
```toml
# ~/.config/starship.toml
[java]
symbol = "🌟 "
```
## NodeJS ## NodeJS
`nodejs`モジュールは、現在インストールされているNodeJSのバージョンを示します。次の条件のいずれかが満たされると、モジュールが表示されます。 `nodejs`モジュールは、現在インストールされているNodeJSのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`package.json`ファイルが含まれている - カレントディレクトリに`package.json`ファイルが含まれている
- カレントディレクトリに`node_modules`ディレクトリが含まれている - カレントディレクトリに`node_modules`ディレクトリが含まれている
@ -476,11 +576,11 @@ pure_msg = "pure shell"
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | -------------- | ----------------------------- |
`symbol` | `"⬢ "` | NodeJSのバージョンを表示する前に使用される記号です。 | `symbol` | `"⬢ "` | NodeJSのバージョンを表示する前に使用される記号です。 |
`style` | `"bold green"` | モジュールのスタイルです。 | `style` | `"bold green"` | モジュールのスタイルです。 |
`disabled` | `false` | `nodejs`モジュールを無効にします。 | `disabled` | `false` | `nodejs`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -493,7 +593,7 @@ symbol = "🤖 "
## パッケージのバージョン ## パッケージのバージョン
`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。このモジュールは現在、 `npm``cargo` 、および`poetry`パッケージをサポートしています。 `package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 このモジュールは現在、 `npm``cargo` 、および`poetry`パッケージをサポートしています。
- **npm** `npm`パッケージバージョンは、現在のディレクトリにある`package.json`から抽出されます - **npm** `npm`パッケージバージョンは、現在のディレクトリにある`package.json`から抽出されます
- **cargo** `cargo`パッケージバージョンは、現在のディレクトリにある`Cargo.toml`から抽出されます。 - **cargo** `cargo`パッケージバージョンは、現在のディレクトリにある`Cargo.toml`から抽出されます。
@ -503,11 +603,11 @@ symbol = "🤖 "
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | ------------ | ---------------------------- |
`symbol` | `"📦 "` | パッケージのバージョンを表示する前に使用される記号です。 | `symbol` | `"📦 "` | パッケージのバージョンを表示する前に使用される記号です。 |
`style` | `"bold red"` | モジュールのスタイルです。 | `style` | `"bold red"` | モジュールのスタイルです。 |
`disabled` | `false` | `package`モジュールを無効にします。 | `disabled` | `false` | `package`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -522,7 +622,7 @@ symbol = "🎁 "
`python`モジュールは、現在インストールされているPythonのバージョンを示します。 `python`モジュールは、現在インストールされているPythonのバージョンを示します。
`pyenv_version_name`が`true`に設定されている場合 、pyenvでのバージョン名が表示されます 。 `pyenvversionname`が`true`に設定されている場合 、pyenvでのバージョン名が表示されます 。
それ以外の場合は、 `python --version`バージョン番号が表示され、アクティブになっている場合は現在のPython仮想環境が表示されます。 それ以外の場合は、 `python --version`バージョン番号が表示され、アクティブになっている場合は現在のPython仮想環境が表示されます。
@ -537,13 +637,13 @@ symbol = "🎁 "
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | -------------------- | --------------- | ---------------------------------------------------- |
`symbol` | `"🐍 "` | Pythonのバージョンを表示する前に使用される記号です。 | `symbol` | `"🐍 "` | Pythonのバージョンを表示する前に使用される記号です。 |
`pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します | `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します |
`pyenv_prefix` | `"pyenv "` | pyenvバージョン表示の前のprefixデフォルトの表示は`pyenv MY_VERSION` )です | `pyenv_prefix` | `"pyenv "` | pyenvバージョン表示の前のprefixデフォルトの表示は`pyenv MY_VERSION`)です |
`style` | `"bold yellow"` | モジュールのスタイルです。 | `style` | `"bold yellow"` | モジュールのスタイルです。 |
`disabled` | `false` | `python`モジュールを無効にします。 | `disabled` | `false` | `python`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -558,18 +658,18 @@ pyenv_prefix = "foo "
## Ruby ## Ruby
`ruby`モジュールは、現在インストールされているRubyのバージョンを示します。次の条件のいずれかが満たされると、モジュールが表示されます。 `ruby`モジュールは、現在インストールされているRubyのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`Gemfile`ファイルが含まれている - カレントディレクトリに`Gemfile`ファイルが含まれている
- カレントディレクトリに`.rb`の拡張子のファイルが含まれている - カレントディレクトリに`.rb`の拡張子のファイルが含まれている
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | ------------ | --------------------------- |
`symbol` | `"💎 "` | Rubyのバージョンを表示する前に使用される記号です。 | `symbol` | `"💎 "` | Rubyのバージョンを表示する前に使用される記号です。 |
`style` | `"bold red"` | モジュールのスタイルです。 | `style` | `"bold red"` | モジュールのスタイルです。 |
`disabled` | `false` | `ruby`モジュールを無効にします。 | `disabled` | `false` | `ruby`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -582,18 +682,18 @@ symbol = "🔺 "
## Rust ## Rust
`rust`モジュールには、現在インストールされているRustのバージョンが表示されます。次の条件のいずれかが満たされると、モジュールが表示されます。 `rust`モジュールには、現在インストールされているRustのバージョンが表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`Cargo.toml`ファイルが含まれている - カレントディレクトリに`Cargo.toml`ファイルが含まれている
- カレントディレクトリに`.rs`の拡張子のファイルが含まれている - カレントディレクトリに`.rs`の拡張子のファイルが含まれている
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | ------------ | --------------------------- |
`symbol` | `"🦀 "` | Rustのバージョンを表示する前に使用される記号です。 | `symbol` | `"🦀 "` | Rustのバージョンを表示する前に使用される記号です。 |
`style` | `"bold red"` | モジュールのスタイルです。 | `style` | `"bold red"` | モジュールのスタイルです。 |
`disabled` | `false` | `rust`モジュールを無効にします。 | `disabled` | `false` | `rust`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -606,22 +706,24 @@ symbol = "⚙️ "
## 時刻 ## 時刻
`time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。 `time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。
::: tip ::: tip
このモジュールはデフォルトで無効になっています。有効にするには、設定ファイルで`disabled`を`false`に設定します。
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。
::: :::
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ---------- | -------------- | ------------------------------------------------------------------------------------------------- |
`12hr` | `false` | 12時間のフォーマットを有効にします。 | `12hr` | `false` | 12時間のフォーマットを有効にします。 |
`format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 | `format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 |
`style` | `bold yellow` | モジュールのスタイルです。 | `style` | `bold yellow` | モジュールのスタイルです。 |
`disabled` | `true` | `time`モジュールを無効にします。 | `disabled` | `true` | `time`モジュールを無効にします。 |
`12hr`が`true` 、 `format`デフォルトで`"%r"`です。それ以外の場合、デフォルトは`"%T"`です。 `format`を手動で設定すると、 `12hr`の設定が上書きされます。 `12hr`が`true` 、 `format`デフォルトで`"%r"`です。 それ以外の場合、デフォルトは`"%T"`です。 `format`を手動で設定すると、 `12hr`の設定が上書きされます。
### 設定例 ### 設定例
@ -633,21 +735,23 @@ disabled = false
format = "🕙[ %T ]" format = "🕙[ %T ]"
``` ```
## ユーザ名 ## ユーザ
`username`モジュールには、アクティブなユーザーのユーザー名が表示されます。次の条件のいずれかが満たされると、モジュールが表示されます。 `username`モジュールには、アクティブなユーザーのユーザー名が表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントユーザーがroot - カレントユーザーがroot
- カレントユーザーが、ログインしているユーザーとは異なる - カレントユーザーが、ログインしているユーザーとは異なる
- ユーザーがSSHセッションとして接続されている - ユーザーがSSHセッションとして接続されている
- `show_always`変数がtrueに設定されている
### オプション ### オプション
変数 | デフォルト | 説明 | 変数 | デフォルト | 説明 |
--- | --- | --- | ------------- | --------------- | ------------------------- |
`style_root` | `"bold red"` | ユーザーがrootのときに使用されるスタイルです。 | `style_root` | `"bold red"` | ユーザーがrootのときに使用されるスタイルです。 |
`style_user` | `"bold yellow"` | 非rootユーザーに使用されるスタイルです。 | `style_user` | `"bold yellow"` | 非rootユーザーに使用されるスタイルです。 |
`disabled` | `false` | `username`モジュールを無効にします。 | `show_always` | `false` | `username`モジュールを常に表示します。 |
| `disabled` | `false` | `username`モジュールを無効にします。 |
### 設定例 ### 設定例

1
docs/ja/guide/README.md Symbolic link
View File

@ -0,0 +1 @@
../../../README.ja.md