microsoft/tui-test

tui-test

tui-test controls, inspects, tests, and records real shell sessions and full-screen terminal apps on Windows, Linux, and macOS. Use it from the CLI or call the same engine from Rust, Python, or JavaScript. It works for AI agents that need structured access to terminal state, terminal automation, and terminal ui application testing.

<p align="center" <a href="#installation"Installation</a · <a href="#quick-start"Quick start</a · <a href="#agent-commands"AI agents</a · <a href="#api-references"API references</a · <a href="#configuration"Configuration</a </p

[!IMPORTANT] tui-test is undergoing a major rewrite. These docs cover the beta releases.

Installation

CLI

#### Homebrew

brew tap microsoft/tui-test https://github.com/microsoft/tui-test
brew install tui-test

#### Install script

macOS and Linux:

curl --proto '=https' --tlsv1.2 -LsSf https://raw.githubusercontent.com/microsoft/tui-test/main/install/install.sh | TUI_TEST_VERSION=beta sh

Windows:

$env:TUI_TEST_VERSION = "beta"
irm https://raw.githubusercontent.com/microsoft/tui-test/main/install/install.ps1 | iex

You can also download a binary from GitHub Releases.

Libraries

| Language | Install | Reference | | --- | --- | --- | | Rust 1.90+ | cargo add tui-test-rs@0.1.0-beta.5 | docs.rs | | Python 3.8+ | pip install --pre tui-test | Python API | | Node 20+ | npm install @microsoft/tui-test@beta | JavaScript API |

Add the Rust recording-raster feature for APNG, GIF, and MP4 output. It uses installed fonts; recording-font-jetbrains-mono bundles a font.

Quick start