AGENTS.md 让 Codex 桌面端稳定理解项目规则、命令和完成标准。
AGENTS.md:让 Codex 理解项目规范
如果你经常重复告诉 Codex「怎么跑测试、代码风格是什么、哪些文件不能碰」,就应该写 AGENTS.md。
发现顺序
- 全局:
~/.codex/AGENTS.override.md或~/.codex/AGENTS.md。 - 从项目根到当前目录逐层查找
AGENTS.override.md、AGENTS.md。 - 越靠近当前目录,优先级越高。
建议模板
# 项目说明
## 目录结构
## 常用命令
- 安装依赖:
- 启动开发:
- 运行测试:
- 运行 lint:
## 工程规范
## 安全边界
## 完成标准/init 自动生成
在 CLI 或 App 中执行 /init 可生成 AGENTS.md 草稿。生成后必须人工修订,不能把模板当成最终规范。
常见错误
- 写得太空:「请遵守最佳实践」这类话对 Codex 无效。
- 写得太死:穷举所有目录文件,反而让模型困惑。
- 没有「完成标准」:模型不知道什么时候算做完。