Appearance
Codex CLI 快速上手教程
快速导航
使用前准备
开始之前,请完成下列准备事项:
- 安装最新版 VS Code 或 Cursor,建议使用稳定通道。
- 保持 Git 等常用 CLI 工具可用,方便脚本写入配置。
- 若计划使用 CLI 方案,请提前安装 Node.js 16+(可从 nodejs.org 下载)。
准备完成后,选择你喜欢的使用方案继续。
选择使用方案
Codex 提供两种体验方式,你可以任选其一:编辑器插件或命令行工具。
两种方案可以互补,但初次体验选择其中一种即可,后续随时切换。
方案 A:使用 Codex 编辑器插件
打开扩展市场搜索 Codex 并安装,按照提示完成启用即可:
- VS Code:按
Ctrl+Shift+X打开扩展侧边栏,搜索“Codex”。 - Cursor:在 Extensions 页面搜索同名插件并安装。
- 安装完成后,状态栏会出现 Codex 图标,可直接发起对话。
快捷跳转(若已安装对应编辑器,将直接打开扩展页):
登录同一账户即可在多台设备上同步插件设置与对话历史。
方案 B:使用 Codex CLI
开始前请确认已安装 Node.js 16+,并确保 node 与 npm 在终端可用。
安装 CLI:
bash
npm install -g @openai/codex验证版本:
bash
codex --version若出现权限提示:macOS / Linux 使用 sudo,Windows 以管理员身份启动终端。
登录控制台
访问控制台并登录:
登录成功后即可看到账户余额、卡密兑换入口以及 API Key 管理区域。
兑换卡密
进入控制台的「卡密兑换」面板,输入卡号并提交,额度会即时到账。
兑换完成后,前往仪表盘的 API Key 区域,准备复制你的密钥。
下载配置脚本
选择与你系统对应的脚本并保存到本地:
脚本会自动检测网络并写入 Codex 配置,执行前请确保文件已下载完成。
执行脚本并写入密钥
- 从控制台仪表盘复制最新的 Codex API Key。
- Windows:在
codex-config目录下双击运行codex-config.bat,或在 PowerShell 中执行./codex-config.bat。 - macOS / Linux:在终端执行
sh codex-config.sh(请在codex-config目录下运行)。 - 按提示粘贴 API Key 并确认,脚本会自动完成网络检测与配置写入。
脚本执行完毕后,你的插件或 CLI 环境就具备使用 Codex 的全部权限。
完成验证
- 重启 VS Code、Cursor 或重新打开终端中的 Codex CLI。
- 通过 Codex 启动 CLI,或在插件中发起首次对话,验证是否正常。
远程开发小贴士:VS Code 走 SSH 到服务器时,别忘了在远端服务器上运行上面的一键脚本。