Repomix 的 Claude Code 官方插件:MCP 服务器、Slash 命令与 AI 仓库探索实战指南
【免费下载链接】repomix📦 Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. 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.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix
Repomix 为 Claude Code 提供了官方插件,让开发者可以直接在 AI 编程环境中用自然语言完成代码库分析与打包。本文将完整介绍三个插件的安装流程、能力边界与真实命令,并结合本仓库中插件源码(.claude-plugin/marketplace.json、.claude/plugins)逐条拆解其底层实现,帮助你掌握从"本地目录打包"到"远程仓库 AI 探索"的完整工作流。
一、插件总览:三个插件分别解决什么问题
Repomix 在 .claude-plugin/marketplace.json 中注册了三个插件,它们各司其职、可以独立安装也可以组合使用:
| 插件 | 类型 | 核心能力 |
|---|---|---|
repomix-mcp | integration | 通过 MCP 服务器集成提供 AI 代码库分析,是推荐的基础组件 |
repomix-commands | productivity | 提供便捷的 Slash 命令,支持自然语言打包本地/远程仓库 |
repomix-explorer | productivity | AI 分析代理,用 Repomix CLI 智能探索代码库 |
从源码看,repomix-mcp被定位为"地基":它负责把整个仓库打包成单个 AI 友好文件并对外提供搜索、读取能力;repomix-commands在这之上提供人性化的命令入口;repomix-explorer则进一步把"打包 + grep + 定向阅读"封装成一套智能分析流程。三者的关系正如文档中的提示(tip)所述:可以独立安装,但三者齐全才能获得最完整的体验。
二、安装步骤:从添加市场到安装插件
1. 添加 Repomix 插件市场
在 Claude Code 中执行:
/plugin marketplace add yamadashy/repomix该命令将本仓库根目录的.claude-plugin目录注册为插件市场。仓库中的 marketplace.json 定义了市场元数据(名称repomix、所有者yamadashy、版本1.0.2),并声明了三个插件的源码位置与分类。
2. 安装三个插件
# 安装 MCP 服务器插件(推荐的基础组件) /plugin install repomix-mcp@repomix # 安装命令插件(扩展功能) /plugin install repomix-commands@repomix # 安装仓库探索插件(AI 分析) /plugin install repomix-explorer@repomix其中@repomix后缀表示从名为repomix的市场拉取。
3. 替代方式:交互式安装
你也可以直接输入:
/plugin这会打开交互式安装界面,在其中浏览并勾选安装可用插件,效果与逐条命令安装相同。
三、插件详解与源码实现
1. repomix-mcp:MCP 服务器插件
这是基础插件,通过 MCP 服务器集成提供 AI 代码库分析能力,核心功能包括:
- 打包本地与远程仓库
- 在打包后的输出文件中搜索
- 读取生成的输出文件
- 自动启用 Tree-sitter 压缩(约减少 70% token)
从本仓库源码看,MCP 服务器的具体工具实现位于 src/mcp/tools 目录,包括packCodebaseTool(打包代码库)、packRemoteRepositoryTool(打包远程仓库)、grepRepomixOutputTool(在输出中 grep)、readRepomixOutputTool(读取输出)与attachPackedOutputTool(附加打包结果)等,对应上述能力的底层实现。服务器的入口定义在 src/mcp/mcpServer.ts。
2. repomix-commands:Slash 命令插件
该插件在 .claude/plugins/repomix-commands/commands 中定义了三条核心能力所对应的两条命令:
/repomix-commands:pack-local— 以多种选项打包本地代码库/repomix-commands:pack-remote— 打包并分析远程 GitHub 仓库
pack-local 的实现逻辑
根据 pack-local.md,该命令的工作方式是:解析用户自然语言意图 → 决定打包目录、输出格式、是否压缩、文件过滤模式等 → 执行npx repomix@latest [directory] [options]。
它支持的底层选项包括:
| 选项 | 作用 |
|---|---|
--style <format> | 输出格式:xml(默认)、markdown、json、plain |
--include <patterns> | 仅包含匹配的文件,如"src/**/*.ts,**/*.md" |
--ignore <patterns> | 追加忽略模式 |
--compress | 启用 Tree-sitter 压缩(约减少 70% token) |
--output <path> | 自定义输出路径 |
--copy | 将输出复制到剪贴板 |
--include-diffs | 包含 git diff 输出 |
--include-logs | 包含 git 提交历史 |
命令源码还给出了一组典型映射示例:
# "Pack this codebase" npx repomix@latest # "Pack the src directory" npx repomix@latest src/ # "Pack as markdown with compression" npx repomix@latest --style markdown --compress # "Pack only TypeScript and Markdown files" npx repomix@latest --include "src/**/*.ts,**/*.md" # "Pack and copy to clipboard" npx repomix@latest --copy # "Pack with git history" npx repomix@latest --include-diffs --include-logspack-remote 的实现逻辑
根据 pack-remote.md,远程打包命令执行npx repomix@latest --remote <repo> [options],并支持以下仓库格式:
owner/repo(如yamadashy/repomix)https://github.com/owner/repohttps://github.com/owner/repo/tree/branch-name(指定分支)https://github.com/owner/repo/commit/hash(指定提交)
# "Pack yamadashy/repomix" npx repomix@latest --remote yamadashy/repomix # "Pack the develop branch of user/repo" npx repomix@latest --remote https://github.com/user/repo/tree/develop # "Pack microsoft/vscode with compression" npx repomix@latest --remote microsoft/vscode --compress # "Pack only TypeScript files from owner/repo" npx repomix@latest --remote owner/repo --include "src/**/*.ts"3. repomix-explorer:AI 分析代理插件
这是三款插件中最"智能"的一个,其代理定义在 .claude/plugins/repomix-explorer/agents/explorer.md,提供两条命令:
/repomix-explorer:explore-local— AI 辅助分析本地代码库/repomix-explorer:explore-remote— AI 辅助分析远程 GitHub 仓库
核心能力:
- 自然语言探索与分析代码库
- 智能发现模式、理解代码结构
- 使用 grep 与定向文件读取进行增量分析
- 针对大型仓库自动管理上下文
工作流程(三步递进):
- 运行
npx repomix@latest将仓库打包为单个文件; - 使用 Grep 与 Read 工具高效检索输出文件(先 grep 定位、再按需读取片段,绝不整读大文件);
- 在不消耗过多上下文的前提下输出综合分析结论。
从 explorer.md 的源码可以看出,代理被设计为"专家代码分析师",它内置了如下工程化规范:
- 效率规范:超过 10 万行的大型仓库强制使用
--compress;先 Grep 后 Read;分析多个仓库时用--output指定自定义路径避免互相覆盖; - 输出格式建议:默认推荐 XML(结构化、文件边界清晰),Plain 便于 grep、Markdown 适合文档、JSON 适合程序化处理;
- 模式检索模板:内置了函数/类、导入依赖、认证授权、API 端点、数据库模型、错误处理等多组
grep -iE模式示例,可直接套用; - 自检清单:完成分析前逐一核对是否记录指标、是否高效使用 Grep、结论是否有真实数据支撑等。
命令入口文件 explore-local.md 与 explore-remote.md 还规定:命令本身只负责解析路径/仓库并启动explorer代理,实际分析全部交由代理完成——这种"薄命令层 + 厚代理层"的分层设计,保证了命令响应快、分析深度足。
四、实战用例:四条命令的完整演示
场景一:打包本地代码库
使用/repomix-commands:pack-local配合自然语言指令:
/repomix-commands:pack-local Pack this project as markdown with compression其他常用说法:
"Pack the src directory only""Pack TypeScript files with line numbers""Generate output in JSON format"
场景二:打包远程仓库
使用/repomix-commands:pack-remote分析 GitHub 仓库:
/repomix-commands:pack-remote yamadashy/repomix Pack only TypeScript files from the yamadashy/repomix repository其他常用说法:
"Pack the main branch with compression""Include only documentation files""Pack specific directories"
场景三:AI 探索本地代码库
使用/repomix-explorer:explore-local进行 AI 分析:
/repomix-explorer:explore-local ./src Find all authentication-related code其他常用说法:
"Analyze the structure of this project""Show me the main components""Find all API endpoints"
场景四:AI 探索远程仓库
使用/repomix-explorer:explore-remote分析 GitHub 仓库:
/repomix-explorer:explore-remote facebook/react Show me the main component architecture其他常用说法:
"Find all React hooks in the repository""Explain the project structure""Where are error boundaries defined?"
五、配套学习资源
要深入理解这些插件背后的能力,可以继续阅读本仓库内的相关文档:
- MCP 服务器文档 — 了解底层 MCP 服务器的实现
- 配置文档 — 定制 Repomix 的行为
- 安全文档 — 理解安全过滤机制
- 命令行选项文档 — 查看全部可用 CLI 选项
三个插件的源码也都保存在本仓库中:插件市场清单见 .claude-plugin/marketplace.json,命令与代理定义见 .claude/plugins/repomix-commands、.claude/plugins/repomix-explorer 与 .claude/plugins/repomix-mcp。遇到问题时,也可运行npx repomix@latest --help查看全部 CLI 选项作为排错依据。
【免费下载链接】repomix📦 Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. 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.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考