Repomix仓库打包工具

Install using npm

npm install -g repomix

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

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

To pack a specific directory:

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

Process a remote repository and output to a output directory:

docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote https://github.com/yamadashy/repomix

Install MCP server plugin (recommended foundation)

/plugin install repomix-mcp@repomix

Install commands plugin (extends functionality)

/plugin install repomix-commands@repomix

Install repository explorer plugin (AI-powered analysis)

/plugin install repomix-explorer@repomix

**Note**: The `repomix-mcp` plugin is recommended as a foundation. The `repomix-commands` plugin provides convenient slash commands, while `repomix-explorer` adds AI-powered analysis capabilities. While you can install them independently, using all three provides the most comprehensive experience.

**Alternatively, use the interactive plugin installer:**

This will open an interactive interface where you can browse and install available plugins.

#### Available Plugins

**1. repomix-mcp** (MCP Server Plugin)

Foundation plugin that provides AI-powered codebase analysis through MCP server integration.

**Features:**
- Pack local and remote repositories
- Read and search packed outputs
- Automatic Tree-sitter compression (~70% token reduction)

**2. repomix-commands** (Slash Commands Plugin)

Provides convenient slash commands for quick operations with natural language support.

**Available Commands:**
- `/repomix-commands:pack-local` - Pack local codebase with various options
- `/repomix-commands:pack-remote` - Pack and analyze remote GitHub repositories

**Example usage:**

/repomix-commands:pack-remote yamadashy/repomix Pack only TypeScript files from the yamadashy/repomix repository

**3. repomix-explorer** (AI Analysis Agent Plugin)

AI-powered repository analysis agent that intelligently explores codebases using Repomix CLI.

**Features:**
- Natural language codebase exploration and analysis
- Intelligent pattern discovery and code structure understanding
- Incremental analysis using grep and targeted file reading
- Automatic context management for large repositories

**Available Commands:**
- `/repomix-explorer:explore-local` - Analyze local codebase with AI assistance
- `/repomix-explorer:explore-remote` - Analyze remote GitHub repositories with AI assistance

**Example usage:**

/repomix-explorer:explore-remote facebook/react Show me the main component architecture ```

The agent automatically: 1. Runs npx repomix@latest to pack the repository 2. Uses Grep and Read tools to efficiently search the output 3. Provides comprehensive analysis without consuming excessive context

Benefits

• Seamless Integration: Claude can directly analyze codebases without manual preparation
• Natural Language: Use conversational commands instead of remembering CLI syntax
• Always Latest: Automatically uses npx repomix@latest for up-to-date features
• Secret Scanning: Secretlint flags files matching known credential formats so they are left out of the output
• Token Optimization: Tree-sitter compression for large codebases

For more details, see the plugin documentation in the .claude/plugins/ directory.

🚀 Quick Start

📊 Usage

To pack your entire repository:

repomix

To pack a specific directory:

repomix path/to/directory

To pack specific files or directories using glob patterns:

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

To exclude specific files or directories:

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

To pack a remote repository:

```bash 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.

Basic usage

repomix

Send output to stdout, then pipe into another command (for example, simonw/llm)

repomix --stdout | llm "Please explain what this code does."

Full non-interactive example

repomix --remote user/repo --skill-generate my-skill --skill-output ./output --force

#### Generated Structure

The Skills are generated with the following structure:

#### What's Included

- **SKILL.md**: Contains Skills metadata, file/line/token counts, overview, and usage instructions
- **summary.md**: Explains the Skills' purpose, usage guidelines, and provides statistics breakdown by file type and language
- **project-structure.md**: Directory tree with line counts per file for easy file discovery
- **files.md**: All file contents with syntax highlighting headers, optimized for grep-friendly searching
- **tech-stacks.md**: Auto-detected tech stack per package from dependency files (`package.json`, `requirements.txt`, `Cargo.toml`, etc.)

#### Auto-Generated Skills Names

If no name is provided, Repomix auto-generates one:

#### Integration with Repomix Features

Skills generation respects all standard Repomix options:

Command Line Options

#### Basic Options - -v, --version: Show version information and exit

CLI Input/Output Options

Repomix Output Options

File Selection Options

Remote Repository Options

