README.md
September 18, 2026 · View on GitHub
Quota, usage, and token visibility in OpenCode and your terminal.
Quick start
npx @slkiser/opencode-quota init
Important
Node.js >= 22 is required.
Upgrading from v3? Read the v4 migration guide.
After installation:
- Restart OpenCode.
- Run a slash command in OpenCode, or use
opencode-quota showfrom your terminal. - If you enabled the sidebar, open the session sidebar and look for
Quota. - If you enabled the compact status line, look at the bottom of Home or below the message input.
Updating
-
Close OpenCode.
-
Preview the update:
npx @slkiser/opencode-quota@latest update --dry-run -
Inspect the safe setting/cache changes and manual credential findings, then apply:
npx @slkiser/opencode-quota@latest update -
Restart OpenCode.
The updater prints the complete preview before its own config or cache changes. --yes authorizes only the previewed safe config edits and manifest-verified cache cleanup; it never moves or deletes secrets. See Updating safely for detailed behavior and manual credential steps.
Choose your setup
|
|
|
| Sidebar panel A full quota view in OpenCode's session sidebar. |
TUI toast Quota checks can appear automatically while you work. |
|
|
| Compact status line Short quota text on Home and below the message input. |
Token reports/tokens_today, /tokens_weekly, session reports, and more. |
More ways to use it:
- Check quota anywhere: use
opencode-quota showin a terminal or the same slash commands in the TUI, Web, and Desktop. - Automate quota checks with JSON output for scripts, status bars, and CI. Optional OpenTelemetry metrics support monitoring tools.
- Customize the display with
tuiPromptBar.enabled, OpenCode Go's preferred collapsed-sidebar window, spaced reset countdowns by default with aresetTimeSpaced: falsedense opt-out, decimal reset precision, bare percent labels, andaccountingDetail. - Optionally estimate Runs out ≈ 1h 50m for supported fixed windows with
quotaProjection: "runway". It is off by default and leaves JSON output unchanged. - Choose current-session or descendant-tree token totals. Get reset popups for selected windows with
resetNotifications. - Troubleshoot authentication, quota sources, pricing, and maintainer notices.
See Configuration for UI options and Manual install for setup details.
Commands
Core slash commands
| Command | Use when |
|---|---|
/quota | Show current quota |
/quota_status | Diagnose setup, authentication, providers, pricing, and notices |
/quota_announcements | Read active bundled maintainer notices |
/pricing_refresh | Refresh local runtime pricing from models.dev |
/tokens_today | Show tokens used today |
/tokens_daily | Show tokens used in the last 24 hours |
/tokens_weekly | Show tokens used in the last 7 days |
/tokens_monthly | Show tokens used in the last 30 days, including pricing |
/tokens_all | Show tokens used across all local history |
/tokens_session | Show tokens used in the current session |
/tokens_session_all | Show current session plus descendant sessions |
/tokens_between YYYY-MM-DD YYYY-MM-DD | Show tokens used between two dates |
CLI commands
Use the CLI for setup, updates, terminal checks, and custom providers.
| Command | What it does |
|---|---|
npx @slkiser/opencode-quota@latest init | Set up OpenCode Quota |
npx @slkiser/opencode-quota@latest provider add | Add or update a custom provider |
npx @slkiser/opencode-quota@latest show | Show current quota |
npx @slkiser/opencode-quota@latest status | Check configuration and provider problems |
npx @slkiser/opencode-quota@latest update | Update an existing installation |
Run npx @slkiser/opencode-quota@latest --help for command options. See External integration for JSON, scripts, and CI examples.
Providers
Pre-configured American providers
Personal
| Provider | Auth/setup | Data from | Reports |
|---|---|---|---|
| Anthropic (Claude) | Needs setup | Local CLI/OAuth | Quota |
| Chutes AI | Automatic | Remote API | Quota |
| Cursor | Needs setup | Local estimate | Budget and spend |
| GitHub Copilot | Automatic | Remote API | Budget and usage |
| Google AGY | Needs setup | Remote API | Quota |
| Google Antigravity | Needs setup | Remote API | Quota |
| Kilo Gateway | Automatic | Remote API | Quota and balance |
| NanoGPT | Automatic | Remote API | Quota and balance |
| Ollama Cloud | Automatic | Remote API | Quota and usage |
| OpenAI | Automatic | Remote API | Quota |
| OpenCode Go | Automatic | Remote API | Quota |
| OpenCode Zen | Needs setup | Dashboard scraping | Budget and balance |
| OpenRouter | Automatic | Remote API | Budget and spend |
| Synthetic | Automatic | Remote API | Quota |
| xAI SuperGrok | Automatic | Remote API | Quota |
Business / Enterprise
| Provider | Auth/setup | Data from | Reports |
|---|---|---|---|
| Anthropic (Claude) | Needs setup | Local CLI/OAuth | Quota |
| Chutes AI | Automatic | Remote API | Quota |
| Cursor | Needs setup | Local estimate | Budget and spend |
| Gemini CLI (deprecated) | Existing setups only | Remote API | Quota |
| GitHub Copilot | Needs setup | Remote API | Budget and usage |
| Google AGY | Needs setup | Remote API | Quota |
| Google Antigravity | Needs setup | Remote API | Quota |
| NanoGPT | Automatic | Remote API | Quota and balance |
| OpenAI | Automatic | Remote API | Quota |
| OpenCode Zen | Needs setup | Dashboard scraping | Budget and balance |
| OpenRouter | Automatic | Remote API | Budget and spend |
| Synthetic | Automatic | Remote API | Quota |
| xAI SuperGrok | Automatic | Remote API | Quota |
Gemini CLI quota support is deprecated for new installs. Existing v4 configurations still work, with removal planned for v5.0.0. See the provider guide before choosing a replacement.
Pre-configured Chinese providers
Personal
| Provider | Auth/setup | Data from | Reports |
|---|---|---|---|
| Alibaba Coding Plan | Automatic | Local estimate | Quota |
| DeepSeek | Automatic | Remote API | Balance and status |
| Kimi Code | Automatic | Remote API | Quota |
| MiniMax Token Plan | Automatic | Remote API | Quota |
| MiniMax Token Plan (CN) | Automatic | Remote API | Quota |
| Qwen Code | Needs setup | Local estimate | Quota |
| Xiaomi MiMo | Needs setup | Dashboard API | Quota and balance |
| Z.ai Coding Plan | Automatic | Remote API | Quota |
| Zhipu Coding Plan | Automatic | Remote API | Quota |
Business / Team
| Provider | Auth/setup | Data from | Reports |
|---|---|---|---|
| Kimi Code | Automatic | Remote API | Quota |
| MiniMax Token Plan | Automatic | Remote API | Quota |
| MiniMax Token Plan (CN) | Automatic | Remote API | Quota |
| Zhipu Coding Plan | Automatic | Remote API | Quota |
These vendors offer team or business plans, but the current integrations report only the configured member API key rather than organization-wide usage.
Custom providers
Add a provider that uses a remote quota API or tracks a local usage estimate:
npx @slkiser/opencode-quota@latest provider add
The guided setup previews the change before saving. See the custom-provider guide for details.
Troubleshooting
If quota or token data looks wrong:
- Run
/quota_statusin OpenCode, oropencode-quota statusfrom a terminal for the same diagnostics. Useopencode-quota showfor a quick quota glance. - Confirm the expected provider appears in the detected provider list.
- Confirm companion auth plugins are before
@slkiser/opencode-quotainopencode.json. - If token reports are empty, start OpenCode once so it creates
opencode.db, then run a session with model usage. - Check Troubleshooting for common symptoms and provider-specific fixes.
Reference
Project guides:
External references:
- OpenCode docs
- OpenCode config
- OpenCode plugins
- OpenCode TUI
- models.dev pricing data
- Node.js downloads
Contributors
Thanks to everyone who has contributed to OpenCode Quota.
License
MIT
Remarks
OpenCode Quota is not built by the OpenCode team and is not affiliated with OpenCode or any provider listed above.
Star history
