Repomix 提示词模板实战指南：用 AI 完成代码审查、文档生成与代码质量分析

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 友好的文件默认输出repomix-output.xml但要让 Claude、ChatGPT、Gemini 等大模型真正发挥这份打包产物的价值还需要一套结构良好的提示词。本文基于官方文档 Exemplos de Prompts系统整理代码审查、文档生成、分析与改进三大类可直接复用的提示词模板并结合 输出格式 与 命令行选项 说明如何针对不同模型选择格式。读完本文你将掌握一套打包 → 喂给 LLM → 得到结构化分析的完整工作流并理解提示词设计背后的通用原则。使用前提先生成 AI 可读的仓库打包文件所有提示词模板都假设你已用 Repomix 生成了打包文件。基本用法repomix默认输出repomix-output.xmlXML 是默认格式见 configSchema.ts 中style默认值xml。针对不同的下游模型可以切换输出格式# 供 Claude 使用官方推荐 XML repomix --style xml # 供 ChatGPT 使用可读性强 repomix --style markdown # 供程序化处理与 API 集成 repomix --style json # 追求通用兼容性 repomix --style plain四种格式由repomixOutputStyleSchema定义见 configSchema.ts对应的默认文件名分别为repomix-output.xml、repomix-output.md、repomix-output.txt和repomix-output.json见 configSchema.ts。如果打包文件过大超出模型上下文窗口可参考 代码压缩指南 使用--compress提取类、函数、接口等核心结构以降低 token 消耗。生成打包文件后将其作为上下文附带给 AI 助手再配合下文模板提问即可。代码审查类提示词代码审查是 Repomix 最典型的使用场景——模型可以一次性看到全部代码进行跨文件的全局审查。架构审查分析此代码库的架构 1. 评估整体结构和设计模式 2. 识别潜在的架构问题 3. 针对可扩展性提出改进建议 4. 指出遵循了最佳实践的领域 重点关注可维护性和模块化。该模板要求模型从整体结构与模式切入先描述现状再给改进方向最后明确可维护性和模块化这两个评价标准避免泛泛而谈。实践上配合--compress打包可以突出结构与签名、弱化实现细节更利于架构层面的分析。安全审查对代码库执行安全审查 1. 识别潜在的安全漏洞 2. 检查常见的安全反模式 3. 审查错误处理和输入验证 4. 评估依赖安全性 请提供具体的示例和修复步骤。模板强制输出具体示例 修复步骤这正是安全审查的价值所在——不仅指出问题还要给出可落地的补救方案。若审查对象包含大量第三方依赖可先运行repomix --include package-lock.json,package.json只打包依赖清单缩小模型分析范围。性能审查审查代码库的性能表现 1. 识别性能瓶颈 2. 检查资源利用情况 3. 审查算法效率 4. 评估缓存策略 请包含具体的优化建议。性能分析需要量化依据。建议配合--token-count-tree或--include-logsgit 提交历史让模型了解代码的变更频率与热点文件帮助定位频繁改动且逻辑复杂的潜在瓶颈区。文档生成类提示词Repomix 打包了完整的目录结构directory_structure与全部文件内容非常适合生成覆盖全仓库的文档。API 文档生成全面的 API 文档 1. 列出并描述所有公共端点 2. 记录请求/响应格式 3. 包含使用示例 4. 注明任何限制或约束提示词逐项规定了文档必须覆盖的四个要素。如果仓库很大可以先用--include只打包相关模块如repomix --include src/api/**保证端点枚举的完整性。开发者指南创建一份开发者指南涵盖 1. 环境搭建说明 2. 项目结构概览 3. 开发工作流 4. 测试方法 5. 常见问题排查步骤 请提供具体示例和故障排除步骤。这份模板是团队 onboarding 的利器。配合 自定义指令 在打包文件中注入团队规范可以让生成的指南更贴合项目实际约定。架构文档记录系统架构 1. 高层概述 2. 组件交互关系 3. 数据流图 4. 设计决策及其理由 5. 系统约束和限制提示词要求覆盖设计决策及其理由这是架构文档区别于一般代码说明的关键。可以给模型追加要求请引用directory_structure中的具体文件路径作为证据让文档中的每个结论都能追溯到源码位置。分析与改进类提示词依赖分析分析项目依赖 1. 识别过期的包 2. 检查安全漏洞 3. 建议替代包 4. 审查依赖的使用模式 请包含具体的升级建议。依赖分析建议单独打包package.json/package-lock.json文件repomix --include package*.json这样模型可以精确比对声明版本与实际锁定版本给出更准确的升级路径。测试覆盖审查审查测试覆盖率 1. 识别未测试的组件 2. 建议补充测试用例 3. 审查测试质量 4. 推荐测试策略该模板既关注覆盖了多少也关注测得好不好。仓库本身是很好的参照——本仓库在 tests/ 下有大量与源码一一对应的测试文件这种源码-测试的组织方式本身就是值得模型学习的最佳实践。代码质量评估评估代码质量并提出改进建议 1. 审查命名规范 2. 检查代码组织 3. 评估错误处理 4. 审查注释实践 请提供具体的好模式和问题模式的示例。模板结尾要求具体示例能有效约束模型输出防止只给出抽象建议。同时明确评价维度命名、组织、错误处理、注释让审查结果可度量、可追踪。获得更好结果的通用技巧原文档总结了四条提升 AI 分析质量的核心技巧它们适用于上述所有模板保持具体Be Specific在提示词中给出明确的目标和评价标准例如重点关注可维护性比笼统的分析代码更有效设定上下文Set Context说明你希望模型扮演的角色如资深安全工程师以及需要的专业深度指定回复格式Request Format预先定义答案的结构例如逐条列出每条包含问题、影响、修复步骤明确优先级Prioritize指出哪些方面最重要让模型在 token 有限时优先处理关键部分。模型特定注意事项不同大模型对提示词和输入格式的偏好不同原文档给出如下针对性建议模型输出格式偏好关键策略ClaudeXML解析精度最高重要指令放在提示词末尾明确指定响应结构ChatGPTMarkdown将大型代码库拆分成多个小节分别分析可加入系统角色提示词Gemini兼容所有格式单次请求聚焦特定领域采用逐步step-by-step分析这些建议与 Repomix 的输出格式设计高度呼应。官方文档 输出格式 指出选择 XML 作为默认格式主要受 AnthropicClaude、GoogleGemini、OpenAI 官方结构化提示建议的影响而在实现层面outputGenerate.ts 中 XML 与 Markdown、plain 走 Handlebars 模板渲染JSON 走独立的可解析生成路径generateParsableJsonOutput其中 JSON 的instruction字段对应 自定义指令 中output.instructionFilePath注入的内容——该文件由 outputGenerate.ts 在打包时读取并写入输出用于在提示词之外为模型补充仓库专属上下文。扩展阅读输出格式详解 — 四种输出格式的完整结构对比与jq用法自定义指令 — 通过instructionFilePath向输出注入仓库上下文真实使用案例 — 更多 AI 辅助工作流实例bug 调查、重构、安全审计等代码压缩 — 用--compress降低大仓库的 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），仅供参考