Codex 快速入门指南

Codex 快速入门指南

为什么选择 Codex

Codex 是官方的 AI 编程助手，支持上下文理解、代码补全、重构、测试生成等常见开发任务，并且可以与终端、编辑器和 CI 流水线协同工作。

安装

按照你的环境选择其一完成安装：

# macOS（Homebrew）
brew tap codex/cli && brew install codex

# 或使用脚本
curl -fsSL https://cli.codex.sh/install | bash

# 验证
codex --version

基础配置

# 登录并配置工作目录
codex login
codex init

# 连接编辑器（以 VS Code 为例）
codex editor vscode --link

常见可选项：

  • --api-key 指定密钥（更推荐用环境变量 CODEX_API_KEY）
  • --project 指定项目名，便于在不同仓库复用

常用工作流

1. 解释与改进

codex ask "解释 src/hooks/use-chat.ts 的核心逻辑，并建议性能优化"

2. 生成单元测试

codex test src/lib/date.ts --framework vitest --coverage

3. 修复 ESLint / TypeScript 报错

codex fix --lint --typecheck

4. 代码重构

codex refactor src/components/editor --goal "拆分大组件，保留现有 API，不改动行为"

与 CI 集成（可选）

在 CI 中使用 Codex 进行自动审查：

# .github/workflows/codex.yml
name: Codex Review
on: [pull_request]
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: pnpm/action-setup@v4
      - run: pnpm i --frozen-lockfile
      - run: npx codex review --path .
        env:
          CODEX_API_KEY: ${{ secrets.CODEX_API_KEY }}

小结

到此你已经完成：安装 → 登录 → 链接编辑器 → 运行常见命令。接下来可以把 Codex 融入日常开发流，逐步形成自己的提示与命令模板。