Skip to main content

Switch between OpenAI Codex CLI provider configurations (official OpenAI provider, third-party relays, multiple API keys).

Project description

codex-safe-switch

PyPI CI

中文 | English

在官方 ChatGPT、第三方 relay、多组 API key 之间切换 Codex CLI 配置。

30 秒上手

安装 uv,再安装本工具:

uv tool install codex-safe-switch
codex-safe-switch

第一次运行会从当前 ~/.codex/config.toml 导入 provider 配置切片。

已经安装过时,这样升级到最新版:

uv tool upgrade codex-safe-switch

之后常用的就三个命令:

codex-safe-switch ls            # 看已有 profiles
codex-safe-switch use myrelay   # 切到 relay / 自定义 provider
codex-safe-switch official      # 切回官方 ChatGPT

保存一个新 profile

先把 Codex 手动配置到能用的状态。比如你已经配好了某个 relay,并确认 codex 能跑。

然后保存:

codex-safe-switch save myrelay

以后就可以这样切回去:

codex-safe-switch use myrelay

第一次用时会怎样

你现在的状态 会发生什么
正在用官方 ChatGPT 自动保存成 official
正在用 relay / 自定义 provider 自动保存成当前 provider 名
登录过 ChatGPT,但当前正在用 relay 先保存当前 relay;以后跑 codex-safe-switch official 回官方
还没有 ~/.codex/config.toml 提示你先配置一次 Codex

codex-safe-switch official 不需要提前存在 official profile。缺少时会自动创建默认官方配置再切换。

它不会碰登录信息

这个工具只保存和切换 provider 配置切片:modelmodel_providermodel_reasoning_effortmodel_reasoning_summarymodel_verbositywire_apidisable_response_storagepreferred_auth_method,以及当前 provider 对应的 [model_providers.<name>]

切换 profile 时,这些顶层字段和整个 [model_providers] 会被目标 profile 替换;其他 provider block 不会作为备份保留或恢复。项目、插件、MCP 和 TUI 等其他配置保持不变。

它不会保存、复制或覆盖:

  • ~/.codex/auth.json
  • ChatGPT 登录 token
  • API key 文件
  • trusted projects、插件、MCP、TUI 偏好

如果你切到官方后还没登录过 ChatGPT,Codex 会自己提示你登录。

历史会话不见了

通常不是历史丢了,只是历史记录里的 provider 跟当前 provider 对不上。

先看状态:

codex-safe-switch doctor-history

然后切到你想用的 profile,工具会自动对齐历史:

codex-safe-switch use myrelay
# 或
codex-safe-switch official
更多命令
codex-safe-switch              交互选择 profile
codex-safe-switch ls           列出 profiles
codex-safe-switch current      显示当前 profile
codex-safe-switch use <name>   切到指定 profile
codex-safe-switch official     切回官方 ChatGPT
codex-safe-switch save <name>  保存当前 provider 配置
codex-safe-switch show <name>  查看 profile 内容
codex-safe-switch rm <name>    删除 profile
codex-safe-switch restart-codex
                               重启 Codex app/server 进程
codex-safe-switch merge-history --dry-run
                               预览历史修复
codex-safe-switch merge-history
                               修复历史 metadata

useofficial 可以加 --restart-codex

codex-safe-switch use myrelay --restart-codex
文件位置和环境变量

Profiles 默认放在:

~/.codex/profiles/
├── .active
├── .official/
│   └── provider.toml
└── myrelay/
    └── provider.toml

环境变量:

变量 默认值 用途
CODEX_PROFILE_ROOT ~/.codex/profiles profile 存放位置
CODEX_HOME ~/.codex Codex 配置目录

relay profile 示例见 examples/relay-profile/provider.toml

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codex_safe_switch-1.0.5.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codex_safe_switch-1.0.5-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file codex_safe_switch-1.0.5.tar.gz.

File metadata

  • Download URL: codex_safe_switch-1.0.5.tar.gz
  • Upload date:
  • Size: 27.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for codex_safe_switch-1.0.5.tar.gz
Algorithm Hash digest
SHA256 b9cac0a80eaa91933bf9e83a331ae757896bf63de26958fc3c45d3ff5a104a42
MD5 c41b7f8da1bc5bce21509a1f51afb54a
BLAKE2b-256 cb2942aabc808b267c3675afd59d1475e804cd7e22e66e01bc3fb878b1a25d23

See more details on using hashes here.

File details

Details for the file codex_safe_switch-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for codex_safe_switch-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7fa98a92ec71e541822500cb919c80da0fcb06df14692af16e9e5a7202155972
MD5 59e7f561667bed96f34a3e750ec24109
BLAKE2b-256 6276d619f45a04550f42a6d81dbe5109275f68fea5ae945e24900355216c02ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page