Agent skill

Opentui

by zai-org in zai-org/ZCode

Build terminal UIs with OpenTUI. An agent skill from zai-org/ZCode.

Apache-2.0Auto-check passed

Install Opentui

skills CLI
$ npx skills add zai-org/ZCode --skill opentui -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install zai-org/ZCode opentui --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/zai-org/ZCode.git skills-src && mkdir -p .claude/skills && cp -r skills-src/apps/zcode-cli/.agents/skills/opentui .claude/skills/opentui && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
opentui
GitHub stars
7.7k
Token cost
~857 tokens
SKILL.md length
232 words
Files
50
Skills in repo
5
Repo updated
First seen
Licence
Apache-2.0

At a glance

Build terminal UIs with OpenTUI. An agent skill from zai-org/ZCode.

  • SKILL.md covers Path invariant, Reading order by area, Quick routing by intent and Current skill entry pages, plus 1 more section
  • Runs TypeScript scripts from its folder

What it does

Opentui is an agent skill from zai-org/ZCode. Build terminal UIs with OpenTUI. Covers the core API, native audio, keymaps, React and Solid bindings, components, layout, keyboard input, plugins, and testing.

Its SKILL.md is about 860 tokens, which your agent loads only when the skill is triggered. The skill folder holds 52 other files (for example `config.ts`).

It works with React. The repository describes itself as: Z.ai's coding agent harness. Powerful, intelligent, extensible. The licence is Apache-2.0.

Example prompts

  • “/opentui”

Requirements

  • Node.js

What it can do on your machine

Read from SKILL.md and the folder at commit aac4755. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships script files (TypeScript, from the files we listed), which the agent can run.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Opentui loads about 857 tokens when it runs. Until then it costs about 42 tokens; SKILL.md has 232 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~42
When it runs · the whole SKILL.md, loaded when a task matches
~857

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from zai-org/ZCode at commit aac4755, republished under its Apache-2.0 licence (© zai-org). 232 words, ~857 tokens.

