opentui

name	opentui
description	Build terminal UIs with OpenTUI. Covers Core, frameworks, components, application APIs, testing, extensions, integrations, deployment, and public API lookup.

OpenTUI Skill

Canonical reference docs are in the sibling docs/**/*.mdx files.

Inside the OpenTUI repository, this skill root is packages/web/src/content/. The same files are available under packages/web/src/content/docs/**/*.mdx from the repository root.

Path invariant

• /docs maps to docs/getting-started.mdx.
• /docs/components maps to docs/components/overview.mdx.
• Every other /docs/<slug> URL maps to docs/<slug>.mdx relative to this skill root.
• From the repository root, prepend packages/web/src/content/ to each source path.

Reading order by area

• Start: /docs, /docs/getting-started/quickstart, /docs/getting-started/runtime-support
• Frameworks: /docs/bindings/react, /docs/bindings/solid
• Core: /docs/core-concepts/renderer, /docs/core-concepts/layout, /docs/core-concepts/keyboard
• Components: /docs/components, /docs/components/text, /docs/components/input, /docs/components/image, /docs/components/embedded-terminal
• Application APIs: /docs/core-concepts/clipboard, /docs/core-concepts/audio, /docs/application-apis/audio-streaming, /docs/application-apis/audio-capture, /docs/application-apis/animation
• Test and debug: /docs/core-concepts/testing, /docs/test-and-debug/troubleshooting
• Extensions: /docs/plugins/slots, /docs/extend/runtime-plugins
• Keymap: /docs/keymap/overview
• Integrations: /docs/reference/ssh, /docs/reference/three, /docs/reference/qr-encoder
• Ship: /docs/ship/deploy, /docs/reference/standalone-executables
• Reference: /docs/reference/api-index, /docs/reference/package-entrypoints, /docs/reference/env-vars, /docs/reference/native-image

Quick routing by intent

Intent(s)	Start here
getting-started, intro, examples, agent-skill	docs/getting-started.mdx
installation, quickstart	docs/getting-started/quickstart.mdx
runtime-support, bun, nodejs, native-artifacts, ffi, permissions, libc, runtime-assets	docs/getting-started/runtime-support.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
core, renderer, terminal, scrollback, lifecycle	docs/core-concepts/renderer.mdx
layout, flexbox, yoga, positioning	docs/core-concepts/layout.mdx
keyboard, input, keybindings, paste, focus	docs/core-concepts/keyboard.mdx
components, component, component-support, support-matrix, ,

For a component request, read docs/components/overview.mdx, then open docs/components/<name>.mdx. For plugin slot details, start at docs/plugins/slots.mdx, then open the Core, React, or Solid page.

Current skill entry pages

• docs/getting-started.mdx
• docs/getting-started/quickstart.mdx
• docs/getting-started/runtime-support.mdx
• docs/bindings/react.mdx
• docs/bindings/solid.mdx
• docs/core-concepts/renderer.mdx
• docs/core-concepts/layout.mdx
• docs/core-concepts/keyboard.mdx
• docs/components/overview.mdx
• docs/components/text.mdx
• docs/components/input.mdx
• docs/components/image.mdx
• docs/components/embedded-terminal.mdx
• docs/core-concepts/clipboard.mdx
• docs/core-concepts/audio.mdx
• docs/application-apis/audio-streaming.mdx
• docs/application-apis/audio-capture.mdx
• docs/application-apis/animation.mdx
• docs/core-concepts/testing.mdx
• docs/test-and-debug/troubleshooting.mdx
• docs/plugins/slots.mdx
• docs/extend/runtime-plugins.mdx
• docs/keymap/overview.mdx
• docs/reference/ssh.mdx
• docs/reference/three.mdx
• docs/reference/qr-encoder.mdx
• docs/ship/deploy.mdx
• docs/reference/standalone-executables.mdx
• docs/reference/api-index.mdx
• docs/reference/package-entrypoints.mdx
• docs/reference/env-vars.mdx
• docs/reference/native-image.mdx

Working rules

• Read an entry page first, then read the narrower canonical page for the task.
• Read the sibling docs/**/*.mdx files directly. Do not copy their prose into this file.
• Use canonical /docs URLs when you cross-reference documentation.