Aujourd'hui, nous lançons OpenWiki, un agent open source et une CLI pour générer et maintenir la documentation des bases de code.
Les agents écrivent un meilleur code lorsqu'ils comprennent le dépôt dans lequel ils travaillent. Ils doivent savoir où se trouve la logique clé, comment les fichiers sont connectés et quels modèles la base de code attend. Une bonne documentation fournit ce contexte aux agents, ce qui conduit à des modifications de code plus éclairées et à moins d'erreurs évitables.
Le problème est qu'il est difficile de maintenir la documentation à jour. Rédiger la documentation initiale prend du temps, et la mettre à jour à chaque modification du code est encore plus difficile. Dans les grands dépôts avec des PR fréquentes, la documentation peut rapidement devenir obsolète.
OpenWiki gère ce travail automatiquement. Il crée un wiki pour votre dépôt, connecte ce wiki à votre agent de codage et le maintient à jour au fur et à mesure que votre code évolue.
Pourquoi des wikis pour les agents
Nous nous sommes inspirés des travaux existants sur les wikis de bases de code, notamment DeepWiki, AutoWiki et le concept de LLM Wiki de Karpathy. L'idée commune est simple. Un wiki offre aux humains et aux agents un moyen structuré de comprendre une base de code sans forcer tout le contexte dans un seul fichier géant.
C'est important car la plupart des agents de codage lisent déjà des fichiers comme AGENTS.md ou CLAUDE.md pour obtenir des instructions. Ces fichiers sont utiles, mais ils ne sont pas l'endroit approprié pour stocker des centaines de pages de documentation de dépôt. Ils doivent orienter l'agent vers le bon contexte, puis laisser l'agent récupérer ce dont il a besoin.
OpenWiki suit ce modèle. Il génère un wiki de dépôt, puis met à jour vos fichiers d'instructions d'agent avec une référence à ce wiki. À partir de là, votre agent de codage peut découvrir et utiliser la documentation automatiquement.
Pour commencer
OpenWiki est conçu pour être facile à utiliser depuis la ligne de commande.
Installez-le avec NPM :
1npm install -g openwiki
puis exécutez :
1openwiki --init
La commande init demande un fournisseur de modèle et une clé API, puis génère la documentation pour votre dépôt.
OpenWiki prend en charge à la fois les fournisseurs de modèles ouverts et fermés, notamment OpenRouter, Fireworks, Baseten, OpenAI et Anthropic. Par défaut, il utilise OpenRouter avec un modèle ouvert, mais vous pouvez configurer le fournisseur qui convient le mieux à votre configuration.
Comme OpenWiki est construit sur DeepAgents, il prend également en charge le tracing vers LangSmith. Si vous fournissez une clé API LangSmith, OpenWiki tracera les exécutions vers un projet LangSmith afin que vous puissiez inspecter exactement ce que l'agent a fait lors de la génération ou de la mise à jour de votre documentation.
Comment OpenWiki se connecte à votre agent de codage
Après avoir généré le wiki, OpenWiki met à jour les fichiers d'instructions de l'agent de votre dépôt. Si votre dépôt utilise AGENTS.md, CLAUDE.md, ou les deux, OpenWiki ajoute une référence au wiki généré et explique quand l'agent doit l'utiliser.
Nous avons choisi cette approche car placer l'intégralité du wiki dans un fichier d'instructions ajouterait trop de contexte. Dans un grand dépôt, le wiki peut s'étendre sur des centaines de fichiers. Charger tout cela dans chaque exécution d'agent serait inefficace et difficile à maintenir.
Une référence courte fonctionne mieux. Votre agent de codage lit déjà le fichier d'instructions. Une fois qu'OpenWiki a ajouté la référence, l'agent peut trouver le wiki lorsqu'il a besoin du contexte du dépôt, sans que vous ayez à modifier votre flux de travail.
Maintenir le wiki à jour
Générer la documentation une fois est utile. La maintenir à jour est là où OpenWiki devient plus précieux.
OpenWiki inclut une GitHub Action qui peut être exécutée selon un calendrier, par exemple une fois par jour. L'action exécute OpenWiki avec le drapeau de mise à jour. OpenWiki vérifie quels commits ont été effectués depuis la dernière exécution, utilise les diffs git pour comprendre ce qui a changé, puis met à jour le wiki avec le contexte pertinent.
Cela signifie que le flux de travail peut s'exécuter en arrière-plan. Au fur et à mesure que votre base de code évolue, OpenWiki met à jour la documentation. Votre agent de codage continue de récupérer le dernier wiki via la référence existante dans le fichier d'instructions.
Conçu d'abord pour les bases de code
Cette première version se concentre sur les wikis pour les bases de code. L'objectif est de permettre aux agents de comprendre plus facilement les dépôts dans lesquels ils travaillent, sans demander aux développeurs de rédiger et de maintenir manuellement une documentation détaillée.
Au fil du temps, nous pensons que le concept d'OpenWiki peut s'appliquer plus largement. Les agents ont besoin d'un contexte durable pour de nombreux types de travaux, pas seulement le codage. La documentation de base de code est le premier cas d'utilisation, mais le même modèle peut aider les agents à maintenir un contexte utile dans d'autres flux de travail également.
Essayez-le
OpenWiki est open source et disponible dès maintenant.
Vous pouvez l'installer, exécuter openwiki --init et générer un wiki pour votre dépôt en quelques minutes.
Consultez le dépôt ici : https://github.com/langchain-ai/openwiki et regardez la vidéo de démonstration : https://youtu.be/nIVu3zfYprI
