Repomix

Início Rápido ​

Depois de gerar um arquivo compactado (repomix-output.txt) usando o Repomix, você pode enviá-lo para um assistente de IA 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! 🚀

Guia do Usuário Avançado ​

Para usuários avançados que precisam de mais controle, o Repomix oferece extensas opções de personalização através de sua interface CLI.

Início Rápido ​

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

npx repomix

Ou instale globalmente para uso repetido:

# Instalar usando npm
npm install -g repomix

# Alternativamente usando yarn
yarn global add repomix

# Alternativamente usando 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.txt 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:

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

# Você também pode usar o atalho do GitHub:
repomix --remote yamadashy/repomix

# Você pode especificar o nome do branch, tag ou hash do commit:
repomix --remote https://github.com/yamadashy/repomix --remote-branch main

# Ou usar um hash de commit específico:
repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695

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/**"]
  }
}

Mais Exemplos ​