Repomix

🏆 Indicação para os Open Source Awards ​

Estamos honrados! O Repomix foi indicado na categoria Powered by AI no JSNation Open Source Awards 2025.

Isso não teria sido possível sem todos vocês que usam e apoiam o Repomix. Obrigado!

Se o Repomix ajudou você a analisar ou empacotar bases de código para ferramentas de IA, ficaríamos gratos pelo seu voto na categoria Powered by AI.

O que é o Repomix? ​

O Repomix é uma ferramenta poderosa que empacota toda a sua base de código em um único arquivo compatível com IA. Seja trabalhando em revisões de código, refatoração ou precisando de assistência de IA para seu projeto, o Repomix facilita o compartilhamento de todo o contexto do seu repositório com ferramentas de IA.

Início Rápido ​

Depois de gerar um arquivo compactado (repomix-output.xml) usando o Repomix, você pode enviá-lo para um assistente de IA (como ChatGPT, Claude) com um prompt como:

Este arquivo contém todos os arquivos do repositório combinados em um.
Eu quero refatorar o código, então, por favor, revise-o primeiro.

A IA analisará todo o seu código-fonte e fornecerá insights abrangentes:

Ao discutir mudanças específicas, a IA pode ajudar a gerar código. Com recursos como o Artifacts do Claude, você pode até receber vários arquivos interdependentes:

Feliz codificação! 🚀

Por que Repomix? ​

A força do Repomix reside em sua capacidade de trabalhar com serviços de assinatura como ChatGPT, Claude, Gemini, Grok sem se preocupar com custos, enquanto fornece contexto completo da base de código que elimina a necessidade de exploração de arquivos—tornando a análise mais rápida e frequentemente mais precisa.

Com toda a base de código disponível como contexto, o Repomix permite uma ampla gama de aplicações incluindo planejamento de implementação, investigação de bugs, verificações de segurança de bibliotecas de terceiros, geração de documentação e muito mais.

Usando a Ferramenta CLI ​

O Repomix pode ser usado como uma ferramenta de linha de comando, oferecendo recursos poderosos e opções de personalização.

A ferramenta CLI pode acessar repositórios privados pois utiliza o Git instalado localmente.

Início Rápido ​

Você pode experimentar o Repomix instantaneamente no diretório do seu projeto sem instalação:

npx repomix@latest

Ou instale globalmente para uso repetido:

# Instalar com npm
npm install -g repomix

# Ou com yarn
yarn global add repomix

# Ou com bun
bun add -g repomix

# Ou com Homebrew (macOS/Linux)
brew install repomix

# Então execute em qualquer diretório de projeto
repomix

É isso! O Repomix irá gerar um arquivo repomix-output.xml no seu diretório atual, contendo todo o seu repositório em um formato amigável para IA.

Uso ​

Para compactar todo o seu repositório:

repomix

Para compactar um diretório específico:

repomix path/to/directory

Para compactar arquivos ou diretórios específicos usando glob patterns:

repomix --include "src/**/*.ts,**/*.md"

Para excluir arquivos ou diretórios específicos:

repomix --ignore "**/*.log,tmp/"

Para compactar um repositório remoto:

# Usando formato abreviado
npx repomix --remote yamadashy/repomix

# Usando URL completa (suporta branches e caminhos específicos)
npx repomix --remote https://github.com/yamadashy/repomix
npx repomix --remote https://github.com/yamadashy/repomix/tree/main

# Usando URL do commit
npx repomix --remote https://github.com/yamadashy/repomix/commit/836abcd7335137228ad77feb28655d85712680f1

Para inicializar um novo arquivo de configuração (repomix.config.json):

repomix --init

Depois de gerar o arquivo compactado, você pode usá-lo com ferramentas de IA Generativa como Claude, ChatGPT e Gemini.

Uso do Docker ​

Você também pode executar o Repomix usando o Docker 🐳 Isso é útil se você quiser executar o Repomix em um ambiente isolado ou preferir usar contêineres.

Uso básico (diretório atual):

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

Para compactar um diretório específico:

docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix path/to/directory

Processar um repositório remoto e enviar para um diretório output:

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

Formatos de Saída ​

Escolha seu formato de saída preferido:

# Formato XML (padrão)
repomix --style xml

# Formato Markdown
repomix --style markdown

# Formato de texto simples
repomix --style plain

Customização ​

Crie um repomix.config.json para configurações persistentes:

{
  "output": {
    "style": "markdown",
    "filePath": "custom-output.md",
    "removeComments": true,
    "showLineNumbers": true,
    "topFilesLength": 10
  },
  "ignore": {
    "customPatterns": ["*.test.ts", "docs/**"]
  }
}

Casos de Uso do Mundo Real ​

Fluxo de Trabalho de Geração de Código com LLM ​

Um desenvolvedor compartilha como usa o Repomix para extrair contexto de código de bases de código existentes, e então aproveita esse contexto com LLMs como Claude e Aider para melhorias incrementais, revisões de código e geração automatizada de documentação.

Criando Pacotes de Conhecimento para LLMs ​

Autores estão usando o Repomix para empacotar seu conteúdo escrito—blogs, documentação e livros—em formatos compatíveis com LLM, permitindo que leitores interajam com sua expertise através de sistemas de perguntas e respostas alimentados por IA.

Descobrir mais casos de uso →

Guia de Usuários Avançados ​

O Repomix oferece recursos poderosos para casos de uso avançados. Aqui estão alguns guias essenciais para usuários avançados:

• Servidor MCP - Integração do Model Context Protocol para assistentes de IA
• GitHub Actions - Automatize o empacotamento de código base em workflows de CI/CD
• Compressão de Código - Compressão inteligente baseada em Tree-sitter (~70% de redução de tokens)
• Usar como Biblioteca - Integre o Repomix em suas aplicações Node.js
• Instruções Personalizadas - Adicione prompts e instruções personalizadas às saídas
• Recursos de Segurança - Integração Secretlint incorporada e verificações de segurança
• Melhores Práticas - Otimize seus workflows de IA com estratégias comprovadas

Mais Exemplos ​