Hinweis: Diese Inhalte wurden mit Unterstützung von Künstlicher Intelligenz erstellt und redaktionell überprüft (Transparenzhinweis gemäß Art. 50 EU AI Act).

OpenWiki: Open-Source Repo-Dokumentations-Agent (LangChain)¶

OpenWiki ist ein quelloffenes CLI-Tool von LangChain, das automatisch eine navigierbare Dokumentations-Wiki für ein Software-Repository generiert und laufend aktuell hält. Die Kernidee dahinter: Coding-Agenten schreiben besseren Code, wenn sie das Repository verstehen — und veraltete, manuell gepflegte Dokumentation ist in schnell wachsenden Codebasen der Regelfall, nicht die Ausnahme. OpenWiki automatisiert genau diesen Pflegeaufwand. Das Motto des Projekts: „built for agents, explored by humans".

Diese Seite vertieft die Kategorie „Auto-generierte Code-Wikis" aus dem Kapitel Native „LLM-first" Wiki-Tools & Agenten mit konkreten Installations- und Bedienschritten. Das zugrunde liegende Architekturmuster — RAG durch ein persistent kompiliertes Wiki ersetzen — ist eigenständig beschrieben unter LLM-Wiki-Pattern (Karpathy-Muster).

Übersicht¶

graph TD
    Init["openwiki --init"] --> Agent["OpenWiki-Agent (Basis: LangChain DeepAgents)"]
    Agent --> Scan["Repository analysieren, belegte Aussagen (Grounded Claims) sammeln"]
    Scan --> Wiki["Wiki-Seiten + validierte Mermaid-Diagramme als OKF-Bundle erzeugen"]
    Wiki --> Inject["Verweise in AGENTS.md / CLAUDE.md eintragen"]
    Inject --> Agents["Coding-Agenten laden einzelne Wiki-Seiten bei Bedarf nach"]
    CI["CI-Zeitplan (GitHub / GitLab / Bitbucket)"] --> Update["openwiki --update"]
    Update --> Diff["Commits seit letztem Lauf diffen, veraltete Belege neu prüfen"]
    Diff --> Wiki

Zwei Betriebsmodi¶

Der Code-Modus ist für Repositories gedacht und im CI automatisierbar. Der Personal-Modus baut eine persönliche „Brain Wiki" aus externen Connectoren (siehe Connectoren).

Erste Schritte (Code-Modus)¶

1. Node.js ≥ 22 sicherstellen, dann global installieren: npm install -g openwiki.
2. Provider wählen, z. B. Anthropic:

   export OPENWIKI_PROVIDER=anthropic
   export ANTHROPIC_API_KEY=sk-ant-…
   export OPENWIKI_MODEL_ID=claude-sonnet-5
   

   Alternativ genügt bei OpenAI der ChatGPT-Login-Modus ohne API-Key.
3. Im Wurzelverzeichnis des Repositories openwiki --init ausführen. OpenWiki liest den Code, legt openwiki/INSTRUCTIONS.md als Selbst-Briefing an, erzeugt die Wiki-Seiten und trägt Verweise in AGENTS.md / CLAUDE.md ein.
4. openwiki/INSTRUCTIONS.md an die eigenen Schwerpunkte anpassen (die Datei wird bei Updates nie überschrieben) und openwiki --update erneut laufen lassen.
5. Optional: den mitgelieferten CI-Workflow einbinden, damit ein Zeitplan die Wiki nach relevanten Commits aktualisiert.
6. Optional: openwiki visualize für den interaktiven Graphen oder openwiki integrations install claude, um OpenWiki direkt in Claude Code mit dessen Modell und Repo-Werkzeugen laufen zu lassen.

Installation¶

npm install -g openwiki

npx openwiki --init

CLI-Befehle¶

In Coding-Agenten ausführen¶

Statt OpenWiki mit eigenem API-Key laufen zu lassen, kann es innerhalb eines Coding-Agenten ausgeführt werden — mit dessen authentifiziertem Modell und dessen nativen Repository-Werkzeugen:

openwiki integrations install claude    # oder: codex, opencode

Die Integration stellt dem Agenten die Operationen openwiki_begin, openwiki_submit_plan, openwiki_next_page, openwiki_submit_page und openwiki_finish bereit. So entstehen keine zusätzlichen Modell-Kosten neben dem ohnehin genutzten Agenten-Abo, und die Wiki-Generierung nutzt denselben Dateizugriff wie der Agent.

Visualisierung & statischer Export¶

openwiki visualize startet einen lokalen Server mit einem interaktiven Knoten-Graphen der Wiki-Struktur und einem Markdown-Leser daneben:

openwiki visualize                       # öffnet den Browser automatisch
openwiki visualize openwiki --port 4000 --no-open
openwiki visualize openwiki --export ./wiki-html

Das exportierte HTML-Bundle ist statisch und lässt sich auf GitHub Pages, MkDocs oder jedem anderen Static-Host ausliefern — siehe Beste Static-Site- & Docs-Generatoren 2026.

Grounded Claims — belegte Aussagen¶