Configuration Options

#### Security Options - --no-security-check: Skip scanning for sensitive data like API keys and passwords

#### Token Count Options - --token-count-encoding <encoding>: Tokenizer model for counting: o200k_base (GPT-4o), cl100k_base (GPT-3.5/4), etc. (default: o200k_base) - --token-budget <number>: Fail with a non-zero exit code when the packed output exceeds N tokens. Useful as a guard in CI pipelines and agent workflows to keep output within a target model's context window. The output is still generated; only the exit code signals the overflow.

#### MCP - --mcp: Run as Model Context Protocol server for AI tool integration - --sandbox [dir]: (with --mcp) confine the MCP server's file tools to a workspace directory (defaults to the working directory; e.g. --sandbox path/to/project) — every path is relative to that root, absolute/host paths are refused, and remote packing, skill generation, and attaching external outputs are disabled.

Agent Skills Generation

#### Watch Mode - -w, --watch: Watch for file changes and automatically re-pack. Debounces rapid changes (300ms) and logs a timestamp on each rebuild. Stop with Ctrl+C.

Watch mode only works with local directories, so it cannot be combined with --remote, a positional remote repository URL, --stdout, --stdin, --split-output, --skill-generate, or --copy (whether set on the command line or in your config file).

Examples

```bash

Using --remote-branch option

repomix --remote https://github.com/yamadashy/repomix --remote-branch main

Using --remote-branch option

repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695

⚙️ Configuration

Repomix supports multiple configuration file formats for flexibility and ease of use.

Configuration File Formats

Repomix will automatically search for configuration files in the following priority order:

1. TypeScript (repomix.config.ts, repomix.config.mts, repomix.config.cts)
2. JavaScript/ES Module (repomix.config.js, repomix.config.mjs, repomix.config.cjs)
3. JSON (repomix.config.json5, repomix.config.jsonc, repomix.config.json)

JSON Configuration

Create a repomix.config.json file in your project root:

repomix --init

This will create a repomix.config.json file with default settings.

TypeScript Configuration

TypeScript configuration files provide the best developer experience with full type checking and IDE support.

Installation:

To use TypeScript or JavaScript configuration with defineConfig, you need to install Repomix as a dev dependency:

npm install -D repomix

Example:

// repomix.config.ts
import { defineConfig } from 'repomix';

export default defineConfig({
  output: {
    filePath: 'output.xml',
    style: 'xml',
    removeComments: true,
  },
  ignore: {
    customPatterns: ['**/node_modules/**', '**/dist/**'],
  },
});

Benefits: - ✅ Full TypeScript type checking in your IDE - ✅ Excellent IDE autocomplete and IntelliSense - ✅ Use dynamic values (timestamps, environment variables, etc.)

Dynamic Values Example:

// repomix.config.ts
import { defineConfig } from 'repomix';

// Generate timestamp-based filename
const timestamp = new Date().toISOString().slice(0, 19).replace(/[:.]/g, '-');

export default defineConfig({
  output: {
    filePath: `output-${timestamp}.xml`,
    style: 'xml',
  },
});

JavaScript Configuration

JavaScript configuration files work the same as TypeScript, supporting defineConfig and dynamic values.

Configuration Options

Here's an explanation of the configuration options:

Using the CLI Tool `>_`

You can try Repomix instantly in your project directory without installation:

npx repomix@latest

Or install globally for repeated use:

```bash

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.

Find files by extension

cat repomix-output.json | jq -r '.files | keys[] | select(endswith(".ts"))'

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.

repomix --mcp

Sandbox Mode

By default the MCP server can read any path the host user can. That is convenient for a trusted local assistant, but too broad when the server is exposed to an untrusted client or agent. The --sandbox flag confines the server's file tools to a single workspace directory:

```bash

Claude Code Plugins

Repomix provides official plugins for Claude Code that integrate seamlessly with the AI-powered development environment.

Installation

1. Add the Repomix plugin marketplace:

/plugin marketplace add yamadashy/repomix

2. Install plugins:

```text

Alternatively using yarn

yarn global add repomix

Alternatively using bun

bun add -g repomix

Alternatively using Homebrew (macOS/Linux)

brew install repomix

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