Heute veröffentlichen wir OpenWiki, einen Open-Source-Agenten und eine CLI zur Generierung und Pflege von Dokumentation für Codebasen.
Agenten schreiben besseren Code, wenn sie das Repository verstehen, in dem sie arbeiten. Sie müssen wissen, wo die zentrale Logik liegt, wie Dateien zusammenhängen und welche Muster die Codebasis erwartet. Gute Dokumentation liefert den Agenten diesen Kontext, was zu fundierteren Codeänderungen und weniger vermeidbaren Fehlern führt.
Das Problem ist, dass Dokumentation nur schwer aktuell zu halten ist. Das anfängliche Schreiben der Dokumentation nimmt Zeit in Anspruch, und sie bei jeder Codeänderung zu aktualisieren, ist noch schwieriger. In großen Repos mit häufigen PRs kann die Dokumentation schnell veralten.
OpenWiki erledigt diese Arbeit automatisch. Es erstellt ein Wiki für Ihr Repo, verbindet dieses Wiki mit Ihrem Coding-Agenten und hält es auf dem neuesten Stand, während sich Ihr Code ändert.
Warum Wikis für Agenten
Wir wurden von bestehenden Arbeiten zu Codebase-Wikis inspiriert, darunter DeepWiki, AutoWiki und Karpathys LLM Wiki-Konzept. Die gemeinsame Idee ist einfach. Ein Wiki bietet Menschen und Agenten eine strukturierte Möglichkeit, eine Codebasis zu verstehen, ohne den gesamten Kontext in eine einzige riesige Datei zu zwängen.
Das ist wichtig, weil die meisten Coding-Agenten bereits Dateien wie AGENTS.md oder CLAUDE.md für Anweisungen lesen. Diese Dateien sind nützlich, aber nicht der richtige Ort, um Hunderte von Seiten mit Repo-Dokumentation zu speichern. Sie sollten den Agenten auf den richtigen Kontext verweisen und ihm dann ermöglichen, abzurufen, was er benötigt.
OpenWiki folgt diesem Modell. Es generiert ein Repo-Wiki und aktualisiert dann Ihre Agenten-Anweisungsdateien mit einem Verweis auf dieses Wiki. Von dort aus kann Ihr Coding-Agent die Dokumentation automatisch finden und nutzen.
Erste Schritte
OpenWiki ist so konzipiert, dass es einfach über die Befehlszeile ausgeführt werden kann.
Installieren Sie es mit NPM:
1npm install -g openwiki
Führen Sie dann Folgendes aus:
1openwiki --init
Der Init-Befehl fragt nach einem Modellanbieter und einem API-Schlüssel und generiert dann die Dokumentation für Ihr Repo.
OpenWiki unterstützt sowohl offene als auch geschlossene Modellanbieter, darunter OpenRouter, Fireworks, Baseten, OpenAI und Anthropic. Standardmäßig verwendet es OpenRouter mit einem offenen Modell, aber Sie können den Anbieter konfigurieren, der am besten zu Ihrem Setup passt.
Da OpenWiki auf DeepAgents basiert, unterstützt es auch Tracing zu LangSmith. Wenn Sie einen LangSmith-API-Schlüssel angeben, verfolgt OpenWiki die Ausführungen in einem LangSmith-Projekt, sodass Sie genau überprüfen können, was der Agent beim Generieren oder Aktualisieren Ihrer Dokumentation getan hat.
Wie OpenWiki eine Verbindung zu Ihrem Coding-Agenten herstellt
Nach der Generierung des Wikis aktualisiert OpenWiki die Agenten-Anweisungsdateien Ihres Repos. Wenn Ihr Repo AGENTS.md, CLAUDE.md oder beide verwendet, fügt OpenWiki einen Verweis auf das generierte Wiki hinzu und erklärt, wann der Agent es verwenden soll.
Wir haben diesen Ansatz gewählt, weil das Einfügen des gesamten Wikis in eine Anweisungsdatei zu viel Kontext hinzufügen würde. In einem großen Repo kann das Wiki Hunderte von Dateien umfassen. Das Laden all dieser Dateien in jeden Agenten-Durchlauf wäre verschwenderisch und schwer zu warten.
Ein kurzer Verweis funktioniert besser. Ihr Coding-Agent liest bereits die Anweisungsdatei. Sobald OpenWiki den Verweis hinzugefügt hat, kann der Agent das Wiki finden, wenn er Repo-Kontext benötigt, ohne dass Sie Ihren Workflow ändern müssen.
Das Wiki auf dem neuesten Stand halten
Einmalig Dokumentation zu generieren, ist nützlich. Sie aktuell zu halten, macht OpenWiki noch wertvoller.
OpenWiki enthält eine GitHub Action, die nach einem Zeitplan ausgeführt werden kann, zum Beispiel einmal täglich. Die Aktion führt OpenWiki mit dem Update-Flag aus. OpenWiki prüft, welche Commits seit dem letzten Lauf eingegangen sind, verwendet Git-Diffs, um zu verstehen, was sich geändert hat, und aktualisiert dann das Wiki mit dem relevanten Kontext.
Das bedeutet, dass der Workflow im Hintergrund laufen kann. Während sich Ihre Codebasis ändert, aktualisiert OpenWiki die Dokumentation. Ihr Coding-Agent greift über die bestehende Referenz in der Anweisungsdatei weiterhin auf das neueste Wiki zu.
Zuerst für Codebasen entwickelt
Diese erste Veröffentlichung konzentriert sich auf Wikis für Codebasen. Das Ziel ist es, es Agenten zu erleichtern, die Repos zu verstehen, in denen sie arbeiten, ohne dass Entwickler manuell detaillierte Dokumentation schreiben und pflegen müssen.
Im Laufe der Zeit denken wir, dass das OpenWiki-Konzept breiter anwendbar sein wird. Agenten benötigen für viele Arten von Arbeit dauerhaften Kontext, nicht nur für das Programmieren. Die Codebasis-Dokumentation ist der erste Anwendungsfall, aber dasselbe Muster kann Agenten auch bei anderen Workflows helfen, nützlichen Kontext zu erhalten.
Probieren Sie es aus
OpenWiki ist Open Source und ab sofort verfügbar.
Sie können es installieren, openwiki --init ausführen und in wenigen Minuten ein Wiki für Ihr Repo generieren.
Sehen Sie sich das Repo hier an: https://github.com/langchain-ai/openwiki und schauen Sie sich das Walkthrough-Video an: https://youtu.be/nIVu3zfYprI
