Repomix 提示词示例面向 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/repomixRepomix 将整个仓库打包为单一 AI 友好文件后如何让 Claude、ChatGPT、Gemini 等大模型高效消化这些输出取决于你投喂给它的提示词质量。本文整理了一套可直接复制使用的提示词模板覆盖代码审查架构、安全、性能、文档生成API、开发者指南、架构文档与代码分析改进依赖项、测试覆盖率、代码质量三大类场景并结合 Repomix 源码说明这些模板如何与输出格式、自定义指令等机制协同工作帮助你获得更准确、更结构化的 AI 分析结果。提示词模板总览下文所有模板均以整个代码库已打包为单一文件为使用前提。你可以把 Repomix 生成的输出文件默认repomix-output.xml连同模板一起粘贴到 AI 对话中AI 即可基于完整仓库上下文进行分析。模板按用途分为三个大类每类包含三个细分场景可直接复制使用。代码评审架构评审分析此代码库的架构 1. 评估整体结构和模式 2. 识别潜在的架构问题 3. 提出改进可扩展性的建议 4. 标注遵循最佳实践的部分 重点关注可维护性和模块化。该模板聚焦于结构性分析。由于 Repomix 输出中包含完整的目录结构区块AI 无需逐个打开文件即可感知src/、tests/、website/等顶层模块的组织方式。例如在本仓库中repomix-instruction.md提供的项目结构说明src/cli、src/config、src/core 等目录职责正是这类架构评审的理想输入。安全性评审对此代码库进行安全性评审 1. 识别潜在的安全漏洞 2. 检查常见的安全反模式 3. 评审错误处理和输入验证 4. 评估依赖项的安全性 请提供具体示例和修复步骤。安全性评审模板与 Repomix 内置的安全机制形成互补。Repomix 在打包阶段本身会执行安全检查由 src/core/security/securityCheck.ts 实现默认扫描 API 密钥、密码等敏感信息可通过--no-security-check关闭而上述提示词则是对打包后的代码内容进行更深层的逻辑层安全审计——两者结合可构成打包前敏感信息过滤 打包后漏洞模式分析的双重防线。性能评审从性能角度评审代码库 1. 识别性能瓶颈 2. 检查资源使用情况 3. 评审算法效率 4. 评估缓存策略 包含具体的优化建议。性能评审模板要求 AI 从算法效率、缓存策略等维度给出优化建议。配合 代码压缩--compress使用效果更佳压缩模式基于 Tree-sitter 提取函数签名、接口定义等结构要素见 src/core/treeSitter/能大幅降低 token 消耗同时保留足够的结构信息供 AI 定位性能相关的热点函数。文档生成API 文档生成全面的 API 文档 1. 列出并描述所有公共端点 2. 记录请求/响应格式 3. 包含使用示例 4. 说明限制和约束API 文档模板对打包结果中的类型定义、路由处理与请求/响应 schema 非常敏感。若仓库包含 OpenAPI 或 TypeScript 接口定义建议配合--include参数聚焦相关目录例如repomix --include src/api/**/*.ts避免无关文件稀释 AI 的注意力。开发者指南创建包含以下内容的开发者指南 1. 环境搭建说明 2. 项目结构概览 3. 开发工作流程 4. 测试方法 5. 常见问题排查步骤该模板产出适合新成员上手的手册式文档。可以结合自定义指令机制在打包输出中预先注入项目背景例如本仓库根目录的repomix-instruction.md就示范了如何通过repomix.config.json中的output.instructionFilePath将重点关注src/core、忽略tests目录等指导写入输出文件的instruction区块。架构文档记录系统架构 1. 高层概述 2. 组件交互 3. 数据流程图 4. 设计决策及理由 5. 系统限制和约束架构文档模板要求 AI 产出包含数据流与设计决策的正式文档。此时建议优先使用 XML 或 Markdown 格式的完整输出包含目录结构树并考虑启用--include-logs让 git 提交历史进入输出帮助 AI 理解关键设计决策的演进脉络git 日志功能由 src/core/git/gitLogHandle.ts 实现。分析与改进依赖项分析分析项目依赖 1. 识别过时的包 2. 检查安全漏洞 3. 建议替代包 4. 评审依赖使用模式 包含具体的升级建议。依赖分析模板特别适用于package.json、requirements.txt、go.mod等清单文件所在的仓库。你可以通过repomix --include package.json,package-lock.json只打包依赖清单快速完成一次依赖体检需要更全面的结论时再打包整个仓库让 AI 结合源码中的实际导入路径判断依赖使用模式。测试覆盖率评审测试覆盖率 1. 识别未测试的组件 2. 建议额外的测试用例 3. 评审测试质量 4. 推荐测试策略测试覆盖率模板要求 AI 对比源码与测试文件的对应关系。本仓库的测试布局tests/目录按src/结构镜像组织如tests/core/file/fileProcess.test.ts对应src/core/file/fileProcess.ts就是 AI 识别哪些模块缺少配套测试的理想参照模式。代码质量评估代码质量并提出改进建议 1. 评审命名规范 2. 检查代码组织 3. 评估错误处理 4. 评审注释实践 提供具体的良好和问题模式示例。代码质量模板要求 AI 给出正反两面的具体示例。配合--output-show-line-numbers选项为输出内容附加行号defaultAction.ts 中通过outputShowLineNumbers配置项开启可以让 AI 的回答精确到文件路径:行号极大提升后续人工定位与修改的效率。获得更好结果的技巧无论使用哪个模板以下四条通用原则都能显著提升 AI 输出的质量明确具体包含清晰的目标和评估标准——不要只说看看代码有没有问题而是说明关注点如可维护性、可扩展性、安全性。设置上下文说明你的角色和所需的专业水平例如你是一位资深后端架构师。请求格式定义期望的响应结构如请按『问题-影响-建议』三段式输出。设置优先级指出哪些方面最重要例如优先关注安全漏洞其次是性能瓶颈。模型特定说明不同大模型对提示词格式和交互方式有不同偏好Repomix 的四种输出格式XML、Markdown、JSON、纯文本通过--style切换默认 XML为此提供了对应选择详见输出格式。Claude使用 XML 输出格式Claude 对 XML 标签结构的解析精度更高Repomix 默认的 XML 格式即为其优化将重要指令放在最后指定响应结构ChatGPT使用 Markdown 格式可读性好便于对话中分段展开将大型代码库分成小节可配合--include分模块打包或使用--split-output将超大输出拆分为多个文件包含系统角色提示Gemini适用于所有格式对各格式兼容性最好每次请求专注于特定领域避免在一轮对话中混合架构、安全、性能等多个主题使用逐步分析要求 AI 先列计划再逐项执行让提示词发挥最大价值的配套机制提示词模板只是问得好要让 AI 回答得准还需关注 Repomix 输出本身的质量注入项目上下文通过repomix.config.json中的output.instructionFilePath指定自定义指令文件内容会以instruction标签写入输出源码实现见 outputGenerate.ts 中buildOutputGeneratorContext对指令文件的读取逻辑以及 xmlStyle.ts、markdownStyle.ts、plainStyle.ts 三个样式模板对instruction字段的渲染。这样 AI 在分析时会自动遵循你的编码规范与审查目标。控制 token 规模仓库过大时先用--compress压缩保留结构、移除实现、--remove-comments去注释见注释移除或用--ignore/--include裁剪范围避免超出模型上下文窗口。选择合适的输出格式需要程序化处理后端对接时用 JSON可用jq提取.files、.instruction等字段追求可读性用 Markdown与 Claude 配合优先 XML。相关资源输出格式 - 各种输出格式的详细说明自定义指令 - 为输出添加上下文和指引使用场景 - AI 辅助工作流的实际案例代码压缩 - 为大型代码库减少 Token 数量【免费下载链接】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），仅供参考
