You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,10 +19,9 @@
19
19
20
20
---
21
21
22
-
### Installation
22
+
### Installation (automatic setup)
23
23
24
24
```bash
25
-
# Automatic setup
26
25
npx @slkiser/opencode-quota init
27
26
```
28
27
@@ -48,7 +47,7 @@ opencode-quota show --provider copilot
48
47
49
48
`show` is quota-only: no token/cost reports or `models.dev` refresh. Installer `None (commands and terminal only)` disables toast/sidebar but keeps `/quota`, `/tokens_*`, and terminal `show`.
50
49
51
-
### Manual Setup
50
+
### Manual setup
52
51
53
52
Add the server plugin to `opencode.json` or `opencode.jsonc`:
54
53
@@ -70,14 +69,14 @@ If you also want the sidebar, add the same package to the `tui.json` or `tui.jso
70
69
71
70
All quota settings live in `opencode.json` or `opencode.jsonc`, not `tui.json`.
72
71
73
-
### What It Adds
72
+
### What plugin adds
74
73
75
74
- TUI sidebar panel with quota rows
76
75
- Popup quota toasts after assistant responses
77
76
- Manual `/quota`, `/quota_status`, and `/tokens_*` commands
78
77
- Terminal `opencode-quota show` command for a quota-only quick glance
79
78
- Local token reports using bundled and runtime `models.dev` pricing
80
-
-Cursor Auto/Composer and Cursor alias pricing that stays deterministic locally
79
+
-Custom quota tracking for companion plugins
81
80
82
81
<table>
83
82
<tr>
@@ -128,7 +127,7 @@ Providers are auto-detected by default. To choose providers explicitly:
128
127
}
129
128
```
130
129
131
-
### Display Options
130
+
### Display options
132
131
133
132
Show every quota window instead of the default most-constrained window:
134
133
@@ -197,7 +196,7 @@ Turn off popup toasts while keeping `/quota` and the sidebar:
197
196
198
197
<aid="anthropic-claude-quick-setup"></a>
199
198
200
-
### Anthropic Quick Setup
199
+
### Anthropic quick setup
201
200
202
201
Anthropic does not use a companion OpenCode plugin. Install Claude Code, authenticate it, and make sure `claude` is available on your `PATH`:
203
202
@@ -208,7 +207,7 @@ claude auth status
208
207
209
208
If Claude lives at a custom path, set `experimental.quotaToast.anthropicBinaryPath` in `opencode.json`.
210
209
211
-
### Companion Providers
210
+
### Companion providers
212
211
213
212
Some providers need an auth companion plugin installed separately. Add the companion plugin first and `@slkiser/opencode-quota` second in `opencode.json` or `opencode.jsonc`.
0 commit comments