在 VS Code 中使用 Codex 教程

本教程根据以下两篇资料整理改写:

适用场景

如果你希望在 VS Code 中直接使用 Codex 辅助写代码、解释项目、修改文件、排查报错或生成测试,可以按照本文完成插件安装、认证配置和常见问题排查。

如果你在国内网络环境下遇到官网登录卡住、localhost 拒绝连接、授权回调失败等问题,也可以参考本文后半部分的替代配置方案。

准备工作

开始前请准备好:

  • 已安装 VS Code。
  • 可用的 Codex/OpenAI API Key,或兼容 OpenAI API 的服务商 Key。
  • 如果使用第三方服务,需要准备对应的 Base URL。
  • 能访问对应 API 服务的网络环境。
  • 一个准备让 Codex 协助处理的代码项目。

安全提醒:API Key 等同于账号访问凭证,不要提交到 Git 仓库,也不要发给不可信的人或网站。

第一步:安装 VS Code 插件

  1. 打开 VS Code。
  2. 进入左侧扩展面板。
  3. 搜索 Codex
  4. 找到对应插件后点击安装。
  5. 安装完成后,建议重启 VS Code,确保插件命令和侧边栏入口正常加载。

安装完成后,可以在 VS Code 的命令面板中搜索 Codex 相关命令,确认插件已经被识别。

第二步:选择登录或 API Key 方式

Codex 通常有两类接入方式:

  • 官网登录:通过浏览器完成授权,再把登录状态写回本地。
  • API Key:直接在本地配置 Key 和服务地址,让 Codex 通过 API 调用模型。

如果你的网络环境稳定,官网登录可以直接尝试。如果你在国内网络环境下经常遇到登录卡住、回调失败或 localhost 拒绝连接,更建议使用 API Key 方式。

第三步:配置 API Key

你需要准备一个可用的 API Key。通常可以从以下位置获得:

  • OpenAI 官方平台。
  • 兼容 OpenAI API 格式的第三方服务平台。
  • 团队或公司统一发放的 API 访问凭证。

如果使用第三方中转或兼容服务,请额外确认:

  • 服务商是否可信。
  • 计费方式是否清楚。
  • 是否支持你需要使用的模型。
  • API Key 是否会被安全保存。
  • Base URL 是否来自服务商官方说明。

方式 A:使用环境变量

在终端中设置 OPENAI_API_KEY

Windows PowerShell:

$env:OPENAI_API_KEY="你的 API Key"

macOS / Linux:

export OPENAI_API_KEY="你的 API Key"

这种方式适合临时测试。关闭终端后,环境变量可能失效。

方式 B:使用本地认证文件

Codex 也可以读取用户目录下的认证配置。常见目录如下:

Windows:

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

macOS / Linux:

~/.codex

可以在该目录下创建 auth.json,写入类似配置:

{
  "OPENAI_API_KEY": "你的 API Key"
}

保存后请确认:

  • 文件名是 auth.json
  • JSON 格式合法。
  • API Key 前后没有多余空格。
  • 文件没有被提交到 Git。

第四步:配置模型和服务地址

如果使用默认 OpenAI 服务,通常只需要配置 API Key。如果使用兼容服务、代理服务或国内中转服务,通常还需要配置 config.toml

配置文件一般位于:

~/.codex/config.toml

Windows 对应路径通常是:

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

默认服务示例

model = "gpt-4.1"

兼容服务或中转服务示例

如果服务商提供了 Base URL,可以使用类似配置:

model_provider = "relay"

[model_providers.relay]
name = "Relay"
base_url = "在服务商后台复制的 Base URL"
env_key = "OPENAI_API_KEY"
wire_api = "responses"

如果服务商要求使用特定模型名称,请以服务商文档为准。例如,有些兼容服务会提供自己的模型别名。

第五步:重启 VS Code 并测试

