★ FEATURED ARTICLE Deep Code CLI /init实战指南写出让AI编码效率翻倍的AGENTS.md【免费下载链接】deepcode-cliDeep Code 是专为 deepseek-v4 模型优化的终端 AI 编码助手支持深度思考、推理强度控制以及 Agent Skills。项目地址: https://gitcode.com/gh_mirrors/de/deepcode-cliDeep Code CLI 是专为 deepseek-v4 模型优化的终端 AI 编码助手它的/init命令可以一键生成AGENTS.md项目指南文件把安装依赖、运行测试、代码风格等长期规则沉淀下来让 AI 在这个仓库里少猜少错、效率翻倍。本文带你从零上手/init并手把手教你写出一份高质量、可直接落地的AGENTS.md。为什么需要 AGENTS.md如果你每次都在提示词里重复交代先跑哪个测试不要改哪个目录PR 描述要包含什么这些内容就该写进AGENTS.md。它是写给 AI 编码助手的项目说明文件让 Deep Code 在仓库工作时知道如何安装依赖、运行测试、修改代码以及遵守哪些团队约定。官方文档对它有完整说明推荐阅读docs/agents-md.md。一键生成/init 快速上手在 Deep Code 的会话中直接输入/initDeep Code 会分析当前仓库自动创建或更新AGENTS.md。它的背后是一套内置的提示词模板你可以直接查看/init使用的指令结构模板文件packages/core/templates/prompts/init_command.md.ejs模板要求生成的文档标题为 Repository Guidelines建议 200-400 词章节包括项目结构、构建/测试命令、代码风格、测试规范、提交与 PR 约定等。首次使用前的准备如果还没有安装先克隆仓库体验git clone https://gitcode.com/gh_mirrors/de/deepcode-cliAGENTS.md 放在哪里Deep Code 按优先级查找项目级说明文件查找逻辑可在会话加载指令的实现中看到packages/core/src/session.ts文件适合场景AGENTS.md希望项目中不同 AI 编码工具都能读取.deepcode/AGENTS.md规则只面向 Deep Code~/.deepcode/AGENTS.md个人默认偏好适用于没有项目说明的仓库小技巧如果两个项目级文件同时存在.deepcode/AGENTS.md优先级更高都没有时才回退到用户主目录下的全局配置。AGENTS.md 该写什么、不该写什么适合写入的稳定规则项目结构和重要目录安装、开发、构建、测试命令代码风格、命名约定、格式化要求测试要求和验证步骤提交、PR、发布流程安全、配置、凭据处理注意事项不适合写入的内容一次性任务要求例如这次只改登录页——直接写在对话里复杂可复用工作流——更适合写成 Agent Skill外部系统连接信息——更适合通过 MCP 配置API Key、密码、Token 等敏感信息——任何时候都不要写入四条写作原则写出让AI一次读懂的规则1. 写具体命令不写常用命令推荐npm test— 运行全部测试npm run build— 执行类型检查并构建 CLI。 避免完成前运行常用命令。 AI 不知道常用是哪几个。2. 写明确规则不写确保正常推荐修改行为时需要新增或更新测试完成前运行npm test。 避免确保一切正常。 没有可执行的判定标准。3. 写项目事实不写空泛描述推荐src/存放应用代码tests/存放自动化测试。 避免这是一个普通的 TypeScript 项目。 对 AI 毫无信息量。4. 写安全边界不写注意保护密钥推荐不要提交 API Key 或 Token本地凭据放在~/.deepcode/settings.json。 避免注意保护密钥。 边界模糊等于没说。一份完整的 AGENTS.md 示例下面是一份可直接参考的示例完整版见官方文档# 仓库指南 ## 项目结构 - src/ 存放应用代码。 - src/tests/ 存放自动化测试。 - docs/ 存放面向用户的文档。 ## 开发命令 - npm install — 安装依赖。 - npm test — 运行自动化测试。 - npm run build — 运行检查并构建 CLI。 ## 代码风格 使用 TypeScript保持命名清晰遵循现有格式风格不要引入无关重构。 ## 测试 修改行为时需要添加测试。优先运行范围最小的相关测试 完成前运行 npm test 或 npm run build。 ## AI 助手注意事项 - 不要提交密钥或本地生成文件。 - 保留用户已有修改。 - 说明无法执行的验证步骤。AGENTS.md 与 Agent Skill、MCP 的分工三者不是替代关系而是分层协作工具适合放什么AGENTS.md当前仓库的长期规则、命令、风格、验证步骤Agent Skill可复用工作流、领域知识、模板、脚本MCPGitHub、数据库等外部工具和实时数据一个好记的组合口诀在AGENTS.md中写这个项目怎么做在 Agent Skill 中写这类任务怎么做用 MCP 提供需要连接外部服务才能做的能力。日常维护让指南始终有效项目命令变化后及时更新再次运行/init会自动对齐变化删除已经过期的规则避免 AI 被误导保持简短优先保留高频、重要、容易出错的约定规则只适用于某次任务时直接写在当前对话中即可总结/init只是起点真正让 AI 编码效率翻倍的是你持续维护的AGENTS.md。花 10 分钟写好它之后每次对话都省掉大段重复交代——这正是终端 AI 编码助手的正确打开方式。【免费下载链接】deepcode-cliDeep Code 是专为 deepseek-v4 模型优化的终端 AI 编码助手支持深度思考、推理强度控制以及 Agent Skills。项目地址: https://gitcode.com/gh_mirrors/de/deepcode-cli创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
阅读完成 · 觉得有帮助？
