What is Repomix?

Repomix is a versatile tool that transforms your entire codebase into AI-friendly formats such as XML, Markdown, or plain text. This process makes it significantly easier for AI assistants like ChatGPT, Claude, and Gemini to understand and analyze your code. By presenting the codebase in a structured and comprehensible manner, Repomix enables these AI tools to provide comprehensive insights, assist with refactoring, and even generate interdependent code files when used with features like Claude's Artifacts.

It offers flexibility through a command-line interface (CLI) and Docker usage, allowing users to pack entire repositories, specific directories, or even remote repositories. Repomix is also Git-aware, automatically respecting .gitignore files, and incorporates Secretlint for security checks to prevent the inclusion of sensitive information. Additional features include token counting for managing LLM context limits, options to compress code by removing implementation details, and the ability to customize settings via a configuration file.

Features

AI-Optimized Formats: Formats codebase in XML, Markdown, or Plain Text for easy AI understanding and processing.
Git-Aware: Automatically respects .gitignore files during processing.
Security-Focused: Incorporates Secretlint for robust security checks to detect and prevent inclusion of sensitive information.
Token Counting: Provides token counts for each file and the entire repository, useful for managing LLM context limits.
CLI and Docker Support: Usable as a command-line tool (installable via npm, yarn, Homebrew, or runnable with npx) or via Docker for flexible integration.
Code Compression: Utilizes Tree-sitter to intelligently extract essential code signatures and structure while removing implementation details, significantly reducing token usage.
Customization: Allows persistent settings through a `repomix.config.json` file for output format, file inclusion/exclusion, and other processing options.
Remote Repository Processing: Can pack remote repositories directly from GitHub URLs, including specific branches or commits.

Use Cases

Submitting entire codebases to AI assistants for comprehensive review.
Refactoring code with the help of AI analysis.
Generating code with AI, including multiple interdependent files.
Analyzing remote repositories without needing to clone them locally.
Preparing code for Large Language Models (LLMs) while managing token limits.
Securely sharing codebase snippets with AI by automatically checking for sensitive information.

FAQs

What output formats does Repomix support?

Repomix supports XML (default), Markdown, and Plain text formats for packaging your codebase.
How can I use Repomix without installing it?

You can use Repomix instantly in your project directory without installation by running `npx repomix` in your terminal.
Can Repomix process remote repositories?

Yes, Repomix can pack remote repositories using the `--remote` flag followed by the repository URL (e.g., from GitHub).
How does Repomix help with security when packing code?

Repomix incorporates Secretlint, which performs robust security checks to detect and prevent the inclusion of sensitive information in the output.
Is it possible to customize Repomix's behavior for my project?

Yes, you can create a `repomix.config.json` file in your project to define persistent settings such as output style, custom file path, comment removal, line numbers, and custom ignore patterns.