完成配置后:

  1. 关闭 VS Code。
  2. 重新打开 VS Code。
  3. 打开一个项目文件夹。
  4. 打开 Codex 插件面板或命令面板。
  5. 输入一个简单任务,例如:
请解释当前项目的主要结构。

如果 Codex 能正常返回结果,说明基础安装和配置已经完成。

如果你同时安装了 Codex CLI,也可以在终端执行:

codex --help
codex run "say hello in chinese"

如果这两个命令都能正常返回,说明认证配置和模型调用链路基本可用。

国内登录失败的原因

国内用户遇到 Codex 官网登录失败,常见原因不是 VS Code 本身的问题,而是登录链路较长且容易受网络影响。

官网登录通常包含这些环节:

  1. 浏览器打开授权页面。
  2. 授权完成后回调本机 localhost
  3. CLI 或插件把会话写入本地。
  4. 后续继续通过 API 与模型服务通信。

只要其中任意一环不稳定,就可能出现:

  • 登录页面一直转圈。
  • 浏览器提示 localhost 拒绝连接。
  • 授权页面能打开,但回调后仍然没有登录成功。
  • 昨天能用,今天又登录不上。
  • 登录成功后使用过程中继续超时或断连。

国内环境推荐解决方案

如果你反复遇到官网登录失败,建议优先改为 API Key 方式,而不是一直重试网页登录。

更稳的处理思路是:

  1. 获取可用的 API Key。
  2. 如果使用兼容服务,复制服务商提供的 Base URL。
  3. ~/.codex/config.toml 中配置 model_providerbase_url
  4. 通过 OPENAI_API_KEY 环境变量或 auth.json 保存 Key。
  5. 重启 VS Code。
  6. 用简单问题测试插件是否能正常返回。
  7. 如果安装了 CLI,再用 codex --helpcodex run "say hello in chinese" 验证。

这种方式可以减少对浏览器官网登录、授权回调和本地会话写入链路的依赖。

如果仍想尝试官网登录

如果你希望继续使用官网网页登录,可以尝试:

  • 更换浏览器后重新登录。
  • 关闭可能影响回调的浏览器插件。
  • 清理浏览器缓存后重试。
  • 确认本机没有安全软件、代理规则或防火墙拦截 localhost 回调。
  • 确认登录流程没有被网络代理中断。
  • 如果仍反复失败,切换到 API Key 方式通常更省时间。

常见问题排查

插件安装后没有反应

可以尝试:

  • 重启 VS Code。
  • 确认插件已经启用。
  • 打开命令面板搜索 Codex 命令。
  • 查看 VS Code 输出面板中是否有插件报错。

登录或连接一直卡住

可以检查:

  • API Key 是否正确。
  • auth.json 是否放在正确目录。
  • config.toml 是否放在正确目录。
  • 网络是否能访问 API 服务。
  • 如果使用代理或兼容服务,base_url 是否配置正确。
  • 当前模型名称是否被服务商支持。

报错:localhost 拒绝连接

这通常发生在官网登录的本地回调阶段。可以先检查:

  • 浏览器是否拦截了跳转。
  • 本机安全软件是否拦截本地端口。
  • 代理或网络工具是否影响了 localhost
  • 是否有其他进程占用了相关端口。

如果排查后仍反复失败,建议切换到 API Key 方式接入。

返回 401 或认证失败

通常表示认证信息有问题。请检查:

  • API Key 是否过期或被撤销。
  • 是否复制了多余空格。
  • 是否使用了错误的账号或服务商。
  • auth.json 格式是否正确。
  • env_key 是否与环境变量名称一致。

返回模型不存在

通常是模型名称不匹配。请在 config.toml 中改成当前服务支持的模型名称。

Codex 修改范围太大

建议在提示词中明确限制范围:

只分析问题,不要修改文件。

或:

只修改 components/LoginForm.tsx,不要改动其他文件。

常用操作示例

