^{Special thanks to:}

### [Warp, the agent terminal for developers](https://www.warp.dev/repomix) [Available for MacOS, Linux, & Windows](https://www.warp.dev/repomix)

Pack your codebase into AI-friendly formats

Use Repomix online! 👉 repomix.com

Need discussion? Join us on Discord!
Share your experience and tips
Stay updated on new features
Get help with configuration and usage

[![npm](https://img.shields.io/npm/v/repomix.svg?maxAge=1000)](https://www.npmjs.com/package/repomix) [![npm](https://img.shields.io/npm/d18m/repomix)](https://www.npmjs.com/package/repomix) [![Actions Status](https://github.com/yamadashy/repomix/actions/workflows/ci.yml/badge.svg)](https://github.com/yamadashy/repomix/actions?query=workflow%3A"ci") [![codecov](https://codecov.io/github/yamadashy/repomix/graph/badge.svg)](https://codecov.io/github/yamadashy/repomix) [![Sponsors](https://img.shields.io/github/sponsors/yamadashy?logo=github)](https://github.com/sponsors/yamadashy) [![Discord](https://badgen.net/discord/online-members/wNYzTwZFku?icon=discord&label=discord)](https://discord.gg/wNYzTwZFku) [![DeepWiki](https://img.shields.io/badge/DeepWiki-yamadashy%2Frepomix-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/yamadashy/repomix) 📦 Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. It is perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more. [![Sponsors](https://cdn.jsdelivr.net/gh/yamadashy/sponsor-list/sponsors/sponsors.png)](https://github.com/sponsors/yamadashy) ## 🏆 Open Source Awards Nomination We're honored! Repomix has been nominated for the **Powered by AI** category at the [JSNation Open Source Awards 2025](https://osawards.com/javascript/). This wouldn't have been possible without all of you using and supporting Repomix. Thank you! If Repomix has helped you analyze or pack codebases for AI tools, we'd be grateful for your vote in the **Powered by AI** category. ## 🎉 New: Repomix Website & Discord Community! - Try Repomix in your browser at [repomix.com](https://repomix.com/) - Join our [Discord Server](https://discord.gg/wNYzTwZFku) for support and discussion **We look forward to seeing you there!** ## 🌟 Features - **AI-Optimized**: Formats your codebase in a way that's easy for AI to understand and process. - **Token Counting**: Provides token counts for each file and the entire repository, useful for LLM context limits. - **Simple to Use**: You need just one command to pack your entire repository. - **Customizable**: Easily configure what to include or exclude. - **Git-Aware**: Automatically respects your `.gitignore` files and `.git/info/exclude`. - **Security-Focused**: Incorporates [Secretlint](https://github.com/secretlint/secretlint) for robust security checks to detect and prevent inclusion of sensitive information. - **Code Compression**: The `--compress` option uses [Tree-sitter](https://github.com/tree-sitter/tree-sitter) to extract key code elements, reducing token count while preserving structure. ## 🚀 Quick Start ### Using the CLI Tool `>_` You can try Repomix instantly in your project directory without installation: ```bash npx repomix ``` Or install globally for repeated use: ```bash # Install using npm npm install -g repomix # Alternatively using yarn yarn global add repomix # Alternatively using bun bun add -g repomix # Alternatively using Homebrew (macOS/Linux) brew install repomix # Then run in any project directory repomix ``` That's it! Repomix will generate a `repomix-output.xml` file in your current directory, containing your entire repository in an AI-friendly format. You can then send this file to an AI assistant with a prompt like: ``` This file contains all the files in the repository combined into one. I want to refactor the code, so please review it first. ``` ![Repomix File Usage 1](website/client/src/public/images/docs/repomix-file-usage-1.png) When you propose specific changes, the AI might be able to generate code accordingly. With features like Claude's Artifacts, you could potentially output multiple files, allowing for the generation of multiple interdependent pieces of code. ![Repomix File Usage 2](website/client/src/public/images/docs/repomix-file-usage-2.png) Happy coding! 🚀 ### Using The Website 🌐 Want to try it quickly? Visit the official website at [repomix.com](https://repomix.com). Simply enter your repository name, fill in any optional details, and click the **Pack** button to see your generated output. #### Available Options The website offers several convenient features: - Customizable output format (XML, Markdown, or Plain Text) - Instant token count estimation - Much more! ### Using The Browser Extension 🧩 Get instant access to Repomix directly from any GitHub repository! Our Chrome extension adds a convenient "Repomix" button to GitHub repository pages. ![Repomix Browser Extension](website/client/src/public/images/docs/browser-extension.png) #### Install - Chrome Extension: [Repomix - Chrome Web Store](https://chromewebstore.google.com/detail/repomix/fimfamikepjgchehkohedilpdigcpkoa) - Firefox Add-on: [Repomix - Firefox Add-ons](https://addons.mozilla.org/firefox/addon/repomix/) #### Features - One-click access to Repomix for any GitHub repository - More exciting features coming soon! ### Using The VSCode Extension ⚡️ A community-maintained VSCode extension called [Repomix Runner](https://marketplace.visualstudio.com/items?itemName=DorianMassoulier.repomix-runner) (created by [massdo](https://github.com/massdo)) lets you run Repomix right inside your editor with just a few clicks. Run it on any folder, manage outputs seamlessly, and control everything through VSCode's intuitive interface. Want your output as a file or just the content? Need automatic cleanup? This extension has you covered. Plus, it works smoothly with your existing repomix.config.json. Try it now on the [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=DorianMassoulier.repomix-runner)! Source code is available on [GitHub](https://github.com/massdo/repomix-runner). ### Alternative Tools 🛠️ If you're using Python, you might want to check out `Gitingest`, which is better suited for Python ecosystem and data science workflows: https://github.com/cyclotruc/gitingest ## 📊 Usage To pack your entire repository: ```bash repomix ``` To pack a specific directory: ```bash repomix path/to/directory ``` To pack specific files or directories using [glob patterns](https://github.com/mrmlnc/fast-glob?tab=readme-ov-file#pattern-syntax): ```bash repomix --include "src/**/*.ts,**/*.md" ``` To exclude specific files or directories: ```bash repomix --ignore "**/*.log,tmp/" ``` To pack a remote repository: ```bash repomix --remote https://github.com/yamadashy/repomix # You can also use GitHub shorthand: repomix --remote yamadashy/repomix # You can specify the branch name, tag, or commit hash: repomix --remote https://github.com/yamadashy/repomix --remote-branch main # Or use a specific commit hash: repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695 # Another convenient way is specifying the branch's URL repomix --remote https://github.com/yamadashy/repomix/tree/main # Commit's URL is also supported repomix --remote https://github.com/yamadashy/repomix/commit/836abcd7335137228ad77feb28655d85712680f1 ``` To compress the output: ```bash repomix --compress # You can also use it with remote repositories: repomix --remote yamadashy/repomix --compress ``` To initialize a new configuration file (`repomix.config.json`): ```bash repomix --init ``` Once you have generated the packed file, you can use it with Generative AI tools like ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more. ### Docker Usage 🐳 You can also run Repomix using Docker. This is useful if you want to run Repomix in an isolated environment or prefer using containers. Basic usage (current directory): ```bash docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix ``` To pack a specific directory: ```bash docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix path/to/directory ``` Process a remote repository and output to a `output` directory: ```bash docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote https://github.com/yamadashy/repomix ``` ### Prompt Examples Once you have generated the packed file with Repomix, you can use it with AI tools like ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more. Here are some example prompts to get you started: #### Code Review and Refactoring For a comprehensive code review and refactoring suggestions: ``` This file contains my entire codebase. Please review the overall structure and suggest any improvements or refactoring opportunities, focusing on maintainability and scalability. ``` #### Documentation Generation To generate project documentation: ``` Based on the codebase in this file, please generate a detailed README.md that includes an overview of the project, its main features, setup instructions, and usage examples. ``` #### Test Case Generation For generating test cases: ``` Analyze the code in this file and suggest a comprehensive set of unit tests for the main functions and classes. Include edge cases and potential error scenarios. ``` #### Code Quality Assessment Evaluate code quality and adherence to best practices: ``` Review the codebase for adherence to coding best practices and industry standards. Identify areas where the code could be improved in terms of readability, maintainability, and efficiency. Suggest specific changes to align the code with best practices. ``` #### Library Overview Get a high-level understanding of the library ``` This file contains the entire codebase of library. Please provide a comprehensive overview of the library, including its main purpose, key features, and overall architecture. ``` Feel free to modify these prompts based on your specific needs and the capabilities of the AI tool you're using. ### Community Discussion Check out our [community discussion](https://github.com/yamadashy/repomix/discussions/154) where users share: - Which AI tools they're using with Repomix - Effective prompts they've discovered - How Repomix has helped them - Tips and tricks for getting the most out of AI code analysis Feel free to join the discussion and share your own experiences! Your insights could help others make better use of Repomix. ### Output File Format Repomix generates a single file with clear separators between different parts of your codebase. To enhance AI comprehension, the output file begins with an AI-oriented explanation, making it easier for AI models to understand the context and structure of the packed repository. #### XML Format (default) The XML format structures the content in a hierarchical manner: ```xml This file is a merged representation of the entire codebase, combining all repository files into a single document. (Metadata and usage AI instructions) src/ cli/ cliOutput.ts index.ts (...remaining directories) // File contents here (...remaining files) (Custom instructions from `output.instructionFilePath`) ``` For those interested in the potential of XML tags in AI contexts: https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/use-xml-tags > When your prompts involve multiple components like context, instructions, and examples, XML tags can be a > game-changer. They help Claude parse your prompts more accurately, leading to higher-quality outputs. This means that the XML output from Repomix is not just a different format, but potentially a more effective way to feed your codebase into AI systems for analysis, code review, or other tasks. #### Markdown Format To generate output in Markdown format, use the `--style markdown` option: ```bash repomix --style markdown ``` The Markdown format structures the content in a hierarchical manner: ````markdown This file is a merged representation of the entire codebase, combining all repository files into a single document. # File Summary (Metadata and usage AI instructions) # Repository Structure ``` src/ cli/ cliOutput.ts index.ts ``` (...remaining directories) # Repository Files ## File: src/index.js ``` // File contents here ``` (...remaining files) # Instruction (Custom instructions from `output.instructionFilePath`) ```` This format provides a clean, readable structure that is both human-friendly and easily parseable by AI systems. #### Plain Text Format To generate output in plain text format, use the `--style plain` option: ```bash repomix --style plain ``` ```text This file is a merged representation of the entire codebase, combining all repository files into a single document. ================================================================ File Summary ================================================================ (Metadata and usage AI instructions) ================================================================ Directory Structure ================================================================ src/ cli/ cliOutput.ts index.ts config/ configLoader.ts (...remaining directories) ================================================================ Files ================================================================ ================ File: src/index.js ================ // File contents here ================ File: src/utils.js ================ // File contents here (...remaining files) ================================================================ Instruction ================================================================ (Custom instructions from `output.instructionFilePath`) ``` ### Command Line Options #### Basic Options - `-v, --version`: Show tool version #### Output Options - `-o, --output `: Specify the output file name - `--stdout`: Output to stdout instead of writing to a file (cannot be used with `--output` option) - `--style