What OpenTUI does
OpenTUI is a framework designed for creating rich terminal user interfaces. It provides a comprehensive set of components and core concepts that facilitate the development of terminal applications. The skill includes detailed documentation on various aspects such as rendering, audio playback, keyboard handling, and layout management, making it suitable for developers looking to enhance their terminal applications with interactive elements.
The framework supports multiple bindings, including React and Solid, allowing developers to leverage their existing knowledge of these libraries to build terminal UIs. With components for text, input, images, and more, OpenTUI enables the creation of visually appealing and functional interfaces. Additionally, the skill covers advanced topics like SSH integration and Three.js WebGPU, which can be beneficial for projects requiring remote access or 3D graphics.
OpenTUI is particularly useful for developers focused on building terminal applications that require a modern touch. The skill's structured documentation allows for quick navigation through core concepts and components, ensuring that users can find the information they need efficiently. Whether you're building a simple command-line tool or a complex application, OpenTUI provides the necessary tools and guidance to streamline your development process.
When to use it
Use OpenTUI when you need to create terminal applications that require user interaction and visual components.
When not to use it
This skill may not be suitable for projects that do not involve terminal interfaces or require extensive graphical user interface (GUI) capabilities beyond the terminal scope.
What you can build with it
Creating a Command-Line Tool
Use OpenTUI to develop a command-line tool that requires user input and displays formatted text.
Building a Remote Terminal Application
Leverage OpenTUI's SSH capabilities to create a terminal application that connects to remote servers.
Developing a 3D Terminal Interface
Utilize OpenTUI's Three.js WebGPU support to build a terminal application with 3D graphics.
How to install OpenTUI
View source1. Install with the skills CLI
npx skills add anomalyco/opentui/content --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 anomalycoOpenTUI Skill
Canonical reference docs are authored once in sibling docs/**/*.mdx files.
Inside the OpenTUI repo, this skill root lives at packages/web/src/content/, so the same files are also visible at packages/web/src/content/docs/**/*.mdx.
Path invariant
/docs/<slug>maps todocs/<slug>.mdxrelative to this skill root- in the repo, that same slug maps to
packages/web/src/content/docs/<slug>.mdx
Reading order by area
- Getting started:
/docs/getting-started - Core:
/docs/core-concepts/renderer - Testing:
/docs/core-concepts/testing - Audio:
/docs/core-concepts/audio - Keymap:
/docs/keymap/overview - React:
/docs/bindings/react - Solid:
/docs/bindings/solid - Components:
/docs/components/text,/docs/components/input,/docs/components/image - Layout:
/docs/core-concepts/layout - Keyboard:
/docs/core-concepts/keyboard - Plugins:
/docs/plugins/slots - Runtime and packaging:
/docs/reference/env-vars,/docs/reference/standalone-executables - Package entrypoints:
/docs/reference/package-entrypoints - Native images:
/docs/reference/native-image - QR encoding:
/docs/reference/qr-encoder - SSH:
/docs/reference/ssh - Three.js WebGPU:
/docs/reference/three
Quick routing by intent
| Intent(s) | Start here |
|---|---|
getting-started, installation, quickstart, intro | docs/getting-started.mdx |
core, renderer, terminal, scrollback, lifecycle | docs/core-concepts/renderer.mdx |
audio, native-audio, sound, playback, streaming, radio, mp3, flac, pcm, fft | docs/core-concepts/audio.mdx |
keymap, keybindings, shortcuts, commands, leader, ex-commands | docs/keymap/overview.mdx |
layout, flexbox, yoga, positioning | docs/core-concepts/layout.mdx |
keyboard, input, keybindings, paste, focus | docs/core-concepts/keyboard.mdx |
testing, test-renderer, snapshots, frames | docs/core-concepts/testing.mdx |
react, jsx, hooks, keyboard, paste, focus, blur, selection, animation, testing | docs/bindings/react.mdx |
solid, jsx, signals, hooks, keyboard, animation, testing | docs/bindings/solid.mdx |
plugins, plugin, slots, registry, extensions | docs/plugins/slots.mdx |
text, styling, content, selection | docs/components/text.mdx |
input, form, editing, focus | docs/components/input.mdx |
image, image-renderable, image-display, kitty, sixel | docs/components/image.mdx |
env, environment, configuration, flags | docs/reference/env-vars.mdx |
standalone, executable, bun-compile, node-sea, node-assets | docs/reference/standalone-executables.mdx |
package-exports, entrypoints, subpath-exports, imports | docs/reference/package-entrypoints.mdx |
native-image, image-decode, png, jpeg, webp, gif, rgba, pixels, resize | docs/reference/native-image.mdx |
qr, qrcode, qr-encoder, svg-qr, gs1, eci, structured-append | docs/reference/qr-encoder.mdx |
ssh, remote-tui, ssh-server, authentication, middleware | docs/reference/ssh.mdx |
three, threejs, webgpu, 3d, sprites, physics | docs/reference/three.mdx |
For concrete component requests, jump straight to docs/components/<name>.mdx after the relevant entry page. For plugin implementation details, narrow from docs/plugins/slots.mdx into docs/plugins/core.mdx, docs/plugins/react.mdx, or docs/plugins/solid.mdx.
Current skill entry pages
docs/getting-started.mdxdocs/core-concepts/renderer.mdxdocs/core-concepts/audio.mdxdocs/core-concepts/testing.mdxdocs/keymap/overview.mdxdocs/core-concepts/layout.mdxdocs/core-concepts/keyboard.mdxdocs/bindings/react.mdxdocs/bindings/solid.mdxdocs/plugins/slots.mdxdocs/components/text.mdxdocs/components/input.mdxdocs/components/image.mdxdocs/reference/env-vars.mdxdocs/reference/standalone-executables.mdxdocs/reference/package-entrypoints.mdxdocs/reference/native-image.mdxdocs/reference/qr-encoder.mdxdocs/reference/ssh.mdxdocs/reference/three.mdx
Working rules
- Prefer the current entry pages first, then read narrower docs in the same section.
- Read the sibling
docs/**/*.mdxfiles directly instead of copying prose into this file. - Use stable
/docs/...URLs when cross-referencing docs.
Frequently asked questions about OpenTUI
Similar skills
Playwright Component Testing
Test React and Vue components in isolation with Playwright.
Fluent UI Blazor
Integrate Fluent UI components in Blazor applications effortlessly.
Build MCP App
Create interactive UI widgets for MCP servers.
Web Design Reviewer
Identify and fix design issues in websites efficiently.
Markstream Install
Seamlessly integrate Markstream for Markdown rendering.
GSAP & Framer Scroll Animation
Create advanced scroll animations effortlessly.