README.md

OpenTUI (Vybestack Fork)

Note: This is a fork of sst/opentui maintained by Vybestack. This fork adds terminal image support and may operate on a different release schedule than upstream. Published packages use the @vybestack/ scope on npm.

OpenTUI is a TypeScript library for building terminal user interfaces (TUIs). It is currently in development and is not ready for production use. It will be the foundational TUI framework for both opencode and terminaldotshop.

Quick start with bun and create-tui:

bun create tui

This monorepo contains the following packages:

• @vybestack/opentui-core - The core library works completely standalone, providing an imperative API and all the primitives.
• @vybestack/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 @vybestack/opentui-core

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/sst/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

• Development Guide - Building, testing, and local dev linking
• Getting Started - API and usage guide
• Environment Variables - Configuration options

Showcase

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