Codex Windows使用指南¶
强烈推荐:优先使用
install_script.bat一键完成全部环境部署。只要遇到安装或连接问题,第一选择就是重新运行该脚本。
(一) 一键安装脚本(推荐)¶
想一次性完成 Node.js、npm 镜像、Claude Code / Codex / Gemini / Droid CLI / OpenClaw 以及环境变量配置,请优先使用随文档提供的
install_script.bat,而不是手动逐步安装。
- 下载或找到官方一键安装脚本
install_script.bat。 - 在资源管理器中右键该脚本,选择 ”以管理员身份运行”(脚本会先检查管理员权限)。
- 按照脚本提示依次完成:
- 检查 / 安装 Node.js(如未安装会自动下载安装 Node 20+)。
- 将 npm 源切换为
https://registry.npmmirror.com。 - 安装或更新 Claude Code / Codex CLI / Gemini CLI / Droid CLI / OpenClaw。
- 如系统未安装 Git,会自动从国内镜像下载并安装 Git。
- 提示输入 API Base(默认
https://api.share-ai.woolen.wang)和 API Token(如sk-xxxx),脚本会自动:- 写入环境变量:
OPENAI_BASE_URL、OPENAI_API_KEY、CODE_ASSIST_ENDPOINT等; - 生成 Codex 配置目录
C:\Users\你的用户名\.codex及config.toml、auth.json文件。
- 写入环境变量:
- 脚本执行结束后,关闭当前终端窗口,重新打开 PowerShell / CMD,执行:
codex --version
如果能看到版本号,说明 Codex CLI 已安装完成。
只有在不方便使用脚本或脚本执行失败时,才需要参考下面的“手动安装”步骤。
(二) 手动安装 Node.js 环境¶
如果你已经通过
install_script.bat完成安装并确认node --version能正常输出版本号,可以跳过本节。后续任何步骤出错,都可以直接回到这里,重新运行install_script.bat来修复环境。
Windows 安装方法¶
方法一:官网下载(推荐)
- 打开浏览器访问
https://nodejs.org/ - 点击 LTS 版本进行下载(推荐使用 18 或以上版本,脚本默认安装的是 Node 20 LTS)
- 下载完成后双击
.msi文件 - 按照安装向导完成安装,保持默认设置即可
方法二:使用包管理器
如果你安装了 Chocolatey 或 Scoop,可以使用命令行安装:
# 使用 Chocolatey
choco install nodejs
# 或使用 Scoop
scoop install nodejs
Windows 注意事项
- 建议使用 PowerShell 而不是 CMD
- 如果遇到权限问题,尝试以管理员身份运行
- 某些杀毒软件可能会误报,需要添加白名单
验证安装是否成功
安装完成后,打开 PowerShell 或 CMD,输入以下命令:
node --version
npm --version
如果显示版本号,说明安装成功了!
(三) 手动安装 Codex CLI¶
打开 PowerShell 或 CMD,运行以下命令(与一键安装脚本内部使用的命令等价):
# 全局安装 Codex CLI
npm install -g @openai/codex@latest --registry=https://registry.npmmirror.com
该命令会通过国内 npmmirror 源安装最新版本的 Codex。更新也使用这个命令
验证安装¶
codex --version
提示
- 建议使用 PowerShell 而不是 CMD,功能更强大
- 如果遇到权限问题,以管理员身份运行 PowerShell
- 如安装时报缺少 VC++ 运行库,可手动安装 Microsoft Visual C++ 2015-2022 Redistributable,或通过
install_script.bat让脚本自动安装。
提示:如果此处验证失败或者 Codex 无法正常启动,优先选择重新运行
install_script.bat,让脚本自动检查 Node/npm/VC++ 运行库及 Codex 安装状态。
(四) 配置 Codex(Base URL 与 Token)¶
如果你已经在
install_script.bat中输入过 API Base 和 API Token,本节的配置文件和环境变量已经由脚本自动写入,只需了解配置位置即可。如果你怀疑配置文件或环境变量被误改,重新运行install_script.bat是最快的恢复方式。
1. 通过配置文件方式(与脚本一致,推荐)¶
- 配置目录:
C:\Users\你的用户名\.codex(若不存在请手动创建) - 使用记事本或任意文本编辑器打开
config.toml,可参考以下内容(与脚本生成的内容保持一致):
disable_response_storage = true
model = "gpt-5.2"
model_reasoning_effort = "high"
model_provider = "share-ai"
sandbox_mode = "danger-full-access"
windows_wsl_setup_acknowledged = true
base_instructions = "Always prefer built-in tools (read_file, list_dir, grep_files) over shell commands for file operations."
[experimental]
use_freeform_apply_patch = true
use_unified_exec_tool = true
[features]
apply_patch_freeform = true
ghost_commit = true
plan_tool = true
rmcp_client = true
streamable_shell = false
unified_exec = false
view_image_tool = true
web_search_request = true
enable_experimental_windows_sandbox = true
experimental_sandbox_command_assessment = true
parallel = true
[model_providers.share-ai]
base_url = "https://api.share-ai.woolen.wang/v1"
name = "share-ai"
requires_openai_auth = true
wire_api = "responses"
[sandbox_workspace_write]
network_access = true
- 创建或编辑
auth.json文件,内容示例:
{
"OPENAI_API_KEY": "sk-xxx"
}
将 "sk-xxx" 替换为你的 ShareAI API 密钥,格式如 sk-xxxxxxxx。
2. 通过环境变量方式(脚本同样会设置)¶
如果你使用其他支持 OpenAI API 的工具(如 Codex),也可以通过环境变量方式配置:
PowerShell 临时设置(当前会话)
$env:OPENAI_BASE_URL = "https://api.share-ai.woolen.wang"
$env:OPENAI_API_KEY = "你的API密钥"
$env:CODE_ASSIST_ENDPOINT = "https://api.share-ai.woolen.wang"
PowerShell 永久设置(用户级)
# 设置用户级环境变量(永久生效)
[System.Environment]::SetEnvironmentVariable("OPENAI_BASE_URL", "https://api.share-ai.woolen.wang", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("OPENAI_API_KEY", "你的API密钥", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("CODE_ASSIST_ENDPOINT", "https://api.share-ai.woolen.wang", [System.EnvironmentVariableTarget]::User)
使用你的 ShareAI API 密钥,格式如 sk-xxxxxxxx,通常与 Claude Code / Gemini 共用同一个密钥。
验证 Codex 相关环境变量
在 PowerShell 中验证:
echo $env:OPENAI_BASE_URL
echo $env:OPENAI_API_KEY
echo $env:CODE_ASSIST_ENDPOINT
设置后需要重新打开 PowerShell 窗口才能完全生效。
(五) 开始使用 Codex¶
启动 Codex¶
配置完成后,在 PowerShell 或 CMD 中输入以下命令启动 Codex:
codex
首次启动时,Codex 会进行初始化配置。
基本使用¶
- 交互模式:直接输入
codex进入交互式对话 - 指定项目:在项目目录下运行
codex,Codex 会自动识别项目上下文 - 退出程序:输入
exit或按Ctrl+C退出
(六) 常见问题解决¶
1. 命令未找到错误¶
问题:运行 codex 时提示 "不是内部或外部命令"
解决方法:
# 检查 npm 全局安装路径
npm config get prefix
# 确保该路径在 PATH 中
$env:Path
# 如果不在,添加到系统环境变量
# 打开系统环境变量设置,将 npm 全局路径添加到 Path 中
# 默认路径通常是:C:\Users\你的用户名\AppData\Roaming\npm
2. 权限问题¶
问题:安装时提示权限不足
解决方法:
# 以管理员身份运行 PowerShell
# 右键点击 PowerShell 图标,选择"以管理员身份运行"
# 然后重新安装
npm install -g @openai/codex@latest
3. API 连接失败¶
问题:Codex 无法连接到 API 服务
解决方法:
# 检查环境变量是否正确设置
echo $env:OPENAI_BASE_URL
echo $env:OPENAI_API_KEY
# 测试网络连接
Test-NetConnection -ComputerName api.share-ai.woolen.wang -Port 443
# 重新设置环境变量
$env:OPENAI_BASE_URL = "https://api.share-ai.woolen.wang"
$env:OPENAI_API_KEY = "你的API密钥"
如果检查网络与环境变量后仍然无法解决连接问题,推荐直接再次运行
install_script.bat,让脚本重新写入环境变量和配置文件。
4. 更新 Codex¶
问题:如何更新到最新版本
解决方法:
# 更新 Codex(推荐使用国内镜像)
npm i -g @openai/codex@latest --registry=https://registry.npmmirror.com
# 或者重新安装
npm install -g @openai/codex@latest
5. Node.js 版本过低¶
问题:提示 Node.js 版本不兼容
解决方法:
# 检查当前版本
node --version
# 从官网下载最新的 LTS 版本(需要 18 或更高版本)
# 访问 https://nodejs.org/ 下载安装
6. 防火墙或杀毒软件拦截¶
问题:安装或运行时被防火墙拦截
解决方法: - 将 Node.js 和 npm 添加到防火墙白名单 - 临时关闭杀毒软件进行安装 - 检查企业网络策略是否允许访问 npm 仓库