My Docs

Appearance

Codex CLI 快速上手 ​

欢迎使用 Codex！本教程将帮助你快速完成配置，开始使用 AI 编程助手。

📋 快速导航 ​

第一步：获取 Codex API Key ​

1. 登录控制台 ​

访问 Codex 控制台：https://codex-for.me/dashboard.html

登录后可以看到：

  • 账户余额
  • 卡密兑换入口
  • API Key 管理

2. 兑换卡密（如需充值） ​

在控制台的「卡密兑换」面板输入卡号，额度会即时到账。

3. 获取 API Key ​

在控制台的 API Key 区域复制你的密钥，稍后配置时需要用到。

第二步：选择使用方式 ​

Codex 提供两种使用方式，根据你的需求选择：

方式适合人群特点
命令行工具（推荐）开发者功能完整，性能最佳，官方支持
编辑器插件日常开发集成在编辑器中，使用便捷

推荐使用命令行工具：功能更强大，响应更快，体验更好。

两种方式可以同时使用，互不影响。

方案 A：命令行工具（推荐） ​

环境要求 ​

  • Node.js 16 或更高版本
  • npm 或 yarn 包管理器

安装步骤 ​

1. 安装 Codex CLI

bash
npm install -g @openai/codex

如遇权限问题：

  • macOS / Linux：使用 sudo npm install -g @openai/codex
  • Windows：以管理员身份运行终端

2. 验证安装

bash
codex --version

3. 配置 API Key

使用一键配置脚本：

运行方法：

  • Windows：双击 codex-config.bat 或在终端执行 ./codex-config.bat
  • macOS / Linux：在终端执行 sh codex-config.sh

脚本可以在任意目录执行，会自动配置 CLI 环境。

4. 开始使用

bash
codex

启动后即可与 AI 助手对话。

方案 B：编辑器插件 ​

支持的编辑器 ​

  • VS Code
  • Cursor
  • Windsurf

安装步骤 ​

1. 安装插件

在编辑器的扩展市场搜索 ”Codex” 或 ”ChatGPT” 并安装。

快捷方式：

2. 配置 API Key

有两种配置方式：

方式 1：使用一键配置脚本（推荐） ​

下载并运行配置脚本，自动完成所有设置：

运行方法：

  • Windows：双击 codex-config.bat 或在终端执行 ./codex-config.bat
  • macOS / Linux：在终端执行 sh codex-config.sh

按提示粘贴你的 API Key，脚本会自动完成配置。

方式 2：手动配置 ​

  1. 打开编辑器设置（VS Code: Ctrl/Cmd + ,）
  2. 搜索 “OpenAI” 或 “ChatGPT”
  3. 找到以下配置项并填入：

3. 开始使用

配置完成后，在编辑器中：

  • 点击状态栏的 Codex 图标
  • 或使用快捷键打开对话窗口
  • 开始与 AI 助手对话

常见问题 ​

Q: 配置脚本必须在特定目录运行吗？ ​

A: 不需要。配置脚本可以在任意目录执行，会自动找到正确的配置位置。

Q: 如何选择 Base URL？ ​

A: 参考 Base URL 配置说明，根据你的地理位置选择最优端点。推荐使用 api-vip.codex-for.me。

Q: 插件和 CLI 可以同时使用吗？ ​

A: 可以。两者使用相同的配置，互不影响。

Q: 远程开发（SSH）如何配置？ ​

A: 在远程服务器上运行配置脚本即可。VS Code 的远程扩展会自动使用远程服务器的配置。

Q: 配置后无法使用怎么办？ ​

A: 检查以下几点：

  1. API Key 是否正确复制（无多余空格）
  2. Base URL 是否配置正确
  3. 网络是否能访问 Codex 服务
  4. 重启编辑器或终端后重试

Q: 如何更新 API Key？ ​

A: 重新运行配置脚本，或在编辑器设置中手动更新。

需要帮助？ ​

如果遇到问题，可以：