Skip to content

Repository files navigation

Codex 跨平台一键安装与更新器

Compatibility Latest Release License: MIT Platforms OpenAI Codex CLI GitHub stars

Windows / macOS one-click installer and updater for OpenAI Codex CLI, with optional Codex App support on Windows through Microsoft Store / winget and a bundled fallback installer.

这个仓库提供 Windows 和 macOS 的 Codex CLI 一键安装与更新脚本;在 Windows 上,脚本会优先按 OpenAI 官方 Windows 文档 推荐的 Microsoft Store / winget install Codex -s msstore 路径尽量安装或更新 Codex App。如果 Microsoft Store / winget 不可用、失败或 300 秒内未完成,则自动改用仓库同目录的 Codex Installer.exe 作为国内网络/离线兜底。若你在企业内网另有可信安装器,也可以用 CODEX_APP_INSTALLER_URL 作为自定义兜底。它适合希望快速安装、后续持续更新 Codex CLI,又不想手动处理 Git / Node.js / Python / npm registry / 网络镜像的用户。脚本会优先使用官方可获取的安装包;当系统或架构不满足官方安装条件时,会在下载和安装前尽早提示用户。

如果这个项目帮到了你,欢迎 Star、转发给需要的人,或者在 Issues 里补充你的系统环境和安装结果,帮助更多用户少走弯路。

亮点

  • 双击即可开始:Windows 使用 .cmd,macOS 使用 .command,安装和更新都有独立入口。
  • CLI + App + Update:默认安装/更新 Codex CLI;Windows 在未禁用 App 步骤时优先尝试 Microsoft Store / winget 路径,慢速或不可达时自动使用内置 Codex Installer.exe 兜底。
  • 幂等安装:Windows 已检测到 Codex CLI 可用时,默认不重装 CLI、不覆盖配置;Git / Node.js / Python 仍会补缺,保障 Skills 和常见开发任务可用。
  • 更新更稳妥:默认只更新 Codex CLI、可选 App、可选 Skills;Git / Node.js / Python 只补缺,显式启用依赖更新时才升级。
  • 跨平台覆盖:Windows 10 / 11、部分 Windows 8 / 8.1 兼容路径、macOS x64 / Apple Silicon。
  • 国内网络友好:默认使用 npmmirror.comregistry.npmmirror.com,失败时回退官方源。
  • 预检优先:支持只检查系统、架构和下载源,不安装、不写配置。
  • 安全默认值:真实 API Key、本地下载源、安装包和日志默认不会提交到仓库。
  • CI 兜底:GitHub Actions 覆盖 PowerShell 语法、Windows/macOS 安装计划和更新计划。

快速开始

Releases 下载最新压缩包,解压后按系统双击入口:

系统 安装入口 更新入口 命令行入口
Windows Windows双击安装Codex.cmd Windows双击更新Codex.cmd powershell.exe -NoProfile -ExecutionPolicy Bypass -File .\install-codex.ps1
macOS macOS双击安装Codex.command macOS双击更新Codex.command chmod +x macOS双击安装Codex.command macOS双击更新Codex.command install-codex-macos.sh && ./macOS双击安装Codex.command

默认安装/更新目标:

能力 Windows macOS
Codex CLI 安装与更新 安装与更新
Codex App 可选:默认尝试 Microsoft Store / winget install Codex -s msstore;失败或超时后使用同目录 Codex Installer.exe 兜底 暂未自动安装或更新;可按 OpenAI Codex app 文档 手动下载
Codex Skills 可选:提供 codex-skills.zipCODEX_SKILLS_URL 后安装/更新 可选:提供 codex-skills.zipCODEX_SKILLS_URL 后安装/更新
Git / Node.js / Python 每次运行都补缺;-UpdateDependencies 时更新 默认补缺;--update-dependencies 时更新 Node.js / Python

安装完成后,重新打开终端或 PowerShell:

codex --version
codex

支持范围

  • Windows 10 / Windows 11:默认安装兼容优先的官方依赖,适配专业版、企业版、LTSC 常见环境。
  • Windows 8.1:使用旧版官方 Git / Node.js / Python 兼容路径,尽量完成安装。
  • Windows 8:使用更保守的旧版官方依赖,尽量完成安装。
  • macOS 13.5+:支持 x64 和 Apple Silicon。

Windows 8 / 8.1 已过官方生命周期。脚本会尽力安装,但 Codex 最新版本可能不再保证在旧系统完整可用。 GitHub 官方托管 runner 不是 Windows 10 桌面版。仓库内的 GitHub Actions 会做安装计划、下载源和脚本语法矩阵测试;如需真实 Win10 专业版/企业版测试,请注册 self-hosted runner 并使用 workflow_dispatch 触发。

默认下载源

