Codex 配置使用教程

原创 已于 2025-11-02 01:36:24 修改 · 5.4k 阅读 · 46 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#AI编程 #Codex #chatgpt

于 2025-11-02 01:28:28 首次发布

Codex 配置教程

本文档是包含了Codex环境配置教程、基础使用方式，以及使用过程中的一些心得~

Codex是OpenAI公司出品的一款强大的编码智能体，它有三种使用方式：

  1. 以终端运行的方式：Codex CLI
  2. 在VSCode、Cursor 及其他 IDE 中与 Codex 协作，以IDE扩展插件的方式运行：Codex IDE
  3. Codex云端模式，直接与开发者的github账号绑定，在云端进行任务处理，可以说是Codex的最强模式：Codex 云端

可惜Codex云端模式要注册OpenAI官方账号，并且要开通Plus等订阅服务，成本太高，我们只能退而求其次，采用终端模式，再配合我们的中转API站进行使用。

一、环境配置

Windows 版本教程

系统要求
  • Windows 10 或 Windows 11
  • Node.js 22+
  • npm 10+
  • 网络连接
安装步骤

前置步骤！！！
安装 Git Bash，请访问 Git - Downloads 下载对应您电脑系统的版本，之后一直点击“下一步”即可完成安装。1. 安装 Node.js
访问 Node.js 官网 下载并安装最新 LTS 版本。

2. 安装 codex
打开命令提示符 (CMD) 或 PowerShell，运行：

npm install -g @openai/codex

3.验证安装

打开命令提示符 (CMD) 或 PowerShell，运行：

codex --version
配置 API
  1. 获取 Auth Token

访问 https://api.kl-api.info/ 站点页面进行以下操作：

  • 点击 控制台 → API令牌 页面
  • 点击 添加令牌
  • 令牌分组请选择：codex专属（务必选择此分组，否则无法使用）
  • 令牌名称随意
  • 额度建议：设置为 无限额度
  • 其他选项保持默认

  1. 配置文件
重要提示：请将下方的 sk-xxx 替换为您在 http://api.kl-api.info 生成的实际 API 密钥！

2.1 进入当前用户的用户目录下的 .codex 文件夹中，例如：C:\Users\testuser\.codex。
（注意：如果看不到该目录，说明您没有打开 Windows 的“显示隐藏的项目”，请先在文件资源管理器中开启。）

2.2 如果没有 .codex 文件夹，请手动创建该文件夹，然后在其中创建 config.toml 以及 auth.json 两个文件。

2.3 填写配置 (需要将 sk-xxx 替换成您自己创建的真实 SK)。

  1. auth.json 中的配置：
{"OPENAI_API_KEY": "sk-xxx"}

2. config.toml 中的配置（直接粘贴下面的内容即可）：
model_reasoning_effort 可选值为 high, medium, low，分别代表模型思考的努力程度（高、中、低）。

model_provider = "kl-api"
model = "gpt-5-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.kl-api]
name = "kl-api"
base_url = "https://api.kl-api.info/v1"
wire_api = "responses"
启动 codex

重启终端！重启终端！重启终端！

然后进入到您的工程目录：

cd your-project-folder

运行以下命令启动：

codex

然后就会进行codex界面：

VSCode 插件 codex

以上配置完成后，在 VSCode 扩展商店中搜索并安装 codex 即可。

安装完成后会出现在侧边栏。

Mac 版本教程

系统要求
  • macOS 12 或更高版本
  • Node.js 22+
  • npm 10+
  • 网络连接
安装步骤
  1. 安装 Node.js
  • 方式一：直接访问 Node.js 官网 下载并安装最新 LTS 版本。
  • 方式二：使用 Homebrew（推荐）
# 如果尚未安装 Homebrew，请先运行此命令
/bin/bash -c "$(curl -fsSL [https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh](https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh))"

# 安装 Node.js
brew install node
  1. 安装 codex

打开终端 (Terminal)，运行（可能需要加 sudo）：

npm install -g @openai/codex
  1. 验证安装

打开终端 (Terminal)，运行：

codex --version
配置 API
  1. 获取 Auth Token
    访问 api.kl-api.info 站点页面进行以下操作：
  • 点击 控制台 → API令牌 页面
  • 点击 添加令牌
  • 令牌分组请选择：codex特供（务必选择此分组，否则无法使用）
  • 令牌名称随意
  • 额度建议：设置为 无限额度
  • 其他选项保持默认

2. 配置文件

