back to home

anomalyco / opentui

OpenTUI is a library for building terminal user interfaces (TUIs)

8,820 stars
381 forks
128 issues
TypeScriptZigMDX
Chat with CodebaseArchitecture ScanSecurity AuditExplain Codebase

AI Architecture Analysis

This repository is indexed by RepoMind. By analyzing anomalyco/opentui in our AI interface, you can instantly generate complete architecture diagrams, visualize control flows, and perform automated security audits across the entire codebase.

Our Agentic Context Augmented Generation (Agentic CAG) engine loads full source files into context, avoiding the fragmentation of traditional RAG systems. Ask questions about the architecture, dependencies, or specific features to see it in action.

Click here to launch the interactive analysis workspace

Embed this Badge

Showcase RepoMind's analysis directly in your repository's README.

[![Analyzed by RepoMind](https://img.shields.io/badge/Analyzed%20by-RepoMind-4F46E5?style=for-the-badge)](https://repomind-ai.vercel.app/repo/anomalyco/opentui)
Preview:Analyzed by RepoMind

Repository Summary (README)

Preview

OpenTUI

<div align="center"> <a href="https://www.npmjs.com/package/@opentui/core"><img alt="npm" src="https://img.shields.io/npm/v/@opentui/core?style=flat-square" /></a> <a href="https://github.com/anomalyco/opentui/actions/workflows/build-core.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/anomalyco/opentui/build-core.yml?style=flat-square&branch=main" /></a> <a href="https://github.com/msmps/awesome-opentui"><img alt="awesome opentui list" src="https://awesome.re/badge-flat.svg" /></a> </div>

OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications.

Docs: https://opentui.com/docs/getting-started

Quick start with bun and create-tui:

bun create tui

This monorepo contains the following packages:

  • @opentui/core - TypeScript bindings for OpenTUI's native Zig core, with an imperative API and all primitives.
  • @opentui/solid - The SolidJS reconciler for OpenTUI.
  • @opentui/react - The React reconciler for OpenTUI.

Install

NOTE: You must have Zig installed on your system to build the packages.

TypeScript/JavaScript

bun install @opentui/core

AI Agent Skill

Teach your AI coding assistant OpenTUI's APIs and patterns.

For OpenCode (includes /opentui command):

curl -fsSL https://raw.githubusercontent.com/msmps/opentui-skill/main/install.sh | bash

For other AI coding assistants:

npx skills add msmps/opentui-skill

Try Examples

You can quickly try out OpenTUI examples without cloning the repository:

For macOS, Linux, WSL, Git Bash:

curl -fsSL https://raw.githubusercontent.com/anomalyco/opentui/main/packages/core/src/examples/install.sh | sh

For Windows (PowerShell/CMD):

Download the latest release directly from GitHub Releases

Running Examples (from the repo root)

TypeScript Examples

bun install
cd packages/core
bun run src/examples/index.ts

Development

See the Development Guide for building, testing, debugging, and local development linking.

Documentation

Showcase

Consider showcasing your work on the awesome-opentui list. A curated list of awesome resources and terminal user interfaces built with OpenTUI.