Codex 实践总览
本专区整理 OpenAI Codex 在本项目中的推荐用法。内容基于 OpenAI 官方 Codex 文档、OpenAI Codex 开源仓库,以及面向代码生成和安全边界的官方说明,重点是把“怎么用 Codex 更稳定”落到团队文档、提示、配置、验证和复用机制上。
适合本项目的落地路径
- 先用
AGENTS.md固化项目约定:目录结构、运行命令、构建检查、文档规范、禁止事项。 - 每次任务提示都写清楚四件事:目标、上下文、约束、完成标准。
- 对复杂任务先让 Codex 计划,再进入实现。
- 把验证写进完成标准:
npm run docs:build、链接检查、截图或人工审阅。 - 对重复流程沉淀成 Skills 或项目文档,而不是反复复制长提示。
- 对网络、MCP、外部系统访问保持最小权限,并审阅输出和工作日志。
文档目录
- 最佳实践:Codex 工作流的高层原则和团队落地清单。
- AGENTS.md 项目指令:如何给 Codex 提供稳定、分层、可继承的项目上下文。
- 提示与工作流:如何写任务提示、拆分复杂任务、安排验证。
- 配置、沙箱与安全:配置层、权限边界、网络访问和安全策略。
- 来源索引:本专区使用的官方和权威 GitHub 来源。
本项目建议优先补齐
当前仓库是 VitePress 文档站,最值得先加的是仓库根目录 AGENTS.md。建议包含:
- 项目类型:VitePress 文档站,正文位于
docs/。 - 常用命令:
npm run docs:dev、npm run docs:build、npm run docs:preview。 - 文档规范:新增页面必须有
title和orderfrontmatter。 - 修改边界:不要改动
node_modules/、压缩包、截图资产,除非任务明确要求。 - 验证标准:文档结构变更后至少运行
npm run docs:build。