003 核心指令与终端工作流
掌握 Codex 的八大核心指令,建立高效的终端工作流。
学习目标
完成本课程后,你将能够:
一、核心指令总览
Codex 提供了一套斜杠指令(Slash Commands),每个指令对应一种特定的开发任务。
| 指令 | 功能 | 典型场景 |
|---|---|---|
| `/code` | 生成代码 | 根据描述创建新文件或功能模块 |
| `/review` | 代码审查 | Review 当前变更,给出改进建议 |
| `/test` | 生成测试 | 为指定文件或函数编写测试用例 |
| `/debug` | 调试问题 | 分析错误日志,定位并修复 bug |
| `/docs` | 生成文档 | 为代码生成注释、README 或 API 文档 |
| `/refactor` | 重构代码 | 优化代码结构、提取函数、改善可读性 |
| `/deps` | 管理依赖 | 安装、更新、审计项目依赖 |
| `/init` | 初始化项目 | 从零搭建新项目的脚手架 |
二、指令详解
`/code` — 代码生成
最核心的指令,用于根据自然语言描述生成代码。
# 在 Codex 会话中直接使用
> /code 创建一个 Express 路由处理用户注册,包含邮箱验证
# 也可以不加 /code 前缀(Codex 会自动识别)
> 帮我写一个登录表单组件,包含邮箱输入框和密码输入框**最佳实践:**
- 明确指定技术栈("用 React + TypeScript 写一个...")
- 说明边界条件和错误处理要求
- 复杂任务分步执行,不要一次描述太多
`/review` — 代码审查
对当前工作区的代码变更进行全面审查。
> /review 检查 app/api/users/route.ts 的安全漏洞
> /review 审查最近 3 次 commit 的代码质量审查输出通常包括:潜在 bug、安全漏洞、性能问题、代码风格建议、可简化之处。
`/test` — 生成测试
自动分析代码逻辑,生成对应的测试用例。
> /test 为 src/utils/formatDate.ts 写单元测试
> /test 为 POST /api/checkout 写集成测试,覆盖正常和异常场景Codex 会自动识别测试框架(Jest、Vitest、Pytest 等),生成符合项目规范的测试代码。
`/debug` — 调试问题
粘贴错误信息或描述异常行为,Codex 会分析原因并给出修复。
> /debug TypeError: Cannot read properties of undefined (reading 'map')
at HomePage (src/app/page.tsx:25:32)Codex 会读取相关文件,分析调用链,定位根因,并直接修改代码。
`/docs` — 生成文档
> /docs 为 src/lib/api.ts 生成 JSDoc 注释
> /docs 为整个项目生成 README.md`/refactor` — 重构代码
> /refactor 把 utils/helpers.ts 中的 3 个函数提取到独立文件
> /refactor 将 class 组件改为函数组件 + hooks`/deps` — 管理依赖
> /deps 检查当前项目哪些依赖可以更新
> /deps 将 moment.js 替换为 dayjs`/init` — 初始化项目
> /init 创建一个 Next.js 14 + TypeScript + Tailwind CSS 项目Codex 会运行脚手架命令、安装依赖、创建基础目录结构。
三、Shell 管道集成
Codex 是终端原生的,天然支持 Unix 管道。这是它相比 IDE 工具的一大优势。
管道用法示例
# 将命令输出传给 Codex 分析
cat error.log | codex "分析这些错误日志,找出根本原因"
# 用 Codex 处理 git diff
git diff | codex "为这些变更生成一条规范的 commit message"
# 将 ls 输出传给 Codex 解释项目结构
ls -la | codex "解释这个目录的文件结构"
# 结合 find 搜索
find . -name "*.tsx" | codex "统计每个文件的组件数量"管道 + 指令组合
# 查看最近的 git log 并让 Codex 生成 changelog
git log --oneline -20 | codex "/docs 根据这些 commit 生成 CHANGELOG.md"
# 运行测试后分析失败原因
npm test 2>&1 | codex "/debug 分析测试失败原因并修复"**💡 提示:** 管道模式特别适合 CI/CD 流程。你可以将 Codex 作为流水线中的一个步骤,自动分析构建输出。
四、构建高效工作流
典型开发流程
1. /code — 编写新功能代码
2. /test — 为功能生成测试
3. /review — 审查代码质量和安全性
4. /docs — 补充文档注释
5. git commit — 提交(Codex 可生成 commit message)调试流程
1. 复现 bug,复制错误信息
2. /debug — 让 Codex 分析根因
3. /code — 让 Codex 实施修复
4. /test — 生成回归测试
5. 验证修复重构流程
1. /review — 审查现有代码找出问题
2. /refactor — 执行重构
3. /test — 确保重构不破坏现有功能
4. /review — 再次审查重构后的代码五、本课总结
**核心要点:**
- Codex 提供 8 个核心指令,覆盖开发全流程
- `/code` 和 `/debug` 是使用频率最高的两个指令
- Shell 管道将 Codex 深度集成到 Unix 工作流中
- 指令可以自然组合:先 review 发现问题,再 refactor 解决
- 管道模式是 Codex 区别于 IDE 工具的独特优势
**下一步:** 下一课将学习结构化提问方法,掌握角色目标约束格式(RGC),让 Codex 更准确理解你的意图。