Skip to content

PyModel/pythinker-code / .agents/skills/opentui

opentui

Verified

Build terminal UIs with OpenTUI. Covers core, components, audio, keymaps, React, Solid, plugins, testing, standalone executables, QR encoding, SSH, and Three.js WebGPU.

FileKindSize
SKILL.mdskill md5.4 KB
docs/bindings/react.mdxmarkdown11.0 KB
docs/bindings/solid.mdxmarkdown15.0 KB
docs/components/ascii-font.mdxmarkdown4.3 KB
docs/components/box.mdxmarkdown5.5 KB
docs/components/code.mdxmarkdown10.2 KB
docs/components/diff.mdxmarkdown4.2 KB
docs/components/frame-buffer.mdxmarkdown6.7 KB
docs/components/input.mdxmarkdown5.6 KB
docs/components/line-number.mdxmarkdown4.0 KB
docs/components/markdown.mdxmarkdown10.6 KB
docs/components/qr-code.mdxmarkdown4.3 KB
docs/components/scrollbar.mdxmarkdown2.3 KB
docs/components/scrollbox.mdxmarkdown7.5 KB
docs/components/select.mdxmarkdown6.2 KB
docs/components/slider.mdxmarkdown2.2 KB
docs/components/tab-select.mdxmarkdown6.0 KB
docs/components/text-table.mdxmarkdown9.0 KB
docs/components/text.mdxmarkdown4.5 KB
docs/components/textarea.mdxmarkdown7.7 KB
docs/components/time-to-first-draw.mdxmarkdown4.7 KB
docs/core-concepts/audio.mdxmarkdown32.2 KB
docs/core-concepts/colors.mdxmarkdown7.8 KB
docs/core-concepts/console.mdxmarkdown3.2 KB
docs/core-concepts/constructs.mdxmarkdown5.8 KB
docs/core-concepts/keyboard.mdxmarkdown10.4 KB
docs/core-concepts/layout.mdxmarkdown4.0 KB
docs/core-concepts/lifecycle.mdxmarkdown4.4 KB
docs/core-concepts/notifications.mdxmarkdown2.3 KB
docs/core-concepts/renderables-vs-constructs.mdxmarkdown4.5 KB
docs/core-concepts/renderables.mdxmarkdown9.9 KB
docs/core-concepts/renderer.mdxmarkdown30.9 KB
docs/core-concepts/testing.mdxmarkdown14.6 KB
docs/getting-started.mdxmarkdown3.2 KB
docs/keymap/addons.mdxmarkdown15.6 KB
docs/keymap/core.mdxmarkdown38.9 KB
docs/keymap/custom-addons.mdxmarkdown26.7 KB
docs/keymap/hosts.mdxmarkdown15.7 KB
docs/keymap/overview.mdxmarkdown18.1 KB
docs/keymap/react.mdxmarkdown4.9 KB
docs/keymap/solid.mdxmarkdown5.1 KB
docs/plugins/core.mdxmarkdown12.6 KB
docs/plugins/react.mdxmarkdown6.5 KB
docs/plugins/slots.mdxmarkdown12.7 KB
docs/plugins/solid.mdxmarkdown7.0 KB
docs/reference/color-matrix.mdxmarkdown3.8 KB
docs/reference/env-vars.mdxmarkdown6.5 KB
docs/reference/native-span-feed.mdxmarkdown6.0 KB
docs/reference/package-entrypoints.mdxmarkdown9.6 KB
docs/reference/qr-encoder.mdxmarkdown12.3 KB
docs/reference/ssh.mdxmarkdown14.8 KB
docs/reference/standalone-executables.mdxmarkdown7.1 KB
docs/reference/three.mdxmarkdown14.8 KB
docs/reference/tree-sitter.mdxmarkdown4.6 KB

docs/reference/package-entrypoints.mdx

