Repomix is a powerful tool that allows you to package your entire codebase into a single, AI-friendly file. This makes it easy to feed your code to large language models (LLMs) like Claude, ChatGPT, DeepSeek, or Gemini for analysis and assistance.
There are several ways to install and use Repomix:
Run Repomix in your project directory without installation:
npx repomix@latest
Install Repomix globally for repeated use:
# 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
Run Repomix in a Docker container:
# Current directory
docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix
# Specific directory
docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix path/to/directory
# Remote repository
docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote https://github.com/yamadashy/repomix
To pack your entire repository into a single file:
repomix
This will generate a repomix-output.xml
file in your current directory, which you can then send to an AI assistant for analysis.
# Pack a specific directory
repomix path/to/directory
# Pack specific files using glob patterns
repomix --include "src/**/*.ts,**/*.md"
# Exclude specific files or directories
repomix --ignore "**/*.log,tmp/"
# Using a full URL
repomix --remote https://github.com/yamadashy/repomix
# Using GitHub shorthand
repomix --remote yamadashy/repomix
# Specifying a branch
repomix --remote yamadashy/repomix --remote-branch main
# Using find command
find src -name "*.ts" -type f | repomix --stdin
# Using git to get tracked files
git ls-files "*.ts" | repomix --stdin
# Using ripgrep to find files with specific content
rg -l "TODO|FIXME" --type ts | repomix --stdin
To reduce token count while preserving structure:
repomix --compress
Repomix supports three output formats:
repomix --style xml
repomix --style markdown
repomix --style plain
Create a configuration file in your project root:
repomix --init
This creates a repomix.config.json
file that lets you customize:
You can also create a global configuration file:
repomix --init --global
Repomix includes built-in security checks to prevent accidental exposure of sensitive information:
# Disable security check (use with caution)
repomix --no-security-check
Repomix can function as a Model Context Protocol (MCP) server, allowing AI assistants to directly interact with your codebase:
repomix --mcp
This enables AI tools to perform repository analysis without requiring manual file preparation.
Some commonly used options:
# Specify output file
repomix -o output.xml
# Output to stdout
repomix --stdout
# Copy to clipboard
repomix --copy
# Remove comments
repomix --remove-comments
# Include git diffs
repomix --include-diffs
# Using npm
npm update -g repomix
# Using yarn
yarn global upgrade repomix
# Using bun
bun update -g repomix
Using npx repomix
will always use the latest version.
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