opentui

Build terminal user interfaces with Core, React, and Solid APIs.

Updated Dec 25, 2025
One-click install
npx skills add https://github.com/wtg42/tty-clock-timer --skill opentui-wtg42
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: opentui
Source: https://github.com/wtg42/tty-clock-timer/tree/main/.agents/skills/opentui
Command: npx skills add https://github.com/wtg42/tty-clock-timer --skill opentui-wtg42

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

OpenTUI consolidates APIs, patterns, and runtime guidance to eliminate fragmented documentation and runtime pitfalls when building terminal user interfaces, reducing time spent debugging layout, input, and build issues.

Core Features & Use Cases

  • Imperative Core API for maximum control and minimal runtime overhead.
  • React and Solid reconciler references for declarative TUI development and framework-specific patterns.
  • Component catalog (text, boxes, inputs, code/diff, tables), layout patterns, keyboard and paste handling, animations, and testing utilities.
  • Runtime and build guidance for Bun and Zig, Tree-sitter highlighting, test renderers, and common gotchas for production-ready TUIs.
  • Use case: author a performant, keyboard-driven TUI with snapshot tests, keyboard shortcuts, and animated transitions that run on Bun with optional native Zig components.

Quick Start

Open the appropriate framework entry in ./references/<framework>/REFERENCE.md and follow its quick start to scaffold and run a new TUI project.

Frequently Asked Questions about opentui

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build terminal UIs with React or Solid in Bun?

You can build terminal UIs with React or Solid in Bun using OpenTUI, which provides declarative reconcilers, component patterns, and runtime guidance for production-quality TUI applications.

What is the best way to handle keyboard input and animations in a TUI?

The best way to handle keyboard input and animations in a TUI is using OpenTUI's component catalog, which provides specific layout patterns, keyboard handling utilities, and animation support for terminal interfaces.

Can I use Zig components for terminal UI development?

Yes, you can use Zig components for terminal UI development through OpenTUI, which offers runtime and build guidance for integrating optional native Zig components alongside Bun environments.

Does OpenTUI provide utilities for testing terminal user interfaces?

OpenTUI provides testing utilities for terminal user interfaces, including test renderers and snapshot testing capabilities to ensure your TUI components function correctly before production deployment.

How do I add syntax highlighting to a terminal UI application?

You can add syntax highlighting to a terminal UI application using OpenTUI's Tree-sitter integration, which provides code and diff components for rendering highlighted text in terminal environments.

Why does my terminal UI layout break when switching frameworks?

Terminal UI layout issues when switching frameworks often stem from runtime pitfalls; OpenTUI consolidates API references and layout patterns to eliminate fragmented documentation and debug these problems.