---

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

---

📦 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.

🏆 Open Source Awards Nomination

We're honored! Repomix has been nominated for the Powered by AI category at the JSNation Open Source Awards 2025.

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
• Join our Discord Server 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 for robust security checks to detect and prevent inclusion of sensitive information.
• Code Compression: The --compress option uses 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:

1npx repomix@latest

Or install globally for repeated use:

1# Install using npm
2npm install -g repomix
3
4# Alternatively using yarn
5yarn global add repomix
6
7# Alternatively using bun
8bun add -g repomix
9
10# Alternatively using Homebrew (macOS/Linux)
11brew install repomix
12
13# Then run in any project directory
14repomix

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.

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.

Happy coding! 🚀

Using The Website 🌐

Want to try it quickly? Visit the official website at 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.

Install

• Chrome Extension: Repomix - Chrome Web Store
• Firefox Add-on: Repomix - Firefox Add-ons

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 (created by 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! Source code is available on GitHub.

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:

1repomix

To pack a specific directory:

1repomix path/to/directory

To pack specific files or directories using glob patterns:

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

To exclude specific files or directories:

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

To pack a remote repository:

1repomix --remote https://github.com/yamadashy/repomix
2
3# You can also use GitHub shorthand:
4repomix --remote yamadashy/repomix
5
6# You can specify the branch name, tag, or commit hash:
7repomix --remote https://github.com/yamadashy/repomix --remote-branch main
8
9# Or use a specific commit hash:
10repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695
11
12# Another convenient way is specifying the branch's URL
13repomix --remote https://github.com/yamadashy/repomix/tree/main
14
15# Commit's URL is also supported
16repomix --remote https://github.com/yamadashy/repomix/commit/836abcd7335137228ad77feb28655d85712680f1
17

To pack files from a file list (pipe via stdin):

1# Using find command
2find src -name "*.ts" -type f | repomix --stdin
3
4# Using git to get tracked files
5git ls-files "*.ts" | repomix --stdin
6
7# Using grep to find files containing specific content
8grep -l "TODO" **/*.ts | repomix --stdin
9
10# Using ripgrep to find files with specific content
11rg -l "TODO|FIXME" --type ts | repomix --stdin
12
13# Using ripgrep (rg) to find files
14rg --files --type ts | repomix --stdin
15
16# Using sharkdp/fd to find files
17fd -e ts | repomix --stdin
18
19# Using fzf to select from all files
20fzf -m | repomix --stdin
21
22# Interactive file selection with fzf
23find . -name "*.ts" -type f | fzf -m | repomix --stdin
24
25# Using ls with glob patterns
26ls src/**/*.ts | repomix --stdin
27
28# From a file containing file paths
29cat file-list.txt | repomix --stdin
30
31# Direct input with echo
32echo -e "src/index.ts\nsrc/utils.ts" | repomix --stdin

The --stdin option allows you to pipe a list of file paths to Repomix, giving you ultimate flexibility in selecting which files to pack.

When using --stdin, the specified files are effectively added to the include patterns. This means that the normal include and ignore behavior still applies - files specified via stdin will still be excluded if they match ignore patterns.

[!NOTE] When using --stdin, file paths can be relative or absolute, and Repomix will automatically handle path resolution and deduplication.

To compress the output:

1repomix --compress
2
3# You can also use it with remote repositories:
4repomix --remote yamadashy/repomix --compress

To initialize a new configuration file (repomix.config.json):

1repomix --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):

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

To pack a specific directory:

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

Process a remote repository and output to a output directory:

1docker 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 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:

1This file is a merged representation of the entire codebase, combining all repository files into a single document.
2
3<file_summary>
4  (Metadata and usage AI instructions)
5</file_summary>
6
7<directory_structure>
8src/
9cli/
10cliOutput.ts
11index.ts
12
13(...remaining directories)
14</directory_structure>
15
16<files>
17<file path="src/index.js">
18  // File contents here
19</file>
20
21(...remaining files)
22</files>
23
24<instruction>
25(Custom instructions from `output.instructionFilePath`)
26</instruction>

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:

