Opentui

OrganizationPopular

anomalyco

opentui

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

Overview

Publisher	anomalyco
Repository	`opentui`
Skill name	`opentui`
Stars	13.4K
Forks	755
Bundled files	88
License	MIT
Links	Skill source Repository Homepage

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
88 bundled files
Scripts, templates, and references the model can read while it works. Files are read-only and never executed.
Open source
Published by anomalyco on GitHub. Read the source before you install it.

Installation

Install the Opentui AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
https://github.com/anomalyco/opentui/tree/main/packages/web/src/content
Enable the skill in any chat where you want it available.

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/anomalyco/opentui.git /tmp/opentui
mkdir -p .claude/skills
cp -r /tmp/opentui/packages/web/src/content .claude/skills/opentui

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Opentui in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Opentui on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Opentui is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

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.

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 with createCliRenderer().
@opentui/react: use React components, JSX, and hooks with createRoot().
@opentui/solid: use Solid components, JSX, and signals with render().
@opentui/keymap: centralize keyboard bindings and named commands across views. 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.
@opentui/qrcode: encode QR matrices, terminal text, or SVG, or display a 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
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`, `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`
`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.

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 for references between documentation pages. For links in this file, use the corresponding relative docs/**/*.mdx paths.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

docs/application-apis/animation.mdx18 KB
docs/application-apis/audio-capture.mdx18 KB
docs/application-apis/audio-streaming.mdx27 KB
docs/bindings/react.mdx12 KB
docs/bindings/solid.mdx15 KB
docs/components/ascii-font.mdx6 KB
docs/components/box.mdx7 KB
docs/components/code.mdx11 KB
docs/components/diff.mdx6 KB
docs/components/embedded-terminal.mdx16 KB
docs/components/frame-buffer.mdx8 KB
docs/components/image.mdx12 KB
docs/components/input.mdx6 KB
docs/components/line-number.mdx6 KB
docs/components/markdown.mdx12 KB
docs/components/overview.mdx10 KB
docs/components/qr-code.mdx6 KB
docs/components/scrollbar.mdx3 KB
docs/components/scrollbox.mdx9 KB
docs/components/select.mdx8 KB
docs/components/slider.mdx3 KB
docs/components/tab-select.mdx7 KB
docs/components/text-table.mdx10 KB
docs/components/text.mdx7 KB
docs/components/textarea.mdx10 KB
docs/components/time-to-first-draw.mdx5 KB
docs/core-concepts/audio.mdx17 KB
docs/core-concepts/clipboard.mdx15 KB
docs/core-concepts/colors.mdx7 KB
docs/core-concepts/console.mdx10 KB
docs/core-concepts/interaction.mdx14 KB
docs/core-concepts/keyboard.mdx8 KB
docs/core-concepts/layout.mdx13 KB
docs/core-concepts/lifecycle.mdx13 KB
docs/core-concepts/notifications.mdx7 KB
docs/core-concepts/renderables.mdx7 KB
docs/core-concepts/renderer.mdx9 KB
docs/core-concepts/rendering-pipeline.mdx5 KB
docs/core-concepts/testing.mdx18 KB
docs/core-concepts/text-and-cells.mdx9 KB
docs/extend/custom-renderables.mdx11 KB
docs/extend/editing.mdx21 KB
docs/extend/post-processing.mdx11 KB
docs/extend/runtime-plugins.mdx12 KB
docs/getting-started.mdx3 KB
docs/getting-started/quickstart.mdx3 KB
docs/getting-started/runtime-support.mdx9 KB
docs/keymap/addons.mdx17 KB
docs/keymap/core.mdx36 KB
docs/keymap/custom-addons.mdx24 KB
docs/keymap/hosts.mdx14 KB
docs/keymap/overview.mdx5 KB
docs/keymap/react.mdx7 KB
docs/keymap/solid.mdx7 KB
docs/plugins/core.mdx11 KB
docs/plugins/react.mdx6 KB
docs/plugins/slots.mdx12 KB
docs/plugins/solid.mdx6 KB
docs/reference/api-index.mdx114 KB
docs/reference/buffer-api.mdx14 KB

and 28 more files.

Frequently asked questions

What does the Opentui AI skill do?

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

Why use Opentui on TypingMind?

Because you install it once and use it with any model. Opentui is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Opentui in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/anomalyco/opentui/tree/main/packages/web/src/content. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Opentui?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Opentui?

As many as you like. As long as a model supports skills, you can use Opentui with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Opentui AI skill free?

Yes. It is published on GitHub by anomalyco under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Hyperframes

NousResearch

OrganizationPopular

Render MP4/WebM videos from HTML compositions.

Ip As Logo

Design minimal cute IP mascot marks readable at 32px.

Mono Color

Generate one- or two-ink editorial print poster images.

Pretext

Build creative browser demos with DOM-free text layout.

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

OpenTUI Skill

Terminal layout defaults

Path invariant

Choose packages

Reading order by area

Quick routing by intent

Current skill entry pages

Working rules

Bundled files

Frequently asked questions

Related AI Skills

Set up your own AI workspace now