opentui
Installation
Summary
Build terminal user interfaces with three framework options: imperative core API, React reconciler, or Solid reconciler.
- Three frameworks to choose from: core (maximum control), React (familiar component patterns), or Solid (fine-grained reactivity)
- Comprehensive component library covering text display, containers, inputs, code/diff viewers, layout, keyboard handling, animations, and testing
- Critical rules include using
create-tuifor new projects, avoidingprocess.exit(), and nesting text styling tags in React/Solid - Organized reference structure with framework-specific guides (REFERENCE.md, api.md, configuration.md, patterns.md, gotchas.md) plus cross-cutting concept guides for layout, keyboard, animation, and testing
SKILL.md
OpenTUI Platform Skill
Consolidated skill for building terminal user interfaces with OpenTUI. Use decision trees below to find the right framework and components, then load detailed references.
Critical Rules
Follow these rules in all OpenTUI code:
- Use
create-tuifor new projects. See frameworkREFERENCE.mdquick starts. create-tuioptions must come before arguments.bunx create-tui -t react my-appworks,bunx create-tui my-app -t reactdoes NOT.- Never call
process.exit()directly. Userenderer.destroy()(seecore/gotchas.md). - Text styling requires nested tags in React/Solid. Use modifier elements, not props (see
components/text-display.md).
How to Use This Skill
Reference File Structure
Framework references follow a 5-file pattern. Cross-cutting concepts are single-file guides.