核心用法
codex-usage 是一个本地 CLI 辅助工具,用于读取并报告 OpenAI Codex CLI 的授权配置文件健康度与远程使用配额。执行时解析 ~/.openclaw/agents/main/agent/auth-profiles.json 中的 OAuth 凭证,向 chatgpt.com/backend-api/wham/usage 发起 HTTPS 查询,返回 5 小时窗口及周度剩余额度、速率限制状态、Token 过期时间等关键指标。支持 /codex_usage、/codex_usage default|all|<profile> 等多种 Telegram 风格指令,提供交互式按钮或文本菜单选择器,并在执行前发送进度提示以优化 UX。
显著优点
- 只读安全优先:默认仅执行查询,所有删除操作需显式
--confirm-delete与--dry-run预览,避免误删。 - 多配置管理:原生支持多 Profile(如
openai-codex:default、openai-codex:mine),适合团队或公私项目分离场景。 - 容错降级:端点不可达时自动降级为本地健康报告;401 错误时标记为
auth_not_accepted_by_usage_endpoint而非崩溃。 - 隐私保护:全程隐藏完整 Token,仅输出脱敏的健康与配额元数据。
- 诊断友好:内置
--debug模式,输出attempt、elapsed_ms、status等追踪字段,便于排查网络或认证问题。
潜在局限
- 依赖本地凭证:若用户从未运行过 Codex CLI 或凭证文件路径非标准,需手动指定
--auth-path。 - 仅支持 ChatGPT 端点:当前硬编码
chatgpt.com用量 API,暂不兼容企业私有部署或其他 OpenAI 端点。 - Token 生命周期盲区:脚本可报告过期时间,但无法主动刷新或续期 Token,需用户手动重新授权。
- 删除操作不可逆:尽管有备份机制,
--hard-delete仍会永久移除配置文件,误操作后恢复需手动还原备份。
适合人群
- 高频使用 Codex CLI 的开发者与 DevOps,需监控多账户配额消耗。
- 团队管理员,需定期检查成员授权健康状态(Token 是否过期、是否触发限速)。
- 将 Codex 集成至 CI/CD 或自动化工作流前,需做预检配额与认证可用性验证的场景。
常规风险
- 凭证泄露风险:虽然脚本本身不打印 Token,但运行环境(日志、shell 历史、CI 输出)若未妥善配置,可能间接暴露
--auth-path指向的文件路径。 - 网络中间人:尽管强制 HTTPS 并限制
chatgpt.com白名单,运行环境的 SSL/TLS 库若过期或遭篡改,仍存在证书校验绕过风险。 - 误删除配置:用户可能混淆
--confirm-delete与--dry-run的顺序,导致预期外的配置 detach 或硬删除。 - API 行为变更:OpenAI 端点响应格式或认证头要求可能更新,脚本需随上游文档同步维护。