你可以在 VS Code 中让 Codex 执行这些任务:

  • 解释当前文件的作用。
  • 根据报错信息定位问题。
  • 为已有函数补充单元测试。
  • 重构重复代码。
  • 生成 README 或接口文档草稿。
  • 根据需求创建新文件或修改现有文件。
  • 分析项目结构并给出改进建议。

建议一开始使用范围较小、目标明确的请求,例如:

请只修改 src/utils.ts,修复 parseDate 在空字符串时抛错的问题,并补充测试。

相比“帮我优化整个项目”,这种描述更容易得到可靠结果。

使用建议

  • 先让 Codex 阅读和解释代码,再让它修改代码。
  • 每次请求聚焦一个问题,避免一次性塞入过多目标。
  • 修改前让 Codex 说明计划,复杂任务再执行。
  • 修改后运行测试、类型检查或启动项目验证。
  • 对涉及密钥、支付、权限、删除数据的改动保持人工复核。
  • 不要把 API Key 写进项目源码或 README。
  • 使用第三方服务时,注意确认服务商可信度、费用规则和隐私政策。

推荐工作流

一个稳妥的日常工作流是:

  1. 打开项目。
  2. 让 Codex 总结相关文件。
  3. 描述你要解决的问题。
  4. 要求 Codex 给出修改计划。
  5. 确认后让 Codex 修改。
  6. 运行测试或本地启动验证。
  7. 查看 Git diff,确认改动符合预期。
  8. 再提交代码。

小结

在 VS Code 中使用 Codex 的核心步骤是:安装插件、准备 API Key、配置认证文件、按需配置模型和服务地址、重启 VS Code 并测试。

如果在国内网络环境下遇到官网登录卡住、localhost 拒绝连接或授权回调失败,不必反复重试同一条登录链路。更稳的办法是改用 API Key 和 Base URL 配置,减少对浏览器授权回调的依赖。

为了获得更稳定的效果,请尽量给出明确、可验证、范围受控的任务描述,并在关键改动后进行人工检查和本地验证。
C](这里写自定义目录标题)

欢迎使用Markdown编辑器

你好! 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章,了解一下Markdown的基本语法知识。

新的改变

我们对Markdown编辑器进行了一些功能拓展与语法支持,除了标准的Markdown编辑器功能,我们增加了如下几点新功能,帮助你用它写博客:

  1. 全新的界面设计 ,将会带来全新的写作体验;
  2. 在创作中心设置你喜爱的代码高亮样式,Markdown 将代码片显示选择的高亮样式 进行展示;
  3. 增加了 图片拖拽 功能,你可以将本地的图片直接拖拽到编辑区域直接展示;
  4. 全新的 KaTeX数学公式 语法;
  5. 增加了支持甘特图的mermaid语法1 功能;
  6. 增加了 多屏幕编辑 Markdown文章功能;
  7. 增加了 焦点写作模式、预览模式、简洁写作模式、左右区域同步滚轮设置 等功能,功能按钮位于编辑区域与预览区域中间;
  8. 增加了 检查列表 功能。

功能快捷键

撤销:Ctrl/Command + Z
重做:Ctrl/Command + Y
加粗:Ctrl/Command + B
斜体:Ctrl/Command + I
标题:Ctrl/Command + Shift + H
无序列表:Ctrl/Command + Shift + U
有序列表:Ctrl/Command + Shift + O
检查列表:Ctrl/Command + Shift + C
插入代码:Ctrl/Command + Shift + K
插入链接:Ctrl/Command + Shift + L
插入图片:Ctrl/Command + Shift + G
查找:Ctrl/Command + F
替换:Ctrl/Command + G

合理的创建标题,有助于目录的生成

直接输入1次#,并按下space后,将生成1级标题。
输入2次#,并按下space后,将生成2级标题。
以此类推,我们支持6级标题。有助于使用TOC语法后生成一个完美的目录。

