Skip to content

Codex 从 0 到 1

本模块演示如何用 Codex 从空仓库完成同一个“AI 项目交付看板”。重点是把任务写成可验证、可审查、可提交的工程任务。

官方依据

Step -1:安装与登录

课堂至少准备一种 Codex 入口:Codex CLI、Codex App 或 IDE 扩展。CLI 最适合演示从空仓库开始,因为它能直接在终端中读取、修改并验证当前目录。

Node.js 环境可用时:

powershell
npm i -g @openai/codex
codex

macOS Homebrew:

bash
brew install --cask codex
codex

第一次运行 codex 时按提示使用 ChatGPT 账号或 API Key 登录。课堂推荐优先用 ChatGPT 账号登录,便于学员理解“本地 CLI、IDE、云端任务共享同一账号体系”。登录完成后,在演示仓库根目录运行 codex,确认它能读取 AGENTS.mddocs/project/*.md

如果使用 Codex App 或 IDE 扩展,课前同样要确认当前打开的是示例仓库根目录,并且 Codex 可以看到 AGENTS.md。任何 API Key、令牌和账号截图都不要提交到仓库。

Step 0:准备仓库

powershell
mkdir ai-delivery-board
cd ai-delivery-board
git init

推荐方式:下载 Codex 中文包Codex English package,解压到演示仓库。README.mdAGENTS.mddocs/project/*.md 都由资料包提供。

如果不用资料包,则手动创建这些基础文件:

text
README.md
AGENTS.md
docs/project/requirements.md
docs/project/acceptance.md
docs/project/design-context.md
docs/project/test-strategy.md
docs/project/risk-register.md
docs/project/release-checklist.md

解压或手写完成后,再按本页步骤让 Codex 读取上下文并执行任务。

Step 1:写好 AGENTS.md

Codex 需要清楚的项目规则。第一版可以这样写:

markdown
# AGENTS.md

## 项目概览

本项目是 AI 交付看板培训演示。

## 常用命令

- 安装依赖:npm install
- 开发预览:npm run dev
- 构建:npm run build
- 测试:npm test

## 工作规则

- 实现前先阅读 docs/project/*.md。
- v1 不添加数据库。
- v1 不添加登录认证。
- 保持改动小而可审查。
- 声称完成前先运行构建。

## 完成标准

最终回复必须包含修改文件、验证结果和已知风险。

Step 2:让 Codex 先分析

提示词:

text
请核查当前仓库,阅读 AGENTS.md、README.md 和 docs/project/*.md。
先不要改文件。请输出:
1. 项目目标
2. 范围和不做范围
3. 实现计划
4. 受影响文件
5. 验证命令
6. 风险

讲师要点:

  • Codex 很适合带着文件和构建命令推进。
  • 不要只说“帮我做一个看板”,要让它先读上下文。
  • 任务越可验证,Codex 输出越容易审查。

Step 3:执行第一版

提示词:

text
开始实现第一版 AI 项目交付看板。
要求:
- 不使用数据库
- 不做登录
- 支持任务列表、状态筛选、空状态
- 完成后运行构建
- 给出中文说明

如果 Codex 要扩大范围:

text
请回到第一版范围,只实现 acceptance.md 中列出的最小验收项。

Step 4:构建与验证

Codex 完成后运行:

powershell
npm run build
git status --short
git diff --stat

人工验收:

  • 任务列表可见。
  • 状态筛选可用。
  • 空状态可见。
  • 没有数据库或登录代码。
  • 构建通过。

Step 5:让 Codex 做审查

提示词:

text
请以代码审查角度检查当前 diff。
重点看:
- 是否违反 AGENTS.md
- 是否满足 acceptance.md
- 是否有过度设计
- 是否缺少测试或手动验收记录
先只报告问题,不要修改。

Step 6:提交

如果验证通过:

powershell
git add .
git commit -m "feat: 完成 AI 项目交付看板第一版"

团队可以要求 Codex 的最终说明包含:

  • 改动文件
  • 验证命令
  • 手动验收结果
  • 未覆盖风险
  • 下一步建议

Step 7:和 Claude Code 对比

课堂讨论:

维度Claude CodeCodex
项目记忆CLAUDE.md、memory、slash commandsAGENTS.md、任务计划、构建验证
交互方式结对式、会话式工程任务式、验证式
团队落地适合日常结对、快速探索适合明确任务、审查、提交和自动化
共同要求都需要清晰上下文、边界和验收