PyModel OpenTUI 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 - 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 - 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 |
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 |
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/reference/env-vars.mdxdocs/reference/standalone-executables.mdxdocs/reference/package-entrypoints.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.