浏览 AI 知识库

AGENTS.md 怎么写：记录构建命令、规范、禁区和完成标准

AGENTS.md 应该保存每次任务都必须知道的项目事实：构建命令、文件来源、禁止动作和完成标准。写成可执行规则，Agent 才不用反复猜。

需要哪一项，就直接查到哪一段

把表格、命令、清单或规则作为工作中的查询工具，不要求从头顺序阅读。

这张表什么时候有用

Agent 每次进入仓库都重新猜构建命令，有时运行全量格式化，有时修改生成文件。口头提醒不会随新任务稳定传递。

字段参考

要记录的内容	怎么填写	检查点
适用范围	说明规则覆盖目录、子目录覆盖方式和多文件优先级。	Agent 知道当前文件受哪组规则约束
项目入口	列依赖、启动、构建、测试、格式化和生成命令及工作目录。	命令已在当前仓库实测
编辑边界	指出权威内容源、生成物、禁止目录、用户改动处理和允许的重构范围。	不会误改产物或覆盖他人工作
风险与权限	部署、删除、迁移、密钥、网络和生产操作的确认要求。	不可逆动作有明确停止点
完成标准	要求 diff、测试、截图、日志、回滚和未验证项。	完成可被另一人复核

规则文件实例

字段	示例内容	验证
范围	适用于 src/，docs/ 有更近规则	读取当前路径的优先级
入口	npm run build、npm run test:unit	命令已在当前仓库实测
边界	编辑 content/ 源，禁止手改 public/ 生成物	源/生成物对照
风险	部署、删除和生产配置需人工批准	越界任务触发停止
完成	diff、测试、截图和未验证项	另一人可复核

命令和目录为示例；实际规则必须来自当前项目。

本例材料

需要确认	本例内容
现有材料	项目实际命令为 `npm ci`、`npm run build:stage-b` 和四个验证脚本；Footer 与生成源有固定规则。
不能越过的边界	AGENTS.md 记录可执行规则和作用域，不粘贴长篇背景；秘密和个人路径不进入文件；与当前仓库实际一致。
要交付的结果	可执行项目规则文件

最终输出

规则文件写明目录结构、权威源、构建/验证命令、禁止修改 Footer、保留脏工作区和完成证据。新 Agent 进入后能复述这些约束并用正确命令验证，不再先改生成 HTML。

常见失败

验收方式

命令在当前仓库实测禁区和权威源明确完成定义包含可观察证据适用目录和子规则优先级清楚构建、测试、生成器和工作目录可执行源文件、生成物和用户改动边界明确删除、部署、密钥和网络动作有停止点正常任务完成，越界任务被规则拦住

进一步核对

项目规则应写可执行命令、作用范围、限制和完成标准。

交接中的版本、分支、diff 和提交状态必须回到真实仓库核对。