1repomix --style markdown

The Markdown format structures the content in a hierarchical manner:

1This file is a merged representation of the entire codebase, combining all repository files into a single document.
2
3# File Summary
4
5(Metadata and usage AI instructions)
6
7# Repository Structure
8
9```
10src/
11  cli/
12    cliOutput.ts
13    index.ts
14```
15
16(...remaining directories)
17
18# Repository Files
19
20## File: src/index.js
21
22```
23// File contents here
24```
25
26(...remaining files)
27
28# Instruction
29
30(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:

1repomix --style plain

1This file is a merged representation of the entire codebase, combining all repository files into a single document.
2
3================================================================
4File Summary
5================================================================
6(Metadata and usage AI instructions)
7
8================================================================
9Directory Structure
10================================================================
11src/
12  cli/
13    cliOutput.ts
14    index.ts
15  config/
16    configLoader.ts
17
18(...remaining directories)
19
20================================================================
21Files
22================================================================
23
24================
25File: src/index.js
26================
27// File contents here
28
29================
30File: src/utils.js
31================
32// File contents here
33
34(...remaining files)
35
36================================================================
37Instruction
38================================================================
39(Custom instructions from `output.instructionFilePath`)

Command Line Options

Basic Options

• -v, --version: Show tool version

Output Options

• -o, --output <file>: Specify the output file name
• --stdout: Output to stdout instead of writing to a file (cannot be used with --output option)
• --style <style>: Specify the output style (xml, markdown, plain)
• --parsable-style: Enable parsable output based on the chosen style schema. Note that this can increase token count.
• --compress: Perform intelligent code extraction, focusing on essential function and class signatures to reduce token count
• --output-show-line-numbers: Show line numbers in the output
• --copy: Additionally copy generated output to system clipboard
• --no-file-summary: Disable file summary section output
• --no-directory-structure: Disable directory structure section output
• --remove-comments: Remove comments from supported file types
• --remove-empty-lines: Remove empty lines from the output
• --header-text <text>: Custom text to include in the file header
• --instruction-file-path <path>: Path to a file containing detailed custom instructions
• --include-empty-directories: Include empty directories in the output
• --include-diffs: Include git diffs in the output (includes both work tree and staged changes separately)
• --no-git-sort-by-changes: Disable sorting files by git change count (enabled by default)

Filter Options

• --include <patterns>: List of include patterns (comma-separated)
• -i, --ignore <patterns>: Additional ignore patterns (comma-separated)
• --stdin: Read file paths from stdin instead of discovering files automatically
• --no-gitignore: Disable .gitignore file usage
• --no-default-patterns: Disable default patterns

Remote Repository Options

• --remote <url>: Process a remote Git repository
• --remote-branch <name>: Specify the remote branch name, tag, or commit hash (defaults to repository default branch)

Configuration Options

• -c, --config <path>: Path to a custom config file
• --init: Create config file
• --global: Use global config

Security Options

• --no-security-check: Disable security check

Token Count Options

• --token-count-encoding <encoding>: Specify token count encoding used by OpenAI's tiktoken tokenizer (e.g., o200k_base for GPT-4o, cl100k_base for GPT-4/3.5). See tiktoken model.py for encoding details.

MCP

• --mcp: Run as a MCP (Model Context Protocol) server

Other Options

• --top-files-len <number>: Number of top files to display in the summary
• --verbose: Enable verbose logging
• --quiet: Disable all output to stdout

Examples:

1# Basic usage
2repomix
3
4# Custom output
5repomix -o output.xml --style xml
6
7# Output to stdout
8repomix --stdout > custom-output.txt
9
10# Send output to stdout, then pipe into another command (for example, simonw/llm)
11repomix --stdout | llm "Please explain what this code does."
12
13# Custom output with compression
14repomix --compress
15
16# Process specific files
17repomix --include "src/**/*.ts" --ignore "**/*.test.ts"
18
19# Remote repository with branch
20repomix --remote https://github.com/user/repo/tree/main
21
22# Remote repository with commit
23repomix --remote https://github.com/user/repo/commit/836abcd7335137228ad77feb28655d85712680f1
24
25# Remote repository with shorthand
26repomix --remote user/repo

Updating Repomix

To update a globally installed Repomix:

1# Using npm
2npm update -g repomix
3
4# Using yarn
5yarn global upgrade repomix
6
7# Using bun
8bun update -g repomix

Using npx repomix is generally more convenient as it always uses the latest version.

Remote Repository Processing

Repomix supports processing remote Git repositories without the need for manual cloning. This feature allows you to quickly analyze any public Git repository with a single command.

To process a remote repository, use the --remote option followed by the repository URL:

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

You can also use GitHub's shorthand format:

1repomix --remote yamadashy/repomix

You can specify the branch name, tag, or commit hash:

1# Using --remote-branch option
2repomix --remote https://github.com/yamadashy/repomix --remote-branch main
3
4# Using branch's URL
5repomix --remote https://github.com/yamadashy/repomix/tree/main

Or use a specific commit hash:

1# Using --remote-branch option
2repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695
3
4# Using commit's URL
5repomix --remote https://github.com/yamadashy/repomix/commit/836abcd7335137228ad77feb28655d85712680f1

Code Compression

The --compress option utilizes Tree-sitter to perform intelligent code extraction, focusing on essential function and class signatures while removing implementation details. This can help reduce token count while retaining important structural information.

1repomix --compress

For example, this code:

1import { ShoppingItem } from './shopping-item';
2
3/**
4 * Calculate the total price of shopping items
5 */
6const calculateTotal = (
7  items: ShoppingItem[]
8) => {
9  let total = 0;
10  for (const item of items) {
11    total += item.price * item.quantity;
12  }
13  return total;
14}
15
16// Shopping item interface
17interface Item {
18  name: string;
19  price: number;
20  quantity: number;
21}

Will be compressed to:

1import { ShoppingItem } from './shopping-item';
2⋮----
3/**
4 * Calculate the total price of shopping items
5 */
6const calculateTotal = (
7  items: ShoppingItem[]
8) => {
9⋮----
10// Shopping item interface
11interface Item {
12  name: string;
13  price: number;
14  quantity: number;
15}

[!NOTE] This is an experimental feature that we'll be actively improving based on user feedback and real-world usage

MCP Server Integration

Repomix supports the Model Context Protocol (MCP), allowing AI assistants to directly interact with your codebase. When run as an MCP server, Repomix provides tools that enable AI assistants to package local or remote repositories for analysis without requiring manual file preparation.

1repomix --mcp

Configuring MCP Servers

To use Repomix as an MCP server with AI assistants like Claude, you need to configure the MCP settings:

For VS Code:

You can install the Repomix MCP server in VS Code using one of these methods:

1. Using the Install Badge:

2. Using the Command Line:

1code --add-mcp '{"name":"repomix","command":"npx","args":["-y","repomix","--mcp"]}'

For VS Code Insiders:

1code-insiders --add-mcp '{"name":"repomix","command":"npx","args":["-y","repomix","--mcp"]}'

For Cline (VS Code extension):

Edit the cline_mcp_settings.json file:

1{
2  "mcpServers": {
3    "repomix": {
4      "command": "npx",
5      "args": [
6        "-y",
7        "repomix",
8        "--mcp"
9      ]
10    }
11  }
12}

For Cursor:

In Cursor, add a new MCP server from Cursor Settings > MCP > + Add new global MCP server with a configuration similar to Cline.

For Claude Desktop:

Edit the claude_desktop_config.json file with similar configuration to Cline's config.

For Claude Code:

To configure Repomix as an MCP server in Claude Code, use the following command:

1claude mcp add repomix -- npx -y repomix --mcp

Using Docker instead of npx:

You can use Docker as an alternative to npx for running Repomix as an MCP server:

1{
2  "mcpServers": {
3    "repomix-docker": {
4      "command": "docker",
5      "args": [
6        "run",
7        "-i",
8        "--rm",
9        "ghcr.io/yamadashy/repomix",
10        "--mcp"
11      ]
12    }
13  }
14}

Once configured, your AI assistant can directly use Repomix's capabilities to analyze codebases without manual file preparation, making code analysis workflows more efficient.

Available MCP Tools

When running as an MCP server, Repomix provides the following tools:

1. pack_codebase: Package a local code directory into a consolidated XML file for AI analysis

• Parameters:
  • directory: Absolute path to the directory to pack
  • compress: (Optional, default: false) Enable Tree-sitter compression to extract essential code signatures and structure while removing implementation details. Reduces token usage by ~70% while preserving semantic meaning. Generally not needed since grep_repomix_output allows incremental content retrieval. Use only when you specifically need the entire codebase content for large repositories.
  • includePatterns: (Optional) Specify files to include using fast-glob patterns. Multiple patterns can be comma-separated (e.g., "/*.{js,ts}", "src/,docs/**"). Only matching files will be processed.
  • ignorePatterns: (Optional) Specify additional files to exclude using fast-glob patterns. Multiple patterns can be comma-separated (e.g., "test/,*.spec.js", "node_modules/,dist/**"). These patterns supplement .gitignore and built-in exclusions.
  • topFilesLength: (Optional, default: 10) Number of largest files by size to display in the metrics summary for codebase analysis.

2. pack_remote_repository: Fetch, clone, and package a GitHub repository into a consolidated XML file for AI analysis

• Parameters:
  • remote: GitHub repository URL or user/repo format (e.g., "yamadashy/repomix", "https://github.com/user/repo", or "https://github.com/user/repo/tree/branch")
  • compress: (Optional, default: false) Enable Tree-sitter compression to extract essential code signatures and structure while removing implementation details. Reduces token usage by ~70% while preserving semantic meaning. Generally not needed since grep_repomix_output allows incremental content retrieval. Use only when you specifically need the entire codebase content for large repositories.
  • includePatterns: (Optional) Specify files to include using fast-glob patterns. Multiple patterns can be comma-separated (e.g., "/*.{js,ts}", "src/,docs/**"). Only matching files will be processed.
  • ignorePatterns: (Optional) Specify additional files to exclude using fast-glob patterns. Multiple patterns can be comma-separated (e.g., "test/,*.spec.js", "node_modules/,dist/**"). These patterns supplement .gitignore and built-in exclusions.
  • topFilesLength: (Optional, default: 10) Number of largest files by size to display in the metrics summary for codebase analysis.

3. read_repomix_output: Read the contents of a Repomix-generated output file. Supports partial reading with line range specification for large files.

• Parameters:
  • outputId: ID of the Repomix output file to read
  • startLine: (Optional) Starting line number (1-based, inclusive). If not specified, reads from beginning.
  • endLine: (Optional) Ending line number (1-based, inclusive). If not specified, reads to end.
• Features:
  • Specifically designed for web-based environments or sandboxed applications
  • Retrieves the content of previously generated outputs using their ID
  • Provides secure access to packed codebase without requiring file system access
  • Supports partial reading for large files

4. grep_repomix_output: Search for patterns in a Repomix output file using grep-like functionality with JavaScript RegExp syntax

• Parameters:
  • outputId: ID of the Repomix output file to search
  • pattern: Search pattern (JavaScript RegExp regular expression syntax)
  • contextLines: (Optional, default: 0) Number of context lines to show before and after each match. Overridden by beforeLines/afterLines if specified.
  • beforeLines: (Optional) Number of context lines to show before each match (like grep -B). Takes precedence over contextLines.
  • afterLines: (Optional) Number of context lines to show after each match (like grep -A). Takes precedence over contextLines.
  • ignoreCase: (Optional, default: false) Perform case-insensitive matching
• Features:
  • Uses JavaScript RegExp syntax for powerful pattern matching
  • Supports context lines for better understanding of matches
  • Allows separate control of before/after context lines
  • Case-sensitive and case-insensitive search options

5. file_system_read_file: Read a file from the local file system using an absolute path. Includes built-in security validation to detect and prevent access to files containing sensitive information.

• Parameters:
  • path: Absolute path to the file to read
• Security features:
  • Implements security validation using Secretlint
  • Prevents access to files containing sensitive information (API keys, passwords, secrets)
  • Validates absolute paths to prevent directory traversal attacks

6. file_system_read_directory: List the contents of a directory using an absolute path. Returns a formatted list showing files and subdirectories with clear indicators.

• Parameters:
  • path: Absolute path to the directory to list
• Features:
  • Shows files and directories with clear indicators ([FILE] or [DIR])
  • Provides safe directory traversal with proper error handling
  • Validates paths and ensures they are absolute
  • Useful for exploring project structure and understanding codebase organization

⚙️ Configuration

Create a repomix.config.json file in your project root for custom configurations.

1repomix --init

Here's an explanation of the configuration options:

Option	Description	Default
input.maxFileSize	Maximum file size in bytes to process. Files larger than this will be skipped	50000000
output.filePath	The name of the output file	"repomix-output.xml"
output.style	The style of the output (xml, markdown, plain)	"xml"
output.parsableStyle	Whether to escape the output based on the chosen style schema. Note that this can increase token count.	false
output.compress	Whether to perform intelligent code extraction to reduce token count	false
output.headerText	Custom text to include in the file header	null
output.instructionFilePath	Path to a file containing detailed custom instructions	null
output.fileSummary	Whether to include a summary section at the beginning of the output	true
output.directoryStructure	Whether to include the directory structure in the output	true
output.files	Whether to include file contents in the output	true
output.removeComments	Whether to remove comments from supported file types	false
output.removeEmptyLines	Whether to remove empty lines from the output	false
output.showLineNumbers	Whether to add line numbers to each line in the output	false
output.copyToClipboard	Whether to copy the output to system clipboard in addition to saving the file	false
output.topFilesLength	Number of top files to display in the summary. If set to 0, no summary will be displayed	5
output.includeEmptyDirectories	Whether to include empty directories in the repository structure	false
output.git.sortByChanges	Whether to sort files by git change count (files with more changes appear at the bottom)	true
output.git.sortByChangesMaxCommits	Maximum number of commits to analyze for git changes	100
output.git.includeDiffs	Whether to include git diffs in the output (includes both work tree and staged changes separately)	false
include	Patterns of files to include (using glob patterns)	[]
ignore.useGitignore	Whether to use patterns from the project's .gitignore file	true
ignore.useDefaultPatterns	Whether to use default ignore patterns	true
ignore.customPatterns	Additional patterns to ignore (using glob patterns)	[]
security.enableSecurityCheck	Whether to perform security checks on files	true
tokenCount.encoding	Token count encoding used by OpenAI's tiktoken tokenizer (e.g., o200k_base for GPT-4o, cl100k_base for GPT-4/3.5). See tiktoken model.py for encoding details.	"o200k_base"

The configuration file supports JSON5 syntax, which allows:

• Comments (both single-line and multi-line)
• Trailing commas in objects and arrays
• Unquoted property names
• More relaxed string syntax

Example configuration:

1{
2  "input": {
3    "maxFileSize": 50000000
4  },
5  "output": {
6    "filePath": "repomix-output.xml",
7    "style": "xml",
8    "parsableStyle": false,
9    "compress": false,
10    "headerText": "Custom header information for the packed file.",
11    "fileSummary": true,
12    "directoryStructure": true,
13    "files": true,
14    "removeComments": false,
15    "removeEmptyLines": false,
16    "topFilesLength": 5,
17    "showLineNumbers": false,
18    "copyToClipboard": false,
19    "includeEmptyDirectories": false,
20    "git": {
21      "sortByChanges": true,
22      "sortByChangesMaxCommits": 100,
23      "includeDiffs": false
24    }
25  },
26  "include": ["**/*"],
27  "ignore": {
28    "useGitignore": true,
29    "useDefaultPatterns": true,
30    // Patterns can also be specified in .repomixignore
31    "customPatterns": [
32      "additional-folder",
33      "**/*.log"
34    ],
35  },
36  "security": {
37    "enableSecurityCheck": true
38  },
39  "tokenCount": {
40    "encoding": "o200k_base"
41  }
42}

Global Configuration

To create a global configuration file:

1repomix --init --global

The global configuration file will be created in:

• Windows: %LOCALAPPDATA%\Repomix\repomix.config.json
• macOS/Linux: $XDG_CONFIG_HOME/repomix/repomix.config.json or ~/.config/repomix/repomix.config.json

Note: Local configuration (if present) takes precedence over global configuration.

Include and Ignore

Include Patterns

Repomix now supports specifying files to include using glob patterns. This allows for more flexible and powerful file selection:

• Use **/*.js to include all JavaScript files in any directory
• Use src/**/* to include all files within the src directory and its subdirectories
• Combine multiple patterns like ["src/**/*.js", "**/*.md"] to include JavaScript files in src and all Markdown files

Ignore Patterns

Repomix offers multiple methods to set ignore patterns for excluding specific files or directories during the packing process:

• .gitignore: By default, patterns listed in your project's .gitignore files and .git/info/exclude are used. This behavior can be controlled with the ignore.useGitignore setting or the --no-gitignore cli option.
• Default patterns: Repomix includes a default list of commonly excluded files and directories (e.g., node_modules, .git, binary files). This feature can be controlled with the ignore.useDefaultPatterns setting or the --no-default-patterns cli option. Please see defaultIgnore.ts for more details.
• .repomixignore: You can create a .repomixignore file in your project root to define Repomix-specific ignore patterns. This file follows the same format as .gitignore.
• Custom patterns: Additional ignore patterns can be specified using the ignore.customPatterns option in the configuration file. You can overwrite this setting with the -i, --ignore command line option.

Priority Order (from highest to lowest):

1. Custom patterns ignore.customPatterns
2. .repomixignore
3. .gitignore and .git/info/exclude (if ignore.useGitignore is true and --no-gitignore is not used)
4. Default patterns (if ignore.useDefaultPatterns is true and --no-default-patterns is not used)

This approach allows for flexible file exclusion configuration based on your project's needs. It helps optimize the size of the generated pack file by ensuring the exclusion of security-sensitive files and large binary files, while preventing the leakage of confidential information.

Note: Binary files are not included in the packed output by default, but their paths are listed in the "Repository Structure" section of the output file. This provides a complete overview of the repository structure while keeping the packed file efficient and text-based.

Custom Instruction

The output.instructionFilePath option allows you to specify a separate file containing detailed instructions or context about your project. This allows AI systems to understand the specific context and requirements of your project, potentially leading to more relevant and tailored analysis or suggestions.

Here's an example of how you might use this feature:

1. Create a file named repomix-instruction.md in your project root:

1# Coding Guidelines
2
3- Follow the Airbnb JavaScript Style Guide
4- Suggest splitting files into smaller, focused units when appropriate
5- Add comments for non-obvious logic. Keep all text in English
6- All new features should have corresponding unit tests
7
8# Generate Comprehensive Output
9
10- Include all content without abbreviation, unless specified otherwise
11- Optimize for handling large codebases while maintaining output quality

2. In your repomix.config.json, add the instructionFilePath option:

1{
2  "output": {
3    "instructionFilePath": "repomix-instruction.md",
4    // other options...
5  }
6}

When Repomix generates the output, it will include the contents of repomix-instruction.md in a dedicated section.

Note: The instruction content is appended at the end of the output file. This placement can be particularly effective for AI systems. For those interested in understanding why this might be beneficial, Anthropic provides some insights in their documentation:
https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/long-context-tips

Put long-form data at the top: Place your long documents and inputs (~20K+ tokens) near the top of your prompt, above your query, instructions, and examples. This can significantly improve Claude's performance across all models. Queries at the end can improve response quality by up to 30% in tests, especially with complex, multi-document inputs.

Comment Removal

When output.removeComments is set to true, Repomix will attempt to remove comments from supported file types. This feature can help reduce the size of the output file and focus on the essential code content.

Supported languages include:
HTML, CSS, JavaScript, TypeScript, Vue, Svelte, Python, PHP, Ruby, C, C#, Java, Go, Rust, Swift, Kotlin, Dart, Shell, and YAML.

Note: The comment removal process is conservative to avoid accidentally removing code. In complex cases, some comments might be retained.

🔍 Security Check

Repomix includes a security check feature that uses Secretlint to detect potentially sensitive information in your files. This feature helps you identify possible security risks before sharing your packed repository.

The security check results will be displayed in the CLI output after the packing process is complete. If any suspicious files are detected, you'll see a list of these files along with a warning message.

Example output:

🔍 Security Check:
──────────────────
2 suspicious file(s) detected:
1. src/utils/test.txt
2. tests/utils/secretLintUtils.test.ts

Please review these files for potentially sensitive information.

By default, Repomix's security check feature is enabled. You can disable it by setting security.enableSecurityCheck to false in your configuration file:

1{
2  "security": {
3    "enableSecurityCheck": false
4  }
5}

Or using the --no-security-check command line option:

1repomix --no-security-check

[!NOTE] Disabling security checks may expose sensitive information. Use this option with caution and only when necessary, such as when working with test files or documentation that contains example credentials.

🤖 Using Repomix with GitHub Actions

You can also use Repomix in your GitHub Actions workflows. This is useful for automating the process of packing your codebase for AI analysis.

Basic usage:

1- name: Pack repository with Repomix
2  uses: yamadashy/repomix/.github/actions/repomix@main
3  with:
4    output: repomix-output.xml
5    style: xml

Use --style to generate output in different formats:

1- name: Pack repository with Repomix
2  uses: yamadashy/repomix/.github/actions/repomix@main
3  with:
4    output: repomix-output.md
5    style: markdown

Pack specific directories with compression:

1- name: Pack repository with Repomix
2  uses: yamadashy/repomix/.github/actions/repomix@main
3  with:
4    directories: src tests
5    include: "**/*.ts,**/*.md"
6    ignore: "**/*.test.ts"
7    output: repomix-output.txt
8    compress: true

Upload the output file as an artifact:

1- name: Pack repository with Repomix
2  uses: yamadashy/repomix/.github/actions/repomix@main
3  with:
4    directories: src
5    output: repomix-output.txt
6    compress: true
7
8- name: Upload Repomix output
9  uses: actions/upload-artifact@v4
10  with:
11    name: repomix-output
12    path: repomix-output.txt

Complete workflow example:

1name: Pack repository with Repomix
2
3on:
4  workflow_dispatch:
5  push:
6    branches: [ main ]
7  pull_request:
8    branches: [ main ]
9
10jobs:
11  pack-repo:
12    runs-on: ubuntu-latest
13    steps:
14      - name: Checkout code
15        uses: actions/checkout@v4
16
17      - name: Pack repository with Repomix
18        uses: yamadashy/repomix/.github/actions/repomix@main
19        with:
20          output: repomix-output.xml
21
22      - name: Upload Repomix output
23        uses: actions/upload-artifact@v4
24        with:
25          name: repomix-output.xml
26          path: repomix-output.xml
27          retention-days: 30

See the complete workflow example here.

Action Inputs

Name	Description	Default
directories	Space-separated list of directories to process (e.g., src tests docs)	.
include	Comma-separated glob patterns to include files (e.g., **/*.ts,**/*.md)	""
ignore	Comma-separated glob patterns to ignore files (e.g., **/*.test.ts,**/node_modules/**)	""
output	Relative path for the packed file (extension determines format: .txt, .md, .xml)	repomix-output.xml
compress	Enable smart compression to reduce output size by pruning implementation details	true
style	Output style (xml, markdown, plain)	xml
additional-args	Extra raw arguments for the repomix CLI (e.g., --no-file-summary --no-security-check)	""
repomix-version	Version of the npm package to install (supports semver ranges, tags, or specific versions like 0.2.25)	latest

Action Outputs

Name	Description
output_file	Path to the generated output file. Can be used in subsequent steps for artifact upload, LLM processing, or other operations. The file contains a formatted representation of your codebase based on the specified options.

📚 Using Repomix as a Library

In addition to using Repomix as a CLI tool, you can also use it as a library in your Node.js applications.

Installation

1npm install repomix

Basic Usage

1import { runCli, type CliOptions } from 'repomix';
2
3// Process current directory with custom options
4async function packProject() {
5  const options = {
6    output: 'output.xml',
7    style: 'xml',
8    compress: true,
9    quiet: true
10  } as CliOptions;
11  
12  const result = await runCli(['.'], process.cwd(), options);
13  return result.packResult;
14}

Process Remote Repository

1import { runCli, type CliOptions } from 'repomix';
2
3// Clone and process a GitHub repo
4async function processRemoteRepo(repoUrl) {
5  const options = {
6    remote: repoUrl,
7    output: 'output.xml',
8    compress: true
9  } as CliOptions;
10  
11  return await runCli(['.'], process.cwd(), options);
12}

Using Core Components

If you need more control, you can use the low-level APIs:

1import { searchFiles, collectFiles, processFiles, TokenCounter } from 'repomix';
2
3async function analyzeFiles(directory) {
4  // Find and collect files
5  const { filePaths } = await searchFiles(directory, { /* config */ });
6  const rawFiles = await collectFiles(filePaths, directory);
7  const processedFiles = await processFiles(rawFiles, { /* config */ });
8  
9  // Count tokens
10  const tokenCounter = new TokenCounter('o200k_base');
11  
12  // Return analysis results
13  return processedFiles.map(file => ({
14    path: file.path,
15    tokens: tokenCounter.countTokens(file.content)
16  }));
17}

