TL;DRCodex 在老仓库里跑偏,多数时候不是模型不行,而是没人告诉它规矩。这篇给一份 20 分钟补写 AGENTS.md 的 SOP:/init 起稿、按四块骨架补全、小任务验收、纠错回写。
来源信号 SOURCES
以下内容整理自社区公开讨论,本页只做拆解与核实,不搬运原帖;观点归属原作者。
官方指南 · ChatGPT Learn《Best practices》· AGENTS.md 生态查看原帖 ↗Promptessor · Best AGENTS.md Examples 模板合集 · AGENTS.md 生态查看原帖 ↗
事实性知识 FACTS
这些是讨论中被多方印证、或可对照官方文档核实的事实。
- AGENTS.md 已是 Linux Foundation 开放的纯 Markdown 标准:放进仓库、随代码分发,人和代理读同一份。
- 官方最佳实践把沉淀长期指令列为核心用法:每次会话都要重复交代的约束,应该写进 AGENTS.md,而不是靠人的记性。
- 社区模板把 AGENTS.md 的常见骨架归为四块:项目上下文、架构说明、开发命令、编码规范。
- Codex CLI 提供
/init命令,会扫描仓库生成一份 AGENTS.md 初稿——它是改写起点,不是终稿。
概念性知识 CONCEPTS
社区讨论里的概念不全是事实——每条都标注了它的性质,读之前先看标签。
AGENTS.md已验证事实
放在仓库里、给编码代理读的说明文件:项目是什么、命令怎么跑、规矩有哪些。纯 Markdown,人与代理通用。
指令沉淀已验证事实
官方最佳实践的提法:把跨会话有效的约束固化成常驻指令,替代每次开场的人力重复。
初稿依赖个人观点
用 /init 生成后不做校对直接使用。社区经验是初稿常混入模型猜测(不存在的脚本名、过时的路径),直接采用会把错误固化下来。
写给代理的文档个人观点
社区里一种有影响力的主张:AGENTS.md 应优先服务代理——命令可直接执行、禁区可被校验;愿景和感想对代理没有约束力。
场景 SOP STEP BY STEP
目标接手一个没有 AGENTS.md 的现有仓库,20 分钟内补出一份能让 Codex 少跑偏的最低可用版本。
前提本机已安装 Codex CLI 并能登录;仓库可以在本地构建运行。
- 01生成初稿
在仓库根目录启动
codex,输入/init,让它扫一遍仓库生成 AGENTS.md 初稿。 - 02删掉猜错的部分
通读初稿,凡是你拿不准的描述(脚本名、路径、版本号)逐条核对,错的改、没的删——初稿是起点,不是终稿。
- 03补齐四块骨架
按项目上下文、架构说明、开发命令、编码规范补全。命令必须是仓库里真实可跑的,并顺手标注哪些慢、哪些有副作用。
- 04写清禁区
列出不要动的东西:生成目录、锁文件、环境配置。代理对「没说不行」的事,默认都会去试。
- 05用小任务验收
让它修一个已知的小 bug 或补一个单测,观察它是否用对了 AGENTS.md 里的命令、有没有踩禁区。
- 06把纠错写回去
验收中它每犯一类错,就把对应约束补进 AGENTS.md。这份文件的价值靠持续追加,不靠一次写完。
结果仓库根目录多了一份核对过的 AGENTS.md;新会话提需求时,Codex 能直接用对命令、避开禁区。
看完之后 NEXT
想知道今天的重置判定?回到 首页实时雷达。