
Agent TUI
OfficialFreeAutomate and test terminal UI applications programmatically.
Free Β· Opens the source repo
What Agent TUI does
Agent TUI is a specialized tool designed for automating and testing terminal user interface (TUI) applications. It allows developers to programmatically drive TUI applications, making it ideal for testing, automation, and inspection tasks. The skill is particularly useful for those who need to perform regression testing on terminal applications or verify interactive behaviors without manual intervention. By leveraging this tool, developers can create scripts that interact with terminal UIs just as a user would, providing a way to automate repetitive tasks and ensure the reliability of TUI applications.
The functionality of Agent TUI is centered around a closed-loop control system that emphasizes observation, decision-making, action, waiting, and verification. This approach is crucial for terminal automation, where the UI state can change rapidly and is not persistent like in web applications. Users must take a fresh screenshot before every action to ensure that the automation reflects the current state of the UI. The toolβs design philosophy acknowledges the unique challenges posed by terminal environments, such as the need for constant state verification and the handling of transient UI elements.
To use Agent TUI effectively, users must adhere to specific operational rules, such as executing atomic commands and verifying outcomes before proceeding. This ensures that the automation is robust and minimizes the risk of flaky tests. The skill also includes critical guidelines for setup, especially for macOS users, who must navigate specific daemonization issues to avoid connection errors. Overall, Agent TUI serves as a powerful solution for developers looking to enhance their testing workflows for terminal applications.
When to use it
Use Agent TUI when you need to automate interactions with terminal applications, perform regression tests, or verify interactive behaviors programmatically.
When not to use it
This tool is not suitable for automating web applications or environments where a graphical user interface (GUI) is required, as it is specifically designed for terminal UIs.
What you can build with it
Automating CLI Tests
Use Agent TUI to automate testing of CLI applications by scripting interactions and verifying expected outputs.
Regression Testing for TUI Apps
Implement Agent TUI in your CI/CD pipeline to perform regression tests on terminal applications, ensuring consistent behavior.
Interactive Behavior Verification
Utilize Agent TUI to verify the interactive behavior of terminal applications during development, catching issues early.
How to install Agent TUI
View source1. Install with the skills CLI
npx skills add google-gemini/gemini-cli/agent-tui --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by google-geminiπ¨ CRITICAL: macOS Daemon Workaround & Gemini CLI Usage π¨
When using agent-tui in this macOS environment, the default background daemonization process crashes, causing Connection refused (os error 61) errors.
You MUST start the daemon manually shielded from TTY hangups before running any agent-tui commands. Using nohup is insufficient; you must use tmux to provide a fully isolated pseudo-terminal.
To support parallel runs, only restart the daemon if it is not currently running:
# Check if daemon is alive, start it in tmux if it is not
if ! agent-tui sessions >/dev/null 2>&1; then
tmux kill-session -t agent-tui 2>/dev/null || true
agent-tui daemon stop 2>/dev/null || true
rm -f /tmp/agent-tui*
tmux new-session -d -s agent-tui 'agent-tui daemon start --foreground > /tmp/agent-tui-daemon.log 2>&1'
sleep 1
fi
Session ID vs PID (Crucial for Reconnection)
When agent-tui run returns JSON, it includes both a session_id and a pid. The pid is purely informational (the OS process ID of the child command). You do not use the pid to reconnect or issue commands. You must always use the session_id (e.g., --session <id>).
If the daemon crashes (os error 61), the pseudo-terminal is destroyed. Even if the child pid survives as an orphan, you cannot reconnect to it. You must restart the daemon using the workaround above and start a completely new session.
Testing the Gemini CLI
When testing the Gemini CLI with agent-tui, there are several strict requirements to ensure deterministic and accurate behavior:
- Build Before Running:
agent-tuiruns the built JS files, not TypeScript. You MUST runnpm run buildornpm run build:allafter making code changes and before launching the CLI withagent-tui. - Bypass Trust Modals: Always pass
GEMINI_CLI_TRUST_WORKSPACE=truein the environment. If you don't, any new project-level agents or extensions will trigger a full-screen "Acknowledge and Enable" modal. This modal steals focus, swallows automation keystrokes, and causesagent-tui waitcommands to time out. - Isolated Environments: If you need to test without real user credentials or existing agents interfering, isolate the global settings using
GEMINI_CLI_HOME=<some-test-dir>. - Testing State Deltas (e.g., Reloads): If you are testing features that report deltas (e.g.,
/agents reloadoutputting "1 new local subagent"), you MUST:- Start the CLI first so it establishes its baseline registry.
- Use a separate shell command (outside of
agent-tui) to write the new agent.md/.tomlfile. - Use
agent-tui typeandpressto trigger the/agents reloadcommand inside the running session. - (If you add the files before starting the CLI, they become part of the baseline and won't trigger the delta logic).
# Example: Standard isolated run (sandboxed config + bypass trust modals)
env GEMINI_CLI_TRUST_WORKSPACE=true GEMINI_CLI_HOME=test-gemini-home agent-tui run -d "$(pwd)" node packages/cli/dist/index.js
Terminal Automation Mastery
Prerequisites
- Supported OS: macOS or Linux (Windows not supported yet).
- Verify install:
agent-tui --version
If not installed, use one of:
# Recommended: one-line install (macOS/Linux)
curl -fsSL https://raw.githubusercontent.com/pproenca/agent-tui/master/install.sh | sh
# Package manager
npm i -g agent-tui
pnpm add -g agent-tui
bun add -g agent-tui
# Build from source
cargo install --git https://github.com/pproenca/agent-tui.git --path cli/crates/agent-tui
If you used the install script, ensure ~/.local/bin is on your PATH.
Philosophy: Why Terminal Automation Is Different
Terminal UIs are stateless from the observer's perspective. Unlike web browsers with a persistent DOM, terminal automation works with a constantly-refreshed character grid. This fundamental difference shapes everything:
| Web Automation | Terminal Automation |
|---|---|
| DOM persists across interactions | Screen buffer is redrawn constantly |
| Selectors are stable | Text positions may shift |
| Query once, act many times | Must re-verify before EVERY action |
| Network events signal completion | Must detect visual stability |
The Core Insight: agent-tui gives you vision without memory. Each screenshot is a fresh observation. Previous state means nothing after the UI changes. This isn't a limitationβit's the nature of terminal interaction.
Mental Model: The Feedback Loop
Think of terminal automation as a closed-loop control system:
ββββββββββββββββββββββββββββββββββββββββββββββββ
β β
βΌ β
OBSERVE βββΊ DECIDE βββΊ ACT βββΊ WAIT βββΊ VERIFY ββββ
β β
β β
ββββββββ NEVER skip ββββββββββββββββββββββ
Each phase is mandatory. Skipping verification is the #1 cause of flaky automation.
The "Fresh Eyes" Principle
Every time you need to interact with the UI:
- Take a fresh screenshot β your previous one is now stale
- Locate your target visually β text positions may have changed
- Verify the state β the UI may have changed unexpectedly
- Act only when stable β animations and loading states cause failures
This feels slower, but it's the only reliable approach. Optimistic reuse of stale state causes intermittent failures that are painful to debug.
Critical Rules (Non-Negotiable)
RULE 1: Atomic Execution (No Pipelining) You are FORBIDDEN from chaining commands with
&&(e.g.,type "x" && press Enter && wait). Modals or UI updates can intercept your keystrokes. You MUST execute one atomic action, wait, screenshot, and verify before taking the next action in a new turn.
RULE 2: Re-snapshot after EVERY action The UI state is invalidated by any change. Always take a fresh screenshot before acting again.
RULE 3: Never act on unstable UI If the UI is animating, loading, or transitioning,
wait --stablefirst. Acting during transitions because race conditions.
RULE 4: Verify before claiming success Use
wait "expected text" --assertto confirm outcomes. Don't assume an action workedβprove it.
RULE 5: Error Recovery If a
waitcommand times out, DO NOT blindly restart or kill the session. Executescreenshotto visually diagnose what unexpected UI element (modal, error dialog, lost focus) intercepted the flow.
RULE 6: Clean up sessions Always end with
agent-tui kill. Orphaned sessions consume resources and can interfere with future runs.
Decision Framework
Which Screenshot Mode?
Use screenshot --format json when parsing automation output, or plain screenshot for human readable text.
How to Wait?
What are you waiting for?
β
βββΊ Specific text to appear
β βββΊ `wait "text" --assert` (fails if not found)
β
βββΊ Specific text to disappear
β βββΊ `wait "text" --gone --assert`
β
βββΊ UI to stop changing (animations, loading)
β βββΊ `wait --stable`
β
βββΊ Multiple conditions
βββΊ Chain waits sequentially
How to Act?
What do you need to do?
β
βββΊ Type text into the terminal
β βββΊ `type "text"`
β
βββΊ Send keyboard shortcuts/navigation
β βββΊ `press Ctrl+C` or `press ArrowDown Enter`
Core Workflow
The canonical automation loop:
# 1. START: Launch the TUI app
agent-tui run <command> [-- args...]
# 2. OBSERVE: Get current UI state
agent-tui screenshot --format json
# 3. DECIDE: Based on text, determine next action
# (This happens in your head/code)
# 4. ACT: Execute the action
agent-tui type "text"
agent-tui press Enter
# 5. WAIT: Synchronize with UI changes
agent-tui wait "Expected" --assert # or wait --stable
# 6. VERIFY: Confirm the outcome (often combined with step 5)
# If verification fails, handle the error
# 7. REPEAT: Go back to step 2 until done
# 8. CLEANUP: Always clean up
agent-tui kill
Anti-Patterns (What NOT to Do)
β Acting During Animation/Loading
# WRONG: Acting immediately on dynamic UI
agent-tui run my-app
agent-tui screenshot --format json # UI might still be loading!
agent-tui type "value" # β Might miss the input field
# RIGHT: Wait for stability first
agent-tui run my-app
agent-tui wait --stable # Let UI settle
agent-tui screenshot --format json # Now it's reliable
agent-tui type "value"
β Assuming Success Without Verification
# WRONG: Assuming the type worked
agent-tui type "value"
agent-tui press Enter
# ...proceed as if success... # β What if it failed silently?
# RIGHT: Verify the outcome
agent-tui type "value"
agent-tui press Enter
agent-tui wait "Success" --assert # β Proves the action worked
β Skipping Cleanup
# WRONG: Forgetting to kill the session
agent-tui run my-app
# ...do stuff...
# script ends # β Session left running!
# RIGHT: Always clean up
agent-tui run my-app
# ...do stuff...
agent-tui kill # β Clean exit
Before You Start: Clarify Requirements
Before automating any TUI, gather this information:
- Command: What exactly to run? (
my-app --flagornpm start?) - Success criteria: What text/state indicates success?
- Input sequence: What keystrokes/data to enter, in what order?
- Safety: Is it safe to submit forms, delete data, etc.?
- Auth: Does it need login? Test credentials?
- Live preview: Does the user want to watch? (
agent-tui live start --open)
If any of these are unclear, ask before running.
Demo Mode: Showing What agent-tui Can Do
When a user asks what agent-tui is, wants a demo, or asks "show me how it works":
- Don't explainβdemonstrate. Actions speak louder than words.
- Use the live preview so they can watch in real-time.
- Run
topβit's universal and shows dynamic real-time updates.
Quick demo trigger phrases:
- "What is agent-tui?" / "What does agent-tui do?"
- "Demo agent-tui" / "Show me agent-tui"
- "How does agent-tui work?" / "See it in action"
Failure Recovery
| Symptom | Diagnosis | Solution |
|---|---|---|
| "Text not found" | Stale view or text moved | Re-snapshot, locate text again |
| Wait times out | UI didn't reach expected state | Check screenshot, verify expectations |
| "Daemon not running" | Daemon crashed or not started | agent-tui daemon start |
| Unexpected layout | Wrong terminal size | agent-tui resize --cols 120 --rows 40 |
| Session unresponsive | App crashed or hung | agent-tui kill, then re-run |
| Repeated failures | Something fundamentally wrong | Stop after 3-5 attempts, ask user |
Self-Discovery: Use --help
You don't need to memorize every flag. The CLI is self-documenting:
agent-tui --help # List all commands
agent-tui run --help # Options for 'run'
agent-tui screenshot --help # Options for 'screenshot'
agent-tui wait --help # Options for 'wait'
When in doubt, ask the CLI. This skill teaches when and why to use commands. For exact flags and syntax, --help is authoritative.
Quick Reference
# Start app
agent-tui run <cmd> [-- args] # Launch TUI under control
# Observe
agent-tui screenshot # Plain text view
agent-tui screenshot --format json # Machine-readable output
# Act
agent-tui press Enter # Press key(s)
agent-tui press Ctrl+C # Keyboard shortcuts
agent-tui type "text" # Type text
# Wait/Verify
agent-tui wait "text" --assert # Wait for text, fail if not found
agent-tui wait "text" --gone --assert # Wait for text to disappear
agent-tui wait --stable # Wait for UI to stop changing
# Manage
agent-tui sessions # List active sessions
agent-tui live start --open # Start live preview
agent-tui kill # End current session
Frequently asked questions about Agent TUI
Similar skills
Spring Boot Testing
Master testing techniques for Spring Boot 4 applications.
GitHub Issues
Manage GitHub issues efficiently with MCP tools.
Geofeed Tuner
Optimize your IP geolocation feeds in CSV format.
Batch Files
Master Windows batch scripting for automation and task management.
Adobe Illustrator Scripting
Automate your Illustrator workflows with ExtendScript.
Plugin Structure
Create and organize Claude Code plugins effectively.
