AI帮助文档 main codex/setup-codex.md

title: 安装和登录 Codex CLI description: 面向新手说明 Codex CLI 的安装地址、逐步安装、登录方式和第一次安全使用。 keywords:

  • Codex
  • Codex CLI
  • OpenAI Codex

安装和登录 Codex CLI

Codex 是 OpenAI 的编程 Agent,可以在代码仓库里读取文件、修改代码、运行命令和解释结果。

本文只适用于 Codex CLI,也就是在终端里运行 codex 的本地入口。如果你使用的是桌面软件,请先看 安装和登录 Codex App

安装地址

  • npm 国内镜像:https://registry.npmmirror.com
  • npm 包名:@openai/codex
  • Codex CLI 官方仓库:https://github.com/openai/codex
  • Codex CLI 最新 Release:https://github.com/openai/codex/releases/latest
  • macOS / Linux 官方安装脚本:https://chatgpt.com/codex/install.sh
  • Windows 官方安装脚本:https://chatgpt.com/codex/install.ps1

这是一份面向中国国内用户的安装说明。国内网络不一定能稳定访问 ChatGPT、GitHub、OpenAI 或海外 CDN,所以本文优先推荐 npm 镜像安装 CLI。官方安装脚本和 GitHub Release 仍然列出,但只适合当前网络能访问这些站点时使用。

推荐使用路线

这套文档优先推荐:

  1. 先用 npm 国内镜像安装 Codex CLI。
  2. 再使用 ARAI/API 中转站提供的 API Key 或接入信息。
  3. 用 CC Switch 管理 Codex CLI 的供应商配置,减少手动改配置文件。
  4. 如果你的网络和账号可以稳定访问 ChatGPT,再选择 ChatGPT 账号登录。

Codex CLI 官方支持 ChatGPT 账号登录和 API Key 登录。需要注意:Codex Cloud 等依赖 ChatGPT 工作区或云端服务的能力,可能仍然需要 ChatGPT 账号登录。

首选安装方式:npm 国内镜像

macOS、Linux 和 Windows 都可以优先尝试 npm 镜像安装。先确认电脑已经安装 Node.js 和 npm,然后运行:

npm config set registry https://registry.npmmirror.com
npm install -g @openai/codex
codex --version

如果能看到版本号,说明 Codex CLI 已经安装成功。

这种方式主要解决“下载安装包或脚本打不开”的问题。安装成功不代表一定能直接调用模型,后续仍需要配置 ChatGPT 登录、OpenAI API Key,或本文推荐的 ARAI/API 中转站路线。

Codex 安装命令和版本确认

备选方式:官方脚本

官方脚本会从 chatgpt.com 跳转到 GitHub Release 下载文件。国内网络访问这些地址可能不稳定,所以不作为首选。

macOS 或 Linux

  1. 打开终端。
  2. 复制下面命令并回车:
curl -fsSL https://chatgpt.com/codex/install.sh | sh
  1. 等待安装完成。
  2. 重新打开一个终端窗口。
  3. 输入下面命令确认是否安装成功:
codex --version

如果能看到版本号,说明命令已经可用。

无人值守安装可以使用:

curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_NON_INTERACTIVE=1 sh

Windows

PowerShell

  1. 打开 PowerShell。
  2. 复制下面命令并回车:
powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"
  1. 等待安装完成。
  2. 重新打开 PowerShell。
  3. 输入下面命令确认是否安装成功:
codex --version

无人值守安装可以使用:

$env:CODEX_NON_INTERACTIVE=1; irm https://chatgpt.com/codex/install.ps1 | iex

其他安装方式

如果你已经熟悉包管理器,也可以使用:

npm install -g @openai/codex

或:

brew install --cask codex

如果你的网络能访问 GitHub,也可以打开:

https://github.com/openai/codex/releases/latest

按系统选择合适的 Codex CLI 包。官方脚本、GitHub Release 和 Homebrew 都可能依赖 GitHub、ChatGPT 或海外 CDN,可访问性取决于当前网络。

网络打不开时怎么选

