Repomix

https://github.com/yamadashy/repomix
Admin
Repomix packs your entire codebase into a single, AI-friendly file, perfect for feeding to Large...
Tokens:94,338
Snippets:809
Trust Score:9.3
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Setup memory benchmark environment

Source: https://github.com/yamadashy/repomix/blob/main/scripts/memory/README.md

Navigate to the memory benchmark directory and install dependencies.

```bash
cd scripts/memory
npm install
```

--------------------------------

### Verify Installation with Example Prompts

Source: https://github.com/yamadashy/repomix/blob/main/llms-install.md

Two example prompts to verify the Repomix MCP server connection after restarting your LLM application. The first packages a local directory, the second fetches and packages a GitHub repository.

```text
Please package the local directory /path/to/project for AI analysis using Repomix.
```

```text
Please fetch and package the GitHub repository yamadashy/repomix for AI analysis.
```

--------------------------------

### Developer Guide Prompt

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/prompt-examples.md

Use with Repomix output to create a developer guide, covering setup, structure, workflow, testing, and troubleshooting.

```text
Create a developer guide covering:
1. Setup instructions
2. Project structure overview
3. Development workflow
4. Testing approach
5. Common troubleshooting steps
```

--------------------------------

### Setup and Development Commands

Source: https://github.com/yamadashy/repomix/blob/main/browser/README.md

Commands to install dependencies, generate icons, and run development mode for Chrome, Firefox, and Edge.

```bash
# Install dependencies
npm install

# Generate icons
npm run generate-icons

# Development mode for Chrome
npm run dev chrome

# Development mode for Firefox
npm run dev firefox

# Development mode for Edge
npm run dev edge
```

--------------------------------

### Clone and install dependencies

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/development/index.md

Set up the Repomix repository locally by cloning it, installing dependencies with npm, and then running the CLI via npm run repomix.

```bash
git clone https://github.com/yamadashy/repomix.git
cd repomix

# Install dependencies
npm install

# Run CLI
npm run repomix
```

--------------------------------

### .repomixignore example

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/configuration.md

Example of a .repomixignore file in the project root. It follows the same format as .gitignore and defines Repomix-specific ignore patterns. The example excludes cache directories, build outputs, and log files.

```text
# Cache directories
.cache/
tmp/

# Build outputs
dist/
build/

# Logs
*.log
```

--------------------------------

### Example configuration with all options

Source: https://github.com/yamadashy/repomix/blob/main/README.md

Example configuration file using JSON5 syntax. Shows all available options including input, output, include, ignore, security, and tokenCount settings. Comments and trailing commas are allowed.

```json5
{
  "$schema": "https://repomix.com/schemas/latest/schema.json",
  "input": {
    "maxFileSize": 50000000,
    // Optional: transform matching files with an external command before packing (local CLI only)
    // "processors": [
    //   { "pattern": "**/*.json", "command": "npx @toon-format/cli {file}" }
    // ]
  },
  "output": {
    "filePath": "repomix-output.xml",
    "style": "xml",
    "filePathStyle": "target-relative",
    "parsableStyle": false,
    "compress": false,
    // Optional: override the inclusion level per glob (first match wins)
    // "patterns": [
    //   { "pattern": "docs/**/*", "compress": true },
    //   { "pattern": "website/**/*", "directoryStructureOnly": true }
    // ],
    "headerText": "Custom header information for the packed file.",
    "fileSummary": true,
    "directoryStructure": true,
    "files": true,
    "removeComments": false,
    "removeEmptyLines": false,
    "topFilesLength": 5,
    "tokenCountTree": false, // or true, or a number like 10 for minimum token threshold
    // "tokenBudget": 180000, // optional: fail when the packed output exceeds this many tokens
    "showLineNumbers": false,
    "truncateBase64": false,
    "copyToClipboard": false,
    // "splitOutput": 1000000, // optional: split output into multiple ~1MB files
    "includeEmptyDirectories": false,
    "git": {
      "sortByChanges": true,
      "sortByChangesMaxCommits": 100,
      "includeDiffs": false,
      "includeLogs": false,
      "includeLogsCount": 50
    }
  },
  "include": ["**/*"],
  "ignore": {
    "useGitignore": true,
    "useDefaultPatterns": true,
    // Patterns can also be specified in .repomixignore
    "customPatterns": [
      "additional-folder",
      "**/*.log"
    ],
  },
  "security": {
    "enableSecurityCheck": true
  },
  "tokenCount": {
    "encoding": "o200k_base"
  }
}
```

