terminaltui
Star37

Documentation

Everything, in order

If you have thirty seconds, run the tour. If you have an afternoon, start at Getting started and read straight down — the sequence below is the order the concepts actually build on each other.

npx terminaltui try

01

Start here

  1. Getting startedInstall, scaffold, run. The five minutes before anything else makes sense.
  2. RoutingHow a file in pages/ becomes a screen, and what brackets in a filename do.
  3. CLI referenceEvery command, its flags, and what it actually does.

02

Building

  1. ComponentsThe authoring API: content, input, layout and navigation blocks.
  2. LayoutsThe twelve-column grid, panels, columns and rows.
  3. State and dataReactive state, computed values, persistence and fetching.
  4. API routesFiles in api/ become GET endpoints your pages can call.

03

Making it look right

  1. ThemesTwelve built-in themes, custom palettes, and how colour depth is negotiated.
  2. ImagesReal PNG, JPEG and GIF in a terminal — coloured cells everywhere, true pixels on kitty.
  3. VideoFrame packs, playback controls, GIF support, real pixels and the portable cell fallback.
  4. ASCII artFourteen banner fonts, fifteen scenes, and the icon set.

04

Shipping

  1. SSH hostingOne server, many sessions, per-client capability detection.
  2. TestingDrive a real PTY from your test suite and assert on what is on screen.
  3. AI scaffoldingGenerate a tailored prompt so a coding agent can build the first draft.