Usage

🚀 Usage

How to use the /codex_quota command and codex_quota tool.

---

🎯 Quick Reference

Command	Mode	Use Case
/codex_quota	Full	User-facing — complete quota details
/codex_quota compact	Compact	Concise table — same as full but shorter
codex_quota(mode="compact")	Compact	Agent/tool call — inline quota check

---

👤 Full Mode (User Command)

The default mode when you run /codex_quota:

/codex_quota

Shows complete quota details including plan type, primary 5h window, weekly window, code review quota, credits, spend control, and promotional info.

Example Output

# OpenAI Codex Subscription

**Plan:** Plus | **Account:** user@example.com

---

## Quota Limits

| Window | Usage | Progress | Resets At |
|--------|-------|----------|------------|
| **Primary (5h)** | 51% | `██████░░░░░░` 51% | 04:06:26 |
| **Weekly** | 40% | `█████░░░░░░░` 40% | 05:46:54 on 9 Apr |

---

> ⚠️ Primary (5h) at 51% — consider pacing your usage.

---

## Code Review Quota

| Window | Usage | Progress | Resets At |
|--------|-------|----------|------------|
| **Weekly** | 0% | `░░░░░░░░░░░░` 0% | 02:37:12 on 11 Apr |

---

## Spend Control

**Status:** ✅ Within limit

---

*Updated: 2026-03-29T12:00:00.000Z*

---

🤖 Compact Mode (Agent / Tool Call)

For concise output when called by an AI agent or via the slash command:

/codex_quota compact

Or directly as a tool call:

codex_quota(mode="compact")

Example Output

### Codex Quota — Plus

| Window | Usage | Progress | Resets At |
|--------|-------|----------|------------|
| 5h | 51% | `██████░░░░░░` | 04:06:26 |
| Weekly | 40% | `█████░░░░░░░` | 05:46:54 on 9 Apr |

**Status**: ✅ Within limits

---

📊 Conditional Sections

Some sections appear only when relevant:

Section	When Shown
Code Review Quota	When your plan includes code review limits
Credits	When you have credits or unlimited balance
Promotional	When promotional quota is active
Warning banners	When any window is 80–99% or 100%
Advisory notes	When any window is 50–79%

---

⚠️ Warning Thresholds

Usage Level	Behavior
0–49%	Normal display, no warnings
50–79%	Advisory note (blockquote with ⚠️)
80–99%	Warning banner (blockquote with ⚠️)
100%	Limit reached banner (blockquote with 🚫)
>100%	Full bar, actual percentage shown, limit reached banner

---

🔄 How /codex_quota Works

In current OpenCode plugin APIs:

/codex_quota
  → wrapper prompt tells OpenCode to call tool.codex_quota
  → AuthReader: auth.json → JWT → { token, accountId, email }
  → ApiClient: GET wham/usage → QuotaResponse
  → Formatter: QuotaResponse + mode → Markdown string
  → OpenCode TUI renders via Glamour

Note: /codex_quota is LLM-mediated — it's a wrapper prompt that tells OpenCode to call the underlying tool. The tool returns raw Markdown which is rendered by the OpenCode TUI.

---

📖 Next Steps

• Error-Handling — Troubleshoot common issues
• Architecture — Understand the internals
• Technical-Reference — API details and type definitions