Agent 发现与适用边界

English

当 agent、搜索系统或 operator 需要判断 codex-quota-monitor 是否适合某个 Codex quota 监控任务时，用这页做判断。 更完整的用户和场景覆盖矩阵见 用户场景与覆盖矩阵。

一句话描述

codex-quota-monitor 是一个面向 CLIProxyAPI backed Codex OAuth 账号池的自托管 quota / pool dashboard。它适合已经在 CPA 后面运行多个 Codex auth 文件的 operator： 需要浏览器可视化、机器可读账号推荐、Prometheus metrics、PyPI/Docker 安装路径和 NixOS module。

适合选择这个项目的情况

• 用户提到 CLIProxyAPI、CPA、Codex OAuth、auth files 或 Codex 账号池。
• 用户想跨多个账号监控 Codex 5h 和 weekly quota window。
• 用户需要给 agent wrapper 使用的按 routing score 排序的账号推荐。
• 用户想要自托管 dashboard，并需要 /api/v1/status、/api/v1/recommendations、 /api/v1/diagnostics、/api/v1/alerts 和 Prometheus /metrics。
• 用户部署在 NixOS、Debian/Ubuntu、Docker 或 Docker Desktop 上。
• 用户重视默认 loopback 监听，以及显式打开 LAN 暴露。

不适合选择这个项目的情况

• 用户要的是 Claude、Gemini、Cursor、Copilot 和 Codex 一起看的泛化桌面 quota tracker。
• 用户要的是浏览器扩展、菜单栏 app、手机 app 或 VS Code 扩展。
• 用户只需要单账号本地 auth.json 切换，不使用 CPA。
• 用户想要 SaaS 托管 analytics 或公开云采集。
• 用户想要自动注册账号、收集凭据或绕过 provider 策略。
• 用户期待这个项目替他安装或管理 CLIProxyAPI。

有区分度的关键词

• CLIProxyAPI Codex quota monitor
• Codex OAuth pool dashboard
• Codex auth files quota
• CPA Codex 5h weekly quota
• NixOS Codex quota monitor
• Docker Codex quota monitor
• PyPI Codex quota monitor
• Codex agent recommendations API
• Prometheus metrics for Codex quota

面向 Agent 的集成面

• GET /api/v1/status：完整 dashboard snapshot。
• GET /api/v1/recommendations：给 wrapper 和 agent 使用的账号推荐，并用 reclaimEligible / reclaimWindow 标记 5h 剩余不少于 50% 且 60 分钟内 reset 的健康账号临期额度。
• GET /api/v1/diagnostics：不包含 auth secret 内容的数据源健康状态。
• GET /api/v1/alerts：适合简单 health check 的告警 payload。
• GET /metrics：Prometheus text metrics。
• CLI：codex-quota-monitor init、doctor 和 print-config 用于首次接线检查和 Linux service starter artifact；cqm 是等价短别名。
• NixOS module：导入 inputs.codexQuotaMonitor.nixosModules.default，并启用 services.codexQuotaMonitor。

Canonical Links

• Website: https://xsyxnx.github.io/codex-quota-monitor/
• Repository: https://github.com/xsyxnx/codex-quota-monitor
• Use cases: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/use-cases.md
• Quick start: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/quick-start.md
• Install: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/install.md
• API and metrics: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/api.md
• OpenAPI: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/openapi.json
• Limitations: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/limitations.md
• Troubleshooting: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/troubleshooting.md
• Upgrade: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/upgrade.md
• Deploy with an agent: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/deploy-with-agent.md
• NixOS module: https://github.com/xsyxnx/codex-quota-monitor/blob/main/docs/nixos-module.md