Codex 的 AGENTS.md 怎么写？让它记住你的项目规矩｜附模板

每次都要重新交代？

每次跟 Codex 开新对话，都要把同样的规矩再交代一遍：用中文回复，哪些文件别动，改完要检查。

其实可以把这些约定写进一个 AGENTS.md，让 Codex 开工前先读。这期讲三件事：放在哪，写什么，还有怎么确认它真的读到了。完整模板和验证步骤，我也整理成了配套文章。

AGENTS.md 放在哪

AGENTS.md 就是一个普通的文本文件。先从最简单的用法开始，把它放在项目根目录，也就是 Git 仓库最外面那一层，跟这里的 index.html 放在一起。

还有一份全局说明，放在 Codex 主目录里。默认是用户目录下的点 codex 文件夹，适合写“用中文回复”这种个人习惯。如果你自定义过 Codex 主目录，就以实际位置为准。项目里的文件，则用来写这个项目的规矩。

两层都会读，项目里的排在后面，两边说法冲突时，以项目里的为准。

所有说明合起来还有大小上限，默认是三十二 KiB。这是文件大小，不是字数。所以写短一点，只写真正要它遵守的。

先用初始化生成草稿

不知道从哪写起，可以先在输入框输入斜杠 init。这里的菜单叫“初始化”，会让 Codex 看一遍项目，生成 AGENTS.md 草稿。

我这次生成的是英文，里面列了项目结构、检查命令，还有改代码的约定。先检查这些内容是不是符合你的项目，草稿只当参考，下面再按模板改成自己的。

写什么：五段模板

我把模板分成五段，你照着把内容换成自己项目的就行。

第一段，项目说明。一两句话说清楚这是什么项目，用了什么技术。这里是原生 HTML、CSS 和 JavaScript 写的待办清单，没有后端。

第二段，常用命令：怎么预览，怎么检查。这个小网页直接打开 index.html 就能预览，再把 JavaScript 语法检查和 Git 差异检查的命令写进去。有测试的项目，就填你实际使用的测试命令。

第三段最重要，改代码的规矩。比如：开始前先运行 git status，有没提交的改动，先停下来问我。这条接着上期，提醒它先确认你手里的改动。再比如：只改跟任务有关的文件，未经明确要求，不要修改 style.css。

第四段，改完要检查什么：打开网页，把改到的功能实际操作一遍。最后列出改了哪几个文件，每个文件一句话说明。

第五段，沟通习惯：用中文回复，需求不清楚就先问，不要自己猜。

记住，写具体的，别写空话。“注意代码质量”太笼统，换成“改完运行这条检查命令，全部通过再结束”，就有了能核对的动作。

写好保存，再把这个文件提交到 Git。以后规矩改了，也能查到记录。

实测：它到底读到没有

保存以后，新建一个对话再测。

先问它：总结一下你现在要遵守的项目说明。这里它把修改前检查、不要随意动样式文件，还有改完检查这些约定，都复述出来了。

再来一次真的。我先给 app.js 加一行注释，暂时不提交，然后让 Codex 把添加按钮改成蓝色。

它先运行了 git status，发现 app.js 有没提交的改动，就停下来问我是否继续。这次的行为跟规矩写的一样，文件也没有被它改动。

不过，AGENTS.md 是给它的说明，不是保证每次都照做的开关。重要的改动，还是要自己检查。

改了没生效怎么办

改了 AGENTS.md 好像没用？先新建一个对话再试。这次实测里，我把验证标记从 A 改成 B，原来的对话仍然回答 A，新对话才读到了 B。

还不行，就检查文件名和位置：名字是 AGENTS.md，放在项目根目录。再让它总结一次当前说明，核对有没有读到你刚改的内容。

规矩越写越多也不好。删掉空话，只留你确实需要它遵守、而且能够检查的约定。

片尾

完整模板和验证方法已经整理在配套文章里。你可以先给自己的项目写上这五段，再开一个新对话，检查它读到了哪些规矩。

这里是西楚极客，我们继续用 AI，把真正能运行的项目做出来。下期见。