Google 风格指南

Codex CLI 快速上手教程

这份教程帮你在几分钟内完成 Codex 编辑器插件或 CLI 的配置，快速开启高效工作流。

立即准备打开控制台

准备时间: 约 5 分钟
适用人群: VS Code / Cursor 用户
方案选择: 插件或 CLI

步骤 01

使用前准备

确认编辑器、终端与网络环境，确保后续步骤顺利完成。

开始之前，请完成下列准备事项：

安装最新版 VS Code 或 Cursor，建议使用稳定通道。
保持 Git 等常用 CLI 工具可用，方便脚本写入配置。
若计划使用 CLI 方案，请提前安装 Node.js 16+（可从 nodejs.org 下载安装）。

准备完成后，选择你喜欢的使用方案继续。

步骤 02

选择使用方案

Codex 提供两种体验方式，你可以任选其一：编辑器插件或命令行工具。

方案 A：编辑器插件方案 B：Codex CLI

两种方案可以互补，但初次体验选择其中一种即可，后续随时切换。

方案 A

使用 Codex 编辑器插件

在熟悉的编辑器中启用 Codex，保持 Material 风格的轻盈体验。

打开扩展市场搜索 Codex 并安装，按照提示完成启用即可：

VS Code：按 Ctrl + Shift + X 打开扩展侧边栏，搜索“Codex”。
Cursor：在 Extensions 页面搜索同名插件并安装。
安装完成后，状态栏会出现 Codex 图标，可直接发起对话。

下方提供快捷链接，一键跳转到对应的扩展详情页。

安装 VS Code 插件安装 Cursor 插件安装 Windsurf 插件

登录同一账户即可在多台设备上同步插件设置与对话历史。

方案 B

使用 Codex CLI

在终端中运行 Codex 命令行工具，适合偏好脚本与自动化的用户。

开始前请确认已安装 Node.js 16+，并确保 node 与 npm 在终端可用。

使用 npm 全局安装 CLI：

npm install -g @openai/codex

安装完成后执行以下命令确认版本：

codex --version

若出现权限提示：macOS / Linux 使用 sudo，Windows 以管理员身份启动终端。

步骤 03

登录控制台

在控制台管理额度、卡密与 API Key。

访问 https://codex-for.me/dashboard.html，使用邮箱或第三方账号登录。

仪表盘 API 密钥卡密与额度

登录成功后即可看到账户余额、卡密兑换入口以及 API Key 管理区域。

步骤 04

兑换卡密

在控制台将卡密兑换为可用额度，便于后续脚本写入配置。

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

还没有卡密？可点击页面右上角的“联系客服”按钮，向客服获取卡密与额度支持。

兑换完成后，前往仪表盘的 API Key 区域，准备复制你的密钥。

步骤 05

下载配置脚本

根据使用平台下载官方脚本，自动完成网络检测与配置。

选择与你系统对应的脚本并保存到本地：

下载 Windows 脚本（.bat）下载 macOS / Linux 脚本（.sh）

脚本会自动检测网络并写入 Codex 配置，执行前请确保文件已下载完成。

步骤 06

执行脚本并写入密钥

通过脚本完成环境初始化，并将 API Key 写入本地配置。

从控制台仪表盘复制最新的 Codex API Key。
Windows：双击运行 codex-config.bat，或在 PowerShell 中执行 ./codex-config.bat。
macOS / Linux：在终端执行 chmod +x codex-config.sh 后运行 ./codex-config.sh。
按提示粘贴 API Key 并确认，脚本会自动完成网络检测与配置写入。

脚本执行完毕后，你的插件或 CLI 环境就具备使用 Codex 的全部权限。

步骤 07

完成验证

重启工具并试运行 Codex，确认配置已生效。

重启 VS Code、Cursor 或重新打开终端中的 Codex CLI。
在终端运行 codex doctor 检查当前环境状态。
通过 codex run 或插件面板发起首次对话，验证功能是否正常。

恭喜！现在可以把 Codex 集成到日常开发与写作流程中了。

远程开发小贴士：VS Code 走 SSH 到服务器时，别忘了在远端服务器上运行上面的一键脚本。