Repomix

Repomix 是一款将代码库打包为 AI 友好格式的工具，支持本地和远程仓库处理，提供代码压缩、安全检查和多种输出格式。它能够通过智能提取核心代码结构减少令牌数量，提高处理效率，并内置敏感信息检测机制，确保代码的安全性。Repomix 既可作为 CLI 工具使用，也可作为 Node.js 库集成到项目中。

核心功能

Repomix 提供了多种核心功能，使其成为处理代码仓库的强大工具：

• 本地与远程仓库处理：支持扫描本地目录或通过 Git 协议克隆远程仓库，适用于 GitHub 等平台。
• 代码压缩：通过智能提取核心代码结构减少令牌数量，提高处理效率。
• 安全检查：内置敏感信息检测机制，确保代码在处理过程中不泄露敏感数据。
• 多种输出格式：支持 XML、JSON 和文本格式，便于不同场景下的使用。
• 与 AI 工具集成：通过 MCP 协议，Repomix 可以与 AI 工具无缝协作，实现代码审查、测试生成等自动化任务。

安装方法

Repomix 可以通过 npm 安装，具体步骤如下：

npm install repomix

安装完成后，即可在命令行中使用 `repomix` 命令。

使用方法

Repomix 提供了丰富的命令行参数和 API 接口，支持灵活的使用方式。

基本命令

repomix --input <目录> [--output <文件名>] [--format <格式>]

例如，处理当前目录并输出为 `result.xml`：

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

远程仓库处理

Repomix 支持远程仓库的处理，例如从 GitHub 克隆仓库并进行分析。

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

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

文件处理流程

Repomix 提供了完整的文件处理流程，包括文件搜索、收集和处理。

import { searchFiles, collectFiles } from 'repomix';

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

Token 计数器

Repomix 还提供了 Token 计数器，用于统计代码中的 Token 数量。

import { TokenCounter } from 'repomix';

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

使用场景

Repomix 适用于多种开发场景，包括但不限于：

• 代码审查：利用 AI 工具对整个代码库进行全面审查。
• 测试用例生成：根据现有代码生成全面的单元测试套件。
• 代码优化：通过 AI 分析代码结构，提出性能优化建议。
• 自动化文档生成：将代码库转换为结构化文档，便于维护和分享。

注意事项

在使用 Repomix 时，需要注意以下几点：

• 确保安装所有必需的依赖包，包括 `repomix` 及其依赖。
• 处理远程仓库时，需确保有访问权限。
• 对于大规模代码库，建议启用压缩功能以减少存储空间。
• 可以通过配置文件禁用安全检查，例如设置 `security.enableSecurityCheck` 为 `false`。

总结

Repomix 是一款功能丰富、灵活易用的代码库打包工具，能够有效提升与 AI 工具协作的效率。无论是本地还是远程仓库，Repomix 都能提供高效的处理方式，适用于代码审查、测试生成等多种开发场景。