Show HN: Whetuu – Zigで書かれたゼロコンフィグのクロスシェルプロンプト
Show HN: Whetuu – a zero-config cross-shell prompt written in Zig (yamafaktory.github.io)
要約
WhetuuはZigで書かれた、設定不要で高速なクロスシェルプロンプトです。インストールはcurlコマンド1つで完了し、シェルの設定ファイルに自動的に追加されます。SSH接続時やroot権限時のみユーザー名とホスト名を表示し、現在のディレクトリ、Gitブランチとステータス、言語ツールチェーンのバージョン、コマンド実行時間などを表示します。特に、アップキーで呼び出せる履歴ピッカーは、入力に応じてフィルタリングし、色付けされたコマンド履歴を表示します。ディスクアクセスは並列化されており、Gitのハングアップ時でも250ms以内に応答を返すように設計されています。また、ネットワーク通信やテレメトリは一切行わず、セキュリティとプライバシーに配慮しています。
全文翻訳
~/install
2つの方法
バイナリをダウンロードする。 お使いのプラットフォーム用のtarballを取得し、公開されている SHA256SUMS と照合してから、PATH に配置します。その後、シェル設定に1行追加します。
$ sha256sum -c SHA256SUMS --ignore-missing && tar -xzf whetuu-*.tar.gz && mv whetuu ~/.local/bin/
tarballとチェックサムはリリースページにあります。macOSおよびLinuxのx86-64とARM64用です。
またはインストーラーを実行する。 同様のことを行いますが、uname の入力を省けます。プラットフォームを検出し、ダウンロードを検証し、バイナリを ~/.local/bin に配置し、実際に使用しているシェルの設定に初期化行を追加します。二度実行しても何も変わりません。
$ curl --proto '=https' --tlsv1.2 -fsSL https://yamafaktory.github.io/whetuu/install.sh | sh
シェルにパイプしたくない場合は、まずスクリプトをお読みください。自分で検証できること以外は何も検証しません。
その後、新しいシェルを開きます。これでインストールは完了です。
自分でdotfilesを編集したいですか? WHETUU_NO_MODIFY=1 を付けて実行すると、書き込む代わりにそれらの行を出力します。whetuu init <shell> も同様に行を出力し、それらが属するファイルも示します。PATH の行は、~/.local/bin が既に PATH に含まれていない場合にのみ表示されます。
Nerd Font が必要です。 Whetuuは、Gitブランチ、言語ロゴ、スターをNerd Fontのグリフで描画します。ほとんどのターミナルセットアップでは既に実行されているため、まず試してみてください。スターとブランチのグリフが空のボックスとして表示される場合は、ターミナルのフォントを変更してください。
アップグレード
インストール方法に関わらず、コマンドは1つです。whetuu upgrade --check は、まず待機中のアップデートと変更ログを表示し、インストールは行いません。実行中のバイナリを実行中の最新リリースに置き換え、2つのバージョン間のすべての変更ログエントリを表示します。書き込み前にダウンロードは公開されている SHA256SUMS と照合され、すべてWhetuu自身が行います。curl、tar、シェルは一切使用しません。
$ whetuu upgrade
実行中のシェルは、次のコマンドで新しいバイナリを認識します。初期化スクリプトをリロードするには、新しいシェルを開いてください。パッケージマネージャーによるインストールのように書き込み権限のないバイナリはそのままにされます。
アンインストール
プログラム用とデータ用でそれぞれ1行です。履歴ストアと2つのキャッシュは、バイナリの隣ではなくXDGディレクトリの下に配置されるため、Whetuuを削除しても履歴は失われません。 $XDG_DATA_HOME または $XDG_CACHE_HOME がマシン上でそれらを移動させる可能性がある場合は、まず whetuu paths を実行して4つの場所すべてを確認してください。
$ rm ~/.local/bin/whetuu && rm -rf ~/.local/share/whetuu ~/.cache/whetuu
その後、シェル設定から # whetuu ブロックを削除します。
~/demo
実際のシェルでのデモ
ステータスラインはブランチ、Gitステータス、ツールチェーンのバージョンを追跡します。上矢印キーを押すと履歴ピッカーが開きます。これは入力に応じてフィルタリング・ランク付けし、選択したコマンドを実行します。
demo
[画像: A terminal session. The status line tracks the branch, git status and toolchain version. The history picker then filters and runs a command.]
~/modules
表示されるもの
左から右へ、各セグメントは関連する場合にのみ表示されます。
user_host
ユーザー@ホスト は太字の緑色で表示されますが、SSH接続中またはrootユーザーの場合のみで、その場合は警告として太字の赤色になります。
directory
現在のディレクトリは、$HOME が ~ に省略されます。アンカーの + と、幅に収まるだけの末尾のディレクトリを保持します。
git branch
ブランチのグリフと現在のブランチ、または (detached) がマゼンタ色で表示されます。
git state
進行中の操作が黄色で表示されます: (rebasing 2/7), (merging), (cherry-picking)。追加のサブプロセスなしで、.git から直接読み取られます。
git status
コンフリクト、スタッシュ、ステージング済み、変更済み、追跡されていない、ahead、behind の状態が角括弧で囲まれて表示されます。
language
39言語とツールのブランドカラーで、ロゴとツールチェーンのバージョンが表示されます。プロジェクトのマニフェスト、ソースファイルの拡張子、またはインフラマーカーから検出されます。
cmd_duration
最後のコマンドが2秒以上実行された場合、タイマーのグリフと経過時間が表示されます。
update
公開されている新しいリリースのタグがクラウドグリフと共に表示されます。それ以外の場合は何も表示されません。毎日の whetuu upgrade --check が書き込むファイルから読み取られ、ネットワークからは読み取られません。
character
デフォルトでは紫色のスター、または言語のブランドカラーで表示されます。コマンドが失敗すると赤色に変わります。
~/picker
上矢印キーによる履歴ピッカー
コマンドは、終了時に記録されます。正常終了し、テキストである場合のみ記録されるため、タイプミスやターミナルに貼り付けられた画像はストアに保存されません。各コマンドは実行されたディレクトリと共に保存されます。ピッカーは現在のディレクトリにスコープされて開かれ、履歴がない場合はすべての履歴にフォールバックします。直前に失敗したコマンドは例外です。別のコマンドを実行するまで赤色で最上部に表示されるため、それを選択して修正できます。これは決して保存されません。
whetuu history
2d git commit -m "Cache toolchain versions" 1d cd ~/cf/platform && git push -u origin HEAD 17h docker exec -i PGPASSWORD=x db psql 14m nvim ~/.config/fish/config.fish 11m npm ci
行はシンタックスハイライトされます。 コマンド名、フラグ、パス、変数、引用符で囲まれた文字列、演算子は、ターミナルのテーマの色が適用されるため、ピッカーは既に実行しているパレットと一致します。ウィンドウ幅を超えるコマンドは、末尾ではなく中央が … で省略されるため、長いプレフィックスを共有するコマンドの実行が区別されます。
最も一致するものが最初に表示されます。 入力した文字は順序通りに表示される必要があり、隣接している必要はありません。そのため、gcm は git commit -m を見つけます。実行中のコマンド、単語の先頭、またはコマンドの先頭にある文字は、中間にある同じ文字よりも優先されます。これが git commit -m が git checkout main より上位に来る理由です。等しく適合する2つのコマンドの間では、より頻繁に実行され、より最近実行されたものが優先されます。これはあくまでタイブレークです。検索が空の場合はランク付けされないため、上矢印キーは実行したばかりのコマンドに移動します。
- type フィルタリングとランキング。文字は順序通りに、大文字小文字を区別せずに表示される必要があり、検索のすべての単語が一致する必要があります。
- Backspace / Delete 検索の最後の文字を削除します。カーソルは常に末尾にあるため、どちらのキーも同じ動作をします。
- Ctrl+W / Alt+Backspace 検索の最後の単語を削除します。ここでは単語とは検索自体が分割されるものであり、1回のプレスで検索単語1つが削除されます。
- Ctrl+U 検索をクリアします。ピッカーは既に何か入力されている状態で開かれるため、これは新しい検索を開始する方法です。
- ↑ / ↓ / Ctrl+P / Ctrl+N 選択を移動します。上はより古い履歴に移動します。
- Home / End 最新のコマンド、またはリストの最も古いコマンドにジャンプします。
- Ctrl+G 現在のディレクトリの履歴とすべての履歴を切り替えます。
- Enter 選択したコマンドを実行します。何も一致しない検索は入力通りに実行されます。
- Tab 選択したコマンドをシェルのコマンドラインに配置して実行せずに編集できるようにします。これは、使い慣れたエディタで編集できます。
- Esc キャンセルし、コマンドラインに入力したままにします。
~/commands
日常的に実行することはないもの
シェルフックがすべてを駆動し、ピッカーは上矢印キーに割り当てられているため、これらのうち2つは自動的に呼び出され、自分で入力する必要はありません。これがコマンドの全貌です。
| コマンド | 説明 |
|---|---|
whetuu | コマンドリストを表示します。 |
whetuu --version | バージョンを表示します。 |
whetuu init <fish|bash|zsh> | シェル統合スクリプトを表示します。これは source または eval されることを想定しています。ターミナルに直接実行された場合は、セットアップ行を表示します。 |
whetuu render | 1つのステータスラインをレンダリングします。シェルフックによって呼び出され、自分で実行するものではありません。 |
whetuu history | 対話型履歴ピッカーを開きます。 |
whetuu history add -- <command> | 終了したコマンドを記録します。シェルフックによって呼び出されます。 |
whetuu scrub [<text>] | シークレットパターンに一致するすべての保存済みコマンドと、指定したテキストを含むコマンドを削除します。削除された数を表示します。 |
whetuu scrub --dry-run [<text>] | scrub が削除するものをリスト表示し、何も変更しません。 |
whetuu paths | 履歴ストアとバージョンキャッシュの場所、および各ファイルが存在するかどうかを表示します。 |
whetuu upgrade | 実行中のバイナリを実行中の最新リリースに置き換え、変更内容を表示します。 |
whetuu upgrade --check | 待機中のリリースと変更内容を通知し、何もインストールしません。タグをファイルに書き込み、ステータスラインがそれを読み取ります。Whetuuはこれを1日に最大1回自身で実行します。 |
render と history add は、初期化スクリプトのみが渡すフラグ(終了ステータス、期間、幅)を受け取ります。そのため、ここでは省略されています。
新規インストールにはファイルがありません。 whetuu paths は、最初のコマンドが記録され、最初のツールチェーンバージョンがキャッシュされるまで、欠落しているものを隠すのではなくマークします。$HOME も対応するXDG変数も設定されていない場合、書き込み場所がないため、その旨が表示されます。
~/performance
約2ミリ秒でレンダリング
各コマンドの前にステータスラインが実行されるため、シェル内で高速である必要がある唯一のものです。最も遅いモジュールは std.Io を介してタスクとして実行され、残りは並行して実行されるため、レンダリング時間はすべての合計ではなく、最も遅いプローブにかかる時間程度です。
| ディレクトリ | レンダリング時間 | 比較 |
|---|---|---|
| リポジトリなし、ツールチェーンなし | 1.0 ms | — |
| Zigリポジトリ、49ファイル | 2.8 ms | zig version 単体: 3.5 ms |
| モノレポ、10,000ファイル | 11.0 ms | git status 単体: 10.9 ms |
13世代 i9-13900H で hyperfine --warmup 40 --runs 400 を使用して測定。--release=fast、パフォーマンスコアにピン留めし、他のマシンはアイドル状態。モノレポでは、ステータスライン全体が git status 単体と同程度の時間を要します。
リポジトリ外ではサブプロセスは実行されません。 Whetuuは現在のディレクトリからリポジトリを探して上に移動します。これは数回の stat 呼び出しで済み、リポジトリが見つかってから初めてGitを開始します。これが、リポジトリやプロジェクトがないディレクトリで1ミリ秒かかる理由です。
遅いリポジトリでもシェルがハングすることはありません。 両方のサブプロセスには制限があります。Gitは250ミリ秒、ツールチェーンプローブは200ミリ秒で、同時に実行されるため、最悪の場合は大きい方の時間です。Gitが30秒間ハングした場合でも、ステータスラインは257ミリ秒で返されます。Gitセグメントは単にドロップされます。
ステータスラインはGitの邪魔をしません。 呼び出しは --no-optional-locks を渡すため、Gitはインデックスをリフレッシュせずに読み取ります。別のターミナルでの git commit が取得できなくなる index.lock を取得することはありません。
大きな履歴でもピッカーは遅くなりません。 上矢印キーはストア全体ではなく、最近の数メガバイトを読み取るため、70MBのストアでも400KBのストアでも約20ミリ秒で開きます。それを維持するために何も削除されません。長年の履歴はディスクに残ります。
検索も遅くなりません。 キー入力は、約50,000コマンドの全ウィンドウに対して1〜3ミリ秒かかります。これは、同じコードが一度に1コマンドをスコアリングするコストの約5分の1です。コマンドは、プロセッサが既に持つベクトル命令を使用して複数同時にスコアリングされ、ストアの大部分は、スコアリングされる前にコマンドに含まれる文字によって除外されます。
~/security
コマンドはマシンから離れません
ステータスラインは実行されたすべてのコマンドを確認し、ピッカーはそれらを保持します。これは小さなツールに渡すには多すぎる情報なので、Whetuuが正確に何を行い、何を行わないかを説明します。
ネットワーク全体
すべてのリクエストは、ブラウザで誰でも開けるURLに対するTLS経由の GET です。whetuu upgrade は3つのリクエストを行います: api.github.com から最新リリースタグ、github.com からtarballとそのSHA256SUMS(書き込み前に検証)、および変更内容を表示するための CHANGELOG.md を raw.githubusercontent.com から取得します。whetuu upgrade --check は最初の1つと最後のリクエストを行い、タグをファイルに書き込みます。これによりステータスラインがそれを表示し、Whetuuは自身で最大1日に1回このチェックを開始します。これ以外に、テレメトリ、同期、アカウント、サーバーはありません。リクエストは whetuu/<version> というユーザーエージェントを運び、それ以外のあなたやあなたのマシンに関する情報は一切含みません。
4つのファイル
実行中、Whetuuは正確に4つのファイルを書き込みます。履歴ストアはモード 600 で作成され、書き込みごとにリセットされるため、古いバージョンで読み取り可能だったファイルは自己修正されます。ツールチェーンバージョン文字列のキャッシュは ~/.cache/whetuu/versions にあります。~/.cache/whetuu/release には、最新リリースタグとその確認日時が1行で保持されます。そして ~/.cache/whetuu/scrubbed には、保存されたシークレットを最後に削除したバージョンが記録されます。これらのいずれも、いつでも削除できます。
Spec paths only
バイナリは ~/.local/bin に、履歴ストアは $XDG_DATA_HOME の下に、バージョンキャッシュは $XDG_CACHE_HOME の下に配置されます。あなたの $HOME ディレクトリ内に独自のディレクトリはありません。whetuu paths は両方のデータ場所を表示します。
1回のインストール編集
インストーラーは、$SHELL の設定ファイルに初期化行を追加するだけで、それ以外は何も行いません。使用していないシェルの設定ファイルや、二度追加することはありません。PATH の行は、~/.local/bin が既に PATH に含まれていない場合にのみ追加されます。WHETUU_NO_MODIFY=1 を指定すると、代わりにそれらを出力します。
コマンドをスキップする
コマンドをスペースで開始すると、記録されません。URLにパスワードが含まれるコマンドや、リテラル TOKEN=… を含むコマンドもスキップされます。新しいバージョンごとに、既に保存されているものからそれらが削除されます。正常に終了したコマンドのみが保存されます。
シェルは一切使用しない
Whetuuは3つのサブプロセスを実行します: git とツールチェーンバージョンプローブ。どちらもリポジトリやプロジェクトの外では実行されず、1日1回 whetuu upgrade --check として、すべてのストリームを /dev/null にリダイレクトしてデタッチモードで実行されます。それぞれが固定された引数のリストを受け取るため、入力したものがコマンドとして解釈されることはありません。リベース中のような状態は、サブプロセスなしで .git から直接読み取られます。
エスケープ無効化
コマンド、ブランチ名、ディレクトリ内のすべての制御バイトは、ターミナルに到達する前に ? に変換されます。クローンしたばかりのリポジトリが、Whetuuを通じて画面を再描画したりカーソルを移動させたりすることはありません。
設定不要
設定ファイルがないため、設定パーサー、テーマフォーマット、起動時に実行されるユーザーのコードもありません。攻撃対象領域はバイナリと上記の2つのコマンドです。
1つの注意点
言語モジュールは、現在のディレクトリのファイルからプローブするツールチェーンを選択します。そのため、信頼できないリポジトリに入ると、Whetuuが node --version のようなものを実行する可能性があります。これは、リポジトリ内のバイナリではなく、PATH が解決するものを実行します。
検証可能なダウンロード
Linuxビルドは静的なmuslでランタイム依存関係はありません。各リリースには SHA256SUMS ファイルが付属しています。ソースコードはGitHubで公開されており、1つのコマンドでビルドできます。