项目简介:

Repomix是一个多功能的工具,旨在为AI分析准备您的代码库。它不仅可以将整个仓库打包成单个AI友好的文件,还可以作为MCP服务器运行,使AI工具能够直接访问和处理您的代码上下文。

主要功能点:

  • 代码库打包: 将本地或远程仓库打包成纯文本、XML或Markdown等AI友好的单一文件。
  • MCP服务器功能: 实现模型上下文协议(MCP),为AI客户端提供代码库上下文服务。
  • 资源与工具提供: 提供MCP工具,例如 'pack_codebase' 和 'pack_remote_repository',以便按需打包代码库。
  • 可定制的输出: 支持多种输出格式、过滤选项(包含/排除模式)和代码压缩。
  • 安全检查: 集成Secretlint,用于检测和防止敏感信息泄露。

安装步骤:

  1. 安装 Repomix CLI 工具:
    npm install -g repomix
    或者
    yarn global add repomix

服务器配置 (供MCP客户端使用):

要将MCP客户端(如 Cline 或 Claude Desktop)连接到 Repomix MCP 服务器,请使用以下 JSON 设置配置客户端。您只需要配置服务器的启动命令和参数。

{
  "mcpServers": {
    "repomix": {  // 服务器名称 (您可以自定义名称)
      "command": "npx", // 执行命令
      "args": [       // 命令参数
        "-y",         // (可选) 添加 '-y' 以自动确认 npm 包执行
        "repomix",    // 执行 repomix 包
        "--mcp"      // 以 MCP 服务器模式运行 Repomix
      ]
    }
  }
}

基本使用方法:

  1. 启动 Repomix MCP 服务器: 打开您的终端并运行:
    repomix --mcp
    此命令将启动 Repomix 服务器的 MCP 模式,准备接受来自 MCP 客户端的请求。
  2. 配置 MCP 客户端: 使用上述 JSON 配置,配置您的 MCP 兼容 AI 客户端(例如,VS Code 中的 Cline,Claude Desktop)以连接到 Repomix 服务器。
  3. 使用 AI 助手工具: 在您的 AI 助手内,您现在应该能够使用 Repomix 提供的 MCP 工具,例如 'pack_codebase' 和 'pack_remote_repository',来分析您的本地或远程代码库。有关使用 MCP 工具的具体说明,请参阅您的 AI 客户端的文档。

关键词:

代码库打包, AI上下文, LLM工具, 仓库分析, 上下文服务

信息

分类

开发者工具