1. 零门槛必会(5 条)

新手入门必须掌握的基础命令

目的 命令 一句话示例
全局安装 npm i -g @openai/codex 一次装完,全系统可用
登录 codex auth login 浏览器回车即完成 OAuth
交互会话 codex 纯交互,TAB 补全指令
单步执行 codex "指令" codex "给所有函数加 try/catch"
完全免确认 codex --approval-mode full-auto "指令" CI/脚本最爱

2. 文件级高频(4 条)

针对特定文件和目录的常用操作

场景 命令模板 一句话示例
针对文件 codex edit <file> "指令" codex edit src/api.ts "把 axios 换成 fetch"
针对目录 codex . "指令" codex . "按 Clean Architecture 重构整个 backend"
多模态(图) codex -i <pic> "指令" codex -i mockup.png "生成对应 React 页面"
仅预览 --dry-run codex edit app.js --dry-run "先给我看看 diff"

3. 交互里敲「/」指令(6 条)

在 codex 交互界面内直接输入的快捷指令

指令 作用
/init 当前目录生成 AGENTS.md 项目上下文
/model o3 实时切换模型(o3 / o4-mini / gpt-4o 等)
/mode auto-edit 切到自动编辑模式
/approvals never 本次会话不再询问直接写盘
/status 查看当前模型、Token 消耗
/help 列出所有内置 / 指令

4. 批处理 & CI(3 条)

自动化和持续集成场景下的命令

场景 命令模板 一句话示例
非交互headless codex exec "指令" codex exec "生成 CHANGELOG 下一版本"
批量文件 codex batch "<glob>" "指令" codex batch "src/**/*.ts" "统一加上导出注释"
GitHub Actions codex exec --full-auto "指令" 见下方 YAML 片段
.github/workflows/codex.yml 示例
# .github/workflows/codex.yml 示例
- name: Update changelog
  run: |
    npm i -g @openai/codex
    export OPENAI_API_KEY=${{ secrets.OPENAI_KEY }}
    codex exec --full-auto "update CHANGELOG for next release"

5. 配置 & 多 profile(2 文件 1 参数)

配置文件和多环境管理

目的 命令 / 路径 关键示例
全局配置 ~/.codex/config.toml 见下方 TOML 片段
项目配置 <project>/codex.toml 把审批策略、模型锁定到仓库
快速换 profile codex -p <name> codex -p auto "refactor src"
~/.codex/config.toml 最简可用示例
# ~/.codex/config.toml 最简可用示例
model = "o4-mini"
approval_policy = "on-request"
sandbox_mode = "workspace-write"

[profiles.auto]
approval_policy = "never"
sandbox_mode = "danger-full-access"

6. 典型「一条龙」组合(直接抄)

常见工作流程的完整命令组合

1. clone 项目 → 生成上下文 → 全自动重构
git clone xxx.git && cd xxx
codex /init                       # 生成 AGENTS.md
codex -p auto "按 RESTful 规范重构所有路由"
2. Code Review 前自动补测试 & 改 CHANGELOG
codex exec --full-auto "为本次改动的函数补单测"
codex exec --full-auto "更新 CHANGELOG"
git add . && git commit -m "test & changelog updated by codex"

总结

把上面 18 条命令贴到终端侧,就能覆盖 90% 日常场景。
更多冷门参数可 codex --help 或进交互后敲 /help 实时查。祝你使用愉快!

macOS/Linux Codex 安装指南

在 macOS 或 Linux 系统上安装官方 Codex CLI,100% 使用官方原版安装包

系统要求

确保您的系统满足以下要求

支持的操作系统

  • macOS 10.15+ 系统
  • Linux 系统(各主流发行版)

安装步骤

按照以下步骤完成 Codex CLI 的安装和配置

1 安装 Codex 官方原版包

选择一种安装方式
npm install -g @openai/codex
# 或者
brew install codex

2 创建配置目录

创建 Codex 配置目录
mkdir ~/.codex

3 获取 API 密钥

访问 Claude Code 平台获取您的 API 密钥

🔗 获取API密钥

点击下方链接访问 Claude Code 平台,注册并获取您的 API 密钥:

🚀 访问 Claude Code 平台

💡 提示:请妥善保管您的API密钥,不要泄露给他人

4 创建 auth.json 文件

删除 ~/.codex 路径下已存在的 auth.json 文件(若有),然后新建一个 auth.json

~/.codex/auth.json
{
  "OPENAI_API_KEY": "你的API_KEY"
}

5 创建 config.toml 文件

删除 ~/.codex 路径下已存在的 config.toml 文件(若有),然后新建一个 config.toml

~/.codex/config.toml
model_provider = "yourapi"
model = "gpt-5-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.yourapi]
name = "yourapi"
base_url = "https://api.claudecode.net.cn/api/codex/backend-api/codex"
wire_api = "responses"

6 验证安装结果

重启终端后运行以下命令,确认安装成功

验证安装
codex -v

开始使用

安装完成后,您可以在任何项目目录中开始使用 Codex

启动 Codex
# 导航到您的项目
cd your-project-folder

# 启动 Codex
codex

🎉 安装完成!

现在您可以使用上面的18条常用命令来提升开发效率了。如有疑问,请参考技术支持或查看官方文档。

⚡ 一键快速安装脚本

适合有经验的开发者,一条命令完成所有配置

⚠️ 使用前请注意

  • 请先将下面脚本中的 *** 替换为您的真实API密钥
  • 此脚本会覆盖现有的配置文件,请谨慎使用
  • 确保您已经从 Claude Code 平台 获取了API密钥
一键安装脚本(请替换API密钥后使用)
# 全局安装 Codex CLI
npm install -g @openai/codex

# 创建配置目录和文件
mkdir -p ~/.codex && echo '{"OPENAI_API_KEY": "***"}' > ~/.codex/auth.json && echo 'model_provider = "yourapi"
model = "gpt-5-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.yourapi]
name = "yourapi"
base_url = "https://api.claudecode.net.cn/api/codex/backend-api/codex"
wire_api = "responses"' > ~/.codex/config.toml

# 启动 Codex
codex

💡 使用说明

  1. 复制上面的脚本到文本编辑器
  2. *** 替换为您从 Claude Code 平台获取的真实API密钥
  3. 在终端中粘贴并执行修改后的脚本
  4. 等待安装完成,Codex 将自动启动