当前网络情况 推荐选择
能访问 registry.npmmirror.com 优先使用 npm 国内镜像安装。
能访问 GitHub 可以使用 GitHub Release 或官方脚本。
不能稳定访问 ChatGPT 或 OpenAI 优先使用 ARAI/API 中转站 + CC Switch 的本地 CLI 路线。
不能稳定访问 Codex Cloud 不要把 Cloud 当作国内首选路线,先跑通本地 CLI。

安装阶段只解决 codex 命令是否可用;调用阶段还需要能访问你配置的模型服务。如果使用 ARAI/API 中转站,重点检查 ARAI 控制台、API Key、CC Switch 配置和调用记录。

IDE 和 Cloud 入口

这些入口不是国内首选路线,但如果你的网络能访问,可以直接使用:

  • VS Code:vscode:extension/openai.chatgpt
  • Cursor:cursor:extension/openai.chatgpt
  • Windsurf:windsurf:extension/openai.chatgpt
  • VS Code Insiders / Marketplace:https://marketplace.visualstudio.com/items?itemName=openai.chatgpt
  • Codex Cloud:https://chatgpt.com/codex
  • Codex Cloud 环境设置:https://chatgpt.com/codex/settings/environments

进入项目目录

Codex 会围绕当前目录工作,所以先进入你要处理的项目目录。

macOS / Linux 示例:

cd /path/to/your/project

Windows PowerShell 示例:

cd C:\path\to\your\project

把示例路径换成你自己的项目路径。

第一次启动

在项目目录里运行:

codex

如果你还没有登录,Codex CLI 会引导你选择登录方式。本文档推荐先按你的中转站/API Key 方案配置;如果暂时不用中转站,再选择 ChatGPT 登录。

Codex 首次启动登录选择

使用 ARAI/API 中转站

如果你准备通过 ARAI 中转站使用:

  1. 先完成 ARAI 注册和登录
  2. 购买合适的订阅或额度。
  3. 进入 添加和管理 API Key,创建或选择要给 Codex 使用的 API Key。
  4. 优先使用 ARAI API Key 页面的一键导出 CC Switch 配置能力,避免手动抄 API 地址、Key 和模型名。
  5. 打开 CC Switch 基础用法,导入配置并应用到 Codex CLI。
  6. 回到终端运行 codex,用一个小请求验证。

ARAI 控制台里的按钮名和字段名可能更新,操作时以实际页面为准。

使用 ChatGPT 账号登录

如果你不使用中转站:

  1. 在终端运行 codex
  2. 选择 ChatGPT 登录。
  3. 按提示在浏览器里完成登录。
  4. 登录后回到终端。
  5. 用一个小请求确认 Codex 能正常读取当前项目。

ChatGPT Plus、Pro、Business、Edu 和 Enterprise 等计划通常包含 Codex。具体额度和功能以 OpenAI 当前说明为准。

第一个安全请求

第一次不要直接让 Codex 大规模改项目。先输入:

请先阅读这个项目的 README 和目录结构,告诉我这个项目是做什么的。先不要修改文件。

这个请求只让 Codex 阅读和解释,更适合新手观察它的工作方式。

Codex 第一个安全请求结果

验证结果

安装和登录完成后,确认:

  • codex --version 能输出版本号。
  • 在项目目录运行 codex 能启动。
  • Codex 能读取当前项目文件。
  • 第一个请求没有要求它修改文件。
  • 如果使用 ARAI/API 中转站,调用记录或额度变化能在平台侧对上。

常见问题

我应该优先用哪种登录方式

如果你正在使用 ARAI/API 中转站,优先走 API Key 和供应商配置路线;如果你只想使用 OpenAI 官方账户能力,再用 ChatGPT 登录。

Codex Cloud 也能走中转站吗

不一定。Codex Cloud 依赖 ChatGPT 工作区或云端服务时,可能需要 ChatGPT 账号登录。中转站路线更适合本地 Codex CLI 工作流。

第一次就让它改很多文件可以吗

先从阅读项目、解释报错、修改一个小文件开始,确认工具运行正常。

相关页面