
Repomix Prompt 实战指南为 AI 代码审查、安全分析与性能优化打造高质量 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将整个仓库打包成单个 AI 友好文件只是第一步真正决定分析质量的是你提交给 AI 的 Prompt。本篇指南以 Repomix 的 Prompt 示例文档为主体系统讲解基础分析、Bug 定位、重构、功能扩展、文档生成、代码评审、跨语言转换、性能优化八大场景的模板化 Prompt并结合仓库源码说明输出格式、自定义指令、代码压缩与安全检测如何与这些 Prompt 协同工作帮助你快速上手一套可直接复制使用的 AI 辅助开发工作流。为什么需要针对 Repomix 输出的专门 PromptRepomix 的核心能力是把代码库打包进单一文件默认repomix-output.xml再交给 Claude、ChatGPT、Gemini、DeepSeek 等大语言模型分析。打包文件的语义与普通源码文件不同它包含了 File Summary文件摘要、Directory Structure目录结构与 Files文件内容等结构化区块因此 Prompt 中应当显式声明这份文件是整个项目代码库的打包表示让 AI 以全局视角而非单文件视角来解读。从实现上看打包文件的每个区块都可以按需开关。在 src/core/output/outputGenerate.ts 的createRenderContext中fileSummaryEnabled、directoryStructureEnabled、filesEnabled等开关直接来自配置的output.fileSummary、output.directoryStructure、output.files字段默认均为true见 src/config/configSchema.ts。这意味着你在设计 Prompt 时可以结合输出结构写出更精准的指令例如让 AI 优先阅读file_summary区块再深入具体文件。Prompt 基础模板这是所有分析任务的起点适合第一次把打包文件交给 AI 时使用此文件包含由 Repomix 打包的我的完整项目代码库。请分析该代码库并提供其结构与功能的总体概述。这条 Prompt 的作用是让 AI 建立对项目的整体认知先确认它面对的是完整代码库而非零散文件然后要求输出结构概览。配合 XML 默认格式时AI 可以从file_summary获取元数据与使用指南从directory_structure获取目录树再抽查files中的具体实现。代码库深度分析当你需要比总体概述更深入的分析时可以使用结构化编号的 Prompt要求 AI 依次完成五类任务此文件包含由 Repomix 打包的我的完整项目代码库。请 1. 分析项目的整体结构 2. 识别主要模块及其相互关系 3. 解释数据流与控制流 4. 识别所使用的设计模式 5. 评估代码库的可维护性与可扩展性编号化的任务清单能显著提高 AI 输出的完整性——模型倾向于逐条回答而非遗漏要点。这种 Prompt 适合架构评审、新成员上手理解系统、以及为后续重构或技术方案设计做准备。定位 Bug 与排查问题把你正在遇到的问题嵌入 Prompt可以让 AI 带着目标去检索代码此文件包含由 Repomix 打包的我的完整项目代码库。我遇到了 [问题描述]。请 1. 分析代码库以查找潜在 Bug 2. 识别可能的性能问题 3. 检查安全漏洞 4. 针对你发现的任何问题提出修复建议Repomix 打包输出的优势在于AI 可以跨文件追踪调用链而不必像传统方式那样逐个文件人工喂给模型。例如src/core/security/securityCheck.ts中会同时把工作区改动workTreeDiffContent、暂存区改动stagedDiffContent与 Git 提交历史logContent纳入安全检查范围你可以参照这一思路在排查线上问题时把最近的 Git 差异信息也打包进输出帮助 AI 定位最近哪次改动引入了问题。代码重构重构类 Prompt 的关键是明确保持功能不变这一约束避免 AI 在优化结构时破坏行为此文件包含由 Repomix 打包的我的完整项目代码库。我想对它进行重构以提高可维护性和可扩展性。请 1. 识别需要重构的区域 2. 提出改善代码结构的具体变更 3. 为关键部分提供重构后的代码示例 4. 解释建议变更的收益如果代码库很大可以先用 Repomix 的代码压缩功能降低 token 消耗。启用--compress后输出会保留函数签名、接口与类型定义、类结构等关键骨架同时移除函数体实现、循环与条件逻辑细节、内部变量声明参见 code-compress.md。配合output.compress配置src/config/configSchema.tsAI 可以更聚焦于架构层面的重构建议而不会被实现细节淹没。添加新功能新增功能的 Prompt 需要同时包含做什么与从哪里集成两个信息此文件包含由 Repomix 打包的我的完整项目代码库。我想添加以下功能[功能描述]。请 1. 分析代码库以确定新功能应集成的位置 2. 提出实现该功能所需的变更 3. 为新功能提供示例代码 4. 解释新功能如何与现有代码交互由于打包文件内含完整的目录结构与文件内容AI 能判断新功能应放在哪个模块、复用哪些既有抽象、遵循哪种项目内已有的代码风格——这正是与只给 AI 一段代码片段的本质区别。若希望 AI 严格遵守项目内的架构约束可以结合自定义指令功能在repomix.config.json中配置output.instructionFilePath指向一个 Markdown 指令文件参见 custom-instructions.md其内容会以instruction区块出现在输出中随文件一并提交给 AI。生成文档文档生成是 Repomix 的典型应用场景模板如下此文件包含由 Repomix 打包的我的完整项目代码库。我需要生成全面的文档。请 1. 生成项目概述 2. 为主要模块生成 API 文档 3. 解释主要功能的用法 4. 为常见使用场景提供示例 5. 生成安装与配置指南从源码层面看Repomix 的 JSON 输出格式--style json非常适合文档工作流文件内容以files对象路径为键、内容为值组织配合jq可以程序化提取任意文件的路径与内容详见 output.md 中的jq示例。你可以先自动生成文件清单与字数统计再让 AI 据此规划文档结构兼顾效率与准确性。代码评审评审类 Prompt 应明确评审维度让 AI 的反馈更有针对性此文件包含由 Repomix 打包的我的完整项目代码库。请评估代码质量并针对以下方面提供反馈 1. 可读性与可维护性 2. 性能与优化 3. 最佳实践的遵循情况 4. 安全性与错误处理 5. 可测试性与可扩展性关于安全维度Repomix 自身在打包阶段就会执行安全检查默认开启的security.enableSecurityCheck默认true见 src/config/configSchema.ts会基于secretlint的推荐规则集扫描全部文件内容见 src/core/security/workers/securityCheckWorker.ts对疑似密钥、令牌等敏感信息给出告警。这意味着进入 AI 评审的文件通常已剔除最明显的凭据泄露风险但 AI 评审仍应覆盖业务层面的安全逻辑如 SQL 注入、越权等两者形成互补。跨语言/框架代码转换技术栈迁移或语言重写的 Prompt 模板此文件包含由 Repomix 打包的我的完整项目代码库。它目前使用 [当前语言/框架] 编写。我想将其转换为 [目标语言/框架]。请 1. 分析现有代码库 2. 提供迁移计划 3. 将主要模块转换为 [目标语言/框架] 4. 解释任何必要的架构变更完整代码库上下文让 AI 在转换时能够保持模块边界、数据模型和接口约定的对齐避免逐文件翻译导致的结构性偏差。转换前建议生成一次 XML 输出因为 XML 的标签化结构file path...能让 AI 更准确地建立文件路径 ↔ 内容的映射关系Repomix 默认即 XML 格式理由详见 output.md。性能优化性能调优的 Prompt 模板此文件包含由 Repomix 打包的我的完整项目代码库。我遇到了性能问题尤其是 [问题描述]。请 1. 识别潜在的性能瓶颈 2. 提出具体的优化建议 3. 为关键部分提供优化后的代码 4. 提出改善整体性能的架构变更如果你的项目很大建议在性能分析时配合--remove-comments与--remove-empty-lines等选项降低 token 占用CLI 定义见 src/cli/cliRun.ts让有限的上下文窗口更多地留给核心实现逻辑。自定义 Prompt 的五个要素无论哪个场景为特定项目定制 Prompt 时都应考虑以下要素来自 prompt-examples.md 的官方建议项目背景提供项目目的与范围的信息具体要求明确说明你需要 AI 输出什么输出格式指定信息以何种形式呈现如表格、编号列表、代码片段约束与限制说明任何限制条件如不要改动测试文件保持向后兼容优先级澄清对你最重要的方面让 AI 在冲突时有所取舍让 Prompt 效果更好的进阶技巧具体化目标与评价标准不要在 Prompt 里只写检查代码质量而要定义可评估的维度与验收标准例如指出命名约定违规并给出 3 个改写示例。模糊的指令会得到模糊的反馈。设定角色与上下文可以指定 AI 扮演的角色及所需专业水平例如你是一位资深安全工程师正在对上线前的项目做最终审查这能显著影响回答的语气与深度。指定响应结构明确要求按 问题 / 影响 / 建议 / 示例代码 的格式逐条输出可让结果更容易批量处理与归档。不同模型的适配建议根据官方文档与社区实践不同模型各有偏好Claude优先使用 XML 输出格式Repomix 默认格式与之天然契合把重要指令放在 Prompt 末尾明确指定响应结构。ChatGPT更适合 Markdown 格式超大代码库可分章节提交可加入 system role 设定。Gemini兼容所有输出格式建议每次请求聚焦特定区域使用分步分析step-by-step以获得更稳健的结果。相关资源导航输出格式详解 XML、Markdown、JSON、Plain Text 四种格式的结构与选型自定义指令向输出中添加项目专属上下文与约束使用场景AI 辅助工作流的真实案例与更多示例 Prompt代码压缩降低大型代码库的 token 消耗命令行动态参考--style、--compress、--include等全部 CLI 参数说明常见问题安装、隐私与 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),仅供参考