opentui
Skill403 starsChanged 2 days agoApache-2.0View on GitHub
Build terminal UIs with OpenTUI. Covers Core, frameworks, components, application APIs, testing, extensions, integrations, deployment, and public API lookup.
14 other projects use a version of this, 3 of them edited; 3 of 3 edited versions we compared changed its rules; 2 new projects in the last 4 weeks, against 0 the 4 before.
How people change it
3 of 3 edited versions changed its rules, and some changes recur.
Of the 3 edited versions we compared: 3 made changes of their own.
Rules people drop
- Do not use gaps between adjacent UI panels.dropped by 3 of 3
- Do not add unnecessary margins or padding.dropped by 3 of 3
- Prefer compact, information-dense layouts over website-style card spacing.dropped by 3 of 3
- Every other
/docs/<slug>URL maps todocs/<slug>.mdxrelative to this skill root.dropped by 3 of 3 - Use Core directly or choose a React or Solid binding for the UI. Recommend companion packages when their features fit the task. Do not install every package by default.dropped by 3 of 3
- Start with
createDefaultOpenTuiKeymap()from@opentui/keymap/opentui. Use@opentui/keymap/reactor@opentui/keymap/solidfor providers and hooks. …dropped by 3 of 3 - Use
@opentui/keymap/reactor@opentui/keymap/solidfor providers and hooks. [Direct keyboard events](docs/core-concepts/keyboard.mdx) or component-local bindings are enough for simple local input.dropped by 3 of 3 - 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.dropped by 3 of 3
Rules people add
- Prefer the current entry pages first, then read narrower docs in the same section.added by 3 of 3
- Read the sibling
docs/**/*.mdxfiles directly instead of copying prose into this file.added by 3 of 3 - Use stable
/docs/...URLs when cross-referencing docs.added by 3 of 3
We split this file and each edited version into the rules they give an agent and match them by wording. A version that adds no rule of its own and has not changed since this file last did reads as an older text, so what it lacks is not counted as dropped. We keep no past texts of a file, so that is inferred, and an edited version that started from an older text still counts its gaps as drops.
Adopted by
Surging: 2 new projects took it in the last 4 weeks, none the 4 weeks before.thin data
Most recently taken up by
- noodle-rest/noodleword for word, first seen Nov 15, 2026
- timmo001/notesword for word, first seen Nov 11, 2026
- Limatura/tesseratheir own version, first seen Nov 1, 2026
- patterson-agents/cliedited, first seen Oct 13, 2026
- Aniket-508/termcntheir own version, first seen Oct 9, 2026
- patterson-agents/skillsedited, first seen Aug 12, 2026
Other versions14 projects use a version of this.
Word for word · 2
- noodle-rest/noodle★ 403100% same
- timmo001/notes★ 2100% same
Edited · 3
- Mark-Life/peektrace★ 441% same
- patterson-agents/cli★ 241% same
- patterson-agents/skills★ 041% same
Wrote their own version · 9
- cline/cline★ 72ksame name
- Aniket-508/termcn★ 1.2ksame name
- Limatura/tessera★ 81same name
- nitodeco/ralph★ 19same name
- LeonardoTrapani/better-skills★ 11same name
- yumazak/joy★ 4same name
- christyjacob4/claude-tricks★ 2same name
- FelipeAngeli/skills★ 2same name
- sarfraznawaz2005/agent-skills-collection★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository4 other files it gives its agents.
- AGENTS.mdAGENTS.md
- noodle-devSkill
- noodle-releaseSkill
- noodle-useSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
16 rules. 0 are common, 7 are distinctive, and 9 are very specific to this project.
0
Common
Most of the 12 edited versions we read keep these.
7
Distinctive
This author's own choices. Worth a look.
9
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 17
Do not use gaps between adjacent UI panels.
- Distinctive: line 18
Do not add unnecessary margins or padding.
- Distinctive: line 19
Prefer compact, information-dense layouts over website-style card spacing.
- Very specific: line 25
Every other /docs/<slug> URL maps to docs/<slug>.mdx relative to this skill root.
- Distinctive: line 37
Use Core directly or choose a React or Solid binding for the UI.
- Very specific: line 45
Start with createDefaultOpenTuiKeymap() from @opentui/keymap/opentui.
- Very specific: line 46
Use @opentui/keymap/react or @opentui/keymap/solid for providers and hooks.
- Very specific: line 49
Import createServer() from the package root.
- Distinctive: line 59
Use the API and symbol index to find exports.
- Distinctive: line 60
Use public package entry points instead of source-file deep imports.
- Very specific: line 64
Start: /docs, /docs/getting-started/quickstart, /docs/getting-started/runtime-support
- Very specific: line 69
Test and debug: /docs/core-concepts/testing, /docs/test-and-debug/troubleshooting
- Very specific: line 120
Read docs/native/host-io-time.mdx for Session clocks, terminal delivery, and native file operations.
- Distinctive: line 161
Read an entry page first, then read the narrower canonical page for the task.
- Very specific: line 162
Read the sibling docs//*.mdx files directly.
- Very specific: line 163
Use canonical /docs URLs for references between documentation pages.
“Common” is measured: kept by at least 6 in 10 of the 12 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
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
/docsmaps todocs/getting-started.mdx./docs/componentsmaps todocs/components/overview.mdx.- Every other
/docs/<slug>URL maps todocs/<slug>.mdxrelative to this skill root. - From the repository root, prepend
packages/web/src/content/to each source path. /docs/releases/<version>maps todocs/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. Recommend companion packages when their features fit the task. Do not install every package by default.
@opentui/core: use imperative renderables and events withcreateCliRenderer().@opentui/react: use React components, JSX, and hooks withcreateRoot().@opentui/solid: use Solid components, JSX, and signals withrender().@opentui/keymap: centralize keyboard bindings and named commands across views. The package supports focus-scoped layers, configurable shortcuts, and multi-key sequences. Start withcreateDefaultOpenTuiKeymap()from@opentui/keymap/opentui. Use@opentui/keymap/reactor@opentui/keymap/solidfor 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. ImportcreateServer()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.@opentui/qrcode: encode QR matrices, terminal text, or SVG, or display aQRCodeRenderable. For JSX, useregisterQRCode()from@opentui/qrcode/reactor@opentui/qrcode/solid. See the QR code component.@opentui/three: render Three.js WebGPU scenes in the terminal withThreeRenderable. 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 - 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 - 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-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, react-components, solid-components | docs/components/overview.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 |
embedded-terminal, terminal-renderable, ghostty, vt, pty | docs/components/embedded-terminal.mdx |
clipboard, copy, osc52, host-clipboard | docs/core-concepts/clipboard.mdx |
audio, native-audio, sound, playback, mixer, devices, tap | docs/core-concepts/audio.mdx |
audio-streaming, audio-stream, pcm, f32le, radio, mp3, flac, icy, backpressure, reconnect | docs/application-apis/audio-streaming.mdx |
audio-capture, microphone, pcm, recording, wav, audio-recorder | docs/application-apis/audio-capture.mdx |
animation, timeline, easing, use-timeline | docs/application-apis/animation.mdx |
testing, test-renderer, snapshots, frames | docs/core-concepts/testing.mdx |
troubleshooting, terminal-reset, ffi-errors, native-loading, runtime-plugins, protocols, test-timeouts | docs/test-and-debug/troubleshooting.mdx |
plugins, plugin, slots, registry, extensions | docs/plugins/slots.mdx |
runtime-plugins, dynamic-import, external-modules, bun-plugin, module-maps, plugin-loading | docs/extend/runtime-plugins.mdx |
keymap, keybindings, shortcuts, commands, leader, ex-commands | docs/keymap/overview.mdx |
ssh, remote-tui, ssh-server, authentication, middleware | docs/reference/ssh.mdx |
three, threejs, webgpu, 3d, sprites, physics | docs/reference/three.mdx |
qr, qrcode, qr-encoder, svg-qr, gs1, eci, structured-append | docs/reference/qr-encoder.mdx |
deploy, bundle, bun-executable, nodejs-esm, node-sea, ssh-deployment | docs/ship/deploy.mdx |
standalone, executable, bun-compile, node-sea, node-assets | docs/reference/standalone-executables.mdx |
api, symbols, exports, public-api, api-index, lookup | docs/reference/api-index.mdx |
native, native-rendering, native-scene, native-api | docs/native/overview.mdx |
package-exports, entrypoints, subpath-exports, imports | docs/reference/package-entrypoints.mdx |
env, environment, configuration, flags | docs/reference/env-vars.mdx |
native-image, image-decode, png, jpeg, webp, gif, rgba, pixels, resize | docs/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
docs/getting-started.mdxdocs/getting-started/quickstart.mdxdocs/getting-started/runtime-support.mdxdocs/bindings/react.mdxdocs/bindings/solid.mdxdocs/core-concepts/renderer.mdxdocs/core-concepts/layout.mdxdocs/core-concepts/keyboard.mdxdocs/components/overview.mdxdocs/components/text.mdxdocs/components/input.mdxdocs/components/image.mdxdocs/components/embedded-terminal.mdxdocs/core-concepts/clipboard.mdxdocs/core-concepts/audio.mdxdocs/application-apis/audio-streaming.mdxdocs/application-apis/audio-capture.mdxdocs/application-apis/animation.mdxdocs/core-concepts/testing.mdxdocs/test-and-debug/troubleshooting.mdxdocs/plugins/slots.mdxdocs/extend/runtime-plugins.mdxdocs/keymap/overview.mdxdocs/reference/ssh.mdxdocs/reference/three.mdxdocs/reference/qr-encoder.mdxdocs/native/overview.mdxdocs/ship/deploy.mdxdocs/reference/standalone-executables.mdxdocs/reference/api-index.mdxdocs/reference/package-entrypoints.mdxdocs/reference/env-vars.mdxdocs/reference/native-image.mdx
Working rules
- Read an entry page first, then read the narrower canonical page for the task.
- Read the sibling
docs/**/*.mdxfiles directly. Do not copy their prose into this file. - Use canonical
/docsURLs for references between documentation pages. For links in this file, use the corresponding relativedocs/**/*.mdxpaths.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

