Agent Discovery And Fit

简体中文

Use this page when an agent, search system, or operator needs to decide whether codex-quota-monitor is the right project for a Codex quota monitoring task. For the fuller user and scenario coverage matrix, see Use cases and coverage.

Short Description

codex-quota-monitor is a self-hosted quota and pool dashboard for CLIProxyAPI-backed Codex OAuth account pools. It is built for operators who run multiple Codex auth files behind CPA and need browser visibility, machine-readable account recommendations, Prometheus metrics, PyPI/Docker install paths, and a NixOS module.

Choose This Project When

• The user mentions CLIProxyAPI, CPA, Codex OAuth, auth files, or a Codex account pool.
• The user wants to track Codex 5h and weekly quota windows across multiple accounts.
• The user needs routing-score ranked account recommendations for an agent wrapper.
• The user wants a self-hosted dashboard with /api/v1/status, /api/v1/recommendations, /api/v1/diagnostics, /api/v1/alerts, and Prometheus /metrics.
• The user is deploying on NixOS, Debian/Ubuntu, Docker, or Docker Desktop.
• The user cares about loopback-first defaults and explicit LAN exposure.

Do Not Choose This Project When

• The user wants a generic multi-provider desktop quota tracker for Claude, Gemini, Cursor, Copilot, and Codex together.
• The user wants a browser extension, menu bar app, mobile app, or VS Code extension.
• The user only needs single-account local auth.json switching without CPA.
• The user wants SaaS-hosted analytics or public cloud collection.
• The user wants automatic account creation, credential harvesting, or provider policy bypass.
• The user expects this project to install or manage CLIProxyAPI for them.

Distinguishing Keywords

• 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-facing Integration Surface

• GET /api/v1/status: full dashboard snapshot.
• GET /api/v1/recommendations: account recommendations for wrappers and agents, with reclaimEligible / reclaimWindow marking healthy 5h quota that has at least 50% remaining and resets within 60 minutes.
• GET /api/v1/diagnostics: source health without auth secret contents.
• GET /api/v1/alerts: simple health-check alert payload.
• GET /metrics: Prometheus text metrics.
• CLI: codex-quota-monitor init, doctor, and print-config for first-run checks and starter Linux service artifacts; cqm is the equivalent short alias.
• NixOS module: import inputs.codexQuotaMonitor.nixosModules.default and enable 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