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

EntrypointPublic purpose
@opentui/coreMain imperative renderer, renderables, buffers, input, audio, plugins, Tree-sitter client, utilities, and shared types
@opentui/core/testingTest renderer, input/mouse drivers, capability fixtures, clocks, spies, Tree-sitter mock, and frame recorder
@opentui/core/runtime-pluginBun runtime-module plugin factory, module-ID helpers, rewrite options, and runtime module entry types
@opentui/core/runtime-plugin-supportInstalls core runtime-plugin support as an import side effect and re-exports its setup API
@opentui/core/runtime-plugin-support/configureConfigurable ensureRuntimePluginSupport() without import-time installation
@opentui/core/yogaNative Yoga Config/Node, enums, constants, layout values, and callback types
@opentui/core/tree-sitter/update-assetsupdateAssets, runUpdateAssetsCli, and UpdateOptions for Tree-sitter assets
@opentui/core/parser.workerTree-sitter parser worker module; no named application API
@opentui/core/node-assetsgetNodeAssets(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 and Tree-sitter reference for their workflows.

@opentui/react

EntrypointPublic purpose
@opentui/reactReact renderer root, intrinsic catalogue, components, hooks, slots, TimeToFirstDraw, and component types
@opentui/react/rendererPublished alias for the root renderer exports, including createRoot and Root
@opentui/react/test-utilsReact-aware testRender(node, options) over @opentui/core/testing
@opentui/react/runtime-plugin-supportInstalls the React runtime-module plugin as an import side effect
@opentui/react/runtime-plugin-support/configureConfigurable React ensureRuntimePluginSupport() without import-time installation
@opentui/react/jsx-runtimeAutomatic JSX runtime: Fragment, jsx, jsxs, and OpenTUI JSX types
@opentui/react/jsx-dev-runtimeDevelopment 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

EntrypointPublic purpose
@opentui/solidSolid renderer, root render/testRender, reconciler helpers, elements, scrollback, slots, hooks, and types
@opentui/solid/preloadBun preload that installs the Solid source transform
@opentui/solid/bun-pluginSolid transform plugin factory/default export and installation/reset helpers
@opentui/solid/runtime-plugin-supportInstalls Solid transform and runtime-module support as an import side effect
@opentui/solid/runtime-plugin-support/configureConfigurable Solid runtime support without import-time installation
@opentui/solid/componentsextend, getComponentCatalogue, and component extension types
@opentui/solid/jsx-runtimeAutomatic JSX runtime and OpenTUI JSX namespace
@opentui/solid/jsx-dev-runtimeDevelopment 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.

@opentui/keymap

EntrypointPublic purpose
@opentui/keymapHost-agnostic Keymap, extension context, key stringifiers, and shared types
@opentui/keymap/extrasBinding lookup, command-binding, and formatting helpers
@opentui/keymap/extras/graphGraph snapshots and graph projection types
@opentui/keymap/addonsUniversal parser, field, metadata, leader, sequence, command, and diagnostics addons
@opentui/keymap/addons/opentuiUniversal addons plus OpenTUI base-layout and edit-buffer/textarea helpers
@opentui/keymap/testingHost-agnostic fake host, targets/events, diagnostics, and createTestKeymap
@opentui/keymap/htmlDOM host/event adapter and bare/default HTML keymap factories
@opentui/keymap/opentuiCliRenderer/Renderable host adapter and bare/default OpenTUI keymap factories
@opentui/keymap/reactOpenTUI React provider, hooks, and store-backed reactive matcher
@opentui/keymap/solidOpenTUI Solid provider, hooks, selector, and signal-backed reactive matcher
@opentui/keymap/runtime-modulesRuntime-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 for how the entrypoints compose.

@opentui/qrcode

EntrypointPublic purpose
@opentui/qrcodeQR encoder, segment/ECC APIs, SVG/terminal output, and QRCodeRenderable
@opentui/qrcode/reactregisterQRCode() for the React qr-code intrinsic
@opentui/qrcode/solidregisterQRCode() for the Solid qr_code intrinsic

See QR encoder and QR Code component for the two API layers.

@opentui/ssh

EntrypointPublic purpose
@opentui/sshSSH 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.

@opentui/three

EntrypointPublic purpose
@opentui/threeThree.js WebGPU renderer, renderable, sprites, effects, resource pools, physics adapters, and THREE
@opentui/three/runtime-modulesRuntime-module map containing the @opentui/three root for Bun-loaded plugins

Both entrypoints are Bun-only. See Three.js WebGPU.