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

Repomix AI 提示词实战指南代码审查、文档生成与质量分析的 LLM Prompt 模板【免费下载链接】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 官方文档西语版prompt-examples的深度展开围绕把打包后的代码库喂给 AI 助手这一核心场景系统整理代码审查、文档生成、分析与改进三大类可直接复用的 Prompt 模板并结合仓库源码解释 Repomix 输出结构、输出格式选择与自定义指令机制。读完本文你将掌握一套开箱即用的 AI 代码分析提示词并能根据模型Claude / ChatGPT / Gemini差异调整提示策略让 LLM 的审查与写作结果更稳定、更聚焦。为什么需要专门的 Prompt 模板Repomix 会把整个仓库打包成一个 AI 友好的单文件默认repomix-output.xml其中包含文件摘要、目录结构、全部文件内容以及可选的 Git 日志和自定义指令。文件本身已经过 AI 优化但喂进去之后问什么直接决定了分析质量。prompt-examples.md 正是为此准备的它不讲解 Repomix 的安装与配置这些见 README.md 与 使用指南而是提供一组结构化的 Prompt 模板覆盖最常见的 AI 辅助代码分析任务。模板的统一思路是给模型一个明确角色 一组编号步骤 一个输出侧重点从而减少发散性回答。第一步生成 Repomix 打包文件在使用任何模板之前先在项目根目录生成打包文件npx repomixlatest # 或全局安装后直接运行 repomix默认会生成repomix-output.xml。如果需要切换格式用--style指定repomix --style markdown # 可读性优先 repomix --style json # 程序化处理 repomix --style plain # 通用纯文本四种输出格式中XML 是默认值configSchema.ts 中style默认xml其对 Claude 等模型的解析准确度最高Markdown 适合人类阅读JSON 便于用jq提取信息并接入 API 流程。格式的详细对比如 输出格式指南 所述。代码审查类 Prompt架构审查把整个仓库的架构评估交给 AI 时模板要求模型同时给出问题和做得好的地方避免只挑毛病Analyze this codebases architecture: 1. Evaluate the overall structure and patterns 2. Identify potential architectural issues 3. Suggest improvements for scalability 4. Note areas that follow best practices Focus on maintainability and modularity.关键设计在于最后一句显式声明关注点可维护性、模块化让评估标准可度量而不是泛泛而谈。安全审查安全审查模板把任务拆成漏洞、反模式、错误处理、依赖安全四个可执行检查项并要求给出修复步骤Perform a security review of this codebase: 1. Identify potential security vulnerabilities 2. Check for common security anti-patterns 3. Review error handling and input validation 4. Assess dependency security Provide specific examples and remediation steps.这与 Repomix 自身的理念一致官方在打包阶段就集成了 Secretlint 做敏感信息扫描见 README.md 的 Security-Focused 特性配合本模板可以在入参阶段和分析阶段做双重安全检查。性能审查Review the codebase for performance: 1. Identify performance bottlenecks 2. Check resource utilization 3. Review algorithmic efficiency 4. Assess caching strategies Include specific optimization recommendations.性能类分析特别强调给出具体的优化建议Include specific optimization recommendations——这是模板中反复出现的收尾句式用于把模型的泛泛评论逼到可执行层面。文档生成类 PromptAPI 文档生成Generate comprehensive API documentation: 1. List and describe all public endpoints 2. Document request/response formats 3. Include usage examples 4. Note any limitations or constraints注意第 4 步标注限制与约束它让生成的 API 文档不仅罗列接口还具备工程文档应有的诚实性。开发者指南生成Create a developer guide covering: 1. Setup instructions 2. Project structure overview 3. Development workflow 4. Testing approach 5. Common troubleshooting steps该模板覆盖了 onboarding 文档的五个必要板块。值得说明的是Repomix 仓库自身就存放了一份repomix-instruction.md仓库根目录其作用正是指导 AI 理解项目结构与代码规范——两者可以组合使用先用本模板生成指南再用--instruction-file-path注入项目专属上下文。架构文档生成Document the system architecture: 1. High-level overview 2. Component interactions 3. Data flow diagrams 4. Design decisions and rationale 5. System constraints and limitations架构文档模板要求模型补全设计决策与理由以及系统约束这比单纯画组件关系图更能沉淀出有价值的架构知识。分析与改进类 Prompt依赖分析Analyze the project dependencies: 1. Identify outdated packages 2. Check for security vulnerabilities 3. Suggest alternative packages 4. Review dependency usage patterns Include specific upgrade recommendations.该模板把依赖健康度拆成过时、漏洞、替代品、使用模式四个维度并强制输出升级建议。测试覆盖审查Review the test coverage: 1. Identify untested components 2. Suggest additional test cases 3. Review test quality 4. Recommend testing strategies一个实用技巧Repomix 的--ignore选项可排除测试文件生成纯生产代码视角也可以配合--include **/*.test.ts单独打包测试目录做对比分析。代码质量评估Assess code quality and suggest improvements: 1. Review naming conventions 2. Check code organization 3. Evaluate error handling 4. Review commenting practices Provide specific examples of good and problematic patterns.最后一行要求同时给出好模式与问题模式的具体示例这是让质量审查结果可落地、可对照修改的关键约束。获得更好结果的四个原则原文档总结了四条提示词设计原则适用于上述所有模板具体化Be Specific包含清晰的目标与评估标准避免帮我看看代码这类模糊指令设定上下文Set Context声明你的角色如资深架构师与所需专业深度模型会据此调整输出粒度要求输出格式Request Format规定回答结构列表、分节、表格、示例代码块显著提升可读性设定优先级Prioritize标明哪些方面最重要防止模型平均用力、抓不住重点。从源码结构看Repomix 的输出本身就为这些原则提供了支撑XML 输出通过file_summary、directory_structure、files三段式组织见 xmlStyle.ts模型拿到的是高度结构化的上下文此时提示词越结构化两者配合越好。按模型调优Claude / ChatGPT / Gemini 的差异不同 LLM 对提示格式的敏感度不同原文档给出了针对性的建议模型推荐做法原因Claude使用 XML 输出格式把重要指令放在提示末尾明确指定响应结构Claude 对 XML 标签与提示尾部的指令敏感度较高ChatGPT使用 Markdown 格式将大型代码库拆成多个部分加入系统角色提示system role promptMarkdown 分节更利于其逐步处理长上下文Gemini兼容所有格式每次请求聚焦特定领域采用逐步分析step-by-step分而治之能明显提升其长文本分析稳定性搭配 Repomix 使用时拆段可以借助--include/--ignore例如repomix --include src/**/*.ts只打包核心源码或使用--split-output 1mb把超大输出拆成多个编号文件如 Google AI Studio 有约 1MB 的上传限制详见 输出格式指南。用自定义指令强化 PromptinstructionFilePath很多团队希望在分析前注入项目专属规范如只关注 src/core、忽略 tests。Repomix 支持通过output.instructionFilePath把自定义指令写进打包文件{ output: { instructionFilePath: repomix-instruction.md } }repomix-instruction.md的内容会出现在输出的instruction段XML 结构见 xmlStyle.ts从而在每次 AI 分析时自动生效。仓库根目录的 repomix-instruction.md 就是一个真实示例。该配置项在 configSchema.ts 与 defaultAction.ts 中均有对应实现。实践建议把仓库分析规范 业务上下文放进repomix-instruction.md再把具体任务审查/文档/质量写进对话 prompt两者分层配合效果远好于把所有要求塞进一句话。进阶把 JSON 输出接入自动化分析如果你的工作流需要脚本化处理--style json配合jq可以自动提取关键信息再喂给后续的 prompt 流水线。例如# 列出所有 TypeScript 文件 cat repomix-output.json | jq -r .files | keys[] | select(endswith(.ts)) # 统计总文件数 cat repomix-output.json | jq .files | keys | length # 抽取 README 内容单独分析 cat repomix-output.json | jq -r .files[README.md]这样自动筛选文件 → 构造针对性 prompt → 交给 LLM的全链路就可以通过 CI 脚本固化下来详细命令集见 输出格式指南 的 JSON 章节。相关资源输出格式指南每种输出格式的详细结构与选择建议自定义指令通过instructionFilePath为输出注入项目上下文实际用例错误调查、实现规划、重构、安全审计等真实场景的完整 prompt代码压缩用--compress降低大仓库的 token 数配合上述模板可显著压缩成本FAQ 与排障安装、隐私与 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），仅供参考