Codex / 配置
用 AGENTS.md 指导 Codex
AGENTS.md 是项目级规则入口,适合记录命令、架构、代码风格和协作边界。

AGENTS.md 的作用
AGENTS.md 是给 Codex 的项目级指导文件,适合记录仓库结构、命令、测试、风格、设计规则、权限边界和交付要求。
它应该像给新同事的操作手册,而不是长篇教程。越靠近子目录的 AGENTS.md 越具体,能覆盖上层规则。
建议内容
写 Codex 无法稳定猜到但每次都需要遵守的信息。
| 应该写 | 不建议写 |
|---|---|
| 构建、测试、lint 命令。 | 语言基础教程。 |
| 项目特有架构和目录边界。 | 逐文件解释整个代码库。 |
| 设计规范和响应式要求。 | 过时的临时状态。 |
| 禁止事项和安全边界。 | 密钥、账号、cookie。 |
示例片段
把要求写成可执行检查项。
## 验证
- 前端改动后运行 pnpm build
- 页面改动检查移动端
## 禁止
- 不要提交 .env
- 不要改支付逻辑,除非任务明确要求完整使用要点
补充官方文档中容易被压缩遗漏的核心概念、操作顺序、权限边界和验证要求,方便中文学习者按页面完整学习。
学习检查清单
把本页内容落到真实任务中,用入口、上下文、权限、验证和团队规则五个维度检查是否真正掌握。
学习检查清单
读完本页后,不要只记住概念名。你应该能把“用 AGENTS.md 指导 Codex”放回 Codex 的真实工程流程里:任务从哪里发起,系统会加载什么上下文,哪些动作需要审批,结果如何验证,失败时如何回退。
如果这是配置或参考页面,要特别确认配置放在哪里、是否会被提交、是否包含敏感信息、是否会扩大默认权限,以及如何在失败时排查实际生效的设置。
- 能用自己的话说明本页解决的具体问题,而不是只复述标题。
- 能写出一个最小示例任务,并标明目标、范围、禁止事项和验收标准。
- 能判断哪些信息应该放进当前提示,哪些应该沉淀到项目规则或配置里。
- 能说明哪些长期规则应该写进 AGENTS.md,哪些运行行为应该交给 config.toml、permission profile、skills 和 MCP。
- 能在任务完成后检查 diff、命令输出、测试结果、截图或 PR 说明,而不是只相信自然语言总结。
如果要把本页用于团队培训,可以让学员用 Codex 完成一个小任务:先只读解释,再提交计划,再执行最小改动,最后用真实验证命令和人工 diff 审查收尾。
Codex 实操注意事项
围绕本地环境、权限升级、远程入口、自动化失败和回滚补齐 Codex 使用中最容易被忽略的执行细节。
Codex 实操注意事项
这一页会影响 Codex 的默认行为。配置前要先判断它会不会扩大文件写入、网络访问、工具调用或无提示执行能力,并为团队保留审计和回滚方式。
处理“用 AGENTS.md 指导 Codex”相关任务时,建议始终先确认当前 Git 状态和工作目录。Codex 可以很快完成修改,但它不会自动知道哪些未提交改动来自用户、哪些文件不能碰、哪些命令会影响生产环境。
- 本地任务优先使用低风险分支或工作树,完成后用 git diff 审查。
- 涉及安装依赖、联网、数据库、部署、push、删除、reset 时,先要求 Codex 解释影响再批准。
- 远程或协作入口生成的结果,也要回到 PR、CI、构建日志和测试证据中确认。
- 自动化任务要提前定义失败输出和退出条件,避免 Codex 在错误方向上反复尝试。
把 Codex 当成能执行命令的工程队友,而不是只会写文本的助手。越靠近真实系统,越需要明确边界、证据和回滚。