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.