Repomix

🚀 Repomix Usage Guide

Repomix is a powerful tool that can be used as a CLI command-line tool or a Node.js library. It can handle local and remote code repositories and offers various output formats.

🚀 Quick Start

Installation

npm install repomix

Basic Command

repomix --input <directory> [--output <filename>] [--format <format>]

Example

Process the current directory and output as result.xml:

repomix . --output result.xml --format xml

✨ Features

1. Multiple File Processing Modes

• Local Mode: Scan the current directory and its subdirectories to generate reports in the specified format.
• Remote Mode: Clone a remote repository via the Git protocol and then process it.

2. Support for Multiple Output Formats

• XML
• JSON
• Text (default)

3. Compression Function

Support compressing the generated files for easy storage and transmission.

📦 Installation

Install the Tool

npm install repomix

💻 Usage Examples

Basic Usage

repomix --input <directory> [--output <filename>] [--format <format>]

Example

repomix . --output result.xml --format xml

📚 Documentation

Configuration Options

1. Common Parameters

• --input or -i: Specify the input directory or file path.
• --output or -o: Specify the output file name, default is repomix-output.txt.
• --format or -f: Specify the output format, supports txt, xml, json.
• --compress or -c: Enable the compression function, default is false.

2. Advanced Options

• --style: Specify the output style (only for text format), supports plain and markdown.
• --quiet or -q: Disable terminal output and only generate files.

Core Components

1. File Search and Collection

import { searchFiles, collectFiles } from 'repomix';

async function processFiles(directory) {
  const files = await searchFiles(directory);
  const collected = await collectFiles(files);
  return collected;
}

2. File Processing Flow

import { processFiles } from 'repomix';

async function handleFiles(filePaths, directory) {
  const rawFiles = await collectFiles(filePaths, directory);
  const processed = await processFiles(rawFiles);
  return processed;
}

3. Token Counter

import { TokenCounter } from 'repomix';

const counter = new TokenCounter('gpt-4');
const tokens = counter.countTokens('Hello World!');

Example Code

Process a Remote Repository

import { runCli, type CliOptions } from 'repomix';

async function processRemoteRepo(url: string) {
  const options: CliOptions = {
    input: url,
    output: 'remote-output.xml',
    format: 'xml',
    compress: true
  };
  await runCli(options);
}

Notes

1. Dependency Management: Ensure all necessary packages, including repomix and its dependencies, are installed.
2. Permission Issues: Ensure you have access permissions when processing remote repositories.
3. Performance Optimization: For large-scale code repositories, it is recommended to enable the compression function to reduce storage space.

Project Contribution

Contribution Guidelines

1. Submit an ISSUE to report issues or propose requirements.
2. Fork the code repository and submit a PR to fix bugs or improve features.
3. Join the community discussion and participate in development decisions.

Repository Address

GitHub | Gitee

📄 License

This project is open-sourced under the MIT license:

Copyright (c) 2023 Repomix Development Team This work is released under the MIT license, allowing free use, modification, and distribution.

Appendix

• Document Historical Versions
• FAQ
• Change Log