Hoje estamos lançando o OpenWiki, um agente e CLI de código aberto para gerar e manter documentação para bases de código.
Agentes escrevem código melhor quando entendem o repositório em que estão trabalhando. Eles precisam saber onde a lógica principal está, como os arquivos se conectam e quais padrões a base de código espera. Uma boa documentação dá aos agentes esse contexto, o que leva a mudanças de código mais informadas e menos erros evitáveis.
O problema é que a documentação é difícil de manter atualizada. Escrever os documentos iniciais leva tempo, e atualizá-los toda vez que o código muda é ainda mais difícil. Em repositórios grandes com PRs frequentes, a documentação pode ficar desatualizada rapidamente.
O OpenWiki cuida desse trabalho automaticamente. Ele cria uma wiki para seu repositório, conecta essa wiki ao seu agente de codificação e a mantém atualizada conforme seu código muda.
Por que wikis para agentes
Fomos inspirados por trabalhos existentes sobre wikis de bases de código, incluindo DeepWiki, AutoWiki e o conceito de LLM Wiki do Karpathy. A ideia compartilhada é simples. Uma wiki oferece a humanos e agentes uma maneira estruturada de entender uma base de código sem forçar todo o contexto em um único arquivo gigante.
Isso é importante porque a maioria dos agentes de codificação já lê arquivos como AGENTS.md ou CLAUDE.md para instruções. Esses arquivos são úteis, mas não são o lugar certo para armazenar centenas de páginas de documentação do repositório. Eles devem apontar o agente para o contexto certo e, em seguida, deixar o agente recuperar o que precisa.
O OpenWiki segue esse modelo. Ele gera uma wiki do repositório e, em seguida, atualiza seus arquivos de instrução do agente com uma referência a essa wiki. A partir daí, seu agente de codificação pode descobrir e usar a documentação automaticamente.
Primeiros passos
O OpenWiki foi projetado para ser fácil de executar a partir da linha de comando.
Instale-o com NPM:
npm install -g openwiki
depois execute:
openwiki --init
O comando init pergunta por um provedor de modelo e chave de API, e então gera a documentação para seu repositório.
O OpenWiki suporta provedores de modelo abertos e fechados, incluindo OpenRouter, Fireworks, Baseten, OpenAI e Anthropic. Por padrão, ele usa o OpenRouter com um modelo aberto, mas você pode configurar o provedor que funciona melhor para sua configuração.
Como o OpenWiki é construído sobre o DeepAgents, ele também suporta rastreamento para o LangSmith. Se você fornecer uma chave de API do LangSmith, o OpenWiki rastreará as execuções para um projeto do LangSmith para que você possa inspecionar exatamente o que o agente fez ao gerar ou atualizar sua documentação.
Como o OpenWiki se conecta ao seu agente de codificação
Após gerar a wiki, o OpenWiki atualiza os arquivos de instrução do agente do seu repositório. Se seu repositório usa AGENTS.md, CLAUDE.md ou ambos, o OpenWiki adiciona uma referência à wiki gerada e explica quando o agente deve usá-la.
Escolhemos essa abordagem porque colocar a wiki inteira dentro de um arquivo de instrução adicionaria muito contexto. Em um repositório grande, a wiki pode abranger centenas de arquivos. Carregar tudo isso em cada execução do agente seria ineficiente e difícil de manter.
Uma referência curta funciona melhor. Seu agente de codificação já lê o arquivo de instrução. Depois que o OpenWiki adiciona a referência, o agente pode encontrar a wiki quando precisar de contexto do repositório, sem exigir que você mude seu fluxo de trabalho.
Mantendo a wiki atualizada
Gerar documentação uma vez é útil. Mantê-la atualizada é onde o OpenWiki se torna mais valioso.
O OpenWiki inclui uma GitHub Action que pode ser executada em um cronograma, por exemplo, uma vez por dia. A ação executa o OpenWiki com a flag de atualização. O OpenWiki verifica quais commits foram feitos desde a última execução, usa os diffs do git para entender o que mudou e, em seguida, atualiza a wiki com o contexto relevante.
Isso significa que o fluxo de trabalho pode ser executado em segundo plano. Conforme sua base de código muda, o OpenWiki atualiza a documentação. Seu agente de codificação continua pegando a wiki mais recente através da referência existente no arquivo de instrução.
Feito para bases de código em primeiro lugar
Este primeiro lançamento foca em wikis para bases de código. O objetivo é facilitar para que os agentes entendam os repositórios em que trabalham, sem exigir que os desenvolvedores escrevam e mantenham manualmente documentações detalhadas.
Com o tempo, acreditamos que o conceito do OpenWiki pode ser aplicado de forma mais ampla. Agentes precisam de contexto durável para muitos tipos de trabalho, não apenas codificação. A documentação da base de código é o primeiro caso de uso, mas o mesmo padrão pode ajudar agentes a manter contexto útil em outros fluxos de trabalho também.
Experimente
O OpenWiki é código aberto e está disponível agora.
Você pode instalá-lo, executar openwiki --init e gerar uma wiki para seu repositório em alguns minutos.
Confira o repositório aqui: https://github.com/langchain-ai/openwiki e assista ao vídeo de demonstração: https://youtu.be/nIVu3zfYprI
