文档中心

主题

官方交流入口

AI LINK 官方交流群

群号：819235884

扫码加入 QQ 群，获取部署支持、配置答疑和教程更新。

AI LINK 官方交流群 QQ 二维码，群号 819235884

Codex CLI 快速部署 ​

本教程参考 OpenAI 官方 Codex CLI 文档，帮助你在本地完成安装、登录、配置和首次运行。

1. 环境准备 ​

Codex CLI 推荐在 macOS、Linux 或 Windows WSL2 环境中使用。请先确认已经安装 Node.js 和 npm：

bash
node --version
npm --version

如果没有安装 Node.js，请访问 Node.js 官网 下载 LTS 版本。macOS 用户也可以使用 Homebrew：

bash
brew install node

2. 安装 Codex CLI ​

使用 npm 全局安装官方 CLI：

bash
npm install -g @openai/codex

安装完成后验证版本：

bash
codex --version

如果提示找不到 codex 命令，请重新打开终端，或检查 npm 全局 bin 目录是否已经加入 PATH。

3. 登录或配置 API Key ​

推荐使用 ChatGPT 账号登录：

bash
codex login

如果你使用 API Key，也可以设置环境变量：

bash
export OPENAI_API_KEY="你的 API Key"

如需长期生效，请写入当前 shell 的配置文件：

bash
echo 'export OPENAI_API_KEY="你的 API Key"' >> ~/.zshrc
source ~/.zshrc

Linux Bash 用户可改写到 ~/.bashrc：

bash
echo 'export OPENAI_API_KEY="你的 API Key"' >> ~/.bashrc
source ~/.bashrc

4. 在项目中启动 ​

进入你的项目目录后运行：

bash
cd /path/to/your/project
codex

也可以直接带上任务描述：

bash
codex "阅读这个项目并告诉我如何启动"
codex "修复测试失败的问题"
codex "为登录接口补充单元测试"

5. 常用命令 ​

bash
# 查看帮助
codex --help

# 查看版本
codex --version

# 登录账号
codex login

6. 部署检查清单 ​

  • 已安装 Node.js 和 npm
  • 已执行 npm install -g @openai/codex
  • codex --version 能正常输出版本号
  • 已完成 codex login 或设置 OPENAI_API_KEY
  • 已在项目根目录运行 codex

7. 官方资料 ​

遇到问题 ​

如果部署过程中遇到安装、登录或模型调用问题，请优先加入页面顶部的 AI LINK 官方交流群：群号 819235884。