Oggi rilasciamo OpenWiki, un agente open source e CLI per generare e mantenere la documentazione dei codebase.
Gli agenti scrivono codice migliore quando comprendono il repository in cui lavorano. Devono sapere dove risiede la logica chiave, come sono collegati i file e quali pattern il codebase si aspetta. Una buona documentazione fornisce agli agenti questo contesto, portando a modifiche del codice più informate e meno errori evitabili.
Il problema è che la documentazione è difficile da mantenere aggiornata. Scrivere la documentazione iniziale richiede tempo, e aggiornarla ogni volta che il codice cambia è ancora più difficile. Nei repository grandi con PR frequenti, la documentazione può diventare rapidamente obsoleta.
OpenWiki gestisce questo lavoro automaticamente. Crea una wiki per il tuo repository, collega quella wiki al tuo agente di codifica e la mantiene aggiornata man mano che il codice cambia.
Perché le wiki per gli agenti
Siamo stati ispirati da lavori esistenti sulle wiki dei codebase, tra cui DeepWiki, AutoWiki e il concetto di LLM Wiki di Karpathy. L'idea condivisa è semplice. Una wiki offre a umani e agenti un modo strutturato per comprendere un codebase senza forzare tutto il contesto in un unico file enorme.
Questo è importante perché la maggior parte degli agenti di codifica legge già file come AGENTS.md o CLAUDE.md per le istruzioni. Questi file sono utili, ma non sono il posto giusto per memorizzare centinaia di pagine di documentazione del repository. Dovrebbero indirizzare l'agente verso il contesto giusto, e poi lasciare che l'agente recuperi ciò di cui ha bisogno.
OpenWiki segue questo modello. Genera una wiki del repository, poi aggiorna i tuoi file di istruzioni dell'agente con un riferimento a quella wiki. Da lì, il tuo agente di codifica può scoprire e utilizzare automaticamente la documentazione.
Per iniziare
OpenWiki è progettato per essere facile da eseguire dalla riga di comando.
Installalo con NPM:
1npm install -g openwiki
poi esegui:
1openwiki --init
Il comando init chiede un provider di modelli e una chiave API, quindi genera la documentazione per il tuo repository.
OpenWiki supporta sia provider di modelli aperti che chiusi, tra cui OpenRouter, Fireworks, Baseten, OpenAI e Anthropic. Per impostazione predefinita, utilizza OpenRouter con un modello aperto, ma puoi configurare il provider più adatto alla tua configurazione.
Poiché OpenWiki è basato su DeepAgents, supporta anche il tracing verso LangSmith. Se fornisci una chiave API LangSmith, OpenWiki tracerà le esecuzioni verso un progetto LangSmith in modo da poter ispezionare esattamente cosa ha fatto l'agente durante la generazione o l'aggiornamento della documentazione.
Come OpenWiki si collega al tuo agente di codifica
Dopo aver generato la wiki, OpenWiki aggiorna i file di istruzioni dell'agente del tuo repository. Se il tuo repository utilizza AGENTS.md, CLAUDE.md o entrambi, OpenWiki aggiunge un riferimento alla wiki generata e spiega quando l'agente dovrebbe usarla.
Abbiamo scelto questo approccio perché inserire l'intera wiki all'interno di un file di istruzioni aggiungerebbe troppo contesto. In un repository di grandi dimensioni, la wiki può estendersi su centinaia di file. Caricare tutto questo in ogni esecuzione dell'agente sarebbe dispendioso e difficile da mantenere.
Un breve riferimento funziona meglio. Il tuo agente di codifica legge già il file di istruzioni. Una volta che OpenWiki aggiunge il riferimento, l'agente può trovare la wiki quando ha bisogno del contesto del repository, senza richiederti di modificare il tuo flusso di lavoro.
Mantenere la wiki aggiornata
Generare la documentazione una volta è utile. Mantenerla aggiornata è dove OpenWiki diventa più prezioso.
OpenWiki include una GitHub Action che può essere eseguita su base programmata, ad esempio una volta al giorno. L'azione esegue OpenWiki con il flag di aggiornamento. OpenWiki controlla quali commit sono stati effettuati dall'ultima esecuzione, utilizza i diff git per capire cosa è cambiato, quindi aggiorna la wiki con il contesto pertinente.
Ciò significa che il flusso di lavoro può essere eseguito in background. Man mano che il tuo codebase cambia, OpenWiki aggiorna la documentazione. Il tuo agente di codifica continua a prelevare l'ultima wiki tramite il riferimento esistente nel file di istruzioni.
Costruito prima di tutto per i codebase
Questo primo rilascio si concentra sulle wiki per i codebase. L'obiettivo è rendere più facile per gli agenti comprendere i repository in cui lavorano, senza chiedere agli sviluppatori di scrivere e mantenere manualmente documenti dettagliati.
Col tempo, pensiamo che il concetto di OpenWiki possa essere applicato più ampiamente. Gli agenti hanno bisogno di un contesto durevole per molti tipi di lavoro, non solo per la codifica. La documentazione del codebase è il primo caso d'uso, ma lo stesso schema può aiutare gli agenti a mantenere un contesto utile anche in altri flussi di lavoro.
Provalo
OpenWiki è open source e disponibile ora.
Puoi installarlo, eseguire openwiki --init e generare una wiki per il tuo repository in pochi minuti.
Dai un'occhiata al repository qui: https://github.com/langchain-ai/openwiki e guarda il video dimostrativo: https://youtu.be/nIVu3zfYprI