For more examples, check the source code at website/server/src/remoteRepo.ts which demonstrates how repomix.com uses the library.

🤝 Contribution

We welcome contributions from the community! To get started, please refer to our Contributing Guide.

Contributors

🔒 Privacy Policy

Repomix CLI Tool

• Data Collection: The Repomix CLI tool does not collect, transmit, or store any user data, telemetry, or repository information.
• Network Usage: Repomix CLI operates fully offline after installation. The only cases where an internet connection is needed are:
  • Installation via npm/yarn.
  • Using the --remote flag to process remote repositories.
  • Checking for updates (manually triggered).
• Security Considerations: Since all processing is local, Repomix CLI is safe to use with private and internal repositories.

Repomix Website (repomix.com)

• Data Collection: The Repomix website uses Google Analytics to collect usage data, such as page views and user interactions. This helps us understand how the website is used and improve the user experience.
• File Processing: When uploading ZIP files or folders, your files are temporarily stored on our servers for processing. All uploaded files and processed data are automatically deleted immediately after processing is complete.

Repomix Browser Extension

• Data Collection: The Repomix browser extension does not collect, transmit, or store any user data, telemetry, or repository information.
• Permissions: The extension only requires minimal permissions necessary to add the Repomix button to GitHub repository pages. It does not access or modify repository data.

Liability Disclaimer

Repomix (the CLI tool, website, and browser extension) is provided "as is" without any warranties or guarantees.
We do not take responsibility for how the generated output is used, including but not limited to its accuracy, legality, or any potential consequences arising from its use.

📜 License

This project is licensed under the MIT License.

    Back To Top