如何改变文本的样式

强调文本 强调文本

加粗文本 加粗文本

标记文本

删除文本

引用文本

H2O is是液体。

210 运算结果是 1024.

插入链接与图片

链接: link.

图片: Alt

带尺寸的图片: Alt

居中的图片: Alt

居中并且带尺寸的图片: Alt

当然,我们为了让用户更加便捷,我们增加了图片拖拽功能。

如何插入一段漂亮的代码片

博客设置页面,选择一款你喜欢的代码片高亮样式,下面展示同样高亮的 代码片.

// An highlighted block
var foo = 'bar';

生成一个适合你的列表

  • 项目
    • 项目
      • 项目
  1. 项目1
  2. 项目2
  3. 项目3
  • 计划任务
  • 完成任务

创建一个表格

一个简单的表格是这么创建的:

项目 Value
电脑 $1600
手机 $12
导管 $1

设定内容居中、居左、居右

使用:---------:居中
使用:----------居左
使用----------:居右

第一列 第二列 第三列
第一列文本居中 第二列文本居右 第三列文本居左

SmartyPants

SmartyPants 是一个文本转换工具,主要功能是将普通的 ASCII 标点符号自动转换为更美观的印刷体标点符号。例如:

原始符号 转换后 说明
"引号" “引号” 直引号变弯引号
'单引号' ‘单引号’ 直单引号变弯单引号
-- 两个连字符变短破折号
--- 三个连字符变长破折号
... 三个点变省略号

创建一个自定义列表

Markdown
Text-to- HTML conversion tool
Authors
John
Luke

如何创建一个注脚

一个具有注脚的文本。2

注释也是必不可少的

Markdown将文本转换为 HTML

KaTeX数学公式

您可以使用渲染LaTeX数学表达式 KaTeX:

Gamma公式展示 Γ ( n ) = ( n − 1 ) ! ∀ n ∈ N \Gamma(n) = (n-1)!\quad\forall n\in\mathbb N Γ(n)=(n1)!nN 是通过欧拉积分

Γ ( z ) = ∫ 0 ∞ t z − 1 e − t d t   . \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. Γ(z)=0tz1etdt.

你可以找到更多关于的信息 LaTeX 数学表达式here.

新的甘特图功能,丰富你的文章

2014-01-07 2014-01-09 2014-01-11 2014-01-13 2014-01-15 2014-01-17 2014-01-19 2014-01-21 已完成 进行中 计划一 计划二 现有任务 Adding GANTT diagram functionality to mermaid
  • 关于 甘特图 语法,参考 这儿,

UML图表

可以使用UML图表进行渲染,例如下面产生的一个序列图:

王五 李四 张三 王五 李四 张三 李四想了很长时间, 文字太长了 不适合放在一行. 你好!李四, 最近怎么样? 你最近怎么样,王五? 我很好,谢谢! 我很好,谢谢! 打量着王五... 很好... 王五, 你怎么样?
  • 关于 UML图表 语法,参考 这儿,

流程图

链接

长方形

圆角长方形

菱形

  • 关于 Mermaid 语法,参考 这儿,

FLowchart流程图

我们依旧会支持flowchart.js的流程图语法:

Created with Raphaël 2.3.0 开始 我的操作 确认? 结束 yes no
  • 关于 Flowchart流程图 语法,参考 这儿.

导出与导入

导出

如果你想尝试使用此编辑器, 你可以在此篇文章任意编辑。当你完成了一篇文章的写作, 在上方工具栏找到 文章导出 ,生成一个.md文件或者.html文件进行本地保存。

导入

如果你想加载一篇你写过的.md文件,在上方工具栏可以选择导入功能进行对应扩展名的文件导入,
继续你的创作。


  1. mermaid语法说明 ↩︎

  2. 注脚的解释 ↩︎

Logo

汇聚全球AI编程工具,助力开发者即刻编程。

更多推荐