重要提示：请将下方的 sk-xxx 替换为您在 http://api.kl-api.info 生成的实际 API 密钥！

2.1 创建目录和文件：

mkdir -p ~/.codex
touch ~/.codex/auth.json
touch ~/.codex/config.toml

2.2 编辑 auth.json 文件：

vi ~/.codex/auth.json

按 i 进入插入模式，粘贴以下内容（将 sk-xxx 替换为您的密钥），然后按 ESC 键，输入 :wq 并回车保存退出。

{"OPENAI_API_KEY": "sk-xxx"}

2.3 编辑 config.toml 文件：

vi ~/.codex/config.toml

按 i 进入插入模式，粘贴以下内容，然后按 ESC 键，输入 :wq 并回车保存退出。

model_provider = "kl-api"
model = "gpt-5-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.kl-api]
name = "kl-api"
base_url = "https://api.kl-api.info/v1"
wire_api = "responses"
启动 codex

重启终端！重启终端！重启终端！

然后进入到您的工程目录：

cd your-project-folder

运行以下命令启动：

codex
VSCode 插件 codex

以上配置完成后，在 VSCode 扩展商店中搜索并安装 codex 即可。

安装完成后会出现在侧边栏。

Linux 版本教程

系统要求
  • 主流 Linux 发行版 (Ubuntu 20.04+, Debian 10+, CentOS 7+, etc.)
  • Node.js 22+
  • npm 10+
  • 网络连接
安装步骤
  1. 安装 Node.js
  • Ubuntu/Debian
