opentui
Comprehensive OpenTUI skill for building terminal user interfaces. Covers the core imperative API, React reconciler, and Solid reconciler. Use for any TUI development task including components, layout, keyboard handling, animations, and testing.
Security Assessment
Detected risks:
About opentui
The opentui skill is a comprehensive toolkit designed to assist developers in building terminal user interfaces (TUIs) using the OpenTUI platform. It provides structured guidance and reference materials for selecting and implementing the appropriate framework—whether using the core imperative API, a React-based reconciler, or a Solid-based reconciler. The skill addresses common challenges in TUI development, such as choosing the right architecture, organizing code, and following platform-specific rules, enabling developers to efficiently create robust terminal applications.
The skill includes detailed reference structures for each framework, organized into consistent documentation files covering API usage, configuration, patterns, and troubleshooting. It supports a wide range of capabilities including component creation, layout management, keyboard input handling, animations, and testing. Additionally, it enforces critical development rules such as using the `create-tui` tool for project setup, proper ordering of CLI arguments, avoiding direct process termination, and adhering to styling conventions in React and Solid. Decision trees are provided to help developers quickly determine the appropriate framework or component for their needs.
This skill is particularly useful for developers building terminal-based applications, libraries, or frameworks. It is suitable for users with varying levels of experience, including those familiar with React or Solid who want to transition into TUI development, as well as those seeking maximum control through the core API. It also benefits teams looking for standardized documentation practices and efficient onboarding into OpenTUI-based development workflows.
FAQ
Which framework should I choose when using opentui?
You should choose based on your needs: use the core API for maximum control and performance, React reconciler for familiar component patterns, and Solid reconciler for fine-grained reactivity and efficient updates.
How do I start a new OpenTUI project?
You must use the `create-tui` tool, ensuring that options are placed before arguments (e.g., `bunx create-tui -t react my-app`).
Can I directly exit my application using process.exit()?
No, you should not call `process.exit()` directly. Instead, use `renderer.destroy()` as specified in the core gotchas documentation.
What runtime environment does OpenTUI require?
OpenTUI runs on Bun and uses Zig for native builds. You should review the core gotchas documentation for detailed runtime and build requirements.
Where can I find information about specific components or features?
You should follow the reference file structure, starting with `REFERENCE.md` for your chosen framework, then exploring files like `api.md`, `configuration.md`, or component-specific documentation as needed.
All Files
26 filesInstall opentui
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
msmps/opentui-skill