ARTICLE DETAIL

资讯详情

深耕网站视觉设计与运营推广的一线实战洞察。

Repomix 官方 Claude Code 插件使用指南:MCP 集成、Slash 命令与 AI 仓库探索

Repomix 官方 Claude Code 插件使用指南:MCP 集成、Slash 命令与 AI 仓库探索 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本文基于仓库文档 claude-code-plugins.md及同内容英文版 website/client/src/en/guide/claude-code-plugins.md编写并结合仓库内插件定义与 MCP 工具源码进行纵深验证。Repomix 为 Claude Code 提供了三个官方插件让开发者可以直接在 AI 开发环境中用自然语言完成代码库打包、远程仓库分析与智能探索。读完本文你将掌握插件的安装步骤、三个插件的定位与分工、四类典型用法并了解其底层 MCP 服务器与 CLI 调用链的实现细节。一、认识官方 Claude Code 插件体系Repomix 的核心能力是把整个仓库打包成单个 AI 友好的文件默认 XML供 Claude、ChatGPT 等大语言模型消费。在 Claude Code 中官方插件把这一能力直接搬进交互终端无需手动生成文件、再复制粘贴而是通过自然语言命令即可触发打包与分析。仓库中插件体系的载体如下插件市场定义.claude-plugin/marketplace.json声明了repomix-mcp、repomix-commands、repomix-explorer三个插件及其分类integration与productivity插件源码目录.claude/plugins/ 下分别存放三个插件的命令、代理与配置。三个插件的关系可以概括为repomix-mcp是推荐的基础底座提供 MCP 服务器集成repomix-commands提供便捷的 Slash 命令repomix-explorer增加 AI 驱动的分析代理能力。三者可以独立安装但组合使用体验最完整。二、安装流程1. 添加 Repomix 插件市场首先把 Repomix 的插件市场注册到 Claude Code/plugin marketplace add yamadashy/repomix该命令指向仓库中的 .claude-plugin/marketplace.json其中metadata.version当前仓库为 1.0.2用于标识市场版本plugins数组声明了可安装的三个插件及其来源路径。2. 安装插件在 Claude Code 中依次执行以下命令# 安装 MCP 服务器插件推荐的基础组件 /plugin install repomix-mcprepomix # 安装命令插件扩展功能 /plugin install repomix-commandsrepomix # 安装仓库探索插件AI 驱动的分析 /plugin install repomix-explorerrepomix提示repomix-mcp被推荐作为基础。repomix-commands提供便捷的 Slash 命令repomix-explorer则增加 AI 分析能力。虽然可以独立安装但三者组合能获得最完整的体验。3. 替代方案交互式安装也可以直接输入/plugin这会打开一个交互式界面你可以浏览并选择安装可用的插件无需手写插件名。三、三个插件的定位与分工1. repomix-mcpMCP 服务器插件基础底座作为基础插件它通过 MCP 服务器集成提供 AI 驱动的代码库分析能力核心特性包括打包本地与远程仓库pack_codebase/pack_remote_repository在打包输出中搜索grep_repomix_output读取生成的输出文件read_repomix_output自动 Tree-sitter 压缩约减少 70% token从源码看MCP 服务器在 src/mcp/mcpServer.ts 中创建注册了以下工具部分工具仅在沙箱模式或非沙箱模式下可用工具作用注册条件pack_codebase打包本地目录为 XML 等格式始终可用read_repomix_output按行区间读取打包输出始终可用grep_repomix_output用 JavaScript RegExp 在输出中搜索始终可用pack_remote_repository克隆并打包 GitHub 仓库非沙箱模式generate_skill从代码库生成 Claude Agent Skill非沙箱模式attach_packed_output挂载已有打包输出非沙箱模式file_system_read_file/file_system_read_directory读文件、列目录仅沙箱模式例如pack_codebase实现见 src/mcp/tools/packCodebaseTool.ts支持directory、compress、includePatterns、ignorePatterns、outputPatterns、topFilesLength默认 10、stylexml/markdown/json/plain默认xml等参数底层调用runCli复用 Repomix CLI 的完整能力并默认开启securityCheck: true做安全扫描。2. repomix-commandsSlash 命令插件提供两个支持自然语言解析的便捷命令源码见 .claude/plugins/repomix-commands//repomix-commands:pack-local— 以多种选项打包本地代码库/repomix-commands:pack-remote— 打包并分析远程 GitHub 仓库根据 pack-local.md 的定义命令会把用户的自然语言意图翻译为npx repomixlatest [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 提交历史值得注意的是该命令在用户需要分析输出时会刻意避免一次性读取整个大文件而是委托repomix-explorer:explorer等子代理用 grep 与增量读取来节省上下文。3. repomix-explorerAI 分析代理插件这是一个 AI 驱动的仓库分析代理能够智能地探索代码库核心特性自然语言的代码库探索与分析智能模式发现与代码结构理解使用 grep 与定向文件读取做增量分析大型仓库的自动上下文管理可用命令/repomix-explorer:explore-local— 在 AI 辅助下分析本地代码库/repomix-explorer:explore-remote— 在 AI 辅助下分析远程 GitHub 仓库工作方式与 skills/repomix-explorer/SKILL.md 及 .claude/plugins/repomix-explorer/agents/explorer.md 中定义一致执行npx repomixlatest打包仓库远程仓库建议输出到/tmp避免污染当前项目目录用 Grep 与 Read 工具高效检索输出文件先看文件树与指标摘要再按需 grep 模式、分片读取具体段落在不消耗过多上下文的前提下给出全面分析结论。命令定义细节见 explore-local.md 与 explore-remote.md例如/repomix-explorer:explore-local支持绝对路径、相对路径如./src或省略当前目录并会把分析任务封装成给explorer代理的标准指令模板。四、实战用法示例以下示例均来自官方文档原文可直接在 Claude Code 中运行。打包本地代码库使用/repomix-commands:pack-local配合自然语言指令/repomix-commands:pack-local Pack this project as markdown with compression更多示例Pack the src directory only只打包 src 目录Pack TypeScript files with line numbers打包带行号的 TypeScript 文件Generate output in JSON format生成 JSON 格式输出打包远程仓库使用/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打包 main 分支并压缩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查找所有 API 端点用 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查找仓库中所有 React hooksExplain the project structure解释项目结构Where are error boundaries defined?错误边界定义在哪里五、源码级原理插件背后的调用链1. 从自然语言到 CLI 命令repomix-commands的核心是把自然语言解析为npx repomixlatest命令参数见 pack-local.md。例如打包为 markdown 并压缩会翻译为npx repomixlatest --style markdown --compress打包 src 目录则翻译为npx repomixlatest src/。2. 从 CLI 到 MCP 工具MCP 插件模式下同样的打包逻辑由服务器端工具承载。以pack_remote_repositorysrc/mcp/tools/packRemoteRepositoryTool.ts为例它接受remote支持user/repo、完整 URL、带分支的 URL 三种形式、compress、includePatterns、ignorePatterns、outputPatterns、topFilesLength、style参数内部创建临时工作区、调用runCli执行远程打包并通过redactUrl对回显的仓库地址做脱敏处理避免带凭据的 URL 残留在对话记录中。grep_repomix_outputsrc/mcp/tools/grepRepomixOutputTool.ts则提供 grep 风格的搜索支持 JavaScript RegExp 语法、contextLines/beforeLines/afterLines上下文控制、ignoreCase忽略大小写返回命中行号、行内容与格式化输出对于从不可信路径挂载的输出文件还会先经过 secretlint 密钥格式扫描runSecretLint命中敏感格式即拒绝返回内容。3. 探索代理的工作流repomix-explorer的explorer代理.claude/plugins/repomix-explorer/agents/explorer.md遵循先打包、再搜索、后精读的策略远程仓库执行npx repomixlatest --remote repo本地目录执行npx repomixlatest [directory]默认输出 XML结构化、文件边界清晰官方推荐优先用 Grep 搜索函数/类export.*function|export.*class、导入依赖、认证鉴权auth|login|password|token|jwt、API 端点、数据库模型、错误处理等常见模式对大型仓库强制建议--compress超过约 10 万行用--include收窄范围输出文件用--output指定独立路径避免互相覆盖。六、相关资源MCP 服务器文档 — 了解插件背后的 MCP 服务器包括--mcp启动方式、--sandbox沙箱模式以及 VS Code / Cline / Cursor / Claude Desktop / Claude Code 的接入配置配置文档 — 定制 Repomix 行为输出格式、忽略规则等安全文档 — 理解密钥扫描等安全特性命令行选项文档 — 全部可用 CLI 选项插件市场定义.claude-plugin/marketplace.json插件源码目录.claude/plugins/七、使用建议与注意事项按场景选择插件只想快速打包repomix-commands足够需要让 AI 深入理解代码结构配合repomix-explorer如果希望在其他 MCP 客户端中复用则直接使用repomix-mcp对应的 MCP 服务器npx -y repomix --mcp。大仓库务必压缩官方在文档与源码中均注明 Tree-sitter 压缩可减少约 70% token探索代理也会在仓库过大时自动启用--compress。输出文件管理远程仓库的分析输出建议写到/tmp多个仓库使用不同的--output路径分析结束后清理大文件避免污染项目目录或浪费磁盘。上下文预算无论走 Slash 命令还是 MCP 工具都应遵循先 grep、后精读的增量分析策略不要一次性读取数 MB 的输出文件。这套官方插件把 Repomix 的打包能力与 Claude Code 的交互式开发环境无缝衔接是进行代码审查、文档生成、Bug 调查与陌生仓库理解的高效工作流起点。【免费下载链接】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),仅供参考
返回列表