--------------------------------

### file_system_read_file and file_system_read_directory example

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/mcp-server.md

Example usage of the file_system_read_file and file_system_read_directory tools, available only in sandbox mode (--sandbox).

```typescript
// Reading a file
const fileContent = await tools.file_system_read_file({
  path: 'src/index.ts'
});

// Listing directory contents
const dirContent = await tools.file_system_read_directory({
  path: 'src'
});
```

--------------------------------

### Complete repomix.config.json example

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/configuration.md

A full example configuration file showing all available options, including input, output, include, ignore, security, and tokenCount settings. Note that commented-out sections show optional processors and patterns.

```json
{
  "$schema": "https://repomix.com/schemas/latest/schema.json",
  "input": {
    "maxFileSize": 50000000,
    // "processors": [
    //   { "pattern": "**/*.json", "command": "npx @toon-format/cli {file}" }
    // ]
  },
  "output": {
    "filePath": "repomix-output.xml",
    "style": "xml",
    "filePathStyle": "target-relative",
    "parsableStyle": false,
    "compress": false,
    "headerText": "Custom header information for the packed file.",
    "fileSummary": true,
    "directoryStructure": true,
    "files": true,
    "removeComments": false,
    "removeEmptyLines": false,
    "topFilesLength": 5,
    "showLineNumbers": false,
    // "patterns": [
    //   { "pattern": "docs/**/*", "compress": true },
    //   { "pattern": "website/**/*", "directoryStructureOnly": true }
    // ],
    "truncateBase64": false,
    "copyToClipboard": false,
    "includeEmptyDirectories": false,
    "git": {
      "sortByChanges": true,
      "sortByChangesMaxCommits": 100,
      "includeDiffs": false,
      "includeLogs": false,
      "includeLogsCount": 50
    }
  },
  "include": ["**/*"],
  "ignore": {
    "useGitignore": true,
    "useDefaultPatterns": true,
    // Patterns can also be specified in .repomixignore
    "customPatterns": [
      "additional-folder",
      "**/*.log"
    ],
  },
  "security": {
    "enableSecurityCheck": true
  },
  "tokenCount": {
    "encoding": "o200k_base"
  }
}
```

--------------------------------

### Install Repomix Explorer skill for specific agents

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/repomix-explorer-skill.md

Targets a specific assistant by passing the --agent flag. The examples show installing for Codex and OpenClaw.

```bash
npx skills add yamadashy/repomix --skill repomix-explorer --agent codex
npx skills add yamadashy/repomix --skill repomix-explorer --agent openclaw
```

--------------------------------

### Example references/project-structure.md

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/agent-skills-generation.md

Example content of references/project-structure.md, showing a directory tree with line counts per file.

```text
src/
  index.ts (42 lines)
  utils/
    helpers.ts (128 lines)
    math.ts (87 lines)
```

--------------------------------

### Release note example v0.2.25

Source: https://github.com/yamadashy/repomix/blob/main/repomix-instruction.md

Example release note for v0.2.25, demonstrating formatting with improvements, special thanks, and update instructions.

```markdown
This release brings significant improvements to output formatting and introduces flexible remote repository handling capabilities along with enhanced logging features.

# Improvements ⚡

## Remote Repository Enhancement (#335)
- Added branch/tag parsing directly from repository URLs:
```bash
repomix --remote https://github.com/yamadashy/repomix/tree/0.1.x
```
Functions identically to:
```bash
repomix --remote https://github.com/yamadashy/repomix --remote-branch 0.1.x
```

Special thanks to @huy-trn for implementing this user-friendly feature!

## Enhanced Output Formatting (#328, #329, #330)
- Added "End of Codebase" marker for better clarity in output
- Improved output header accuracy:
  - Better representation of codebase scope
  - Clear indication when using `--include` or `--ignore` options

Special thanks to @gitkenan for adding the "End of Codebase" marker and reporting the header issue!

## Path Pattern Support (#337)
- Added support for special characters in paths:
  - Handles parentheses in include patterns (e.g., `src/(categories)/**/*`)
  - Improved escaping for `[]` and `{}`
  - Essential for Next.js route groups and similar frameworks

Thank you @matheuscoelhomalta for improving path pattern support!

# How to Update

```bash
npm update -g repomix
```

---

As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support.
```

--------------------------------

### Release note example v0.2.24

Source: https://github.com/yamadashy/repomix/blob/main/repomix-instruction.md

Example release note for v0.2.24, demonstrating formatting with new features, improvements, and update instructions.

```markdown
This release significantly enhances configuration flexibility with comprehensive CLI flag support and expands default ignore patterns for better project scaffolding. 

# What's New 🚀

## CLI Flags Revolution (#324)
- New command-line configuration now available.

```
- `--no-gitignore`: Disable .gitignore file usage
- `--no-default-patterns`: Disable default patterns
- `--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
```

Special recognition to @massdo for driving ecosystem growth.

# Improvements ⚡

## Enhanced Ignore Patterns (#318, #322)
- Expanded default ignores for Rust projects:
  - `target/`, `Cargo.lock`, build artifacts
  - PHP, Ruby, Go, Elixir, Haskell: package manager lock files

To @boralg for helping curate Rust-specific patterns!

# How to Update
```bash
npm update -g repomix
```

---

As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support.
```

--------------------------------

### TypeScript configuration example

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/configuration.md

Example repomix.config.ts using defineConfig with output and ignore options.

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

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

--------------------------------

### Token Count Tree Output Example

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/usage.md

Example output of the token count tree, showing token counts per directory.

```text
🔢 Token Count Tree:
────────────────────
└── src/ (70,925 tokens)
    ├── cli/ (12,714 tokens)
    │   ├── actions/ (7,546 tokens)
    │   └── reporters/ (990 tokens)
    └── core/ (41,600 tokens)
        ├── file/ (10,098 tokens)
        └── output/ (5,808 tokens)
```

--------------------------------

### Run website development server

Source: https://github.com/yamadashy/repomix/blob/main/CONTRIBUTING.md

Starts the VitePress website development server. Requires Docker to be installed. The website is accessible at http://localhost:5173/.

```bash
# Prerequisites: Docker must be installed on your system

# Start the website development server
npm run website

# Access the website at http://localhost:5173/
```

--------------------------------

### Install Repomix Plugins

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/claude-code-plugins.md

Installs the three official Repomix plugins: repomix-mcp (recommended foundation), repomix-commands (slash commands), and repomix-explorer (AI-powered analysis).

```text
# 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
```

--------------------------------

### README.md - usage instructions

Source: https://github.com/yamadashy/repomix/blob/main/tests/integration-tests/fixtures/packager/outputs/simple-project-output.md

Provides project description and usage instructions, including the npm start command.

```markdown
# Simple Project

This is a simple project used for testing Repomix.

## Usage

To run the project:

```
npm start
```

This will output a greeting message to the console.
```

--------------------------------

### Example file processor commands

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/configuration.md

Example processor commands paired with suitable patterns. Each command must write transformed content to standard output and the tool must be available on PATH; npx-based commands download the tool on first use. Since the first matching pattern wins, apply only one processor per file.

```bash
jq -c . {file}
```

```bash
npx @toon-format/cli {file}
```

```bash
npx svgo -i {file} -o -
```

```bash
jupyter nbconvert --to script --stdout {file}
```

--------------------------------

### Run project with npm start

Source: https://github.com/yamadashy/repomix/blob/main/tests/integration-tests/fixtures/packager/inputs/simple-project/README.md

Use this command to run the project. It will output a greeting message to the console.

```bash
npm start
```

--------------------------------

### read_repomix_output example

Source: https://github.com/yamadashy/repomix/blob/main/llms-install.md

Example JSON for reading a Repomix output file, specifying outputId and optional startLine/endLine for partial reading.

```json
{
  "outputId": "8f7d3b1e2a9c6054",
  "startLine": 100,
  "endLine": 200
}
```

--------------------------------

### attach_packed_output tool parameters example

Source: https://github.com/yamadashy/repomix/blob/main/llms-install.md

Example parameters for the attach_packed_output tool. The path is required and can be a directory containing repomix-output.xml or a direct path to the XML file; topFilesLength defaults to 10.

```json
{
  "path": "/path/to/directory/with/repomix-output.xml",
  "topFilesLength": 10
}
```

--------------------------------

### pack_codebase tool example parameters

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/mcp-server.md

Example parameters for the pack_codebase tool. With compress: true as the catch-all, files under src/core/ are kept at full content, docs/ files are listed in the directory structure only, and everything else is compressed.

```json
{
  "directory": "/path/to/your/project",
  "compress": true,
  "includePatterns": "src/**/*.ts,**/*.md",
  "ignorePatterns": "**/*.log,tmp/",
  "outputPatterns": [
    { "pattern": "src/core/**" },
    { "pattern": "docs/**/*", "directoryStructureOnly": true }
  ],
  "topFilesLength": 10
}
```

--------------------------------

### Example custom instruction markdown file

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/custom-instructions.md

Example markdown file (e.g., repomix-instruction.md) containing custom instructions. Its content is included in the output under the "Instruction" section.

```markdown
# Repository Instructions

This repository contains the source code for the Repomix tool. Please follow these guidelines when analyzing the code:

1. Focus on the core functionality in the `src/core` directory.
2. Pay special attention to the security checks in `src/core/security`.
3. Ignore any files in the `tests` directory.
```

--------------------------------

### JSON output structure example

Source: https://github.com/yamadashy/repomix/blob/main/README.md

Example structure of the JSON output produced by Repomix, showing the top-level keys and their purposes.

```json
{
  "fileSummary": {
    "generationHeader": "This file is a merged representation of the entire codebase, combined into a single document by Repomix.",
    "purpose": "This file contains a packed representation of the entire repository's contents...",
    "fileFormat": "The content is organized as follows...",
    "usageGuidelines": "- This file should be treated as read-only...",
    "notes": "- Some files may have been excluded based on .gitignore, .ignore, and .repomixignore rules..."
  },
  "userProvidedHeader": "Custom header text if specified",
  "directoryStructure": "src/\n  cli/\n    cliOutput.ts\n    index.ts\n  config/\n    configLoader.ts",
  "files": {
    "src/index.js": "// File contents here",
    "src/utils.js": "// File contents here"
  },
  "instruction": "Custom instructions from instructionFilePath"
}
```

--------------------------------

### pack_codebase tool parameters example

Source: https://github.com/yamadashy/repomix/blob/main/llms-install.md

Example parameters for the pack_codebase tool. The directory is required; compress defaults to false, includePatterns and ignorePatterns use fast-glob patterns, and topFilesLength defaults to 10.

```json
{
  "directory": "/path/to/your/project",
  "compress": false,
  "includePatterns": "src/**/*.ts,**/*.md",
  "ignorePatterns": "**/*.log,tmp/",
  "topFilesLength": 10
}
```

--------------------------------

### Install Repomix globally with npm, yarn, pnpm, bun, or Homebrew

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/installation.md

Install Repomix globally using your preferred package manager. Choose one command based on your environment.

```bash
npm install -g repomix
```

```bash
yarn global add repomix
```

```bash
pnpm add -g repomix
```

```bash
bun add -g repomix
```

```bash
brew install repomix
```

--------------------------------

### Common repomix command examples

Source: https://github.com/yamadashy/repomix/blob/main/skills/repomix-explorer/SKILL.md

Common repomix command examples: basic remote pack, basic local pack, specific directory, large repo with --compress, and include patterns. The --compress option reduces tokens by ~70% for large repos.

```bash
# Basic remote pack (always use /tmp)
npx repomix@latest --remote yamadashy/repomix --output /tmp/repomix-analysis.xml

# Basic local pack
npx repomix@latest

# Pack specific directory
npx repomix@latest ./src

# Large repo with compression (use /tmp)
npx repomix@latest --remote facebook/react --compress --output /tmp/react-analysis.xml

# Include only specific file types
npx repomix@latest --include "**/*.{ts,tsx,js,jsx}"
```

--------------------------------

### Plain text output structure example

Source: https://github.com/yamadashy/repomix/blob/main/README.md

Example structure of the plain text output produced by Repomix, showing the sections for file summary, directory structure, files, and instructions.

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

--------------------------------

### package.json - project configuration

Source: https://github.com/yamadashy/repomix/blob/main/tests/integration-tests/fixtures/packager/outputs/simple-project-output.md

Defines the simple-project package with metadata, main entry, and start script.

```json
{
  "name": "simple-project",
  "version": "1.0.0",
  "description": "A simple project for testing Repomix",
  "main": "src/index.js",
  "scripts": {
    "start": "node src/index.js"
  },
  "keywords": ["simple", "test"],
  "author": "Test Author",
  "license": "MIT"
}
```

--------------------------------

### Library Overview Prompt

Source: https://github.com/yamadashy/repomix/blob/main/README.md

Use this prompt to get a high-level understanding of the library from the packed codebase.

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

--------------------------------

### Use repomix-explorer commands

Source: https://github.com/yamadashy/repomix/blob/main/README.md

Example usage of the repomix-explorer plugin: analyze a local codebase or a remote GitHub repository using natural language queries.

```text
/repomix-explorer:explore-local ./src
Find all authentication-related code

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

--------------------------------

### Use repomix-commands slash commands

Source: https://github.com/yamadashy/repomix/blob/main/README.md

Example usage of the repomix-commands plugin: pack the local codebase as markdown with compression, or pack only TypeScript files from a remote GitHub repository.

```text
/repomix-commands:pack-local
Pack this project as markdown with compression

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

--------------------------------

### Security check CLI output

Source: https://github.com/yamadashy/repomix/blob/main/README.md

Example CLI output shown after packing when the security check finds suspicious files. Lists each detected file and advises reviewing them for sensitive information.

```text
🔍 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.
```

--------------------------------

### Update repomix globally

Source: https://github.com/yamadashy/repomix/blob/main/README.md

Commands to update a globally installed repomix using npm, yarn, or bun. Using npx repomix is generally more convenient as it always uses the latest version.

```bash
npm update -g repomix
```

```bash
yarn global upgrade repomix
```

```bash
bun update -g repomix
```

--------------------------------

### Initialize configuration file

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/index.md

Create a repomix.config.json file with default settings.

```bash
repomix --init
```

--------------------------------

### Interactive Plugin Installation

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/claude-code-plugins.md

Opens the interactive plugin installer in Claude Code, allowing you to browse and install available plugins.

```text
/plugin
```

--------------------------------

### Install Repomix

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/development/using-repomix-as-a-library.md

Install Repomix as a dependency in your Node.js project.

```bash
npm install repomix
```

--------------------------------

### Quick Start: Run Repomix with npx

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/index.md

Run this command in your project directory to pack the repository into a single AI-friendly file. It outputs a `repomix-output.xml` file.

```bash
npx repomix@latest
```

--------------------------------

### Set up Repomix for local development

Source: https://github.com/yamadashy/repomix/blob/main/CONTRIBUTING.md

Clones the repository, changes into the project directory, and installs dependencies. Required before running Repomix locally.

```bash
git clone https://github.com/yamadashy/repomix.git
cd repomix
npm install
```

--------------------------------

### Verify Repomix installation

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/installation.md

Check that Repomix is installed correctly by displaying its version and help information.

```bash
repomix --version
repomix --help
```

--------------------------------

### Example references/files.md

Source: https://github.com/yamadashy/repomix/blob/main/website/client/src/en/guide/agent-skills-generation.md

Example content of references/files.md, showing a markdown file with a syntax-highlighted code block for each source file.

```markdown
## File: src/index.ts
```typescript
import { sum } from './utils/helpers';

export function main() {
  console.log(sum(1, 2));
}
```
```

--------------------------------

### Start the website development server

Source: https://github.com/yamadashy/repomix/blob/main/website/README.md

Runs the development server for the Repomix website. Access the site at http://localhost:5173/.

```bash
# Start the website development server
npm run website

# Access the website at http://localhost:5173/
```
Tokens:
Raw