agent-tui について
agent-tuiは、ターミナルUIセッションを自動化・検証するコマンドラインスキルです。スナップショットと操作を繰り返し、画面の安定や指定テキストを待ってからセッションを終了できます。
主な機能
- 01UIセッションの起動と管理
- 02JSON形式で画面を取得
- 03キー、テキスト、スクロールを入力
- 04安定状態やアサーションを待機
- 05セッションを終了
活用シーン
- 01ターミナルUIのタスクを自動化
- 02操作後のUI変化を検証
- 03再現可能なセッションチェックを実行
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ pproenca/ agent-tui --skill agent-tuiインストール後、Claude Code で/agent-tuiを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
agents/openai.yamlreferences/assertions.mdclarifications.mdcommand-atlas.mddecision-tree.mddemo.mdflows.mdoutput-contract.mdprompt-templates.mdrecovery.mdsafety.mdsession-lifecycle.mdtest-plan.mduse-cases.md詳細
agent-tui
クイックスタート
- インストールを確認します:
agent-tui --version npm i -g agent-tuiでインストールします(またはpnpm add -g agent-tui、bun add -g agent-tui)。- 別のインストール方法:
curl -fsSL https://raw.githubusercontent.com/pproenca/agent-tui/master/install.sh -o /tmp/agent-tui-install.sh && sh /tmp/agent-tui-install.shまたはcargo install --git https://github.com/pproenca/agent-tui.git --path cli/crates/agent-tui。 - インストールスクリプトを使用した場合は、
~/.local/binが PATH に含まれていることを確認します。 - セッションを開始します:
agent-tui run --format json <command> -- <args...> - 状態を確認します:
agent-tui screenshot --format json - 操作します:
agent-tui press Enter、agent-tui type "text"、またはagent-tui scroll down - 待機または検証します:
agent-tui wait "Expected text" --assertまたはagent-tui wait --stable - クリーンアップします:
agent-tui kill --yes
基本的なワークフロー
現在の自動化ループ:run -> screenshot -> press/type/scroll -> wait -> kill --yes。
agent-tui runでアプリを実行し、JSON 出力からsession_idを取得します。agent-tui screenshotまたはagent-tui screenshot --format jsonで最新のスナップショットを取得します。- 最新のスナップショットに基づいて、次の操作を決定します。
press、type、またはscrollで操作します。wait --assertまたはwait --stableで同期します。- タスクが完了するまで、手順 2 から繰り返します。
agent-tui kill --yesでクリーンアップします。
信頼性に関するルール
- UI が変化する可能性のある操作の後は、必ずスナップショットを再取得します。
- 画面が変化している間は操作しないでください。先に安定するまで待ちます。
- 成功したと決めつけず、
wait --assertで結果を検証します。 - 自動化の実行は必ず
kill --yesまたはsessions cleanup --yesで終了します。
レガシーからの移行
新しいスクリプトでは現在のコマンドを使用してください。レガシー互換形式は古いスクリプト用に引き続き解析されますが、それぞれの形式は非推奨の通知を stderr に出力し、JSON の stdout は解析可能な状態に保たれ、次のメジャーバージョンで削除されるまでサポートされます。
agent-tui input "text"->agent-tui type "text"。agent-tui action <selector> click->agent-tui press Enter。agent-tui action <selector> fill <text>->agent-tui type "<text>"。agent-tui screenshot -e->agent-tui screenshot。agent-tui screenshot -a->agent-tui screenshot。agent-tui wait -e <ref>->agent-tui wait "<text>"。agent-tui scroll-into-view <selector>->agent-tui scroll <direction> [amount]またはagent-tui press ...。互換コマンドはターミナル入力を送信しません。
セッションの管理
- セッションが複数ある場合は、すべてのコマンドに
--session <id>を指定します。 - セッション ID が分からなくなった場合は、
agent-tui sessionsとagent-tui sessions show <id>を実行します。
ライブプレビュー(任意)
- ライブプレビューが必要かどうかを確認します。
- プレビューを開始します:
agent-tui live start --open - 単独のプレビュー状態を停止するには
agent-tui live stopを実行します。デーモンが使用するプレビューは、agent-tui daemon stop --yesを実行するまで利用できます。
詳細リファレンス
- CLI の全機能とオプション:
references/command-atlas.md - JSON 出力の仕様:
references/output-contract.md - エンドツーエンドのコマンドシーケンス:
references/flows.md - コマンドのクイック選択:
references/decision-tree.md - セッションのライフサイクルと並行処理:
references/session-lifecycle.md - アサーションとテストオラクル:
references/assertions.md - 失敗からの復旧手順:
references/recovery.md - 安全性と確認プロンプト:
references/safety.md - 確認事項のチェックリスト:
references/clarifications.md - テスト計画のテンプレート:
references/test-plan.md - デモスクリプト:
references/demo.md - ユーザープロンプトのテンプレート:
references/prompt-templates.md - ユースケース別の最小コマンドセット:
references/use-cases.md - エクスプローラー/リプレイ自動化スキル:
../tui-explorer/SKILL.md
コメント
Markdown 対応