opentui README

The project's README from github.com/anomalyco/opentui. As one markdown file: README.md.

OpenTUI logo

npm version Core build status

OpenTUI is a library to build terminal user interfaces.

OpenCode uses OpenTUI in production for millions of users.

Website | Documentation | Packages

Packages

Private packages

AI agent skill

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

npx skills add anomalyco/opentui --skill opentui

Add -g to install the skill globally.

Development

Development requires Bun 1.4.1 or later and Zig 0.16.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 native code or cross-package build outputs. Ordinary TypeScript changes do not require a root build.

Run repository tests and static checks from the repository root:

bun run test
bun run fmt:check
bun run lint

To link the source packages into a Bun-managed project, install that project's dependencies, then run ./scripts/link-opentui-dev.sh /path/to/project from the repository root. Add --react or --solid when needed.

Contributing

OpenTUI is open for contributions.

License

OpenTUI is licensed under the MIT License.

opentui (anomalyco/opentui)

Searching Database…

13.6K ·GitHub
What is this?OpenTUI is a library for building terminal user interfaces — interactive, text-mode apps that run in the terminal, written in TypeScript.
So I build my own apps with it — plain TypeScript or a framework?It is a library, not a finished app. You write TypeScript directly against the core, or build with the bundled React and Solid renderers.
How do I start building a TUI with it?Install @opentui/core from npm, and add @opentui/react or @opentui/solid if you want a framework renderer; keymap, qrcode, three and ssh packages are optional extras.
The core is written in Zig — do I need to learn Zig to use it?No. Zig powers the native core, but application code is TypeScript; you only touch Zig if you build the native part when contributing.
Is it proven in production or still experimental?It is battle-tested: OpenCode uses OpenTUI in production serving millions of users.
Can my TUI be served to users over SSH instead of running locally?Yes — the @opentui/ssh package adds SSH server integration, so an OpenTUI application can be exposed to users through an SSH connection.
Can an AI coding assistant learn the OpenTUI API?Yes — the documentation ships as an installable agent skill: run npx skills to add it, with -g for a global install.
Is the keymap package tied to OpenTUI apps only?No — @opentui/keymap is a standalone key binding and command routing library that works for terminal and browser applications.
What are similar projects?ink, hqtui, canvas-ui, editor, tokscale, react-bits, hntui, shaders
Creator
anomalyco
Size
72.2 MB
Stars
13.6K
Age
1y
Commits · 90 Days