Codex 版标准化 MD 文件集
Codex 版的核心是 AGENTS.md。它负责给 Codex 提供项目指令、运行命令、验证标准、权限边界和 Git 规则。相比 Claude 版,Codex 版更强调沙箱、审批、配置和任务完成证据。
推荐文件树
text
project-root/
├── AGENTS.md
├── README.md
├── CONTRIBUTING.md
├── SECURITY.md
├── docs/
│ ├── product/PRD.md
│ ├── architecture/OVERVIEW.md
│ ├── architecture/FRONTEND.md
│ ├── architecture/BACKEND.md
│ ├── api/API_SPEC.md
│ ├── development/SETUP.md
│ ├── development/CODING_STANDARDS.md
│ ├── development/REVIEW_CHECKLIST.md
│ ├── testing/TEST_STRATEGY.md
│ ├── operations/DEPLOYMENT.md
│ └── ai/
│ ├── PROMPTING.md
│ ├── CODEX_WORKFLOW.md
│ ├── CODEX_REVIEW.md
│ └── TASK_TEMPLATES.md
└── .codex/
└── config.tomlAGENTS.md 示例
markdown
# AGENTS.md
## 项目概览
这是一个前后端分离项目:
- 前端:React + TypeScript + Vite
- 后端:Node.js + NestJS
- 数据库:PostgreSQL
- API 文档:docs/api/API_SPEC.md
## 常用命令
- 安装依赖:pnpm install
- 前端开发:pnpm --filter web dev
- 后端开发:pnpm --filter api dev
- 类型检查:pnpm typecheck
- 单元测试:pnpm test
- 构建:pnpm build
## 工作规则
- 修改代码前先阅读相关文件,不要凭空改接口。
- 保持改动范围和用户请求一致。
- 不要修改 node_modules、dist、coverage、生成产物和密钥文件。
- 涉及 API 变更时同步更新 docs/api/API_SPEC.md。
- 涉及部署或环境变量时同步更新 docs/operations/DEPLOYMENT.md 或 ENVIRONMENT.md。
## Git 规则
- 完成并验证后提交 Git。
- 提交信息使用中文。
- 不要把无关未跟踪文件加入提交。
## 验证标准
- 代码变更后运行 pnpm typecheck 和 pnpm test。
- 构建相关变更后运行 pnpm build。
- 如果验证失败,先修复;无法修复时说明原因和剩余风险。.codex/config.toml 示例
toml
# .codex/config.toml
approval_policy = "on-request"
sandbox_mode = "workspace-write"
[features]
plugins = true
[profiles.docs]
model = "gpt-5.4"
reasoning_effort = "medium"配置文件要保持克制。项目级配置只写团队共享规则,不放个人 token、个人路径和临时偏好。
Codex 专属补充
| 文件 | 用途 |
|---|---|
docs/ai/CODEX_WORKFLOW.md | Codex 任务拆分、实现、验证、提交流程 |
docs/ai/CODEX_REVIEW.md | Codex 代码审查关注点和输出格式 |
docs/ai/PROMPTING.md | 常用提示模板 |
.codex/config.toml | 项目级 Codex 配置 |
适用场景
Codex 版适合希望 AI 直接参与读代码、改代码、跑测试、提交 Git 的团队。重点是把权限边界、完成标准和提交规则写清楚,让每次任务都有可验证证据。