Repomix: empacotamento da base de código em um arquivo de texto para recuperação de modelos grandes

Introdução geral

O Repomix (anteriormente conhecido como Repopack) é uma ferramenta de código aberto projetada para empacotar toda uma base de código em um único arquivo compatível com IA. Essa ferramenta permite que os desenvolvedores disponibilizem facilmente sua base de código para análise e processamento por grandes modelos de linguagem, como Claude, ChatGPT e Gemini. Ela foi originalmente projetada para simplificar a tarefa de IA na compreensão e geração de código para cenários que exigem uma rápida revisão ou refatoração da base de código. O Repomix é compatível com vários formatos de saída, incluindo XML, Markdown e texto simples, e oferece perfis para atender às necessidades de diferentes projetos.

Lista de funções

• Embalagem da base de códigoEmpacote o projeto inteiro em um único arquivo para facilitar a análise de IA.
• Suporte a saída em vários formatosFormato de saída: fornece vários formatos de saída, como XML, Markdown e texto simples, que podem ser selecionados pelo usuário conforme desejado.
• Flexibilidade de configuraçãoPor meio do arquivo de configuração, você pode personalizar opções como ignorar arquivos, remover comentários e assim por diante.
• Suporte remoto ao armazémCódigo de pacote: Você pode buscar e empacotar códigos diretamente de um repositório remoto do GitHub.
• Suporte ao DockerImagens do Docker: são fornecidas para facilitar a execução do Repomix em um ambiente de contêineres.
• verificação de segurançaVerificações de segurança: As verificações de segurança são ativadas por padrão para evitar o vazamento de informações confidenciais.

Usando a Ajuda

Instalando o Repomix

O Repomix é uma ferramenta baseada em Node.js, portanto, você precisa ter certeza de que o Node.js está instalado em seu sistema.

1.Instalação do Node.js::

• Visite o site oficial do Node.js para fazer download e instalar a versão apropriada para seu sistema.

2.Instalando o Repomix::

• Instale o Repomix globalmente via npm:

  npm install -g repomix
  

Usando o Repomix

Uso básico

• Empacotamento de projetos locais::
  Vá para o diretório de seu projeto e execute-o:

repomix

Isso gerará um arquivo no diretório atual chamadorepomix-output.xmldo arquivo. Se precisar especificar o formato de saída, você pode usar ** --styleParâmetros:

repomix --style markdown

• Armazém remoto de embalagens::
  Se você quiser empacotar um repositório remoto do GitHub diretamente, execute:

  repomix --remote https://github.com/yamadashy/repomix
  

  Você também pode especificar ramificações ou commits específicos:

  repomix --remote yamadashy/repomix --remote-branch main
  

arquivo de configuração

• O Repomix oferece suporte a configurações personalizadas que podem ser configuradas por meio dorepomix --initGerar umrepomix.config.jsonDocumento. Você pode definir nesse documento:
  • Ignorar arquivos: use **.repomixignoreou arquivo de configuração no arquivoignorarsemelhante à opção.gitignore**.
  • formato de saídaFormato do arquivo de saída: selecione o formato do arquivo de saída (por exemplo, XML, Markdown).
  • Texto do cabeçalhoTexto explicativo: adiciona texto explicativo ao início do arquivo de saída.
  • verificação de segurançaSe deve ativar as verificações de segurança para evitar a divulgação de informações confidenciais.

  Exemplo de arquivo de configuração:

  {
  "output": {
  "filePath": "repomix-output.xml",
  "style": "xml",
  "fileSummary": true
  }, "fileSummary": true
  "ignore": {
  "useGitignore": true
  }
  }
  

Executando o Repomix

• Execução no Docker::
  Se preferir usar o Docker para gerenciar seu ambiente, você pode fazer isso:

  docker run -v . /output:/app -it --rm ghcr.io/yamadashy/repomix --remote yamadashy/repomix
  

Repomix para uso com outras ferramentas de IA

• O arquivo único gerado pode ser carregado diretamente em ferramentas de IA, como Claude, ChatGPT ou Gemini, para análise:
  • Revisão do códigoFornecimento de documentação para a IA solicitando uma revisão de código ou sugerindo refatoração.
  • Geração de documentosGeração de documentação ou arquivos README com base na base de código.
  • Solução de problemasIdentificação de problemas no código e fornecimento de soluções por meio de ferramentas de IA.