Ansiq Documentation

Ansiq is a runtime-first TUI framework for long-running terminal software.

It is aimed at terminal applications that keep running, receive new data over time, and need explicit control over viewport and scrollback behavior.

Pick your path

• I want to build a TUI app
• I want to understand the runtime
• I want to browse examples

What you will learn here

The goal of this documentation is not to mirror the repository layout. It is to build the Ansiq mental model progressively:

• first run a stable example
• then build a small real app
• then understand signal -> dirty scope -> subtree rerender -> patch
• and only after that go deeper into runtime, viewport, and history

If you come from browser UI frameworks, Ansiq will feel familiar in some places and very different in others:

• component authoring is declarative
• state propagation is signal-first
• the runtime owns focus, layout, viewport, and terminal patching

But the target is the terminal, not the DOM.

Start here

• Introduction
• Quick Start
• Your First App

Recommended path

1. Introduction
2. Quick Start
3. Your First App
4. Reactivity
5. Streaming and Async Tasks
6. Viewport and History