anomalyco/opentui

OpenTUI 是一个用于构建终端用户界面的库。

• 它是用Zig写的。
• 你可以直接或通过React和Solid编写TypeScript。
• 你用Flexbox来排列盒子和文本。
• 你可以通过键盘和鼠标添加选择、输入和滚动框。
• 你可以播放声音、展示图片并渲染3D图形。

OpenCode 在生产环境中使用 OpenTUI，服务数百万用户。

网站 |文档 |软件包

包裹

• @opentui/core - 带有TypeScript绑定的本地终端界面库。
• @opentui/react - 用于构建 OpenTUI Core 终端用户界面的 React 渲染器。
• @opentui/solid - 用于构建 OpenTUI Core 终端用户界面的坚固渲染器。
• @opentui/keymap - 终端和浏览器应用的按键绑定和命令路由库。
• @opentui/qrcode - 二维码编码器，支持React和Solid表面渲染。
• @opentui/three - Three.js OpenTUI的WebGPU渲染器。
• @opentui/ssh - OpenTUI 应用的 SSH 服务器集成。

私人包裹

• @opentui/native - 私有工作区，包含 Zig 实现、本地测试和基准测试。

OpenTUI is a library to build terminal user interfaces.

• It is written in Zig.
• You write TypeScript directly or through React and Solid.
• You arrange boxes and text with flexbox.
• You add selects, inputs, and scroll boxes with keyboard and mouse controls.
• You can play sounds, show images, and render 3D graphics.

OpenCode uses OpenTUI in production for millions of users.

Website | Documentation | Packages

Packages

• @opentui/core - Native terminal UI library with TypeScript bindings.
• @opentui/react - React renderer for building terminal user interfaces with OpenTUI Core.
• @opentui/solid - Solid renderer for building terminal user interfaces with OpenTUI Core.
• @opentui/keymap - Key binding and command routing library for terminal and browser applications.
• @opentui/qrcode - QR code encoder and renderable with React and Solid surfaces.
• @opentui/three - Three.js WebGPU renderer for OpenTUI.
• @opentui/ssh - SSH server integration for OpenTUI applications.

Private packages

• @opentui/native - Private workspace with the Zig implementation, native tests, and benchmarks.
• @opentui/examples - Private workspace with example applications and a standalone examples executable.
• @opentui/web - Private workspace with the documentation website and the AI agent skill.

AI agent skill

Install the OpenTUI documentation as a skill for your AI coding assistant with npx skills:

npx skills add https://opentui.com --skill opentui

Add -g to install the skill globally. The skill matches the latest release, and npx skills update moves it to each new release. Install from https://opentui.com/docs/next to follow the main branch. A skill installed with npx skills add anomalyco/opentui follows the main branch; run the command above to switch it to releases.

Development

Development requires Bun 1.4.1 or later and Zig 0.17.0.

See AGENTS.md for engineering, tooling, and verification conventions.

bun install

Run package scripts from their package directory. Run bun run build from the repository root after you change