O que llm_wiki faz?
Automatize sua documentação usando LLMs para ler arquivos, estruturar uma wiki pesquisável e manter o conteúdo atualizado com rastreamento de fontes.
Visão Geral
Este skill utiliza modelos de linguagem de grande escala (LLMs) para analisar automaticamente arquivos de código-fonte, extrair informações relevantes e gerar uma wiki estruturada e pesquisável. Ele mantém o conteúdo sincronizado com as últimas alterações no código, rastreando as fontes originais para garantir precisão e contexto.
Como Funciona
- Leitura de Arquivos: O skill percorre diretórios e lê arquivos de código suportados.
- Análise por LLM: Os arquivos são enviados a um LLM que extrai trechos importantes, definições de funções, classes e comentários.
- Estruturação da Wiki: O conteúdo extraído é organizado em uma estrutura de wiki com páginas, índices e links internos.
- Rastreamento de Fontes: Cada entrada da wiki mantém referência ao arquivo de origem e linha, permitindo rastreamento bidirecional.
- Atualização Contínua: Sempre que o código é alterado, o skill pode reanalisar apenas os arquivos modificados e atualizar a wiki incrementalmente.
Plataformas Suportadas
- Claude Code
- Cursor
- Codex
- Outros agentes compatíveis com skills
Comandos
generate_wiki: Gera a wiki completa a partir de um diretório de código.update_wiki: Atualiza a wiki com base em alterações recentes.search_wiki <termo>: Pesquisa na wiki gerada por termos específicos.track_source <página>: Exibe as fontes rastreadas para uma página da wiki.
Exemplo de Uso
# Gerar wiki para o diretório atual
skill-cli generate_wiki --dir ./meu_projeto --output ./docs/wiki
# Atualizar wiki após alterações
skill-cli update_wiki --dir ./meu_projeto --wiki ./docs/wiki
# Pesquisar na wiki
skill-cli search_wiki "função de autenticação"
Configuração
| Variável | Descrição | Padrão |
|---|---|---|
LLM_WIKI_DIR | Diretório do projeto a ser analisado | . |
LLM_WIKI_OUTPUT | Diretório de saída da wiki | ./wiki |
LLM_WIKI_MODEL | Modelo LLM a ser usado | gpt-4 |
LLM_WIKI_UPDATE_INTERVAL | Intervalo de atualização automática (segundos) | 300 |
Licença
MIT