PyModel/pythinker-code / .agents/skills/opentui
opentui
VerifiedBuild terminal UIs with OpenTUI. Covers core, components, audio, keymaps, React, Solid, plugins, testing, standalone executables, QR encoding, SSH, and Three.js WebGPU.
docs/getting-started.mdx
View on GitHub---
title: Getting started
description: Install OpenTUI and create your first terminal UI
order: 1
navTitle: Introduction
skill:
entry: true
intents: [getting-started, installation, quickstart, intro]
---
# Getting started
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.
## Installation
OpenTUI's renderer examples use [Bun](https://bun.sh). You can import portable entry points such as `@opentui/keymap` and
`@opentui/core` in Node.js without installing Bun or enabling FFI. These imports do not create a native renderer. To
create a native renderer in Node.js, you need Node.js 26.4.0 with experimental FFI enabled.
```bash
mkdir my-tui && cd my-tui
bun init -y
bun add @opentui/core
```
## Runtime support
Importing packages does not require native FFI. For example, Node.js can load
`await import("@opentui/keymap")` and `await import("@opentui/core")` without `--experimental-ffi`.
Creating a native renderer requires FFI. This includes calling `createCliRenderer()` or any other API that loads and calls
OpenTUI's native Zig renderer. In Node.js, use Node.js 26.4.0 with `--experimental-ffi`. If you use Node.js permissions,
you must also add `--allow-ffi` and the filesystem permissions your app needs. OpenTUI does not install Node.js, so select
the required version before you run Node.js-specific examples or scripts.
## Hello world
Create `index.ts`:
```typescript
import { createCliRenderer, Text } from "@opentui/core"
const renderer = await createCliRenderer({
exitOnCtrlC: true,
})
renderer.root.add(
Text({
content: "Hello, OpenTUI!",
fg: "#00FF00",
}),
)
```
Run it:
```bash
bun index.ts
```
You should see green text. Press `Ctrl+C` to exit.
## Composing components
Components nest naturally. Here's a bordered panel with content:
```typescript
import { createCliRenderer, Box, Text } from "@opentui/core"
const renderer = await createCliRenderer({
exitOnCtrlC: true,
})
renderer.root.add(
Box(
{ borderStyle: "rounded", padding: 1, flexDirection: "column", gap: 1 },
Text({ content: "Welcome", fg: "#FFFF00" }),
Text({ content: "Press Ctrl+C to exit" }),
),
)
```
`Box` and `Text` are factory functions. The first argument is props; additional arguments are children.
## What's next
### Core concepts
- [Renderer](/docs/core-concepts/renderer) - The rendering engine
- [Layout](/docs/core-concepts/layout) - Flexbox positioning
- [Constructs](/docs/core-concepts/constructs) - The declarative component API
### Components
- [Text](/docs/components/text), [Box](/docs/components/box) - Display and layout
- [Input](/docs/components/input), [Select](/docs/components/select) - User interaction
### Framework bindings
The OpenTUI monorepo includes `@opentui/react` and `@opentui/solid`. Other language and framework bindings live in
separate repositories.
- [React](/docs/bindings/react)
- [Solid.js](/docs/bindings/solid)
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |