.. | ||
README.md |
ウェブサイト
·
インストール
·
設定
Starship は小さく、とても高速に動作し、非常にカスタマイズ可能なすべてのシェルに対応したプロンプトです!
プロンプトには、作業中に必要な情報が表示されます。
🍬 機能
- 最後のコマンドがゼロ以外のコードで終了すると、プロンプト文字が赤に変わります
- ログインユーザーと異なる場合にユーザー名を表示する
- 現在の Java のバージョン (
☕
) - 現在の Node.js のバージョン (
⬢
) - 現在の Rust のバージョン (
🦀
) - 現在の Ruby のバージョン (
💎
) - 現在の Python のバージョン (
🐍
) - 現在の Go バージョン (
🐹
) - Nix-shell の環境検出
- 指定した1つの環境変数の表示
- カレントディレクトリにある現在のパッケージバージョン(
📦
)- npm (Node.js)
- cargo (Rust)
- poetry (Python)
- 現在のバッテリー残量と状態
- 現在の Git ブランチとリッチなリポジトリの状態
=
— 競合している変更⇡
— リモートブランチより進んでいる変更⇣
—リモートブランチに追いついていない変更⇕
— 分岐した変更?
— 追跡されていない変更$
— stashされた変更!
— 変更されたファイル+
— 追加されたファイル»
— 名前が変更されたファイル✘
— 削除されたファイル
- 閾値を超えた際の、コマンドの実行時間
- バックグラウンドジョブのインジケーター (
✦
) - 現在のKubernetesクラスタとネームスペース (
☸
) - Current AWS profile (
☁️
)
🚀 インストール
必要なもの
- Powerline フォント がターミナルにインストールされて有効になっている必要があります(例えば Fira Code を試してみてください)。
入門
-
Starship のバイナリをインストール
もし以下のプラットフォームを使用していない場合は コンパイル済みのバイナリファイルをダウンロード してください。
Homebrew
$ brew install starship
Rust (v1.38 もしくはそれ以上)
$ cargo install starship
Arch Linux (AUR)
Starship は AUR 上の
starship
というパッケージ名で利用可能です。yay
またはお好きな AUR ヘルパーでインストールしてください。$ yay -S starship
Nix (unstable)
$ nix-env --install starship
Termux
$ pkg install starship
Other x86-64 Linux Platforms
Download a prebuilt binary and place in /usr/local/bin/
$ wget -q --show-progress https://github.com/starship/starship/releases/latest/download/starship-x86_64-unknown-linux-gnu.tar.gz $ tar xvf starship-x86_64-unknown-linux-gnu.tar.gz $ sudo mv starship /usr/local/bin/
-
初期化のためのスクリプトをシェルの設定ファイルに追加
Bash
~/.bashrc
の最後に以下を追記してください# ~/.bashrc eval "$(starship init bash)"
Fish
~/.config/fish/config.fish
の最後に以下を追記してください# ~/.config/fish/config.fish starship init fish | source
Zsh
~/.zshrc
の最後に以下を追記してください# ~/.zshrc eval "$(starship init zsh)"
Powershell
Add the following to the end of
~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1
(or~/.config/powershell/Microsoft.PowerShell_profile.ps1
on -Nix):# ~\Documents\PowerShell\Profile.ps1 Invoke-Expression (&starship init powershell)
🔧 設定
Starship の設定方法の詳細に関しては、ドキュメントをチェックしてください。
🤝 貢献
私たちは常にすべてのスキルレベルの貢献者を探しています! もし簡単にプロジェクトへ参加する方法をお探しなら、 good first issue に取り組んでみてください。
特に必要としています
- 👩💼 プロダクトマネージャー
- GitHub のプロジェクトには、整理/優先度付けがされていない機能や、Issue になっていないアイデアが多くあります。 プロダクトの方針を持っていただける方が Starship には必要です!
- 👩🎨 デザイナー
- 目を引く Web サイトを作りたいですか? 素晴らしい! 我々は Starship の栄光を際立てる美しい Web サイトを作成したいと考えています。 Starship ブランドのデザインを手助けすることは、新しいアイデアを試す絶好の機会です!
- 👩💻 Rust デベロッパー
- 慣用的な Rust の作成、効果的な Rust アーキテクチャの設計、パフォーマンスの最適化、クロスプラットフォームビルドの最適化などに関しては、_多く_の簡単な成果があります。 私(@matchai)は Rust の初心者です。 私たちを正しい方向に向けてください!
もしあなたが Starship への貢献に興味がある場合は、我々の貢献ガイドをご覧ください。 また、気軽に我々のDiscord サーバーへ顔を出してください。 👋
貢献者
これらの素晴らしい方々に感謝します (emoji key):
このプロジェクトは all-contributors の仕様に従っています。 どんな種類の貢献でもお待ちしています!
💭影響を受けたプロダクト
よければStarship の作成に影響を与えた、これまでのプロジェクトをチェックしてください 🙏
-
denysdovhan/spaceship-prompt - 宇宙飛行士のための ZSH プロンプト。
-
denysdovhan/robbyrussell-node - 多くの shell に対応した JavaScript で書かれた robbyrussell テーマ。
-
reujab/silver - 多くの shell に対応しているカスタマイズ可能でアイコンを表示できる powerline のようなプロンプト。
📝 ライセンス
Copyright © 2019-present, Starship Contributors.
このプロジェクトは ISC でライセンスされています。