Repomix is a tool that packs your codebase into AI-friendly formats, making it easier to analyze your code with large language models like Claude, ChatGPT, and others. It converts your entire repository into a single structured file that's optimized for AI processing.
You can use Repomix without installation:
npx repomix@latest
Or install it globally:
# Using npm
npm install -g repomix
# Using yarn
yarn global add repomix
# Using bun
bun add -g repomix
# Using Homebrew (macOS/Linux)
brew install repomix
Running Repomix in your project directory will generate an AI-friendly file:
repomix
This creates a repomix-output.xml
file containing your entire repository in a structured format.
Process a specific directory:
repomix path/to/directory
Include only specific files using glob patterns:
repomix --include "src/**/*.ts,**/*.md"
Exclude specific files:
repomix --ignore "**/*.log,tmp/"
Pack a remote GitHub repository:
# Using full URL
repomix --remote https://github.com/yamadashy/repomix
# Using GitHub shorthand
repomix --remote yamadashy/repomix
# Specify branch or commit
repomix --remote yamadashy/repomix --remote-branch main
Reduce token count while preserving structure:
repomix --compress
Choose between different output formats:
# XML format (default)
repomix --style xml
# Markdown format
repomix --style markdown
# Plain text format
repomix --style plain
Process files from a file list via stdin:
# Using find command
find src -name "*.ts" -type f | repomix --stdin
# Using git to get tracked files
git ls-files "*.ts" | repomix --stdin
Run Repomix in Docker:
# Current directory
docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix
# Remote repository
docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote yamadashy/repomix
Create a configuration file:
repomix --init
This generates a repomix.config.json
file with customizable options for:
Run Repomix as a Model Context Protocol (MCP) server:
repomix --mcp
This allows AI assistants to directly interact with your codebase. You can configure MCP servers in VS Code, Cline, Cursor, Claude Desktop, or Claude Code.
Once you've generated the packed file, send it to an AI tool 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.
Example prompt types:
To add this MCP server to Claude Code, run this command in your terminal:
claude mcp add-json "repomix" '{"command":"npx","args":["-y","repomix","--mcp"]}'
See the official Claude Code MCP documentation for more details.
There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json
file so that it is available in all of your projects.
If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json
file.
To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".
When you click that button the ~/.cursor/mcp.json
file will be opened and you can add your server like this:
{
"mcpServers": {
"repomix": {
"command": "npx",
"args": [
"-y",
"repomix",
"--mcp"
]
}
}
}
To add an MCP server to a project you can create a new .cursor/mcp.json
file or add it to the existing one. This will look exactly the same as the global MCP server example above.
Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.
The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.
You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.
To add this MCP server to Claude Desktop:
1. Find your configuration file:
~/Library/Application Support/Claude/claude_desktop_config.json
%APPDATA%\Claude\claude_desktop_config.json
~/.config/Claude/claude_desktop_config.json
2. Add this to your configuration file:
{
"mcpServers": {
"repomix": {
"command": "npx",
"args": [
"-y",
"repomix",
"--mcp"
]
}
}
}
3. Restart Claude Desktop for the changes to take effect