0
183
近 7 天 10
33.9
生态多维模型
2 小时前
2026-10-05
快速安装与配置
opencode.json写入当前项目的 opencode.json,只对这个仓库生效。
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-ai-usage@1.0.1"]
}写入 ~/.config/opencode/opencode.json,对所有项目生效。
~/.config/opencode/opencode.json
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-ai-usage@1.0.1"]
}若你要在本地改造这个插件,先装到项目里再从本地路径引用。
shell
pnpm add -D opencode-ai-usageOpenCode 启动时会通过内嵌运行时自动加载 npm 依赖并缓存至本地目录,无需手动在全局环境执行安装。
An OpenCode TUI sidebar plugin that displays AI provider usage in one unified sidebar. Each detected provider gets its own collapsible section with rate limit windows, reset countdowns, and account info.
Mixed mode (default):
▼ Claude Usage
admin@example.com
Session resets in 3h 16m
━━━━━━━━───────────────── 31%
Weekly resets in 4d 5h
━━━────────────────────── 11%
▼ OpenAI Usage
user@example.com
Session resets in 1h 42m
━━━━━━━━━━━━━━──────────── 46%
Weekly resets in 2d 9h
━━━━━━──────────────────── 22%
Supported subscriptions
- Claude
- OpenAI (Codex)
- OpenCode Go
Install
Paste below into your OpenCode.
Install and configure opencode-ai-usage by following the instructions here:
https://raw.githubusercontent.com/stevejkang/opencode-ai-usage/refs/heads/main/docs/installation.md
Manual setup
The same package works on OpenCode v1 and OpenCode v2. Only the config file differs.
OpenCode v1 — ~/.config/opencode/tui.json
{
"$schema": "https://opencode.ai/tui.json",
"plugin": [["opencode-ai-usage", { "enabled": true }]]
}
OpenCode v2 — ~/.config/opencode/cli.json
{
"$schema": "https://opencode.ai/v2/cli.json",
"plugins": [{ "package": "opencode-ai-usage", "options": {} }]
}
Local path
OpenCode v1:
{
"$schema": "https://opencode.ai/tui.json",
"plugin": [["./path/to/opencode-ai-usage/src/tui.tsx", { "enabled": true }]]
}
OpenCode v2 (points at the repository directory, which exposes a root tui.ts):
{
"$schema": "https://opencode.ai/v2/cli.json",
"plugins": [{ "package": "/path/to/opencode-ai-usage", "options": {} }]
}
Options
Shown in OpenCode v1 form. On OpenCode v2, put the same object under options of the cli.json entry.
{
"plugin": [
[
"opencode-ai-usage",
{
"enabled": true,
"disabledProviders": [],
"displayMode": "mixed",
"showRemaining": false,
"debugLog": { "enabled": false, "retentionDays": 7, "maxFileSizeMB": 10 },
"providers": {
"claude": { "refreshInterval": 60, "headerColor": "#E07A3A" },
"openai": { "refreshInterval": 30, "headerColor": "#10A37F" },
"opencode-go": { "refreshInterval": 60, "headerColor": "#FDFCFC" }
}
}
]
]
}
| Option | Default | Description |
|---|---|---|
disabledProviders |
[] |
Provider IDs to skip entirely, e.g. ["openai"] |
displayMode |
"mixed" |
"mixed", "text", or "bar" (see below) |
showRemaining |
false |
Show remaining capacity instead of used (see below) |
debugLog.enabled |
false |
Write diagnostic JSONL logs to ~/.cache/opencode-ai-usage/debug-YYYY-MM-DD.log |
debugLog.retentionDays |
7 |
Delete debug log files not written to for this many days |
debugLog.maxFileSizeMB |
10 |
Move a day's log file aside once it reaches this size |
providers.<id>.refreshInterval |
Seconds between data refreshes (claude: 60, openai: 30, opencode-go: 60) |
|
providers.<id>.headerColor |
Section header color (claude: #E07A3A, openai: #10A37F, opencode-go: #FDFCFC) |
Provider IDs currently available: claude, openai, opencode-go. Use these in disabledProviders and as keys under providers.
displayMode
Text mode ("displayMode": "text"):
▼ Claude Usage
admin@example.com
Session 31% resets in 3h 16m
Weekly 11% resets in 4d 5h
Bar mode ("displayMode": "bar"):
▼ Claude Usage
admin@example.com
Session █████░░░░░░░░░ 31% (3h 16m)
Weekly ██░░░░░░░░░░░░ 11% (4d 5h)
showRemaining
By default, bars and percentages track how much of a window you've used. Setting showRemaining: true flips the math: bars fill with what's left, and the percentage shown is 100 - used%. Color grading flips with it, going from a calm default toward warning and danger colors as the remaining amount shrinks, rather than as usage grows.
Providers
| Provider | ID | Detection | Requirements |
|---|---|---|---|
| Claude | claude |
OAuth token from any of: env var, credentials file, OpenCode auth, macOS Keychain | Logged in via Claude CLI, OpenCode auth, or CLAUDE_CODE_OAUTH_TOKEN env var |
| OpenAI (Codex) | openai |
Codex CLI binary in PATH | Codex CLI installed and logged in (codex login) |
| OpenCode Go | opencode-go |
API key from ~/.local/share/opencode/auth.json or OPENCODE_API_KEY env var |
OpenCode Go subscription active, connected via /connect in OpenCode |
Providers are detected automatically on startup. If a provider's requirements are not met, its section is hidden entirely.
Requirements
- OpenCode v1 with plugin support (
@opencode-ai/plugin>= 1.4.3), or OpenCode v2 (@opencode/plugin>= 2.0.20)
Development
git clone https://github.com/stevejkang/opencode-ai-usage.git
cd opencode-ai-usage
bun install
bun run test
bun run typecheck
bun run lint
bun run format
License
MIT
同类生态推荐
Tui Quota Usage
opencode-tui-quota-usage
OpenCode quota usage sidebar tracker for OpenCode V2 CLI/TUI
Codex Usage
opencode-plugin-codex-usage
OpenCode TUI plugin that shows live Codex usage limits in the session sidebar.
Magic Compact
magic-compact
Lossless context compression plugin for OpenCode.