@slkiser/opencode-quota 5.0.2 → 6.0.0-beta.1

package/README.md

@@ -23,13 +23,13 @@
 ## Quick start
 
 ```bash
-npx @slkiser/opencode-quota init
+opencode plugin add @slkiser/opencode-quota
 ```
 
 Then restart OpenCode and type `/quota`.
 
 > [!IMPORTANT]
-> You need OpenCode `2.0.16+` and Node.js `22.13+` or `23.4+`. Still on OpenCode 1? Run `npx @slkiser/opencode-quota@4 init` instead.
+> You need OpenCode `2.0.26+`; the terminal commands also need Node.js `22.13+` or `23.4+`. Still on OpenCode 1? Run `npx @slkiser/opencode-quota@4 init` instead.
 
 Upgrading from 4.x? Read [what changed in 5.0](#breaking-changes-in-500).
 
@@ -51,68 +51,60 @@ Also:
 - **Terminal:** `npx @slkiser/opencode-quota@latest show` works even with OpenCode closed.
 - **Web and Desktop:** slash commands post the report in the chat.
 - **Scripts and status bars:** JSON, an export file, and metrics. See [External integration](docs/readme/external-integration.md).
-- **Your look:** used or left, reset style, a runs-out estimate, and more. See [Configuration](docs/readme/configuration.md).
-- **Retry at the reset:** when a request hits a limit and that provider's quota shows a used-up window, OpenCode retries after it resets. Turn off with `waitForQuotaReset: false`.
+- **Your words:** used or left, reset style, and more. See [Configuration](docs/readme/configuration.md).
+- **Retry at the reset:** when a request hits a limit and that provider's quota shows a used-up window, OpenCode retries after it resets. Turn off with `providers.checking.waitForQuotaReset: false`.
 
 ## Updating
 
-Close OpenCode, then preview and apply the update:
-
 ```bash
-npx @slkiser/opencode-quota@latest update --dry-run
-npx @slkiser/opencode-quota@latest update
+opencode plugin update
 ```
 
-Restart OpenCode. The updater never moves or deletes secrets. See [Updating safely](docs/readme/updating.md).
+Restart OpenCode. Coming from 5.x? Your old settings are converted automatically on the first start; see [Moving from 5.x](docs/readme/updating.md#moving-from-5x).
 
 ### Breaking changes in 5.0.0
 
 > [!WARNING]
-> - OpenCode 1 is no longer supported. `init` and `update` keep OpenCode 1 users on 4.x (`@slkiser/opencode-quota@4`).
+> - OpenCode 1 is no longer supported. OpenCode 1 users stay on 4.x (`@slkiser/opencode-quota@4`).
 > - Logins come from OpenCode 2, never from `auth.json`. If a provider is missing, log in again.
 > - Web and Desktop get the slash commands, but no toasts or panels.
-> - TUI reports open in a popup. To keep them in the chat, set `tuiCommandDisplay: "inline"`.
+> - TUI reports open in the quota window and leave no chat message.
 > - OpenCode Zen uses your OpenCode Console sign-in: `opencode auth login opencode`.
 
 Full list: [Moving to OpenCode 2](docs/readme/updating.md#moving-to-opencode-2).
 
+All quota settings live in `opencode-quota/settings.jsonc`, with sections for Sidebar, Collapsed, Status line, Toast, Colors, Layout, Words, Providers and System. Save in `/quota_settings` keeps comments; file edits reach every open TUI within a few seconds. [Settings and defaults](docs/readme/configuration.md).
+
 ## Commands
 
 ### Slash commands
 
-Type these in OpenCode. Add dates after the command, like `/tokens_between 2026-09-01 2026-09-25`.
-
-| Command                                 | What it shows                                        |
-| --------------------------------------- | ---------------------------------------------------- |
-| `/quota`                                | Current quota                                        |
-| `/quota_status`                         | Setup check: logins, providers, pricing, and notices |
-| `/quota_announcements`                  | Maintainer notices                                   |
-| `/pricing_refresh`                      | Refreshes token pricing from `models.dev`            |
-| `/tokens_today`                         | Tokens used today                                    |
-| `/tokens_daily`                         | Tokens used in the last 24 hours                     |
-| `/tokens_weekly`                        | Tokens used in the last 7 days                       |
-| `/tokens_monthly`                       | Tokens used in the last 30 days, with pricing        |
-| `/tokens_all`                           | Tokens used across all local history                 |
-| `/tokens_session`                       | Tokens used in this session                          |
-| `/tokens_session_all`                   | This session plus its subagent sessions              |
-| `/tokens_between YYYY-MM-DD YYYY-MM-DD` | Tokens used between two dates                        |
+Type these in OpenCode. Add a range after `/quota_usage`, like `/quota_usage 30d` or `/quota_usage between 2026-09-01 2026-09-25`.
+
+| Command                | What it shows                                                                                                                 |
+| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `/quota`               | Limits. Web and Desktop: limits next to the last 7 days of usage                                                              |
+| `/quota_usage [range]` | Tokens and API cost: `today` (default), `24h`, `7d`, `30d`, `90d`, `all`, `session` (with its subagents), `between` two dates |
+| `/quota_status`        | Setup check: logins, providers, pricing, and notices                                                                          |
+| `/quota_settings`      | TUI: quota window, Settings tabs                                                                                              |
+
+In the terminal, `/quota_usage` opens the window's Usage tab on that range. The model table's Cache column is the share of each model's input tokens read from the cache, with ⚠ below 50% once the model read 200K input tokens. ↑↓ pick a range in its list, → moves to the model rows, enter or a click opens a model's details. `c` cost, `t` tokens, `b` by model or day, `d` types the Between dates, `p` updates pricing from `models.dev`.
+
+Moving from 4.x or 5.x? Your `/tokens_*` commands still work. See [Updating](docs/readme/updating.md#moving-from-5x).
 
 ### CLI commands
 
-| 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 setup and provider problems |
-| `npx @slkiser/opencode-quota@latest update`       | Update an existing installation   |
+| Command                                     | What it does                      |
+| ------------------------------------------- | --------------------------------- |
+| `npx @slkiser/opencode-quota@latest show`   | Show current quota                |
+| `npx @slkiser/opencode-quota@latest status` | Check setup and provider problems |
 
 `show` and `status` work with OpenCode closed ([how they differ](docs/readme/troubleshooting.md#terminal-commands)). Add `--help` to see all options.
 
 ## Providers
 
 Most providers work automatically once you log in through OpenCode. **Needs setup** links show the extra step.
-OpenAI ChatGPT quota requires an OAuth login; stored API keys show "ChatGPT quota unavailable for API key" without a ChatGPT request.
+OpenAI ChatGPT quota needs a Codex login (`/connect` → OpenAI → **Codex browser (legacy)** or **Codex device code (legacy)**). OpenAI doesn't share ChatGPT usage with **Sign in with ChatGPT** logins or API keys, so those show a "ChatGPT quota unavailable" row without a ChatGPT request.
 
 ### Pre-configured American providers
 
@@ -128,7 +120,7 @@ OpenAI ChatGPT quota requires an OAuth login; stored API keys show "ChatGPT quot
 | Google AGY         | [Needs setup](docs/readme/providers.md#google-agy-quick-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    |
+| Ollama Cloud       | Automatic                                                      | Remote API         | Quota and balance  |
 | OpenAI             | Automatic                                                      | Remote API         | Quota              |
 | OpenCode Go        | Automatic                                                      | Remote API         | Quota              |
 | OpenCode Zen       | Automatic                                                      | Remote API         | Budget and balance |
@@ -197,27 +189,21 @@ These show only your own member API key's usage, not the whole organization's.
 
 ### Custom providers
 
-Track a provider that is not listed, from its quota API or from a local estimate:
-
-```bash
-npx @slkiser/opencode-quota@latest provider add
-```
-
-It previews the change before saving. See the [custom-provider guide](docs/readme/providers.md#custom-providers).
+Track a provider that is not listed, from its quota API or from a local estimate. Ask your agent to add a custom provider: its `quota_provider_add` tool saves one switched off, and you switch it on (`"enabled": true` in `opencode-quota/settings.jsonc`, or `/quota_settings` → **Providers**); [docs/readme/providers.md#custom-providers](docs/readme/providers.md#custom-providers) has a copy-paste prompt.
 
 ## Troubleshooting
 
-1. Run `/quota_status` in OpenCode, or `npx @slkiser/opencode-quota@latest status` in a terminal.
+1. Run `/quota_status` in an OpenCode session, or `npx @slkiser/opencode-quota@latest status` in a terminal.
 2. Provider missing? Log in to it again in OpenCode 2.
 3. Using a companion plugin (Cursor, Google)? List it **before** `@slkiser/opencode-quota` in `opencode.json`.
 4. `claude` or `bl` not found? See [Service environment](docs/readme/troubleshooting.md#service-environment).
-5. Token reports empty? Start OpenCode once, then use a model.
+5. `/quota_usage` empty? Start OpenCode once, then use a model.
 
 More fixes: [Troubleshooting](docs/readme/troubleshooting.md).
 
 ## Reference
 
-Guides: [Manual install](docs/readme/manual-install.md) · [Configuration](docs/readme/configuration.md) · [Providers](docs/readme/providers.md) · [Troubleshooting](docs/readme/troubleshooting.md) · [External integration](docs/readme/external-integration.md) · [Updating safely](docs/readme/updating.md)
+Guides: [Manual install](docs/readme/manual-install.md) · [Configuration](docs/readme/configuration.md) · [Providers](docs/readme/providers.md) · [Troubleshooting](docs/readme/troubleshooting.md) · [External integration](docs/readme/external-integration.md) · [Updating](docs/readme/updating.md)
 
 Outside links: [OpenCode docs](https://opencode.ai/docs/) · [OpenCode config](https://opencode.ai/docs/config/) · [OpenCode plugins](https://opencode.ai/docs/plugins/) · [OpenCode TUI](https://opencode.ai/docs/tui/) · [models.dev pricing data](https://models.dev/) · [Node.js downloads](https://nodejs.org/en/download)
 

package/dist/agent-tools.d.ts

@@ -0,0 +1,24 @@
+type QuotaAgentToolsHost = {
+    /** The providers OpenCode serves now; a custom provider shows only when its providerId is one. */
+    openCodeProviderIds(): Promise<readonly string[]>;
+};
+/** A tool as `ctx.tool.transform(editor => editor.add(tool))` takes it. */
+type QuotaAgentTool = {
+    name: string;
+    description: string;
+    input: {
+        type: "object";
+        properties: Record<string, {
+            type: string;
+            description: string;
+        }>;
+        required?: string[];
+        additionalProperties: false;
+    };
+    execute(input: unknown): Promise<{
+        content: string;
+    }>;
+};
+export declare function quotaAgentTools(host: QuotaAgentToolsHost): QuotaAgentTool[];
+export {};
+//# sourceMappingURL=agent-tools.d.ts.map

package/dist/agent-tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent-tools.d.ts","sourceRoot":"","sources":["../src/agent-tools.ts"],"names":[],"mappings":"AA8CA,KAAK,mBAAmB,GAAG;IACzB,kGAAkG;IAClG,mBAAmB,IAAI,OAAO,CAAC,SAAS,MAAM,EAAE,CAAC,CAAC;CACnD,CAAC;AAEF,2EAA2E;AAC3E,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ,CAAC;QACf,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAClE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,oBAAoB,EAAE,KAAK,CAAC;KAC7B,CAAC;IACF,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACvD,CAAC;AA0mBF,wBAAgB,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,cAAc,EAAE,CA2D3E"}