脚本默认使用国内友好的公开加速源:

  • Node.js / Python / Git for Windows:优先 https://npmmirror.com/mirrors/...,失败后回退官方源。
  • npm registry:默认 https://registry.npmmirror.com,安装 Codex CLI 失败时自动回退 https://registry.npmjs.org

如果你在海外网络、公司内网或有自己的镜像,可设置 CODEX_DOWNLOAD_MIRROR=official,或使用环境变量 / downloads.local.json 覆盖具体 URL。

Windows

解压最新 Release 后双击运行:

Windows双击安装Codex.cmd

或在 PowerShell 中运行:

powershell.exe -NoProfile -ExecutionPolicy Bypass -File .\install-codex.ps1

后续更新可双击:

Windows双击更新Codex.cmd

或在 PowerShell 中运行:

powershell.exe -NoProfile -ExecutionPolicy Bypass -File .\install-codex.ps1 -Update

可选参数:

.\install-codex.ps1 -SkipGit -SkipPython -SkipSkills -SkipCodexApp
.\install-codex.ps1 -Update -UpdateDependencies
.\install-codex.ps1 -Force
.\install-codex.ps1 -Reconfigure
.\install-codex.ps1 -SkipConfig

Windows 幂等策略:

  • 如果 codex --version 已成功返回,安装模式会提示是否强制重装 Codex CLI;默认回答为否,非交互模式也会跳过 CLI 重装。
  • 即使 Codex CLI 已可用,Git / Node.js / Python 仍会按“缺失才安装”的方式检查并补齐,方便 Skills、Git 工作流和本地脚本使用。
  • 已有 ~/.codex/config.toml~/.codex/auth.json 默认保留,不会被安装/更新覆盖。
  • 使用 -Force 可强制重装 Codex CLI 以及已配置的可选 App/Skills;使用 -Reconfigure 才会备份后重写 Codex 配置/认证文件。
  • 如果配置写入后后续步骤失败,脚本会自动还原本次修改过的 config.toml / auth.json;成功时备份会保留在 ~/.codex/backups/installer-...

Windows Codex App 可选安装方式:

  • 默认路径:脚本会先按 OpenAI 官方 Windows 文档 尝试 winget install Codex -s msstore;如果已检测到 Codex App,会尝试 winget upgrade Codex -s msstore
  • 国内/离线兜底:如果 winget 不可用、失败或 300 秒内未完成,脚本会自动改用同目录 Codex Installer.exe
  • 企业自定义兜底:如果需要使用自己的可信安装器下载源,可设置 CODEX_APP_INSTALLER_URL / downloads.local.jsonCodexAppUrl
  • 自定义安装器会先尝试静默安装;如果安装器不支持静默参数,会打开普通安装窗口。
  • Codex App 是可选步骤;Store / winget / 自定义安装器失败时,脚本会给出提示,但不会影响 Codex CLI、Git、Node.js、Python 或 Skills 的安装结果。
  • 如只想安装 Codex CLI,可传入 -SkipCodexApp
  • 仓库内置的 Codex Installer.exe 是国内网络/离线兜底,不作为首选更新源;如关注最新 App 版本,优先使用 winget 或替换为你刚从官方入口下载的新安装器。

预检模式,不安装、不写配置,适合先排查系统兼容性和下载源:

.\install-codex.ps1 -CheckOnly -VerifyDownloads -NoPause
.\install-codex.ps1 -Update -CheckOnly -VerifyDownloads -NoPause

macOS

解压最新 Release 后双击运行:

macOS双击安装Codex.command

如果系统提示没有执行权限,再用终端运行:

chmod +x macOS双击安装Codex.command macOS双击更新Codex.command install-codex-macos.sh
./macOS双击安装Codex.command

后续更新可双击:

macOS双击更新Codex.command

或在终端中运行:

./install-codex-macos.sh --update
./install-codex-macos.sh --update --update-dependencies
./install-codex-macos.sh --skip-config
./install-codex-macos.sh --reconfigure

macOS 默认保留已有 ~/.codex/config.toml~/.codex/auth.json;需要跳过配置写入时使用 --skip-config,需要备份后重写配置/认证文件时使用 --reconfigure

说明:Windows 和 macOS 的双击入口格式不同,所以仓库提供 .cmd.command 两个原生入口。它们会自动调用对应系统的安装脚本。 Codex macOS App:OpenAI 官方 Codex App 文档提供 Apple Silicon 和 Intel 版本下载入口;本仓库当前只自动安装/更新 macOS Codex CLI,不自动下载、缓存或安装 macOS App 包。

更新策略

