https://github.com/slkiser/opencode-quota
Quota and token tracking for OpenCode providers via Toasts and Commands.
https://github.com/slkiser/opencode-quota
opencode opencode-plugin opencode-plugins quota tokens
Last synced: 19 days ago
JSON representation
Quota and token tracking for OpenCode providers via Toasts and Commands.
- Host: GitHub
- URL: https://github.com/slkiser/opencode-quota
- Owner: slkiser
- License: mit
- Created: 2026-01-22T22:45:14.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-01-28T22:29:04.000Z (26 days ago)
- Last Synced: 2026-01-29T13:52:36.065Z (25 days ago)
- Topics: opencode, opencode-plugin, opencode-plugins, quota, tokens
- Language: TypeScript
- Homepage:
- Size: 414 KB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Opencode Quota
Quota and token tracking for OpenCode providers via Toasts and Commands with no LLM calls.
## What It Does
**Quota Toasts** - See your remaining quota at a glance after each assistant response.
**Token Report Commands** - Track token usage and estimated costs across sessions.
## Installation
Add to your `opencode.json`:
```json
{
"plugin": ["@slkiser/opencode-quota"]
}
```
## Quick Start
Enable the providers you use:
```jsonc
{
"experimental": {
"quotaToast": {
"enabledProviders": ["copilot", "openai", "google-antigravity"],
},
},
}
```
That's it. Toasts appear automatically after main agent responses.
## Commands
### Token Reports
| Command | Title |
| ----------------- | -------------------------------------------------------- |
| `/tokens_today` | Tokens used (Today) (/tokens_today) |
| `/tokens_daily` | Tokens used (Last 24 Hours) (/tokens_daily) |
| `/tokens_weekly` | Tokens used (Last 7 Days) (/tokens_weekly) |
| `/tokens_monthly` | Tokens used (Last 30 Days) (/tokens_monthly) |
| `/tokens_all` | Tokens used (All Time) (/tokens_all) |
| `/tokens_session` | Tokens used (Current Session) (/tokens_session) |
| `/tokens_between` | Tokens used (YYYY-MM-DD .. YYYY-MM-DD) (/tokens_between) |
### Quota Toast & Diagnostics
| Command | Title |
| --------------- | --------------------------------- |
| `/quota` | Quota Toast (Verbose) (/quota) |
| `/quota_status` | Quota Diagnostics (/quota_status) |
### Legacy Aliases
The following `/quota_*` commands remain as backwards-compatible aliases:
- `/quota_today` -> `/tokens_today`
- `/quota_daily` -> `/tokens_daily`
- `/quota_weekly` -> `/tokens_weekly`
- `/quota_monthly` -> `/tokens_monthly`
- `/quota_all` -> `/tokens_all`
- `/quota_session` -> `/tokens_session`
- `/quota_between` -> `/tokens_between`
## Supported Providers
| Provider | Config id | Notes |
| ------------------ | -------------------- | --------------------------------------------- |
| GitHub Copilot | `copilot` | Uses OpenCode auth\* |
| OpenAI (Plus/Pro) | `openai` | Uses OpenCode auth |
| Firmware AI | `firmware` | Uses OpenCode auth or API key |
| Chutes AI | `chutes` | Uses OpenCode auth or API key |
| Google Antigravity | `google-antigravity` | Multi-account via `opencode-antigravity-auth` |
### Firmware AI Setup
Firmware works automatically if OpenCode has Firmware configured. Alternatively, you can provide an API key in your `opencode.json`:
```jsonc
{
"provider": {
"firmware": {
"options": {
"apiKey": "{env:FIRMWARE_API_KEY}",
},
},
},
"experimental": {
"quotaToast": {
"enabledProviders": ["firmware"],
},
},
}
```
The `apiKey` field supports the `{env:VAR_NAME}` syntax to reference environment variables, or you can provide the key directly.
### Chutes AI Setup
Chutes works automatically if OpenCode has Chutes configured. Alternatively, you can provide an API key in your `opencode.json`:
```jsonc
{
"provider": {
"chutes": {
"options": {
"apiKey": "{env:CHUTES_API_KEY}",
},
},
},
"experimental": {
"quotaToast": {
"enabledProviders": ["chutes"],
},
},
}
```
### GitHub Copilot Setup (optional)
Copilot works with no extra setup as long as OpenCode already has Copilot configured and logged in.
_Optional:_ if Copilot quota does not show up (or you want more reliable quota reporting), you can provide a fine-grained PAT so the plugin can use GitHub's public billing API:
1. Create a fine-grained PAT at GitHub with **Account permissions > Plan > Read**
2. Create `~/.config/opencode/copilot-quota-token.json`:
```json
{
"token": "github_pat_...",
"username": "your-username",
"tier": "pro"
}
```
Tier options: `free`, `pro`, `pro+`, `business`, `enterprise`
\* The plugin reads Copilot auth from OpenCode. The PAT file is only a fallback for reliability.
## Configuration Reference
All options go under `experimental.quotaToast` in `opencode.json`:
| Option | Default | Description |
| ------------------- | ------------ | ------------------------------------------- |
| `enabled` | `true` | Enable/disable plugin |
| `enableToast` | `true` | Show popup toasts |
| `enabledProviders` | `[]` | Provider ids to query |
| `minIntervalMs` | `300000` | Min ms between fetches (5 min) |
| `toastDurationMs` | `9000` | Toast display time |
| `onlyCurrentModel` | `false` | Only show current model's quota |
| `showSessionTokens` | `true` | Show per-model input/output tokens in toast |
| `googleModels` | `["CLAUDE"]` | Google models: `CLAUDE`, `G3PRO`, `G3FLASH` |
| `debug` | `false` | Show debug info in toasts |
### Example Configuration
Here's a complete example `opencode.json` with all common options:
```jsonc
{
"plugin": ["@slkiser/opencode-quota"],
"experimental": {
"quotaToast": {
"enabledProviders": ["copilot", "openai"],
"showSessionTokens": true,
"minIntervalMs": 300000,
"toastDurationMs": 9000,
},
},
}
```
## Troubleshooting
Toast not appearing? Run `/quota_status` to check config and provider availability.
## License
MIT