Back to the catalog

@theokit/tui knowledge bundle

Bundle OKF 0.2 · 4 conceitos · usetheokit/theokit-tui

Open source Repository Open in the app JSON README (API)

About

# @theokit/tui knowledge bundle

Agent-readable knowledge for `@theokit/tui` — the AI-agent terminal UI primitive
set built on React. This bundle records what was **measured, audited and decided**
about the V4 renderer program and the component-parity mandate: the parity gates
against Ink, the byte-cost evidence behind the own renderer, the peer-parity
matrix and its exit audit, and the benchmark baselines the test suite pins.

It is the successor to the former `docs/` folder, converted concept-by-concept.

## Start here

- **"Is our renderer faithful to Ink?"** → [Ink parity gate](/concepts/ink-parity-gate.md),
then the per-milestone reports under [Renderer](/renderer/index.md).
- **"Why did we build our own renderer at all?"** → [Differential renderer](/concepts/differential-renderer.md).
- **"Do we have component parity with the peer CLIs?"** → [V4 parity matrix](/parity/v4-parity-matrix.md).
- **"How does a parity row earn a ✓?"** → [Exit-gate triple](/concepts/exit-gate-triple.md)

Details

Kind
OKF bundles
Topic
Developer tools
Publisher
usetheokit
Origin
okf_github
Category
dados
Version
0.2
Last push
2026-09-09T23:39:53Z
Repository state
ativo
Language
TypeScript
License
Apache-2.0
Added
2026-09-09 05:03:59
Updated
2026-09-09 05:03:59
Origin id
usetheokit/theokit-tui:wiki/index.md

README

<p align="center">
  <img src="./assets/banner.svg" alt="TheoKit TUI — AI-agent primitives for the terminal" width="100%">
</p>

# theokit-tui

Workspace for [`@theokit/tui`](./packages/tui) — AI-agent terminal UI primitives for
agent CLIs, built on Ink (React for the terminal).

**The package documentation lives in [`packages/tui/README.md`](./packages/tui/README.md).**
That is the file npm publishes; this one describes the repository around it.

## Layout

```
packages/tui/     the published package — src, tests, examples, benchmarks
assets/           brand artwork
wiki/             the OKF knowledge bundle: parity gates, benchmarks, decisions
CHANGELOG.md      the single changelog, and the source of the next version
```

One package, one workspace. The workspace shape is shared with the rest of the Theo
framework (`theokit-sdk`) so a contributor moving between repositories finds the same
tree, the same `biome.json`, and the same `.ls-lint.yml` rules.

## Gates

```bash
corepack enable && corepack prepare pnpm@10.34.1 --activate
pnpm install --frozen-lockfile
pnpm gates    # format:check + validate:naming + lint + typecheck + depcruise + build + test
```

`pnpm gates` is what CI runs. Contribution rules, branch model and test conventions are
in [CONTRIBUTING.md](./CONTRIBUTING.md); security reporting is in [SECURITY.md](./SECURITY.md).

## License

Apache-2.0

More