更新模式的目标是“尽量少打扰、安全刷新”:

  • Codex CLI:安装模式下如果已可用则默认跳过;更新模式运行 npm install -g @openai/codex@latest,更新到 npm registry 可获取的最新版本。
  • Codex Windows App:更新模式会优先使用 Microsoft Store / winget 尝试安装或更新;如果 winget 失败或超时,则改用同目录 Codex Installer.exe,再尝试 CODEX_APP_INSTALLER_URL / CodexAppUrl 自定义路径。
  • Codex Skills:仅在提供 codex-skills.zipCODEX_SKILLS_URL 时重新同步。
  • Git / Node.js / Python:默认只在缺失或不满足最低要求时安装;Windows 使用 -UpdateDependencies,macOS 使用 --update-dependencies 时才按当前计划版本重新安装。
  • 密钥与配置:默认保留已有 ~/.codex/config.toml~/.codex/auth.json;仅缺失时补写,或在显式传入 -Reconfigure 时备份后重写。

密钥配置

首次安装且未检测到 auth.json 时,脚本会提示输入 OPENAI_API_KEY。也可以在脚本同目录创建 codex-auth.json

{"OPENAI_API_KEY":"YOUR_OPENAI_API_KEY"}

如果已有 auth.json,脚本默认不会用同目录 codex-auth.json 覆盖;需要覆盖时 Windows 请显式传入 -Reconfigure,macOS 请显式传入 --reconfigurecodex-auth.json 已加入 .gitignore,不要提交真实密钥。

私有下载源与域名去敏

仓库默认只保留公开官方下载源,不包含私有域名、签名 URL、临时 token 或镜像域名。

如果需要使用自己的下载源,请使用环境变量或本地 downloads.local.json 覆盖;该文件已加入 .gitignore

可用字段 / 环境变量:

字段 环境变量 用途
DownloadMirror CODEX_DOWNLOAD_MIRROR 下载源模式:chinaofficial
NodeVersion CODEX_NODE_VERSION 覆盖默认 Node.js 版本
PythonVersion CODEX_PYTHON_VERSION 覆盖默认 Python 版本
GitUrl CODEX_GIT_URL Git for Windows 安装包
NodeUrl CODEX_NODE_URL Node.js 安装包
PythonUrl CODEX_PYTHON_URL Python 安装包
SkillsUrl CODEX_SKILLS_URL 可选 Skills zip 包
CodexAppUrl CODEX_APP_INSTALLER_URL 可选 Codex Windows App 自定义安装器,企业/离线兜底使用
NpmRegistry CODEX_NPM_REGISTRY 可选 npm registry
CodexBaseUrl CODEX_BASE_URL 可选 OpenAI 兼容 API 地址
CodexModel CODEX_MODEL 可选默认模型

示例:

{
  "DownloadMirror": "china",
  "SkillsUrl": "https://example.invalid/codex-skills.zip",
  "CodexAppUrl": "https://example.invalid/Codex%20Installer.exe",
  "NpmRegistry": "https://registry.npmmirror.com",
  "CodexBaseUrl": "https://api.openai.com/v1",
  "CodexModel": "gpt-5.5"
}

CodexAppUrl 不是默认下载源。普通 Windows 用户建议使用官方 Microsoft Store / winget 路径;只有企业镜像、离线安装或自建可信镜像时才需要填写。

GitHub Actions 兼容性测试

仓库提供 .github/workflows/compatibility.yml

  • Windows PowerShell 5.1 语法解析。
  • Windows 10 Pro、Windows 10 Enterprise LTSC、Windows 11、Windows 8/8.1 的安装与更新计划模拟。
  • Windows hosted runner 的真实环境预检。
  • macOS x64 / arm64 安装与更新计划模拟。
  • 可选 self-hosted Win10 Pro / Enterprise 真实机器安装与更新计划测试。

真实 Win10 桌面版测试需要在 GitHub 仓库注册 self-hosted runner,并给机器加标签:

self-hosted, Windows, X64, win10-pro
self-hosted, Windows, X64, win10-enterprise

然后在 GitHub Actions 页面手动运行 Compatibility workflow,并把 run_self_hosted_windows 设为 true

安全提示

  • 不要提交 codex-auth.jsondownloads.local.json、安装包、zip 包或日志文件。
  • 脚本写入配置前会备份已有 ~/.codex/config.toml
  • Windows 日志在 %TEMP%\codex-installer
  • macOS 日志在 ${TMPDIR}/codex-installer

参与贡献

欢迎提交 Issue、改进脚本、补充真实设备测试结果或提供新的下载源兼容反馈。为了让问题更快被复现,请尽量带上:

  • 操作系统版本、CPU 架构和终端类型。
  • 运行的入口文件或命令。
  • 是否使用代理、公司内网或自定义镜像。
  • 预检命令输出、错误截图或日志中的关键错误信息。

适合新贡献者的任务会标记为 good first issue,需要社区协助验证的任务会标记为 help wanted