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
Что это такое?OpenTUI — это библиотека для создания терминальных пользовательских интерфейсов: интерактивных текстовых приложений, которые работают в терминале. Она написана на TypeScript.
То есть я буду писать свои приложения сам — на чистом TypeScript или через фреймворк?Это библиотека, а не готовое приложение. Можно писать TypeScript напрямую поверх ядра или собирать интерфейсы с помощью встроенных рендереров React и Solid.
С чего начать, чтобы сделать TUI на этой библиотеке?Установите @opentui/core из npm, а если хотите рендерер для фреймворка — добавьте @opentui/react или @opentui/solid; пакеты keymap, qrcode, three и ssh — необязательные дополнения.
Ядро написано на Zig — мне нужно выучить Zig, чтобы пользоваться библиотекой?Нет. На Zig работает нативное ядро, но код самого приложения пишется на TypeScript. К Zig вы прикоснётесь, только если соберёте нативную часть ради контрибуции в проект.
Она проверена в продакшене или это пока экспериментальный проект?Она обкатана в реальной работе: OpenCode использует OpenTUI в продакшене, и ею пользуются миллионы пользователей.
Можно ли показывать моё TUI-приложение пользователям через SSH, а не запускать локально?Да — пакет @opentui/ssh добавляет интеграцию с SSH-сервером, так что приложение на OpenTUI можно открыть пользователям через SSH-подключение.
Сможет ли ИИ-ассистент для кодинга изучить API OpenTUI?Да — документация поставляется как устанавливаемый навык для агента: выполните npx skills, чтобы добавить его, а с флагом -g — установить глобально.
Пакет keymap работает только с приложениями OpenTUI?Нет — @opentui/keymap это самостоятельная библиотека привязок клавиш и маршрутизации команд, которая подходит и для терминальных, и для браузерных приложений.
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