Repomix: packaging the code base into a text file for large model retrieval

General Introduction

Repomix (formerly known as Repopack) is an open source tool designed to package an entire codebase into a single, AI-friendly file. This tool allows developers to easily make their codebase available for analysis and processing by large language models such as Claude, ChatGPT, and Gemini. It was originally designed to simplify the task of AI in code comprehension and generation for scenarios that require a quick review or refactoring of the codebase.Repomix supports a variety of output formats, including XML, Markdown, and plain text, and provides profiles to meet the needs of different projects.

Function List

• Code base packaging: Package the entire project into a single file for easy AI analysis.
• Multi-format output support: Provides a variety of output formats such as XML, Markdown and plain text, which can be selected by the user as desired.
• Configuration Flexibility: Through the configuration file, you can customize options such as ignore files, comment removal, etc.
• Remote Warehouse Support: You can fetch and package code directly from a remote GitHub repository.
• Docker Support: Provides Docker images to facilitate running Repomix in a containerized environment.
• safety check: Enable security checks by default to avoid leakage of sensitive information.

Using Help

Installing Repomix

Repomix is a Node.js-based tool, so you'll need to make sure you have Node.js installed on your system.

1.Installing Node.js::

• Visit the official Node.js website to download and install the appropriate version for your system.

2.Installing Repomix::

• Install Repomix globally via npm:

  npm install -g repomix
  

Using Repomix

Basic use

• Packaging Local Projects::
  Go to your project directory and run it:

repomix

This will generate a file in the current directory calledrepomix-output.xmlof the file. If you need to specify the output format, you can use ** --styleParameters:

repomix --style markdown

• Packaging Remote Warehouse::
  If you want to package a remote GitHub repository directly, execute:

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

  You can also specify branches or specific commits:

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

configuration file

• Repomix supports custom configurations that can be configured via therepomix --initGenerate arepomix.config.jsonFile. You can define in it:
  • Ignore files: use **.repomixignorefile or configuration file in theignoreoption, similar to the.gitignore**.
  • output format: Select the format of the output file (e.g. XML, Markdown).
  • Header text: Add explanatory text to the beginning of the output file.
  • safety check: Whether to turn on security checks to avoid disclosure of sensitive information.

  Example configuration file:

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

Running Repomix

• Running in Docker::
  If you prefer to use Docker to manage your environment, you can do so:

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

Repomix for use with other AI tools

• The generated single file can be uploaded directly to AI tools such as Claude, ChatGPT or Gemini for analysis:
  • Code review: Provide documentation to the AI requesting a code review or suggesting refactoring.
  • Document Generation: Generate documentation or README files based on the code base.
  • Problem solving: Identify problems in code and provide solutions through AI tools.