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 上可靠地自动化和测试终端应用程序及 shell 会话的问题。它为您提供对运行中终端状态(可见文本、样式、光标位置、回滚缓冲区、剪贴板等)的结构化访问,并允许您执行逼真的用户操作,如键入、点击、滚动和调整大小。这对于验证全屏 TUI 应用、编写重复性终端工作流的脚本以及为 AI 代理提供与命令行环境交互的受控方式尤其有用。
工作原理
tui-test 控制真实的终端会话,而不是模拟它们。它在终端后端(如 Alacritty、Ghostty、Rio 或 xterm.js)中启动 shell 或程序,然后通过 CLI 和适用于 Rust、Python、JavaScript 和 Go 的原生库公开一组统一的操作。您可以发出命令来查找屏幕上的文本(使用正则表达式、锚点、样式匹配)、执行键盘和鼠标输入、读取终端状态(退出代码、光标、视口、响铃事件)、等待条件(文本、空闲、退出、就绪),并将输出捕获为屏幕截图、GIF/MP4/APNG 录制或 asciinema 录像。会话在 CLI 命令之间持续存在,并且相同的底层引擎适用于所有支持的语言。对于 AI 代理,该工具提供结构化输出(JSON、跟踪文件)和技能命令,以集成到代理工作流中。
适用对象
此工具专为需要自动化和测试终端 UI(尤其是跨平台工具和全屏应用)的开发人员和 QA 工程师而构建。它也适用于需要结构化访问终端状态和受控输入的 AI 代理,以及任何为 shell 或 CLI 程序编写自动化脚本的人。
亮点
- 跨平台支持:Windows、Linux、macOS,支持多种 shell(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配置配置文件、颜色、录制样式和跟踪设置
相关
- 项目
- 项目
- 项目
- 项目