codex
Codex使用教程

Codex 使用指南

了解如何使用玖亿 AI 编程助手来提高您的开发效率

快速开始

1. 获取 API Key(必须)

在开始使用 Codex 之前,您需要先获取 API Key。

👉 前往获取 API Key (opens in a new tab)

2. 安装 Codex

手动安装

使用 npm 或 brew 安装 OpenAI Codex CLI 工具:

npm install -g @openai/codex  # 或者使用: brew install codex

3. 配置文件设置

创建 ~/.codex/ 文件夹并配置必要的文件。

配置文件位置

  • macOS/Linux: ~/.codex/
  • Windows: %USERPROFILE%\.codex\

⚠️ 注意: .codex 文件夹需要手动创建(如以前使用过 codex 命令,则无需创建 .codex 文件夹,只需找到对应的文件夹修改配置文件即可)

创建 config.toml

~/.codex/config.toml 中添加以下配置:

model_provider = "crs"
model = "gpt-5-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"
 
[model_providers.crs]
name = "crs"
base_url = "https://code.claude.best/openai"
wire_api = "responses"
requires_openai_auth = true
env_key = "CRS_OAI_KEY"

创建 auth.json

~/.codex/auth.json 中添加以下内容:

{
  "OPENAI_API_KEY": null
}

💡 说明: 将 OPENAI_API_KEY 设置为 null,然后设置环境变量 CRS_OAI_KEY 为您的 API 密钥(格式如 cr_xxxxxxxxxx)。

4. 环境变量设置

Windows 系统

方法1:通过系统设置(推荐)
  1. Win + R,输入 sysdm.cpl,按回车
  2. 点击"环境变量"按钮
  3. 在"用户变量"或"系统变量"中点击"新建"
  4. 变量名输入:CRS_OAI_KEY
  5. 变量值输入:你的API密钥
  6. 点击"确定"保存
方法2:命令行设置

CMD(命令提示符)

# 临时设置(仅当前会话有效)
set CRS_OAI_KEY=你的API密钥
 
# 永久设置(需要管理员权限)
setx CRS_OAI_KEY "你的API密钥"

PowerShell

# 临时设置(仅当前会话有效)
$env:CRS_OAI_KEY = "你的API密钥"
 
# 永久设置(用户级别)
[System.Environment]::SetEnvironmentVariable('CRS_OAI_KEY', '你的API密钥', [System.EnvironmentVariableTarget]::User)
 
# 永久设置(系统级别,需要管理员权限)
[System.Environment]::SetEnvironmentVariable('CRS_OAI_KEY', '你的API密钥', [System.EnvironmentVariableTarget]::Machine)
验证配置

CMD验证

echo %CRS_OAI_KEY%

PowerShell验证

echo $env:CRS_OAI_KEY

macOS/Linux 系统

临时设置
export CRS_OAI_KEY=cr_xxxxxxxxxx   # 仅当前会话有效
持久保存

添加到您的 shell 配置文件中:

对于 zsh(默认)

echo "export CRS_OAI_KEY=cr_xxxxxxxxxx" >> ~/.zshrc
source ~/.zshrc

对于 bash

echo "export CRS_OAI_KEY=cr_xxxxxxxxxx" >> ~/.bash_profile
source ~/.bash_profile

5. 开始使用

在您的项目目录中运行 Codex 命令:

codex

使用示例

基础命令

查看帮助信息

codex help

编辑文件

codex edit src/components/Button.tsx

分析代码

codex analyze --files src/

高级用法

生成提交信息

自动分析代码变更并生成合适的 Git 提交信息:

codex commit

代码重构

使用指定的设计模式重构代码:

codex refactor --pattern observer src/stores/

配置说明

模型选择

您可以在 config.toml 中选择不同的模型:

  • gpt-5: 标准模型
  • gpt-5-codex: 专门针对代码优化的模型(推荐)

推理强度设置

model_reasoning_effort 参数控制 AI 的推理深度:

  • low: 快速响应
  • medium: 平衡模式
  • high: 深度分析(推荐)

响应存储

disable_response_storage = true 确保您的代码和对话不会被存储在服务器上,保护隐私安全。

故障排除

常见问题

1. API Key 无效

  • 确认您已获取了正确的 API Key
  • 检查环境变量 CRS_OAI_KEY 是否设置正确
  • 验证 API Key 格式(应为 cr_xxxxxxxxxx

2. 环境变量不生效

  • Windows: 重启命令行窗口或相关应用程序
  • macOS/Linux: 执行 source ~/.zshrcsource ~/.bash_profile
  • 确认环境变量设置方法正确

3. 配置文件路径错误

  • 确认 .codex 文件夹在正确的位置
  • 检查文件权限设置
  • 验证配置文件语法

4. 网络连接问题

  • 确认可以访问 https://code.claude.best
  • 检查防火墙设置
  • 尝试使用代理设置

常见问题解答

Q: 设置后环境变量不生效?

A: 确保重启了相关的应用程序或命令行窗口。永久设置的环境变量需要重新启动程序才能读取到。

Q: 如何删除环境变量?

A: 在环境变量设置界面选中要删除的变量,点击"删除"按钮。

获取支持

如果遇到其他问题,请:

  1. 查看详细的错误信息
  2. 检查配置文件语法
  3. 联系玖亿 AI 技术支持

注意事项

  • ⚠️ 重启应用: 永久设置后需要重启相关应用程序才能生效
  • 💡 推荐方式: Windows 建议使用图形界面方式更直观且不容易出错
  • 🔒 安全提醒: 妥善保管您的 API Key,不要提交到版本控制系统
  • 📋 生产环境: 在生产环境中使用时,考虑额外的安全措施

更新日志

定期查看官方文档以获取最新的功能更新和配置变更。


💡 提示: 首次使用建议在测试项目中试用,熟悉各项功能后再在重要项目中使用。