Download SKILL.mdSave it as .claude/skills/opentui/SKILL.md (or your agent's skills folder). This skill also uses 49 other files; get the full folder from GitHub.
name
opentui
description
Build terminal UIs with OpenTUI. Covers the core API, native audio, keymaps, React and Solid bindings, components, layout, keyboard input, plugins, and testing.

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 to docs/<slug>.mdx relative 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
  • 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
  • Reference: /docs/reference/env-vars

Quick routing by intent

Intent(s)Start here
getting-started, installation, quickstart, introdocs/getting-started.mdx
core, renderer, terminal, scrollback, lifecycledocs/core-concepts/renderer.mdx
audio, native-audio, sound, playback, pcm, fftdocs/core-concepts/audio.mdx
keymap, keybindings, shortcuts, commands, leaderdocs/keymap/overview.mdx
layout, flexbox, yoga, positioningdocs/core-concepts/layout.mdx
keyboard, input, keybindings, paste, focusdocs/core-concepts/keyboard.mdx
react, jsx, hooks, animation, testingdocs/bindings/react.mdx
solid, signals, jsx, hooks, animation, testingdocs/bindings/solid.mdx
plugins, plugin, slots, registry, extensionsdocs/plugins/slots.mdx
text, styling, content, selectiondocs/components/text.mdx
input, form, editing, focusdocs/components/input.mdx
env, environment, configuration, flagsdocs/reference/env-vars.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.mdx
  • docs/core-concepts/renderer.mdx
  • docs/core-concepts/audio.mdx
  • docs/keymap/overview.mdx
  • docs/core-concepts/layout.mdx
  • docs/core-concepts/keyboard.mdx
  • docs/bindings/react.mdx
  • docs/bindings/solid.mdx
  • docs/plugins/slots.mdx
  • docs/components/text.mdx
  • docs/components/input.mdx
  • docs/reference/env-vars.mdx

Working rules

  • Prefer the current entry pages first, then read narrower docs in the same section.
  • Read the sibling docs/**/*.mdx files directly instead of copying prose into this file.
  • Use stable /docs/... URLs when cross-referencing docs.

© zai-org, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 49 other files in apps/zcode-cli/.agents/skills/opentui of zai-org/ZCode.

  • SKILL.md
  • config.ts
  • docs/bindings/react.mdx
  • docs/bindings/solid.mdx
  • docs/components/ascii-font.mdx
  • docs/components/box.mdx
  • docs/components/code.mdx
  • docs/components/diff.mdx
  • docs/components/frame-buffer.mdx
  • docs/components/input.mdx
  • docs/components/line-number.mdx
  • docs/components/markdown.mdx
  • docs/components/qr-code.mdx
  • docs/components/scrollbar.mdx
  • docs/components/scrollbox.mdx
  • docs/components/select.mdx
  • docs/components/slider.mdx
  • docs/components/tab-select.mdx
  • … and 32 more

Open the folder on GitHubat commit aac4755

Compare with similar skills

Opentui next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Opentui compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Opentui this skillzai-org/ZCode7.7k—~857Automated safety check: PassApache-2.0
Web Artifacts Builderanthropics/skills180k40 repos~769Automated safety check: PassApache-2.0
Vercel Composition Patternssupabase/supabase111k58 repos~726Automated safety check: PassMIT
React Doctormakeplane/plane61k12 repos~657Automated safety check: PassAGPL-3.0
React Router Developmentremix-run/react-router57k1 repos~1.5kAutomated safety check: PassMIT
React UI State PatternsChrisWiles/claude-code-showcase6.1k8 repos~1.6kAutomated safety check: PassNone

Similar skills

  • Web Artifacts Builder

    anthropics/skills

    Official

    Builds multi-component claude.ai HTML artifacts as a small React, TypeScript and Tailwind project, then bundles it into one shareable HTML file.

    180k GitHub starsUsed in 40 repos~769 tokens
    Frontend & DesignAuto-check passed
  • Official

    React composition patterns that scale. An agent skill from supabase/supabase.

    111k GitHub starsUsed in 58 repos~726 tokens
    DevelopmentAuto-check passed
  • React Doctor

    makeplane/plane

    Scans React code for lint, accessibility, bundle size and architecture issues, reports a health score and checks that changes do not lower it.

    61k GitHub starsUsed in 12 repos~657 tokens
    Frontend & DesignAuto-check passed
  • React Router Development

    remix-run/react-router

    Guides work on React Router apps by first identifying whether the app uses Framework, Data or Declarative mode, then loading the matching reference and the installed package docs.

    57k GitHub starsUsed in 1 repo~1.5k tokens
    Frontend & DesignAuto-check passed
  • React UI State Patterns

    ChrisWiles/claude-code-showcase

    Sets patterns for React interfaces: when to show loading spinners or skeletons, how to surface errors, how to disable buttons during async work and how to handle empty lists.

    6.1k GitHub starsUsed in 8 repos~1.6k tokens
    Frontend & DesignAuto-check passed
  • Tells the agent where new code belongs in an Electron multi-process project and which APIs each process may use, with rules for new bridges, services, agents and workers.

    33k GitHub starsUsed in 1 repo~1.8k tokens
    DevelopmentAuto-check passed

More from zai-org/ZCode

All 25 skills in this repo
  • DOCX

    zai-org/ZCode

    Complete DOCX document creation, editing, and analysis capabilities with support for revisions, comments, formatting preservation, and text extraction.

    7.7k GitHub stars~4.9k tokensUpdated yesterday
    Auto-check: notes
  • Visualize

    zai-org/ZCode

    Create visualizations and interactive tools directly in conversation.

    7.7k GitHub stars~8.7k tokensUpdated yesterday
    Auto-check passed
  • PDF

    zai-org/ZCode

    Professional PDF toolkit covering four production workflows: reports, creative visuals, academic LaTeX, and existing PDF processing.

    7.7k GitHub stars~18k tokensUpdated yesterday
    Auto-check: notes
  • A skill your agent uses when ZCode needs to inspect, plan, or execute restoration of old ACP-era ZCode sessions from ~/.zcode/v2/sessions into the new ZCode task/session stores.

    7.7k GitHub stars~1.2k tokensUpdated yesterday
    Auto-check passed
  • Generate, verify, or remove large synthetic ZCode task fixtures in local ~/.zcode persistence for UI/session performance testing.

    7.7k GitHub stars~698 tokensUpdated yesterday
    Auto-check passed
  • Check ZCode module and layer boundaries for code changes. An agent skill from zai-org/ZCode.

    7.7k GitHub stars~1.3k tokensUpdated yesterday
    Auto-check passed

Works with

Questions about Opentui

What does Opentui do?

Build terminal UIs with OpenTUI. An agent skill from zai-org/ZCode. Opentui is an agent skill from zai-org/ZCode. Build terminal UIs with OpenTUI.

How do I install Opentui in Claude Code?

Run `npx skills add zai-org/ZCode --skill opentui -a claude-code`. Or copy the skill folder (apps/zcode-cli/.agents/skills/opentui in zai-org/ZCode) into .claude/skills/opentui in your project. Claude Code loads it when a task matches its description.

How do I install Opentui in Codex?

Run `npx skills add zai-org/ZCode --skill opentui -a codex`. Or copy the skill folder (apps/zcode-cli/.agents/skills/opentui in zai-org/ZCode) into .agents/skills/opentui in your project. Codex loads it when a task matches its description.

Can I use Opentui in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add zai-org/ZCode --skill opentui -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/opentui, .gemini/skills/opentui, .github/skills/opentui and .opencode/skills/opentui in your project.

What does Opentui need to run?

Going by SKILL.md and its folder, Opentui needs TypeScript for the scripts in its folder. Our summary lists: Node.js.

Does Opentui access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Opentui safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Opentui use?

Opentui is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Opentui use?

About 857 tokens (SKILL.md is roughly 3.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Opentui?

Skills that share tags, products or a category with Opentui: Web Artifacts Builder (anthropics/skills, 180k stars), Vercel Composition Patterns (supabase/supabase, 111k stars), React Doctor (makeplane/plane, 61k stars) and React Router Development (remix-run/react-router, 57k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Opentui?

zai-org (a GitHub organization) maintains it in zai-org/ZCode, which has 7,659 GitHub stars. The repository holds 5 skills in this directory. The repository was last updated on October 10, 2026.

Source: zai-org/ZCode on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.