create-codex-config
v1.0.1
Published
Interactive npm CLI for updating local Codex base URL and API key.
Readme
create-codex-config
一个零依赖的 npm 命令行工具,用来修改本机 Codex 的两项关键配置:
auth.json里的OPENAI_API_KEYconfig.toml里的base_url
现在还额外支持一键测试连通性,检查当前配置是否真的能请求到 Codex,并明确识别:
- 是否可以正常对话
- 是否返回
429 - 是否返回
503
配置文件位置
默认情况下,Codex 配置目录是:
~/.codex这个工具会修改:
~/.codex/auth.json
~/.codex/config.toml不同系统下,默认目录通常对应为:
- Windows:
C:\Users\用户名\.codex - macOS:
/Users/用户名/.codex - Linux:
/home/用户名/.codex
如果设置了环境变量 CODEX_HOME,工具会优先使用 CODEX_HOME。
使用方式
发布到 npm 后,用户可以直接运行:
npm create codex-config@latest或者:
npx create-codex-config@latest本地调试
在当前项目目录执行:
npm link安装后可以直接运行:
codex-config也可以运行:
create-codex-config交互菜单
运行后会看到以下功能:
- 查看当前配置
- 更新 API 地址和 SK 密钥
- 仅更新 API 地址
- 仅更新 SK 密钥
- 测试连通性
- 退出
非交互用法
查看当前配置:
codex-config --show测试当前配置是否能访问 Codex:
codex-config --test测试结果会明确告诉你:
- 是否请求成功
- 是否已经拿到对话响应
- 是否返回
429 - 是否返回
503 - 是否是鉴权失败或网络失败
一次性更新地址和密钥:
codex-config --set --url https://your-api-host --key sk-xxxx只更新地址:
codex-config --set-url https://your-api-host只更新密钥:
codex-config --set-key sk-xxxx连通性测试说明
--test 会读取当前配置中的:
base_urlOPENAI_API_KEYmodel
然后向 ${base_url}/responses 发起一次最小请求,验证当前接口是否真的可用。
成功时会显示返回文本;失败时会尽量区分:
429: 请求过多或触发限流503: 服务暂时不可用401/403: 鉴权失败network_error: 网络不通或接口地址不可达timeout: 15 秒内未返回
说明
- 默认读取
CODEX_HOME;如果没有设置,则使用~/.codex - 写入前会自动备份原始文件到
~/.codex/backups/codex-config-cli/ - 如果
config.toml里不存在[model_providers.custom],工具会自动补齐 - 适用于 Windows、macOS 和 Linux
发布到 npm
首次发布前先登录:
npm login然后发布:
npm publish --access public发布完成后,用户即可执行:
npm create codex-config@latest说明:
npm create codex-config实际执行的是 npm 包create-codex-config- 如果包名已被占用,需要改成你自己的唯一名字,例如
create-huaji-codex-config
