@aicippy/tui-core
v0.5.13
Published
AiCIPPYTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)
Readme
AiCIPPYTUI 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.
AicippY uses AiCIPPYTUI in production for millions of users.
Website | Documentation | Packages
AiCIPPYTUI Core
@aicippy/tui-core supplies the renderer and TypeScript API. You use imperative renderables and events directly. The
TypeScript packages call native Zig through an internal foreign function interface (FFI) boundary.
import { TextRenderable, createCliRenderer } from "@aicippy/tui-core"
const renderer = await createCliRenderer({ exitOnCtrlC: true })
renderer.root.add(new TextRenderable(renderer, { content: "Hello, AiCIPPYTUI!" }))exitOnCtrlC: true calls renderer.destroy() when the user presses Ctrl+C. The code that creates the renderer must
call renderer.destroy() on every other shutdown path.
Install the package:
bun add @aicippy/tui-coreThen build your first app with the quickstart.
Runtime and platform support
@aicippy/tui-core runs on Bun 1.3.0 or later, or on Node.js 26.4.0 or later with ECMAScript modules (ESM) and
--experimental-ffi.
Use Bun 1.4.0 or later on native Windows arm64.
The native ABI and the generated platform packages, such as @aicippy/tui-core-linux-x64, are internal distribution
surfaces, not application APIs.
AI agent skill
Install the AiCIPPYTUI documentation as a skill for your AI coding assistant with npx skills:
npx skills add aicippy/aicippytui --skill aicippytuiAdd -g to install the skill globally.
License
AiCIPPYTUI is licensed under the MIT License.
