livewiki

Code-anchored documentation that knows when it is stale.

livewiki turns a repository into a Markdown wiki whose every code reference is anchored to a real indexed symbol. An LLM writes the prose; livewiki does the deterministic work — planning the pages, running structural anti-hallucination checks on what the model wrote, tracking which anchored symbols changed, and preserving your edits.

The wiki is exposed to any coding agent by @livewiki/mcp — an MCP (Model Context Protocol) server with eight tools for reading, searching, and safely writing the wiki.

livewiki view builds a self-contained offline site from the wiki — grouped sidebar, offline search, diagrams, and dark mode:

Example wiki generated by livewiki for MoneyPrinterTurbo-Plus, an external Python repository.

Why

Technical docs go stale the moment the code changes. livewiki makes that visible and cheap to fix instead of silent:

• Deterministic anti-hallucination checks. Every code reference must point at a real indexed symbol. livewiki verify reads the wiki fresh from disk and fails on invented symbols, broken anchors, and signatures that no longer match — including references the LLM wrote seconds ago, without running index first, and without spending a token. Structural, not semantic; the section below draws the line.
• Your edits win. Pages you mark owner: human are never rewritten, and lw:manual blocks are preserved byte-for-byte.
• Debt is tracked, not discovered. livewiki status ranks what drifted; a GitHub Action can gate every merge on zero documentation debt, without spending tokens.
• Works where you already work. Bootstrap and maintain through the coding agent you use, or run a fully automated batch.

What verify checks — and what it doesn't

The anti-hallucination layer is deterministic and structural. livewiki verify reads the wiki fresh from disk — so a page an LLM wrote seconds ago is checked without running index first — and fails on:

• a cited symbol that does not exist in the code;
• an anchor that broke because the symbol moved, was renamed, or was deleted;
• a cited signature that no longer matches the indexed one;
• an internal link that does not resolve;
• a referenced artifact that is missing from disk;
• frontmatter or page structure that violates the format contract.

That removes whole classes of fabricated content — the invented function, the API that never existed, the reference that quietly rotted — before a reader ever sees it, at zero token cost. Anything that fails is rejected and rolled back rather than merged.

It does not prove that a sentence is true. A plausible but wrong explanation of code that really does exist passes every check above, because every check above is about structure and identity, not meaning. Read "anti-hallucination" here as a layer that mechanically eliminates a large class of fabrication and tells you the moment code moves under the prose — not as a guarantee of factual accuracy. Reviewing the explanation itself is still your job.

Quick start

Requires Node.js 24 or newer.

1. Install

npm install -g @livewiki/cli

(npx @livewiki/cli works too, without installing globally.)

2. Initialize

From the root of the repository you want documented:

livewiki init
``

... [View full README on GitHub](https://github.com/eduardoabreu81/livewiki#readme)