Tuil Overview

tuil is a renderer-neutral framework for terminal applications that need more than rendered text. It supports existing React Ink components and direct renderer applications on the deterministic cell backend while coordinating lifecycle, typed events, services, commands, focus, hotkeys, routes, forms, workflows, operations, themes, plugins, source-owned components, semantic tests, and portable stories.

Choose a path

Build your first app

Scaffold a project with the CLI, run it, and understand the generated runtime boundary.

Understand the architecture

Follow ownership and data flow from the application runtime to terminal rendering.

Browse packages

Inspect every package, export, lifecycle contract, event surface, and focused example.

Explore components

Open interactive stories for components, subcomponents, controls, callbacks, and semantics.

The runtime at a glance

Documentation flow diagram. CLI and registry leads to TuilApp; App leads to services and commands; App leads to events, focus, hotkeys, routes; Runtime leads to renderer application; Renderer leads to React Ink compatibility; Renderer leads to cell backend; Ink leads to components and application blocks; Cell leads to UI — **Documentation flow diagram.** CLI and registry leads to TuilApp; App leads to services and commands; App leads to events, focus, hotkeys, routes; Runtime leads to renderer application; Renderer leads to React Ink compatibility; Renderer leads to cell backend; Ink leads to components and application blocks; Cell leads to UI

Install

Use the umbrella package when you want the complete runtime:

npm install @mwillbanks/tuil @mwillbanks/tuil-ink react ink

Focused packages are independently installable. The package reference documents ownership and compatibility for each boundary.