OpenAI Codex 部署与配置指南:CLI、VS Code 和自定义 API

1465 字
7 分钟
OpenAI Codex 部署与配置指南:CLI、VS Code 和自定义 API

Codex 是面向真实项目开发的 AI 编程代理。它既可以在终端中运行,也可以通过 VS Code 扩展参与代码阅读、修改、测试和任务执行。

本篇将介绍 Windows、Linux、macOS 与 VS Code 的安装方式,并整理自定义 API、模型配置和 Token 计费的关键概念。

安全提醒

示例中的 API 地址、模型名称和密钥需要替换成你自己的配置。不要将 auth.json、密钥或包含敏感信息的终端截图上传到公开仓库。

开始前需要准备什么#

Codex CLI 通过 npm 安装,需要 Node.js 18 或更高版本:

node --version
npm --version

如果命令不存在,请先安装 Node.js LTS 版本。

Windows 安装#

1. 安装 Codex CLI#

在 PowerShell 中执行:

npm install -g @openai/codex --registry=https://registry.npmmirror.com

验证安装:

codex --version

2. 创建配置目录#

Codex 的用户配置通常位于:

C:\Users\你的用户名\.codex

需要用到两个主要文件:

文件用途
config.toml模型、服务地址和运行选项
auth.jsonAPI 密钥等认证信息

3. 配置自定义模型服务#

创建 .codex/config.toml

model_provider = "apipaths"
model = "gpt-5.5"
model_reasoning_effort = "xhigh"
disable_response_storage = true

[model_providers.apipaths]
name = "apipaths"
wire_api = "responses"
requires_openai_auth = true
base_url = "http://apipaths.com/v1"

这里有两个容易忽略的细节:

  1. model_provider 的值需要与 [model_providers.apipaths] 的名称一致
  2. base_url 是否包含 /v1,取决于服务商的接口说明

创建 .codex/auth.json

{
  "OPENAI_API_KEY": "你的API密钥"
}

4. 启动 Codex#

进入项目目录:

cd D:\Projects\my-project
codex

建议第一次先执行只读任务:

请分析当前项目的目录结构、依赖、启动命令和测试方式,暂时不要修改文件。

Linux 安装#

1. 安装 CLI#

npm install -g @openai/codex

2. 使用环境变量#

使用 Bash 时:

echo 'export OPENAI_BASE_URL="http://apipaths.com/v1"' >> ~/.bashrc
echo 'export OPENAI_API_KEY="你的API密钥"' >> ~/.bashrc
source ~/.bashrc

启动:

codex

建议

对于需要固定模型、推理强度和服务商参数的场景,更推荐使用 ~/.codex/config.toml,环境变量适合快速测试或临时切换。

macOS 安装#

1. 准备 Node.js#

brew install node

2. 安装 Codex#

npm install -g @openai/codex

3. 配置环境变量#

macOS 默认使用 Zsh:

echo 'export OPENAI_BASE_URL="http://apipaths.com/v1"' >> ~/.zshrc
echo 'export OPENAI_API_KEY="你的API密钥"' >> ~/.zshrc
source ~/.zshrc

启动:

codex

VS Code 配置#

1. 安装扩展#

在 VS Code 扩展市场中搜索:

Codex - OpenAI's coding agent

安装后,扩展会读取用户目录下的 Codex 配置。

2. 配置认证#

~/.codex/auth.json 中写入:

{
  "OPENAI_API_KEY": "你的API密钥"
}

Windows 中的 ~ 对应:

C:\Users\你的用户名

3. 配置模型#

~/.codex/config.toml 中配置:

model_provider = "apipaths"
model = "gpt-5.4"
model_reasoning_effort = "xhigh"
disable_response_storage = true

[model_providers.apipaths]
name = "apipaths"
wire_api = "responses"
requires_openai_auth = true
base_url = "http://apipaths.com/v1"

修改配置后,建议重新加载 VS Code 窗口。

推荐的使用流程#

Codex 能直接修改文件和执行命令,因此最好使用分阶段工作流。

第一步:只读分析#

分析项目结构和问题原因,不要修改文件。

第二步:确认方案#

给出修改方案、涉及文件、风险和测试计划。

第三步:执行修改#

按照方案完成修改,保留现有代码风格,并运行相关测试。

第四步:检查结果#

总结修改内容、测试结果和仍然存在的风险。

这种方式可以减少误操作,也方便在大型项目中控制修改范围。

Token 计费如何理解#

原教程给出的通用计算思路是:

配额消耗 =
(输入 Token + 输出 Token × 完成倍率)
× 模型倍率
× 用户组倍率

其中:

  • 输入 Token:提示词、项目上下文和读取的文件内容
  • 输出 Token:模型生成的文字、代码和工具调用说明
  • 完成倍率:部分平台对输出内容设置的额外倍率
  • 模型倍率:不同模型的成本系数
  • 用户组倍率:服务商针对套餐或用户组设置的系数

具体倍率可能随平台策略调整,应以实际控制台显示为准。

如何减少不必要的消耗#

  1. 明确指定需要分析的目录或文件
  2. 不要重复发送完整项目内容
  3. 将大型任务拆成若干清晰步骤
  4. 先分析再修改,避免反复返工
  5. 要求输出简洁的结果摘要
  6. 使用 .gitignore 排除构建产物和依赖目录

常见问题#

找不到 codex 命令#

npm config get prefix

确认 npm 全局可执行目录已经加入 PATH,然后重新打开终端。

认证失败#

检查以下项目:

  • auth.json 是否为有效 JSON
  • OPENAI_API_KEY 是否填写完整
  • API 密钥是否仍然有效
  • 自定义服务是否要求其他认证头

模型服务不可用#

重点检查:

  • model_provider 与配置节名称是否一致
  • base_url 是否需要 /v1
  • wire_api 是否与服务商兼容
  • 模型名称是否真实可用
  • 是否被代理、防火墙或 DNS 阻断

配置修改没有生效#

关闭并重新打开终端;VS Code 中可以执行“重新加载窗口”。同时确认修改的是当前用户目录下的 .codex,而不是其他项目中的同名目录。

安全与版本管理#

建议将下面内容加入项目的 .gitignore

.codex/
.env
.env.*

在真正让 Codex 修改项目之前,还应当:

  • 确认项目已经纳入 Git
  • 提交或备份当前改动
  • 检查 Codex 即将执行的高风险命令
  • 不授予不必要的系统权限
  • 发布前运行项目测试和构建

部署完成检查表#

  • Node.js 与 npm 可以运行
  • codex --version 可以输出版本
  • API 密钥已正确配置
  • 自定义服务地址可以访问
  • CLI 可以读取项目
  • VS Code 扩展可以正常连接
  • 已了解 Token 消耗的基本组成

完成这些步骤后,Codex 就可以作为项目中的 AI 协作者参与需求分析、代码修改、测试和发布流程。

支持与分享

如果这篇文章对你有帮助,欢迎分享给更多人或打赏支持!

打赏
OpenAI Codex 部署与配置指南:CLI、VS Code 和自定义 API
http://127.0.0.1:4322/posts/codex-deployment-guide/
作者
Firefly
发布于
2026-07-15
许可协议
CC BY-NC-SA 4.0
Profile Image of the Author
Firefly
Hello, I'm Firefly.
公告
欢迎来到我的博客!
音乐
封面

音乐

暂未播放

0:000:00
暂无歌词
分类
标签
站点统计
文章
13
分类
3
标签
23
总字数
15,855
运行时长
0
最后活动
0 天前
站点信息
构建平台
Local
博客版本
Firefly v6.13.10
文章许可
CC BY-NC-SA 4.0