@zettelgeist/tui
v0.2.0
Published
Zettelgeist TUI: terminal-native spec board, detail view, dependency graph, and docs browser.
Maintainers
Readme
@zettelgeist/tui
Terminal-native UI for the Zettelgeist v0.1 format. Built with Ink + React. Runs in-process — no separate server.
Install
npm i -g @zettelgeist/tuiOr alongside the CLI in a project:
pnpm add -D @zettelgeist/cli @zettelgeist/tuiThen run zg-tui inside any directory containing .zettelgeist.yaml. If @zettelgeist/cli is installed too, you can also launch via zettelgeist tui (a thin shim).
Views
- Board (
1) — kanban-style columns, one per status (draft / planned / in-progress / in-review / done / blocked / cancelled). Cards = specs. Specs with a status not in the canonical enum bucket into amisccolumn rather than crashing. - Detail (
2) — open spec with tabs for requirements / tasks / handoff / lenses. Picker shows when no spec is selected. - Graph (
3) — ASCII layered dependency graph, deepest dependencies at the bottom, edges + cycles listed below. - Docs (
4) — browsedocs/markdown files. - Command palette (
?) — fuzzy-search every view-change command.
Keys
| Key | Action |
| --- | --- |
| ↑↓ ←→ / hjkl | navigate |
| enter | open / select |
| 1 2 3 4 | jump to board / detail / graph / docs |
| tab | cycle views |
| ? | command palette |
| esc | close palette / close open doc |
| q / Ctrl-C | quit |
Read-only at v0.2
The TUI reads via @zettelgeist/core directly — there's no separate backend. Mutations still flow through the CLI (zettelgeist), the web viewer (zettelgeist serve), or the MCP server. Write support is on the v0.2.x roadmap.
Flags
zg-tui [--view=board|detail|graph|docs]
zg-tui --help
zg-tui --version