omp packages

pi-openai-codex-usage0.1.2

ChatGPT Codex subscription usage in the pi footer — multi-bucket limits, reset credits, consume action, /codex-usage report. Unofficial, not affiliated with OpenAI.

GitHub Actions Published 1 month ago MIT ~228 downloads/mo

Untested on omp

This is a pi package. No one has reported whether it works on omp yet. If you try it, add your result below.

Did it work for you?

Result

One report per person. A new report replaces your old one.

Reports 0

No reports yet.

Readme

pi-openai-codex-usage

English | 简体中文

非官方扩展。 与 OpenAI 无任何关联。数据来自官方 Codex 客户端使用的同一个 ChatGPT 用量接口(/backend-api/wham/usage)。该接口不是公开文档化的 API,随时可能变化,本扩展也可能随时失效。

在 pi coding agent 的 footer 中展示 ChatGPT Codex 订阅用量,并提供完整的 /codex-usage 报告。

codex 5h ████████░ 43% · 7d █████████░ 12% ↻5h 12m

功能

使用 openai-codex 模型时,footer 显示活跃配额桶(服务端对当前模型计量的那个桶,例如 codex 或 spark),每个窗口一根 8 格进度条(最多两根)、剩余百分比和最近一次重置倒计时。数据陈旧会打标记。多桶套餐、只有周窗口的套餐、额度(Credits)、可用重置次数(可执行一次重置)、套餐类型与支出上限,都在 /codex-usage 报告里。

安装

pi install npm:pi-openai-codex-usage

或从 git 安装:

pi install git:github.com/frederick-wang/pi-openai-codex-usage

需要在 Pi 中 /login 登录 OpenAI Codex(ChatGPT Plus/Pro 订阅 OAuth)。扩展绝不会读取 Codex CLI 自己的认证文件。

命令

  • /codex-usage — 完整报告(全部配额桶、额度、可用重置次数、套餐、支出上限、数据新鲜度)。
  • /codex-usage --json — 稳定的机器可读快照(键名固定英文)。TUI 模式在 overlay 中展示;print 模式输出到 stdout;其他模式拒绝执行。
  • /codex-usage --refresh — 跳过限流立即抓取。

可用重置次数可以在报告里用掉:流程会先校验账户身份,再针对选项的标题/描述/过期时间请求确认,最后解释结果(这是本扩展唯一会改变服务端状态的操作)。

认证与隐私

  • 凭据来自 Pi 自身的 openai-codex 认证;扩展从不刷新或写入凭据,从不读取 ~/.codex/auth.json。
  • 账户 id 只存在于内存中(用于账户切换检测),绝不写入日志、持久化或导出。
  • 持久化到 ~/.pi/agent/pi-openai-codex-usage-snapshots.jsonl 的快照不含 token、原始响应头、账户 id。
  • 无遥测;除用量接口外无任何网络请求。

配置

  • PI_OPENAI_CODEX_USAGE_LANG=zh|en — 界面语言(默认:跟随系统语言,再英文)。

说明

  • 窗口标签由服务端返回的时长动态生成(5h、7d……),可能变化,绝不写死。
  • 数据在激活时、每次回合结束后、每 5 分钟的例行检查以及执行命令时抓取——不做固定高频轮询。
  • 服务端没有返回的窗口一律显示 n/a,绝不显示假的 0%。