Getting Started

This section walks you through installing TermUI, creating your first project, and understanding the package structure. You will go from an empty directory to a running terminal app.

Pre-requisite knowledge

The docs assume some familiarity with TypeScript and Node.js. Before starting, make sure you are comfortable with:

  • Bun 1.3 or later
  • Node.js 18+ if installing from npm
  • TypeScript basics (types, async/await)
  • A terminal emulator with 256-color support

If you know React, the @termuijs/jsx package will feel familiar. If you do not, the widget-tree API works without JSX.

Next Steps

Installation

Scaffold a new project with the create-termui-app CLI, or add packages manually to an existing project.

Quick Start

Build a working terminal app with Box, Text, and keyboard handling. See output in your terminal in minutes.

Architecture

How TermUI is structured as separate packages. The five-layer dependency model and render pipeline.