sudo apt update
curl -fsSL [https://deb.nodesource.com/setup_lts.x](https://deb.nodesource.com/setup_lts.x) | sudo -E bash -
sudo apt-get install -y nodejs
  • CentOS/RHEL/Fedora
# 使用 dnf (Fedora) 或 yum (CentOS/RHEL)
sudo dnf install nodejs npm
# 或
sudo yum install nodejs npm
  • Arch Linux
sudo pacman -S nodejs npm
  1. 安装 codex

打开终端 (Terminal)，运行：

sudo npm install -g @openai/codex
  1. 验证安装

打开终端 (Terminal)，运行：

codex --version
配置 API
  1. 获取 Auth Token
    访问 api.kl-api.info 站点页面进行以下操作：
  • 点击 控制台 → API令牌 页面
  • 点击 添加令牌
  • 令牌分组请选择：codex特供（务必选择此分组，否则无法使用）
  • 令牌名称随意
  • 额度建议：设置为 无限额度
  • 其他选项保持默认

  1. 配置文件
重要提示：请将下方的 sk-xxx 替换为您在 http://api.kl-api.info 生成的实际 API 密钥！

2.1 创建目录和文件：

mkdir -p ~/.codex
touch ~/.codex/auth.json
touch ~/.codex/config.toml

2.2 编辑 auth.json 文件：

vi ~/.codex/auth.json

按 i 进入插入模式，粘贴以下内容（将 sk-xxx 替换为您的密钥），然后按 ESC 键，输入 :wq 并回车保存退出。

{"OPENAI_API_KEY": "sk-xxx"}

2.3 编辑 config.toml 文件：

vi ~/.codex/config.toml

按 i 进入插入模式，粘贴以下内容，然后按 ESC 键，输入 :wq 并回车保存退出。

model_provider = "kl-api"
model = "gpt-5-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.kl-api]
name = "kl-api"
base_url = "https://api.kl-api.info/v1"
wire_api = "responses"
启动 codex

重启终端！重启终端！重启终端！

然后进入到您的工程目录：

cd your-project-folder

运行以下命令启动：

codex
VSCode 插件 codex

以上配置完成后，在 VSCode 扩展商店中搜索并安装 codex 即可。

安装完成后会出现在侧边栏。

二、Codex基础命令

命令中文说明
/model切换模型和推理等级
/approvals设置授权模式
/new开启新的会话
/init初始化 AGENTS.md 指导文件
/compact上下文压缩，避免触发上下文限制
/diff显示 git 差异
/mention引用某个文件
/status显示当前会话配置和 Token 用量

三、如何使用

AGENTS.md文件

我们可以在项目根目录或不同的目录中添加AGENTS.md文件，放入项目大纲、注意事项等。

Codex在运行时会优先阅读该文件，这就是借助上下文工程让Codex快速理解我们的项目。

可以通过指令/init来生成AGENTS.md文件，Codex会自动扫描项目目录下的文件，了解项目目录里是什么语言、架构等信息

之后再在终端运行codex，codex会自动读取AGENTS.md文件，作为核心上下文内容进行AI处理

切换模型与推理等级

Codex 默认搭配的是 OpenAI 最牛的代码专用模型 gpt-5-codex，默认的推理等级是：中等，gpt-5-codex 是 CodeX 专用的代码模型，比 GPT-5 更强。

可以用 /model 命令切换模式及推理等级：

第一步选择模型

第二步选择推理等级

切换授权模式

用 /approvals 命令切换，如果你需要 Codex 在未经你允许的情况下，就能读取文件、编辑内容、运行命令，甚至处理工作目录外的文件或者访问网络，那你可以用 Full Access 完全访问模式。

点击图片可查看完整电子表格

引用文件

和claude code一样，可以通过@符号，来引用相关文件，灵活的使用上下文工程

输入图片

比claude code cli方便的是，codex的客户端可以直接复制粘贴图片到终端，而claude code只能将图片拖拽终端

MCP配置

可参考Claude Code那篇文章中的步骤，去 https://smithery.ai/ 找到对应mcp服务，选择对应的Codex平台，获取安装脚本

也可以在C:\Users\%username%\.codex目录中，找到config.toml文件，定义一个 mcp_servers 部分来配置 MCP，和 Claude 和 Cursor 在各自的 JSON 配置文件中定义 mcpServers 一样，但是 Codex 的格式略有不同，它使用 TOML，而不是 JSON

之后在codex的终端内，输入/mcp，可以看到配置好的mcp服务

常见问题

出现错误请按照如下步骤排查：

  1. 确认 API Key 创建是否正确：额度选择无限额度，不要限制模型，分组选择 codex专属。

更多 codex 配置及使用详情请参考 codex 官方教程。

OpenAI最强编程助手Codex：深度解析与应用指南（含使用方式、提示技巧、趋势）
Code_流苏：在代码中寻诗意，在实践中觅真知
05-19 6313
OpenAI最近上线了最强编程助手基于o3的Codex，一起来看看吧！
深度解码OpenAI的2025野心：Codex重生与GPT-5 APIKey获取调用示例
iduiui997的博客
09-11 1433
AI编程革命：Codex从生成式到代理式的进化 2025年，OpenAI的Codex平台以"软件工程代理"身份回归，标志着AI辅助编程从"生成式"到"代理式"的范式转变。初代Codex作为代码生成工具，在2023年战略撤退后，基于GPT-5实现了质的飞跃：从单轮代码补全升级为能独立规划、执行复杂开发任务的"虚拟队友"。 新版Codex采用混合架构，包含云端大脑（Codex Web）、开源CLI工具、IDE扩展和GitHub深度集
Codex 项目使用教程
gitblog_00294的博客
10-10 1656
Codex 项目使用教程 1、项目介绍 Codex 是一个基于 Laravel 5 的可扩展文档平台，旨在帮助用户轻松创建和维护文档。Codex 提供了丰富的功能，包括 Markdown 和 Creole 文档解析器、多项目和版本管理、语法高亮、SEO 友好的 URL 等。Codex 的设计理念是简单易用、可扩展和可定制，适合各种规模的团队和项目。 2、项目快速启动 安装 首先，确保你已经安装了 ...
分享一个 codex的效率命令
weixin_49869937的博客
10-15 6384
（-c 表示 config）。model_reasoning_effort 是一个控制“推理强度”或“思考深度”的参数。设为 "high" 表示让模型用更高的计算开销、更多的思考步骤来生成更高质量的输出（代价是速度变慢）。，这里是 gpt-5-codex。这意味着调用 Codex 5 代（基于 GPT-5 技术的代码生成模型）。，即无需人工交互地自动执行所有步骤。例如自动读取上下文、生成代码、运行测试、提交结果等。或类似自研命令行封装。用于自动代码生成、补全、执行等。
Codex 真香！终端 AI 编程神器装好了，Cursor可以不续费了
qq_42801126的博客
09-06 7925
Codex是OpenAI推出的智能编程助手，支持自然语言指令生成代码和终端操作，ChatGPT Plus用户可免费使用。它提供CLI终端模式和VSCode插件两种安装方式，支持GPT-5系列模型（暂不支持GPT-4o）。主要功能包括：直接执行终端任务、创建/修改代码文件、记忆任务历史等。安装后可能遇到404报错，通常由环境变量冲突导致，需检查并清理相关配置。Codex可与VSCode配合使用，完全替代Cursor编辑器，支持自定义AI助手规则。优势在于：免费、自然语言交互、丰富的终端功能，是提升开发效率的利
如何用好 Codex？OpenAI 内部最佳实践指南：8 个最佳应用场景
学Java，找哪吒
10-14 1059
使用GPT-5 Codex就不一样了，GPT-5 Codex是OpenAI基于GPT-5和Codex，专为编程任务打造的模型，编程能力一流，旨在打破Claude在编码领域的垄断地位。为了解决这个问题，OpenAI发布了新模式GPT-5 Codex，顾名思义，就是将之前的Codex和GPT-5结合起来了，实现1 + 1 > 2的效果。更可气的是，搜出来的内容，大多都是一样的，同样的内容，不同的人，翻来覆去的发，毫无新意。说实话，大多数人还是倾向于即插即用的方式使用大模型，不喜欢本地部署，门槛还是比较高的。
精通 Codex：从入门到高阶的终极使用技巧
Maynor的博客
09-19 4112
Codex 作为 OpenAI 推出的强大编程助手，不仅能完成基础的代码生成和重构，更隐藏着许多能极大提升开发效率的高阶功能。本文将带你从基础配置出发，一步步解锁 Codex 的全部潜力，让你成为真正的 Codex 大师。
Azure OpenAI 官方指南04｜Codex的模型结构和应用场景
微软技术栈
03-30 2962
Codex 的模型结构和 GPT 完全一样，为了尽可能地利用 GPT 的文本表示，Codex 使用了和 GPT-3 一样的分词器。，可以执行其他模型能够执行的任何任务，而需要更少的指令。Codex、GPT-Neo、GPT-J 和 TabNine 在 HumanEval 上的实验结果对比如下图所示，可以发现 Codex-300M 的效果优于 GPT-J 6B。上收集了数据，包括 179 GB 大小在 1 MB 以下的独一无二的 python 文件，在经过过滤后，最终的数据集大小为 159GB。
【Codex CLI 配置指南（小白速通版）】
zsr154278963的博客
09-20 4066
本文是Codex CLI配置的快速入门指南，介绍了三种优先级从高到低的配置方式：命令行参数、通用配置参数和配置文件。详细讲解了模型选择、提供商切换、批准策略、沙箱模式等核心配置项的使用方法，并提供了常见场景的配置示例。文章还包含配置优先级回顾、一键切换配置档、推理输出细节调整等实用技巧，以及易错点提醒，帮助用户快速上手Codex CLI的个性化配置。
Claude Code UI 一个为 Claude Code 和 Cursor CLI 设计的桌面端和移动端用户界面
最新发布
weixin_49869937的博客
10-31 8131
Claude Code UI 是一款多平台界面工具，支持在桌面和移动端访问 Claude Code 和 Cursor CLI。它提供响应式设计、交互式聊天界面、集成终端、文件/项目管理等功能，兼容 Claude Sonnet 4/Opus 4.1 和 GPT-5 模型。用户可通过 npx 一键启动或本地安装，支持会话管理、Git 操作和可选的 AI 任务规划集成。该工具采用 React/Vite 前端和 Express/WebSocket 后端架构，开源遵循 GPL v3 许可，为开发者提供了便捷的跨平台编
再见 Claude Code！玩转 CodeX CLI 的 16 个实用小技巧，效率拉满！！
Java技术栈，分享最主流的Java技术
09-30 2999
目前来说，Codex 还没有提供专门的命令来验证 MCP 服务器的集成情况，不像 Claude Code / Gemini CLI 能提供详细的 MCP 连接信息，相信后续迭代会添加上。想象成是给 Agents 准备的 README，它提供了一个专门的、可预测的地方，用来提供上下文和指令，帮助 AI 编码 Agents 更好地完成你的项目。有了 Web search 网络搜索，模型就能访问互联网上的最新信息，让模型在生成回复之前，先上网搜搜最新的信息，并提供带有出处的答案。
GPT-5-Codex CLI保姆级教程：获取API Key配置与openai codex安装详解
2501_90831828的博客
09-17 5178
摘要：GPT-5-Codex 开启编程代理新时代 OpenAI 最新发布的 GPT-5-Codex 标志着 AI 编程工具从"副驾驶"向"编程代理"的质变。该模型具备三大突破：1）能独立处理复杂编程任务；2）支持多模态 UI 生成，可直接将设计图转化为代码；3）显著降低"幻觉"错误率，可靠性提升 45%。实测数据显示，其解决 GitHub issue 成功率达 74.9%，跨语言能力达 88%。文章提供了详细的安装教程，指导用户通过 Codex C
【Codex CLI 示例提示词：小白也能学的实战清单】
zsr154278963的博客
09-20 1091
这篇指南为Codex CLI新手提供了7个开箱即用的实战示例，覆盖常见开发场景。每个示例包含可直接运行的命令、预期效果和个性化修改建议，如重构React组件、生成数据库迁移、编写单元测试等。文章强调明确目标约束、分步执行和补充上下文等使用技巧，并提供了快速启动命令模板，帮助零基础用户安全高效地通过命令行驱动AI完成开发任务。
【Codex Sandbox 与审批机制：小白也能看懂的实用教程】
zsr154278963的博客
09-20 2055
这篇教程介绍了Codex工具中的沙盒(Sandbox)和审批(Approvals)机制，帮助用户安全高效地使用Codex协作。沙盒限制Codex访问范围，审批机制则控制敏感操作权限。文章详细讲解了五种常见模式：最安全的安全只读浏览、只读非交互、仓库内编辑、Auto预设和不推荐的YOLO模式。还提供了新手使用路径建议、配置示例和实战场景范式，包括如何测试沙盒行为、不同系统下的实现方式以及常见问题解答。最后附上速查清单，帮助用户快速选择合适的权限组合。
codex怎么安装使用
数据小白的博客
09-06 8357
Codex是Augment的全新升级版本，采用类似Vue 3.x的"按需检索"模式，相比Augment的预加载方式更加高效。本文提供Codex的详细安装指南：可通过官网直接安装VS Code插件，并介绍了输入框下方功能区的使用说明，包括附件添加上下文、自动执行开关、运行位置选择、代理模式设置和推理级别控制等。建议开发者根据项目需求灵活组合这些功能，优先使用Local模式处理敏感代码，在版本控制下谨慎使用full access代理模式。
Codex 的使用指南
TEDDY的博客
09-16 1273
本文介绍了Codex CLI工具的安装与使用方法。主要内容包括：通过npm或Homebrew安装Codex CLI，验证安装成功；首次使用时的登录流程和API密钥认证；常用操作命令如退出登录、禁用沙箱安全设置等；支持任务描述模式和非交互模式两种工作方式；以及如何切换预定义的配置集。文章还提供了具体命令示例，如代码重构、更新日志等操作指令，帮助用户快速掌握Codex CLI的基本使用。
AI编程之codex使用教程
lpl9472的博客
10-20 1795
本文介绍了Codex AI编程工具的本地部署方法和主要命令。部署需要Node.js 18+和Git环境，提供两种安装方式：GAC站内授权和API KEY配置。主要命令包括初始化项目(/init)、压缩上下文(/compact)、切换模型(/model)等。文章还提供了详细的配置步骤和截图说明，适合开发者快速上手使用Codex进行编程辅助。该工具在科研开发和简单代码作业中表现良好，文末还提供了订阅咨询渠道。
玩转CodeX：CodeX安装教程（Windows+Linux+MacOS）
热门推荐
踏雨歌青春，诗酒趁年华
10-08 1万+
本文详细介绍如何在Windows、Linux和MacOS系统中安装AI编码工具CodeX。安装步骤包括：1)注册CodeX中国镜像站账户并获取API密钥；2)通过npm安装@openai/codex包；3)配置.auth.json和config.toml文件。安装完成后，用户可在项目目录中启动CodeX，并使用特定参数跳过授权流程。文中提供了详细的配置文件和命令行操作指南，确保用户能顺利完成安装并验证版本号。
分享AI乱改代码的 后悔药
weixin_49869937的博客
10-13 2868
摘要：本文介绍了两种高效代码管理方式：1）使用Codex结合IDE，通过本地项目目录实时记录代码变动；2）采用Git版本控制，将每次修改明确写入Markdown文件并及时提交。还提到Codex赠送3000积分，足够一天使用，推荐开发者试用。两种方法都能有效跟踪代码变更，提高开发效率。
codex CLIwindows系统使用
08-24
我们正在处理用户关于在Windows系统上使用Codex CLI的问题。根据用户提供的引用，我们有一些关于设置环境变量和启动Codex CLI的信息。 用户引用中提到了一个start.ps1脚本，其中设置了环境变量并运行了codex命令。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值