Skip to content

README.ja.md

Latest commit

 

History

History
194 lines (140 loc) · 7.51 KB

README.ja.md

File metadata and controls

194 lines (140 loc) · 7.51 KB

English 中文 日本語 한국어

Codex HUD

OpenAI Codex CLI 用のリアルタイムステータスバー HUD。軽量・設定不要・tmux 内で動作。

Windows WSL サポート

Windows サポートは Ubuntu WSL 経由で feature/windows-support-dual-entry branch に用意されています。macOS/Linux では main、Windows (WSL) ではその feature branch を使用してください。

Claude Code の claude-hud にインスパイアされています。

Codex HUD — シングルセッション

なぜ Codex HUD が必要？

Q: Codex CLI だけで十分では？

計器なしのフライトと同じです。Codex HUD はターミナル下部に常駐ダッシュボードを表示します：

  • ブランチ・モデル・権限 —— 一目で把握、推測不要
  • Token 使用量（cache 含む） —— コンテキストの消費量を正確に把握
  • Context ウィンドウ充填バー —— 上限に近づいたら即座にわかる
  • MCP サーバー状況 & ツール呼び出し —— Codex が実際に何をしているか監視
  • Reasoning effort レベル —— 現在の思考深度を表示

Q: 複数の Codex セッションを同時に監視できますか？

はい。Ctrl+T でマルチセッション概要モードに切り替えると、すべてのアクティブセッションの context 使用状況を一画面で確認できます。

Codex HUD — マルチセッション概要

Q: tmux を手動で設定する必要がありますか？

不要です。Codex HUD は tmux を自動的に起動します。codex と入力するだけで HUD が表示されます。tmux 未インストールの場合もインストーラーが対応します。

クイックスタート

macOS/Linux（main）

git clone https://github.com/fwyc0573/codex-hud.git
cd codex-hud
git switch main
./bin/codex-hud-install

# シェルをリフレッシュして、以下を入力：
codex

Windows (WSL)（feature/windows-support-dual-entry）

git clone https://github.com/fwyc0573/codex-hud.git
cd codex-hud
git switch feature/windows-support-dual-entry
.\bin\codex-hud-install.ps1

# 新しい PowerShell または cmd ウィンドウを開いて確認：
codex --self-check

# WSL HUD で起動：
codex

管理コマンド

初回インストール後、以下のコマンドがシェルに追加されます：

コマンド 説明
codex-hud-sync 現在のチェックアウトを再ビルドしエイリアスを更新
codex-hud-upgrade 最新の変更をプルして再ビルド
codex-hud-uninstall エイリアスを削除し HUD セッションを停止

HUD に何が表示される？

[gpt-5.4 xhigh] █████░░░░ 45% │ my-project git:(main ●) │ 12m
mode: dev | 3 extensions | 2 AGENTS.md | Approval: on-req | Sandbox: ws-write
Tokens: 50.2K (in: 35.0K, cache: 5.0K, out: 15.2K) | Ctx: ████░░░░ 45% (50.2K/128K) ↻2
Dir: ~/my-project | Session: abc12345 | CLI: 0.4.2
◐ Edit: file.ts | ✓ Read ×3
行 内容
ヘッダー モデル + effort、context バー、プロジェクト名、git ブランチ、セッションタイマー
環境 設定数、作業モード、MCP サーバー、命令ファイル、承認/サンドボックス
Tokens 合計 token（入力/cache/出力の内訳）、context 充填率、compact 回数
Session 作業ディレクトリ、Session ID、CLI バージョン
アクティビティ 実行中のツール呼び出し、最近のツール履歴

使い方

codex                        # HUD 付きで起動
codex --model gpt-5          # Codex CLI 引数を渡す
codex "help me debug this"   # プロンプト付き
codex-resume                 # 前回のセッションを再開
その他のコマンド 
codex-hud --kill             # 現在のディレクトリのセッションを終了
codex-hud --list             # すべての HUD セッションを一覧表示
codex-hud --attach           # 既存セッションにアタッチ
codex-hud --new-session      # 新規セッションを強制作成
codex-hud --self-check       # 環境診断を実行

設定

環境変数

変数 デフォルト 説明
CODEX_HUD_POSITION bottom HUD ペインの位置（top / bottom）
CODEX_HUD_HEIGHT ターミナルの 1/6 HUD の高さ（行数）
CODEX_HUD_MOUSE 1 マウス/トラックパッドスクロールを有効化
すべての環境変数
変数 デフォルト 説明
CODEX_HUD_HEIGHT_AUTO 0 幅に基づいて高さを自動調整
CODEX_HUD_HEIGHT_MIN CODEX_HUD_HEIGHT 自動モードの最小高さ
CODEX_HUD_HEIGHT_MAX 12 自動モードの最大高さ
CODEX_HUD_AUTO_ATTACH 0 同ディレクトリの最新セッションに自動アタッチ
CODEX_HUD_ALTERNATE_SCREEN 0 codex ペインの tmux alternate-screen
CODEX_HUD_CLEAR_SCROLLBACK 0 初回レンダリング時にスクロールバックをクリア
CODEX_HUD_CWD （未設定） 作業ディレクトリを上書き
CODEX_HOME ~/.codex Codex ホームディレクトリ
CODEX_SESSIONS_PATH （未設定） sessions ディレクトリを上書き

config.toml

HUD は CODEX_HOME/config.toml から設定を読み取ります：

model = "gpt-5.2-codex"
approval_policy = "on-request"
sandbox_mode = "workspace-write"

[mcp_servers.my-server]
command = ["node", "server.js"]
enabled = true

対応システム

プラットフォーム 状態
Linux 対応済み
macOS (Apple Silicon) 対応済み
macOS (Intel) テスト待ち
Windows (WSL) feature/windows-support-dual-entry で対応済み

開発

npm install && npm run build   # ビルド
npm run dev                    # ウォッチモード
node dist/index.js             # HUD を直接実行

変更履歴

日付 変更内容
2026-04-09 クイックインストール/同期/アップグレード/アンインストールコマンドを追加
2026-04-09 HUD セッションを tmux ペインにバインド、reasoning effort を表示
2026-02-09 リサイズ後のメインペインフォーカス修正、マウススクロールのデフォルト改善
2026-02-09 セッションアタッチのデフォルトとスクロールバック設定を更新

ライセンス

MIT

クレジット

Jarrod Watts の claude-hud にインスパイアされています。OpenAI Codex CLI 用に構築。