microsoft/tui-test

💻 control, record, & test any tui app / cli with popular terminals - makes the terminal fully accessible to AI

解決する問題

tui-test は、Windows、Linux、macOS でターミナルアプリケーションやシェルセッションを確実に自動化およびテストするという問題を解決します。実行中のターミナルの状態(表示テキスト、スタイル、カーソル位置、スクロールバック、クリップボードなど)への構造化アクセスを提供し、入力、クリック、スクロール、サイズ変更などの現実的なユーザー操作を実行できます。これは、全画面 TUI アプリの検証、反復的なターミナルワークフローのスクリプト化、AI エージェントにコマンドライン環境と対話する制御された方法を提供する場合に特に役立ちます。

仕組み

tui-test は、ターミナルセッションをシミュレートするのではなく、実際のターミナルセッションを制御します。ターミナルバックエンド(Alacritty、Ghostty、Rio、xterm.js など)内でシェルまたはプログラムを起動し、CLI と Rust、Python、JavaScript、Go 向けのネイティブライブラリを通じて統一された一連の操作を公開します。画面上のテキストの検索(正規表現、アンカー、スタイルマッチングを使用)、キーボードおよびマウス入力の実行、ターミナル状態(終了コード、カーソル、ビューポート、ベルイベント)の読み取り、条件(テキスト、アイドル、終了、準備完了)の待機、出力のスクリーンショット、GIF/MP4/APNG 録画、asciinema キャストとしてのキャプチャを行うコマンドを発行できます。セッションは CLI コマンド間で持続し、同じ基盤エンジンがサポートされているすべての言語で動作します。AI エージェント向けに、このツールは構造化出力(JSON、トレースファイル)と、エージェントワークフローに統合するためのスキルコマンドを提供します。

対象読者

これは、ターミナル UI、特にクロスプラットフォームツールや全画面アプリを自動化およびテストする必要がある開発者と QA エンジニア向けに構築されています。また、ターミナル状態への構造化アクセスと制御された入力を必要とする AI エージェント、およびシェルや CLI プログラムの自動化スクリプトを作成するすべての人にも適しています。

ハイライト

  • クロスプラットフォームサポート:Windows、Linux、macOS、複数のシェル(bash、zsh、fish、PowerShell、cmd など)
  • 複数のインターフェース:CLI に加え、Rust、Python、JavaScript、Go 向けのネイティブライブラリ
  • リッチなテキストロケーター:正規表現、アンカー(前/後)、スタイルマッチング、リンク検証、合成可能なロケーター(AND/OR)
  • 完全な入力シミュレーション:キーボード、マウスクリック/ドラッグ/スクロール、サイズ変更、シグナル、生データ書き込み
  • 状態検査:カーソル、ビューポート、クリップボード、タイトル、ベル、終了コード、コマンド出力など
  • 設定可能なタイムアウト付きの待機およびアサートコマンド(テキスト、アイドル、終了、準備完了)
  • キャプチャと録画:SVG/PNG スクリーンショット、APNG/GIF/MP4 録画、asciinema キャスト
  • 失敗したアサーションの構造化診断(trace.md、trace.json、timeline.json)を備えたトレースビューア
  • AI エージェントフレンドリー:usage、agent-context、skill コマンドが完全なコマンドスキーマとエージェントガイドを公開
  • tui-test.toml でプロファイル、色、録画スタイル、トレース設定を構成可能

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト