livewiki

Code-verankerte Dokumentation, die weiß, wann sie veraltet ist.

livewiki verwandelt ein Repository in ein Markdown-Wiki, dessen jeder Code-Verweis an einem echten indizierten Symbol verankert ist. Ein LLM schreibt den Fließtext; livewiki erledigt die deterministische Arbeit – die Planung der Seiten, strukturelle Anti-Halluzinations-Prüfungen an dem, was das Modell geschrieben hat, die Nachverfolgung geänderter verankerter Symbole und die Bewahrung Ihrer Bearbeitungen.

Das Wiki wird jedem Coding-Agenten über @livewiki/mcp zur Verfügung gestellt – einen MCP-Server (Model Context Protocol) mit acht Werkzeugen zum Lesen, Durchsuchen und sicheren Schreiben des Wikis.

livewiki view erstellt aus dem Wiki eine eigenständige Offline-Seite – gruppierte Seitenleiste, Offline-Suche, Diagramme und Dunkelmodus:

Beispiel-Wiki, das von livewiki für MoneyPrinterTurbo-Plus erzeugt wurde, ein externes Python-Repository.

Warum

Technische Dokumentation wird in dem Moment veraltet, in dem sich der Code ändert. livewiki macht das sichtbar und kostengünstig behebbar, anstatt zu schweigen:

• Deterministische Anti-Halluzinations-Prüfungen. Jeder Code-Verweis muss auf ein reales indiziertes Symbol zeigen. livewiki verify liest das Wiki frisch von der Festplatte und schlägt bei erfundenen Symbolen, defekten Ankern und Signaturen fehl, die nicht mehr übereinstimmen – einschließlich Verweisen, die das LLM vor Sekunden geschrieben hat, ohne vorher index auszuführen und ohne ein Token auszugeben. Strukturell, nicht semantisch; der Abschnitt unten zieht die Grenze.

• Ihre Bearbeitungen haben Vorrang. Seiten, die Sie mit owner: human markieren, werden nie neu geschrieben, und lw:manual-Blöcke werden bytegenau erhalten.

• Schulden werden nachverfolgt, nicht entdeckt. livewiki status stuft ein, was abgewichen ist; eine GitHub Action kann jeden Merge an null Dokumentationsschulden knüpfen, ohne Tokens auszugeben.

• Funktioniert dort, wo Sie bereits arbeiten. Bootstrappen und pflegen Sie über den Coding-Agenten, den Sie verwenden, oder führen Sie einen vollautomatischen Batch aus.

Was verify prüft – und was nicht

Die Anti-Halluzinations-Schicht ist deterministisch und strukturell. livewiki verify liest das Wiki frisch von der Festplatte – eine Seite, die ein LLM vor Sekunden geschrieben hat, wird also geprüft, ohne vorher index auszuführen – und schlägt fehl bei:

• einem zitierten Symbol, das im Code nicht existiert;

• einem Anker, der zerbrochen ist, weil das Symbol verschoben, umbenannt oder gelöscht wurde;

• einer zitierten Signatur, die nicht mehr mit der indizierten übereinstimmt;

• einem internen Link, der nicht aufgelöst werden kann;

• einem referenzierten Artefakt, das auf der Festplatte fehlt;

• Frontmatter oder Seitenstruktur, die den Formatvertrag verletzt.

Das beseitigt ganze Klassen erfundener Inhalte – die erfundene Funktion, die API, die nie existierte, der Verweis, der still verrottet ist – bevor ein Leser es je zu Gesicht bekommt, zu null Token-Kosten. Was fehlschlägt, wird zurückgewiesen und zurückgerollt, anstatt übernommen zu werden.

Es beweist nicht, dass ein Satz wahr ist. Eine plausible, aber falsche Erklärung von Code, der tatsächlich existiert, besteht jede der obigen Prüfungen, weil es bei jeder der obigen Prüfungen um Struktur und Identität geht, nicht um Bedeutung. Verstehen Sie „Anti-Halluzination“ hier als eine Schicht, die mechanisch eine große Klasse von Erfindungen eliminiert und Ihnen den Moment mitteilt, in dem sich Code unter dem Fließtext verändert – nicht als Garantie sachlicher Richtigkeit. Die Erklärung selbst zu überprüfen, ist weiterhin Ihre Aufgabe.

Related MCP server: 50 First Tapes MCP Server

Schnellstart

Erfordert Node.js 24 oder neuer.

1. Installieren

npm install -g @livewiki/cli

(npx @livewiki/cli funktioniert ebenfalls, ohne globale Installation.)

2. Initialisieren

Vom Stammverzeichnis des Repositorys, das Sie dokumentieren möchten:

livewiki init

Indiziert den Code und erstellt das Wiki-Gerüst unter livewiki/ sowie einen abgeleiteten Cache unter .livewiki/ (zu .gitignore hinzugefügt). Deterministisch – kein LLM-Aufruf, keine Tokens.

3. Bootstrappen Sie das Wiki einmal

Sie haben zwei Routen – wählen Sie eine.

Route A – über Ihren Coding-Agenten (kein API-Schlüssel erforderlich):

livewiki install

Der Installer erkennt Ihren Agenten, verdrahtet den MCP-Server, den Skill zum Mitdokumentieren und Git-Hooks. Bitten Sie dann den Agenten, das Wiki zu bootstrappen; er zieht Aufgaben von livewiki_next_task und reicht Seiten mit livewiki_write_doc ein, wobei er das Modell verwendet, das er bereits hat.

Route B – eine konfigurierte LLM-API (unbeaufsichtigt):

livewiki config

Der Assistent listet die Anbieter auf, fragt nach Ihrem API-Schlüssel (ohne Echo eingegeben) und speichert ihn. Ein bloßes livewiki in einem nicht konfigurierten Repository startet denselben Assistenten. Dann:

livewiki init --batch

Die fortsetzbare Pipeline plant echte Seiteneinheiten und schreibt eine Seite pro Quelldatei und Ordner, dazu Flows, Konzeptthemen, Diagramme und eine understanding.md-Synthese. Unterbrechen Sie sie und setzen Sie sie mit livewiki batch resume <runId> fort.

4. Verifizieren und durchsuchen

livewiki verify   # validate code references, internal links, and artifacts
livewiki view     # build an offline site with search, Mermaid, and dark mode

Funktioniert mit Ihrem Coding-Agenten

livewiki install erkennt automatisch und verdrahtet 13 Agenten über MCP (mit Skills und Hooks, wo der Agent sie unterstützt):

Claude Code · Codex · Cursor · Kimi · Gemini CLI · OpenCode · OpenClaw · Cline · Kiro · Qwen · Warp · Zed · Hermes

Sie bevorzugen manuelle Verdrahtung? Jeder stdio-MCP-Client funktioniert:

{
  "mcpServers": {
    "livewiki": {
      "command": "npx",
      "args": ["-y", "@livewiki/mcp", "--repo", "/path/to/repo"]
    }
  }
}

Sprachen

Verankerte Seiten zitieren echte Symbole; die Prosa-Basisebene gibt dennoch jeder Datei einen Platz im Wiki. Die Tier-1-Sprachunterstützung wächst, sobald sich das Muster bewährt (Go, Rust und Java haben jeweils auf diese Weise Einzug gehalten).

Anbieter

livewiki config listet diese 17 Presets auf. Jedes liest seine eigene API-Key-Umgebungsvariable; livewiki config show gibt die aus, die Ihr Preset erwartet, ohne den Wert jemals anzuzeigen.

ollama und lmstudio benötigen für einen lokalen Server keinen Schlüssel. Für CI und Headless-Automatisierung setzen Sie die Umgebungsvariable direkt – sie hat Vorrang vor dem gespeicherten Schlüssel.

Wie eine generierte Seite aussieht

Auszug aus dem eigenen livewiki/core-src/verify.md dieses Repositorys:

## Discovery: walking the wiki from disk

The verifier never trusts the index for which pages exist — a doc freshly written by an LLM must be caught without first running `index`. Two walkers enumerate the `livewiki/` directory from disk; both skip hidden directories but keep dot-prefixed files.

<!-- lw:anchors packages/core/src/verify.ts#collectWikiPages packages/core/src/verify.ts#collectWikiArtifactPaths -->

```ts
async function collectWikiPages(absRoot: string): Promise<{ relPath: string }[]>
```

Der Fließtext erklärt die Implementierung; der lw:anchors-Marker bindet den Abschnitt an reale indizierte Symbole, sodass Veraltung und ungültige Verweise mechanisch erkannt werden.

Wie es funktioniert

• Deterministische Schicht – die CLI indiziert Quellcode, extrahiert Symbole, berechnet Veraltung, plant Arbeiten, verfolgt Schulden und verifiziert – ohne ein Modell.

• Schreibschicht – ein verbundener Agent (oder ein API-gestützter Batch) schreibt den Fließtext anhand einer geschlossenen Liste zulässiger Symbol-Schlüssel.

• Anti-Halluzinations-Schicht – deterministisch und strukturell: Code-Anker, zitierte Signaturen, interne Links, Artefakte und Seitenstruktur werden alle gegen die Festplatte geprüft; ungültige Schreibvorgänge werden zurückgerollt. Sie beseitigt erfundene und verrottete Verweise, keine semantischen Fehler.

• Menschliche Eigentümerschaft – owner: human-Seiten werden nie neu geschrieben; lw:manual-Blöcke werden bytegenau erhalten.

• Portable Baseline – der akzeptierte Zustand jeder Dokumentationsverpflichtung liegt in einer versionierten livewiki/.baseline.json, sodass Schulden gegen eine echte Baseline durchgesetzt werden und das Wiki das Löschen eines lokalen Caches übersteht.

Dokumentationsschulden können in CI jeden Merge blockieren, ohne LLM-Aufrufe oder Tokens – siehe die GitHub Actions-Vorlage.

Methodik historischer Vergleiche und datierte Ergebnisse sind in Benchmarks archiviert.

Pakete

Dokumentation

• SPEC.md – Verhaltens- und Formatverträge

• VISION.md – Produktbegründung und Nicht-Ziele

• docs/ROADMAP.md – genehmigtes Backlog und Ausführungsreihenfolge

Lizenz

MIT – siehe LICENSE.