View on GitHub
---
title: Package entrypoints
description: Public package roots and subpaths across the OpenTUI workspace
order: 5
skill:
  entry: true
  intents: [package-exports, entrypoints, subpath-exports, imports]
---

# Package entrypoints

OpenTUI packages use explicit `exports` maps. Import only the root and subpaths listed below; source-file deep imports are not public package entrypoints.

## @opentui/core

| Entrypoint                                       | Public purpose                                                                                                         |
| ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| `@opentui/core`                                  | Main imperative renderer, renderables, buffers, input, audio, plugins, Tree-sitter client, utilities, and shared types |
| `@opentui/core/testing`                          | Test renderer, input/mouse drivers, capability fixtures, clocks, spies, Tree-sitter mock, and frame recorder           |
| `@opentui/core/runtime-plugin`                   | Bun runtime-module plugin factory, module-ID helpers, rewrite options, and runtime module entry types                  |
| `@opentui/core/runtime-plugin-support`           | Installs core runtime-plugin support as an import side effect and re-exports its setup API                             |
| `@opentui/core/runtime-plugin-support/configure` | Configurable `ensureRuntimePluginSupport()` without import-time installation                                           |
| `@opentui/core/yoga`                             | Native Yoga `Config`/`Node`, enums, constants, layout values, and callback types                                       |
| `@opentui/core/tree-sitter/update-assets`        | `updateAssets`, `runUpdateAssetsCli`, and `UpdateOptions` for Tree-sitter assets                                       |
| `@opentui/core/parser.worker`                    | Tree-sitter parser worker module; no named application API                                                             |
| `@opentui/core/node-assets`                      | `getNodeAssets(target)` plus `NodeAsset` and `NodeAssetTarget` for Node distribution assets                            |

`runtime-plugin`, both runtime-plugin-support entries, and the Tree-sitter update CLI use Bun-specific tooling. See the [Plugin API](/docs/plugins/core) and [Tree-sitter reference](/docs/reference/tree-sitter) for their workflows.

## @opentui/react

| Entrypoint                                        | Public purpose                                                                                             |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `@opentui/react`                                  | React renderer root, intrinsic catalogue, components, hooks, slots, `TimeToFirstDraw`, and component types |
| `@opentui/react/renderer`                         | Published alias for the root renderer exports, including `createRoot` and `Root`                           |
| `@opentui/react/test-utils`                       | React-aware `testRender(node, options)` over `@opentui/core/testing`                                       |
| `@opentui/react/runtime-plugin-support`           | Installs the React runtime-module plugin as an import side effect                                          |
| `@opentui/react/runtime-plugin-support/configure` | Configurable React `ensureRuntimePluginSupport()` without import-time installation                         |
| `@opentui/react/jsx-runtime`                      | Automatic JSX runtime: `Fragment`, `jsx`, `jsxs`, and OpenTUI JSX types                                    |
| `@opentui/react/jsx-dev-runtime`                  | Development JSX runtime: `Fragment`, `jsxDEV`, and OpenTUI JSX types                                       |

The runtime-plugin-support entries use Bun's plugin API. Normal applications use the root and compiler-selected JSX runtime; use `/test-utils` only in tests.

## @opentui/solid

| Entrypoint                                        | Public purpose                                                                                                |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `@opentui/solid`                                  | Solid renderer, root `render`/`testRender`, reconciler helpers, elements, scrollback, slots, hooks, and types |
| `@opentui/solid/preload`                          | Bun preload that installs the Solid source transform                                                          |
| `@opentui/solid/bun-plugin`                       | Solid transform plugin factory/default export and installation/reset helpers                                  |
| `@opentui/solid/runtime-plugin-support`           | Installs Solid transform and runtime-module support as an import side effect                                  |
| `@opentui/solid/runtime-plugin-support/configure` | Configurable Solid runtime support without import-time installation                                           |
| `@opentui/solid/components`                       | `extend`, `getComponentCatalogue`, and component extension types                                              |
| `@opentui/solid/jsx-runtime`                      | Automatic JSX runtime and OpenTUI JSX namespace                                                               |
| `@opentui/solid/jsx-dev-runtime`                  | Development JSX runtime and OpenTUI JSX namespace                                                             |

