Repolode
langchain-ai

langchain-ai/openwiki

Uma CLI que cria e mantém uma wiki em Markdown com links para sua base de código, fundamentada em evidências das fontes, para você e seus agentes de programação.

Estrelas
17,785
Forks
1,313
Issues abertas
175
Último commit
há 19 horas

O que é?

O OpenWiki transforma um repositório e suas fontes de conhecimento em uma wiki em Markdown com links, que permanece no seu repositório como arquivos comuns. Agentes de programação podem usá-la para entender a base de código, responder a perguntas e encontrar contexto em projetos relacionados. Os leitores podem navegar pelas mesmas páginas ou visualizá-las como um grafo interativo.

Nas wikis de repositórios, cada afirmação factual é vinculada a evidências versionadas das fontes. Assim, quando o código muda, o OpenWiki pode limitar as atualizações aos fatos afetados. As atualizações não acionam o modelo quando nada mudou, e execuções interrompidas podem ser retomadas a partir das páginas concluídas.

Você pode iniciar o OpenWiki em agentes de programação compatíveis, como Codex, Claude Code, Cursor e GitHub Copilot CLI, ou executá-lo como uma CLI independente, escolhendo entre vários provedores de modelos. Ele também inclui um modo pessoal que sintetiza conhecimento local a partir de conectores como Notion, Gmail e Hacker News, e pode ser agendado no CI para abrir pull requests com atualizações da documentação.

Recursos principais

  • 01Gera uma wiki em Markdown com links dentro do repositório, que você pode editar e versionar.
  • 02Vincula os fatos das páginas às evidências das fontes, para que as atualizações se concentrem apenas nas afirmações afetadas por mudanças no código.
  • 03Integra-se a vários agentes de programação e disponibiliza ferramentas de busca e leitura via MCP.
  • 04Permite vincular vários repositórios em workspaces para pesquisar entre projetos.
  • 05Oferece um visualizador local com grafo interativo e leitor de Markdown ao vivo, além de exportação estática.
  • 06É compatível com vários provedores de modelos, incluindo endpoints locais compatíveis com OpenAI.

Casos de uso

  • Fornecer a um agente de programação uma visão geral atualizada de um repositório grande ou desconhecido.
  • Manter a documentação de onboarding e arquitetura atualizada por meio de PRs de atualização agendados no CI.
  • Documentar um serviço composto por vários repositórios em um único workspace pesquisável.
  • Publicar um grafo de arquitetura navegável junto com a documentação gerada.

Início rápido

  1. 1

    Instale o OpenWiki globalmente com npm (requer Node.js 22.22.0 ou superior)

    npm install -g openwiki
  2. 2

    Conecte seu agente de programação (exemplo para Codex; os outros agentes têm seu próprio comando de instalação)

    openwiki integrations install codex
  3. 3

    Reinicie o agente, abra um repositório e peça para ele inicializar o OpenWiki com base no código-fonte e nos testes

  4. 4

    Explore a wiki gerada como um grafo interativo no navegador

    openwiki visualize

Antes de usar

  • Requer Node.js 22.22.0 ou superior.
  • O fluxo de trabalho mais simples depende de um agente de programação compatível, e as execuções controladas pelo host só oferecem suporte a wikis de código de repositórios, não a bases de conhecimento pessoais.
  • No Windows, o bun pode recorrer à compilação da dependência nativa better-sqlite3, que requer o Visual Studio Build Tools.

Destaque no Repolode Weekly

Em coleções

Tópicos

Perguntas frequentes

O que é openwiki?
Uma CLI que cria e mantém uma wiki em Markdown com links para sua base de código, fundamentada em evidências das fontes, para você e seus agentes de programação. O OpenWiki transforma um repositório e suas fontes de conhecimento em uma wiki em Markdown com links, que permanece no seu repositório como arquivos comuns. Agentes de programação podem usá-la para entender a base de código, responder a perguntas e encontrar contexto em projetos relacionados. Os leitores podem navegar pelas mesmas páginas ou visualizá-las como um grafo interativo.
openwiki é gratuito? Qual é a licença?
openwiki é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
openwiki ainda é mantido?
Manutenção ativa. O último commit de openwiki foi em 6 de nov. de 2026.
Para que posso usar openwiki?
Fornecer a um agente de programação uma visão geral atualizada de um repositório grande ou desconhecido. Manter a documentação de onboarding e arquitetura atualizada por meio de PRs de atualização agendados no CI. Documentar um serviço composto por vários repositórios em um único workspace pesquisável. Publicar um grafo de arquitetura navegável junto com a documentação gerada.
Como instalar openwiki?
Instale o OpenWiki globalmente com npm (requer Node.js 22.22.0 ou superior): npm install -g openwiki Conecte seu agente de programação (exemplo para Codex; os outros agentes têm seu próprio comando de instalação): openwiki integrations install codex Reinicie o agente, abra um repositório e peça para ele inicializar o OpenWiki com base no código-fonte e nos testes Explore a wiki gerada como um grafo interativo no navegador: openwiki visualize
Onde consigo openwiki?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/langchain-ai/openwiki

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados