Repomix

Warp, built for coding with multiple AI agents

Available for MacOS, Linux, & Windows

Tuple, the premier screen sharing app for developers on macOS and Windows.

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

Please consider sponsoring me.

🏆 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!

Related MCP server: medRxiv-MCP-Server

🎉 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, .ignore, and .repomixignore files.

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

Or install globally for repeated use:

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:

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:

To pack a specific directory:

To pack specific files or directories using glob patterns:

To exclude specific files or directories:

To pack a remote repository:

To pack files from a file list (pipe via 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.

To include git logs in the output:

The git logs include commit dates, messages, and file paths for each commit, providing valuable context for AI analysis of code evolution and development patterns.

To compress the output:

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

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

To pack a specific directory:

Process a remote repository and output to a output directory:

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:

Documentation Generation

To generate project documentation:

Test Case Generation

For generating test cases:

Code Quality Assessment

Evaluate code quality and adherence to best practices:

Library Overview

Get a high-level understanding of the library

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:

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:

The Markdown format structures the content in a hierarchical manner:

This format provides a clean, readable structure that is both human-friendly and easily parseable by AI systems.

JSON Format

To generate output in JSON format, use the --style json option:

The JSON format structures the content as a hierarchical JSON object with camelCase property names:

This format is ideal for:

• Programmatic processing: Easy to parse and manipulate with JSON libraries

• API integration: Direct consumption by web services and applications

• AI tool compatibility: Structured format for machine learning and AI systems

• Data analysis: Straightforward extraction of specific information using tools like jq

Working with JSON Output Using jq

The JSON format makes it easy to extract specific information programmatically:

Plain Text Format

To generate output in plain text format, use the --style plain option:

Command Line Options

Basic Options

• -v, --version: Show version information and exit

CLI Input/Output Options

• --verbose: Enable detailed debug logging (shows file processing, token counts, and configuration details)

• --quiet: Suppress all console output except errors (useful for scripting)

• --stdout: Write packed output directly to stdout instead of a file (suppresses all logging)

• --stdin: Read file paths from stdin, one per line (specified files are processed directly)

• --copy: Copy the generated output to system clipboard after processing

• --token-count-tree [threshold]: Show file tree with token counts; optional threshold to show only files with ≥N tokens (e.g., --token-count-tree 100)

• --top-files-len <number>: Number of largest files to show in summary (default: 5, e.g., --top-files-len 20)

Repomix Output Options

• -o, --output <file>: Output file path (default: repomix-output.xml, use "-" for stdout)

• --style <style>: Output format: xml, markdown, json, or plain (default: xml)

• --parsable-style: Escape special characters to ensure valid XML/Markdown (needed when output contains code that breaks formatting)

• --compress: Extract essential code structure (classes, functions, interfaces) using Tree-sitter parsing

• --output-show-line-numbers: Prefix each line with its line number in the output

• --no-file-summary: Omit the file summary section from output

• --no-directory-structure: Omit the directory tree visualization from output

• --no-files: Generate metadata only without file contents (useful for repository analysis)

• --remove-comments: Strip all code comments before packing

• --remove-empty-lines: Remove blank lines from all files

• --truncate-base64: Truncate long base64 data strings to reduce output size

• --header-text <text>: Custom text to include at the beginning of the output

• --instruction-file-path <path>: Path to file containing custom instructions to include in output

• --include-empty-directories: Include folders with no files in directory structure

• --include-full-directory-structure: Show complete directory tree in output, including files not matched by --include patterns

• --no-git-sort-by-changes: Don't sort files by git change frequency (default: most changed files first)

• --include-diffs: Add git diff section showing working tree and staged changes

• --include-logs: Add git commit history with messages and changed files

• --include-logs-count <count>: Number of recent commits to include with --include-logs (default: 50)

File Selection Options

• --include <patterns>: Include only files matching these glob patterns (comma-separated, e.g., "src/**/.js,.md")

• -i, --ignore <patterns>: Additional patterns to exclude (comma-separated, e.g., "*.test.js,docs/**")

• --no-gitignore: Don't use .gitignore rules for filtering files

• --no-dot-ignore: Don't use .ignore rules for filtering files

• --no-default-patterns: Don't apply built-in ignore patterns (node_modules, .git, build dirs, etc.)

Remote Repository Options

• --remote <url>: Clone and pack a remote repository (GitHub URL or user/repo format)

• --remote-branch <name>: Specific branch, tag, or commit to use (default: repository's default branch)

Configuration Options

• -c, --config <path>: Use custom config file instead of repomix.config.json

• --init: Create a new repomix.config.json file with defaults

• --global: With --init, create config in home directory instead of current directory

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)

MCP

• --mcp: Run as Model Context Protocol server for AI tool integration

Agent Skills Generation

• --skill-generate [name]: Generate Claude Agent Skills format output to .claude/skills/<name>/ directory (name auto-generated if omitted)

Examples

Updating Repomix

To update a globally installed 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:

You can also use GitHub's shorthand format:

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

Or use a specific commit hash:

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.

For example, this code:

Will be compressed to:

Token Count Optimization

Understanding your codebase's token distribution is crucial for optimizing AI interactions. Use the --token-count-tree option to visualize token usage across your project:

This displays a hierarchical view of your codebase with token counts:

You can also set a minimum token threshold to focus on larger files:

This helps you:

• Identify token-heavy files that might exceed AI context limits

• Optimize file selection using --include and --ignore patterns

• Plan compression strategies by targeting the largest contributors

• Balance content vs. context when preparing code for AI analysis

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.

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:

For VS Code Insiders:

For Cline (VS Code extension):

Edit the cline_mcp_settings.json file:

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:

Alternatively, you can use the official Repomix plugins (see Claude Code Plugins section below).

Using Docker instead of npx:

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

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, .ignore, and built-in exclusions.

  • topFilesLength: (Optional, default: 10) Number of largest files by size to display in the metrics summary for codebase analysis.

2. attach_packed_output: Attach an existing Repomix packed output file for AI analysis

• Parameters:

  • path: Path to a directory containing repomix-output.xml or direct path to a packed repository XML file

  • topFilesLength: (Optional, default: 10) Number of largest files by size to display in the metrics summary

• Features:

  • Accepts either a directory containing a repomix-output.xml file or a direct path to an XML file

  • Registers the file with the MCP server and returns the same structure as the pack_codebase tool

  • Provides secure access to existing packed outputs without requiring re-processing

  • Useful for working with previously generated packed repositories

3. 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, .ignore, and built-in exclusions.

  • topFilesLength: (Optional, default: 10) Number of largest files by size to display in the metrics summary for codebase analysis.

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

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

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

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

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:

2. Install plugins:

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

• Search through packed outputs

• Read files with built-in security scanning (Secretlint)

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

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:

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

• Security Built-in: Automatic Secretlint scanning prevents sensitive data exposure

• Token Optimization: Tree-sitter compression for large codebases

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

Agent Skills Generation

Repomix can generate Claude Agent Skills format output, creating a structured Skills directory that can be used as a reusable codebase reference for AI assistants. This feature is particularly powerful when you want to reference implementations from remote repositories.

Basic Usage

When you run the command, Repomix prompts you to choose where to save the Skills:

1. Personal Skills (~/.claude/skills/) - Available across all projects on your machine

2. Project Skills (.claude/skills/) - Shared with your team via git

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-stack.md: Auto-detected tech stack 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:

⚙️ 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:

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:

Example:

Benefits:

• ✅ Full TypeScript type checking in your IDE

• ✅ Excellent IDE autocomplete and IntelliSense

• ✅ Use dynamic values (timestamps, environment variables, etc.)

Dynamic Values Example:

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:

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

Schema Validation

You can enable schema validation for your configuration file by adding the $schema property:

This provides auto-completion and validation in editors that support JSON schema.

Example Configuration

Example configuration:

Global Configuration

To create a global configuration file:

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.

• .ignore: You can use a .ignore file in your project root, following the same format as .gitignore. This file is respected by tools like ripgrep and the silver searcher, reducing the need to maintain multiple ignore files. This behavior can be controlled with the ignore.useDotIgnore setting or the --no-dot-ignore 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. Ignore files (.repomixignore, .ignore, .gitignore, and .git/info/exclude):

   • When in nested directories, files in deeper directories have higher priority

   • When in the same directory, these files are merged in no particular order

3. 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:

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

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:

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

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

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

Use --style to generate output in different formats:

Pack specific directories with compression:

Upload the output file as an artifact:

Complete workflow example:

See the complete workflow example here.

Action Inputs

Action Outputs

📚 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

Basic Usage

Process Remote Repository

Using Core Components

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

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

See our Privacy Policy.

📜 License

This project is licensed under the MIT License.