anomalyco/opentui/content

Claude Code and agent skill by anomalyco/opentui

Trust tier 3
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

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

Install

npx vskill@latest install anomalyco/opentui/content

SKILL.md

The same SKILL.md was published earlier as anomalyco/opentui/content.

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.

Terminal layout defaults

Design for a terminal app, not a browser. Use the available columns and rows efficiently.

  • Do not use gaps between adjacent UI panels.
  • Do not add unnecessary margins or padding.
  • Prefer compact, information-dense layouts over website-style card spacing.

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.
  • /docs/releases/<version> maps to docs/releases/<version>.md, the release notes of that version.

Versions

The docs describe the release or branch that this skill came from. Each release notes file lists what changed in that release and links the pages it affects. When a project uses an older @opentui/core than the docs describe, read the notes of the newer releases before you use an API, and prefer what the project's version provides.

Choose packages

Use Core directly or choose a React or Solid binding for the UI. For a Rust app, use the Rust crates. Recommend companion packages when their features fit the task. Do not install every package by default.

  • `@opentui/core`: use imperative renderables and events with createCliRenderer().
  • `@opentui/react`: use React components, JSX, and hooks with createRoot().
  • `@opentui/solid`: use Solid components, JSX, and signals with render().
  • Rust: use the opentui crate's widgets and event loop with App::new(), without

JavaScript. The crates are not on crates.io: depend on them through Git, pinned to a release tag, and link that release's native archive.

The package supports focus-scoped layers, configurable shortcuts, and multi-key sequences. Start with createDefaultOpenTuiKeymap() from @opentui/keymap/opentui. Use @opentui/keymap/react or @opentui/keymap/solid for providers and hooks. Direct keyboard events or component-local bindings are enough for simple local input.

  • `@opentui/ssh`: serve a terminal UI to standard SSH clients without a local app installation.

Import createServer() from the package root. Pass each session's renderer to Core, React, or Solid. The package has no framework subpaths. Read the SSH guide for authentication, middleware, and session cleanup.

QRCodeRenderable. For JSX, use registerQRCode() from @opentui/qrcode/react or @opentui/qrcode/solid. See the QR code component.

  • `@opentui/three`: render Three.js WebGPU scenes in the terminal with ThreeRenderable.

This integration supports only Bun. Before you choose it, check its runtime and dependency requirements.

See Package entry points for the full list of public imports. The list includes testing, addons, host adapters, and runtime-module maps. Use the API and symbol index to find exports. Use public package entry points instead of source-file deep imports.

Reading order by area

  • Start: /docs, /docs/getting-started/quickstart, /docs/getting-started/runtime-support
  • Bindings: /docs/bindings/react, /docs/bindings/solid, /docs/bindings/rust
  • 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
  • Native: /docs/native/overview
  • 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-skilldocs/getting-started.mdx
installation, quickstartdocs/getting-started/quickstart.mdx
runtime-support, bun, nodejs, native-artifacts, ffi, permissions, libc, runtime-assetsdocs/getting-started/runtime-support.mdx
react, jsx, hooks, keyboard, paste, focus, blur, selection, animation, testingdocs/bindings/react.mdx
solid, jsx, signals, hooks, keyboard, animation, testingdocs/bindings/solid.mdx
rust, cargo, rust-crates, opentui-sysdocs/bindings/rust/overview.mdx
core, renderer, terminal, scrollback, lifecycledocs/core-concepts/renderer.mdx
layout, flexbox, yoga, positioningdocs/core-concepts/layout.mdx
keyboard, input, keybindings, paste, focusdocs/core-concepts/keyboard.mdx
components, component, component-support, support-matrix, react-components, solid-componentsdocs/components/overview.mdx
text, styling, content, selectiondocs/components/text.mdx
input, form, editing, focusdocs/components/input.mdx
image, image-renderable, image-display, kitty, sixeldocs/components/image.mdx
embedded-terminal, terminal-renderable, ghostty, vt, ptydocs/components/embedded-terminal.mdx
clipboard, copy, osc52, host-clipboarddocs/core-concepts/clipboard.mdx
audio, native-audio, sound, playback, mixer, devices, tapdocs/core-concepts/audio.mdx
audio-streaming, audio-stream, pcm, f32le, radio, mp3, flac, icy, backpressure, reconnectdocs/application-apis/audio-streaming.mdx
audio-capture, microphone, pcm, recording, wav, audio-recorderdocs/application-apis/audio-capture.mdx
animation, timeline, easing, use-timelinedocs/application-apis/animation.mdx
testing, test-renderer, snapshots, framesdocs/core-concepts/testing.mdx
troubleshooting, terminal-reset, ffi-errors, native-loading, runtime-plugins, protocols, test-timeoutsdocs/test-and-debug/troubleshooting.mdx
plugins, plugin, slots, registry, extensionsdocs/plugins/slots.mdx
runtime-plugins, dynamic-import, external-modules, bun-plugin, module-maps, plugin-loadingdocs/extend/runtime-plugins.mdx
keymap, keybindings, shortcuts, commands, leader, ex-commandsdocs/keymap/overview.mdx
ssh, remote-tui, ssh-server, authentication, middlewaredocs/reference/ssh.mdx
three, threejs, webgpu, 3d, sprites, physicsdocs/reference/three.mdx
qr, qrcode, qr-encoder, svg-qr, gs1, eci, structured-appenddocs/reference/qr-encoder.mdx
deploy, bundle, bun-executable, nodejs-esm, node-sea, ssh-deploymentdocs/ship/deploy.mdx
standalone, executable, bun-compile, node-sea, node-assetsdocs/reference/standalone-executables.mdx
api, symbols, exports, public-api, api-index, lookupdocs/reference/api-index.mdx
native, native-rendering, native-scene, native-apidocs/native/overview.mdx
package-exports, entrypoints, subpath-exports, importsdocs/reference/package-entrypoints.mdx
env, environment, configuration, flagsdocs/reference/env-vars.mdx
native-image, image-decode, png, jpeg, webp, gif, rgba, pixels, resizedocs/reference/native-image.mdx

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.

For native applications, read docs/native/overview.mdx, docs/native/resources.mdx, and docs/native/frames.mdx in order. docs/native/core.mdx explains Core's TypeScript integration, not a native-language API. Read docs/native/host-io-time.mdx for Session clocks, terminal delivery, and native file operations. Then choose docs/native/c.mdx or docs/native/zig.mdx for a native program.

Current skill entry pages

This is the start of the file. Read the full SKILL.md on GitHub.

Security

  • Security scanPassed, 100 of 100Pattern checks on the skill's files.
  • Model reviewPassed

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

Source

Popularity

Repository stars
13,390
Repository forks
748
7-day trend score
48

Stars and forks are for the whole GitHub repository, not this skill alone. Refreshed 25 Sep 2026, a month ago.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/anomalyco/opentui/content/badge)](https://verified-skill.com/skills/anomalyco/opentui/content)

Something wrong with this skill or its page? Tell us.