`preload`, `bun-plugin`, and both runtime-plugin-support entries are Bun-specific. The root and JSX runtime setup are covered in [Solid.js bindings](/docs/bindings/solid).

## @opentui/keymap

| Entrypoint                        | Public purpose                                                                                |
| --------------------------------- | --------------------------------------------------------------------------------------------- |
| `@opentui/keymap`                 | Host-agnostic `Keymap`, extension context, key stringifiers, and shared types                 |
| `@opentui/keymap/extras`          | Binding lookup, command-binding, and formatting helpers                                       |
| `@opentui/keymap/extras/graph`    | Graph snapshots and graph projection types                                                    |
| `@opentui/keymap/addons`          | Universal parser, field, metadata, leader, sequence, command, and diagnostics addons          |
| `@opentui/keymap/addons/opentui`  | Universal addons plus OpenTUI base-layout and edit-buffer/textarea helpers                    |
| `@opentui/keymap/testing`         | Host-agnostic fake host, targets/events, diagnostics, and `createTestKeymap`                  |
| `@opentui/keymap/html`            | DOM host/event adapter and bare/default HTML keymap factories                                 |
| `@opentui/keymap/opentui`         | `CliRenderer`/`Renderable` host adapter and bare/default OpenTUI keymap factories             |
| `@opentui/keymap/react`           | OpenTUI React provider, hooks, and store-backed reactive matcher                              |
| `@opentui/keymap/solid`           | OpenTUI Solid provider, hooks, selector, and signal-backed reactive matcher                   |
| `@opentui/keymap/runtime-modules` | Runtime-module map for the keymap root, extras, addons, adapters, and lazy framework bindings |

Adapter entrypoints intentionally do not re-export the shared engine. Import `Keymap`, key stringifiers, and shared types from `@opentui/keymap`. See the [Keymap overview](/docs/keymap/overview) for how the entrypoints compose.

## @opentui/qrcode

| Entrypoint              | Public purpose                                                            |
| ----------------------- | ------------------------------------------------------------------------- |
| `@opentui/qrcode`       | QR encoder, segment/ECC APIs, SVG/terminal output, and `QRCodeRenderable` |
| `@opentui/qrcode/react` | `registerQRCode()` for the React `qr-code` intrinsic                      |
| `@opentui/qrcode/solid` | `registerQRCode()` for the Solid `qr_code` intrinsic                      |

See [QR encoder](/docs/reference/qr-encoder) and [QR Code component](/docs/components/qr-code) for the two API layers.

## @opentui/ssh

| Entrypoint     | Public purpose                                                                              |
| -------------- | ------------------------------------------------------------------------------------------- |
| `@opentui/ssh` | SSH server builder, authentication, middleware, sessions, logging, errors, and public types |

The package has no framework-specific subpaths; hand the session renderer to the React or Solid root API. See [SSH](/docs/reference/ssh).

## @opentui/three

| Entrypoint                       | Public purpose                                                                                        |
| -------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `@opentui/three`                 | Three.js WebGPU renderer, renderable, sprites, effects, resource pools, physics adapters, and `THREE` |
| `@opentui/three/runtime-modules` | Runtime-module map containing the `@opentui/three` root for Bun-loaded plugins                        |

Both entrypoints are Bun-only. See [Three.js WebGPU](/docs/reference/three).
finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the workStars: 319kUpdated Claude CodeCodexVerifiedInstall
systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixesStars: 319kUpdated Claude CodeCodexVerifiedInstall
test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation codeStars: 319kUpdated Claude CodeCodexVerifiedInstall
skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.Stars: 196kUpdated Claude CodeCodexVerifiedInstall