Im Code-Modus verankert OpenWiki wesentliche Aussagen an konkreten Fundstellen im Repository, etwa repo://src/server.ts#L40-L82. Die Belege liegen versioniert in einem .claims/-Verzeichnis neben der Wiki. Bei einem openwiki --update prüft der Agent, ob sich die referenzierten Code-Stellen geändert haben; veraltete Belege lösen automatisch eine Neubewertung der betroffenen Seite aus. Dadurch bleibt die Wiki nachvollziehbar an den tatsächlichen Code gekoppelt statt frei zu halluzinieren.

Mermaid-Diagramm-Validierung¶

Eingebettete Mermaid-Diagramme werden nach jedem Lauf validiert. Ein fehlerhaftes Diagramm wird nicht unrepariert veröffentlicht, sondern auf lesbaren Text zurückgestuft und mit einer Reparatur-Notiz für den nächsten Update-Lauf versehen. (Für die manuelle Prüfung eigener Diagramme in diesem Repo: Skill mermaid-validator.)

Konfiguration¶

Kern-Umgebungsvariablen¶

Provider-spezifische Zugangsdaten¶

Pfad-Ausschluss (.openwikiignore)¶

Eine .openwikiignore im Repo-Wurzelverzeichnis (gitignore-Syntax) hält Pfade komplett aus der Analyse heraus — sie werden weder gelesen noch dokumentiert:

secrets/
*.log
!logs/keep.log

Automatische Aktualisierung per CI/CD¶

Ein Scheduled-Workflow prüft regelmäßig die Commits seit dem letzten Wiki-Update, analysiert den Diff und aktualisiert nur die betroffenen Wiki-Abschnitte. Ändert sich etwas, öffnet der Lauf automatisch einen Dokumentations-PR.

Der zentrale Befehl im CI-Kontext:

openwiki code --update --print

Projektstruktur¶

Code-Modus (Repository-Dokumentation)¶

openwiki/                # Generierte Dokumentation
├── INSTRUCTIONS.md      # Selbst verfasstes Briefing (Nutzer passt an, wird nie überschrieben)
├── *.md                 # Generierte Wiki-Seiten inkl. Mermaid-Diagrammen
├── .claims/             # Versionierte Beleg-Sidecars zu den Grounded Claims
├── .run.json            # Zustand eines laufenden Generierungsvorgangs (Resume-Queue)
├── .last-update.json    # Zeitpunkt/Commit des letzten erfolgreichen Laufs
└── .langsmith.json      # LangSmith-Projektkonfiguration (falls aktiv)

Zusätzlich am Repo-Wurzelverzeichnis: AGENTS.md und CLAUDE.md erhalten einen OPENWIKI-Block mit Verweisen auf die Wiki.

Personal-Modus (persönliche Wissensbasis)¶

~/.openwiki/
├── wiki/                # Generierte persönliche Wissensbasis
├── connectors/          # Rohdaten der angebundenen Quellen
├── .env                 # Zugangsdaten
└── INSTRUCTIONS.md      # Instruktionen für die persönliche Wiki

Connectoren (Personal-Modus)¶

Neun eingebaute Connectoren reichern die persönliche Wiki an:

Ausgabeformat¶

OpenWiki erzeugt in beiden Modi Bundles im Google Open Knowledge Format (OKF) v0.2 — ein strukturiertes, werkzeugübergreifendes Format für generiertes Wissen mit YAML-Frontmatter, Provenienz-Metadaten, versionierter Beleg-Verfolgung und validierten Mermaid-Diagrammen. Es geht damit über reine Markdown-Ausgabe hinaus.

Telemetrie & Datenschutz¶

OpenWiki sendet standardmäßig anonyme Nutzungsdaten — ein openwiki_run-Ereignis pro Installations-ID mit Befehlstyp und Ergebnisstatus, beim Setup zusätzlich Modus, Provider- und Connector-Namen.

Nie übertragen: Dateiinhalte, Repository-Daten, Zugangsdaten, Prompts, Modell-Ausgaben, Dateipfade, URLs oder Laufzeiten.

Deaktivieren:

export OPENWIKI_TELEMETRY_DISABLED=1
export DO_NOT_TRACK=1

Die konkrete Nutzlast lässt sich mit --telemetry-file=<pfad> einsehen.

Einordnung gegenüber DeepWiki¶

Verwandte Themen¶

• Startseite — zurück zur Dokumentations-Zentrale
• LLM-Wiki-Pattern (Karpathy-Muster) — das zugrunde liegende Architekturmuster
• Native „LLM-first" Wiki-Tools & Agenten — Gesamteinordnung von OpenWiki in die Werkzeuglandschaft
• Dokumentenerstellung, Wikis & Notebooks — Gesamtübersicht aller Dokumentations-Systeme
• Beste Static-Site- & Docs-Generatoren 2026 (Top 20) — Ziele für den statischen Visualizer-Export
• Multi-LLM- & Sprachmodell-Anbieter im Vergleich — Preise der von OpenWiki unterstützten Modell-Provider

Hinweis: Diese Inhalte wurden mit Unterstützung von Künstlicher Intelligenz erstellt und redaktionell überprüft (Transparenzhinweis gemäß Art. 50 EU AI Act).