@1930dev/opencode-usage 0.1.3 → 0.1.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Agu Rodríguez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -3,6 +3,26 @@
 Usage tracking, budget percentages and model ranking for [opencode](https://opencode.ai):
 a CLI, and a `/usage` slash command for the TUI.
 
+Every connected provider in one table, with each one's remaining budget as a
+comparable percentage — whether the provider bills in tokens, requests, credits or
+neurons.
+
+<!-- Absolute URL so the image also renders on npm, which resolves nothing relative. -->
+![The /usage dialog](https://raw.githubusercontent.com/1930-dev/opencode-usage/main/docs/demo.gif)
+
+[![npm](https://img.shields.io/npm/v/@1930dev/opencode-usage)](https://www.npmjs.com/package/@1930dev/opencode-usage)
+[![license](https://img.shields.io/npm/l/@1930dev/opencode-usage)](./LICENSE)
+
+## Why
+
+opencode talks to many providers at once, and each one meters differently: a weekly
+window here, premium requests there, credits, neurons, tokens per day. Nothing tells
+you which one you are about to exhaust.
+
+This reads opencode's own SQLite and auth store — no configuration, no account — and
+normalizes every quota into one percentage, so the answer to "which provider still has
+room" is one glance.
+
 ## Install
 
 ```bash
@@ -45,7 +65,22 @@ opencode-usage top --limit 10 --json
 ## Plugin for opencode
 
 The package also ships a `/usage` slash command for the opencode TUI. It shows the
-same table as the CLI, with the % budget column drawn as a progress bar.
+same table as the CLI, with the % budget column drawn as a progress bar:
+
+```
+ Usage — today                                                                      esc
+
+ PROVIDER               MSGS   TOK IN  TOK OUT      COST BUDGET
+ opencode-go               7        0        0     $0.00 ████████████ 100% weekly
+ nvidia                   98    10.9M    19.9K     $0.00
+ cloudflare-workers-ai     0        0        0     $0.00
+ github-copilot            1     4.2K      830    $12.35 █████░░░░░░░  42% 1M tok/day
+
+ TOTAL                   106                      $12.35
+```
+
+The dialog sizes itself to the terminal: a wide frame spells the budget labels out,
+a narrow one shortens them to the window (`wk`, `mo`, `d`).
 
 ```bash
 opencode plugin @1930dev/opencode-usage

package/dist/cli.js

@@ -134,13 +134,13 @@ function localUsageByProvider(db, sinceMs) {
   }
   return map;
 }
-function monthlyUsageByProvider(db, startOfMonthMs2) {
+function monthlyUsageByProvider(db, startOfMonthMs) {
   const rows = db.query(`SELECT COALESCE(json_extract(data,'$.providerID'),'?') AS provider,
               COALESCE(SUM(CAST(json_extract(data,'$.cost') AS REAL)),0) AS cost
        FROM message
        WHERE json_extract(data,'$.role')='assistant'
          AND CAST(json_extract(data,'$.time.created') AS INTEGER) >= ?
-       GROUP BY provider`).all(startOfMonthMs2);
+       GROUP BY provider`).all(startOfMonthMs);
   const map = new Map;
   for (const r of rows) {
     map.set(String(r.provider), Number(r.cost));
@@ -840,33 +840,33 @@ async function cmdUsage(flags, json) {
   const withPct = flags.has("--pct");
   if (withPct && groupBy !== "provider")
     fail("--pct only supported with --by provider");
-  const snapshot2 = await getUsageSnapshot(sinceMs, groupBy, withPct);
+  const snapshot = await getUsageSnapshot(sinceMs, groupBy, withPct);
   if (json) {
     const out = {
       since: new Date(sinceMs).toISOString(),
       groupBy,
-      rows: snapshot2.rows,
-      totals: snapshot2.totals,
-      pct: snapshot2.pct
+      rows: snapshot.rows,
+      totals: snapshot.totals,
+      pct: snapshot.pct
     };
     console.log(JSON.stringify(out, null, 2));
   } else {
     const label = flags.has("--today") ? "today" : flags.get("--since") ?? "7d";
-    console.log(usageTable(snapshot2.rows, snapshot2.totals, label, groupBy, snapshot2.pct ? new Map(Object.entries(snapshot2.pct)) : undefined));
+    console.log(usageTable(snapshot.rows, snapshot.totals, label, groupBy, snapshot.pct ? new Map(Object.entries(snapshot.pct)) : undefined));
   }
 }
 async function cmdProviders(flags, json) {
   const statuses = await providerStatuses({ noNet: flags.has("--no-net") });
-  const db2 = openDb();
+  const db = openDb();
   try {
-    const local = localUsageByProvider(db2, Date.now() - parseDuration("7d"));
+    const local = localUsageByProvider(db, Date.now() - parseDuration("7d"));
     if (json) {
       console.log(JSON.stringify({ statuses, local: Object.fromEntries(local) }, null, 2));
     } else {
       console.log(providersTable(statuses, local));
     }
   } finally {
-    db2.close();
+    db.close();
   }
 }
 async function cmdTop(flags, json) {

package/dist/tui.js

@@ -102,13 +102,13 @@ function usageTotals(db, sinceMs) {
     tokensOutput: Number(r?.tokensOutput ?? 0)
   };
 }
-function monthlyUsageByProvider(db, startOfMonthMs2) {
+function monthlyUsageByProvider(db, startOfMonthMs) {
   const rows = db.query(`SELECT COALESCE(json_extract(data,'$.providerID'),'?') AS provider,
               COALESCE(SUM(CAST(json_extract(data,'$.cost') AS REAL)),0) AS cost
        FROM message
        WHERE json_extract(data,'$.role')='assistant'
          AND CAST(json_extract(data,'$.time.created') AS INTEGER) >= ?
-       GROUP BY provider`).all(startOfMonthMs2);
+       GROUP BY provider`).all(startOfMonthMs);
   const map = new Map;
   for (const r of rows) {
     map.set(String(r.provider), Number(r.cost));
@@ -548,8 +548,8 @@ function columnsFor(inner) {
     { title: "COST", width: 8, align: "right" }
   ];
   const used = base.reduce((a, c) => a + c.width, 0) + base.length;
-  const budget2 = Math.max(14, inner - used);
-  return { cols: [...base, { title: "BUDGET", width: budget2, align: "left" }], bar: wide ? WIDE_BAR : COMPACT_BAR };
+  const budget = Math.max(14, inner - used);
+  return { cols: [...base, { title: "BUDGET", width: budget, align: "left" }], bar: wide ? WIDE_BAR : COMPACT_BAR };
 }
 function fmtTokens(n) {
   if (n >= 1e6)
@@ -725,7 +725,7 @@ function Table(props) {
         children: row(layout().cols, layout().cols.map((c) => c.title))
       }),
       props.snapshot.rows.slice(0, 20).map((r) => {
-        const budget2 = props.snapshot.pct?.[r.provider];
+        const budget = props.snapshot.pct?.[r.provider];
         return /* @__PURE__ */ jsxs("box", {
           flexDirection: "row",
           children: [
@@ -734,9 +734,9 @@ function Table(props) {
               wrapMode: "none",
               children: lead(layout().cols, r)
             }),
-            budget2 ? /* @__PURE__ */ jsx(Budget, {
-              pct: budget2.pct,
-              label: budget2.label ?? budget2.source,
+            budget ? /* @__PURE__ */ jsx(Budget, {
+              pct: budget.pct,
+              label: budget.label ?? budget.source,
               palette: p,
               col: layout().cols[layout().cols.length - 1],
               bar: layout().bar
@@ -778,9 +778,9 @@ async function show(api, dialog) {
     api,
     text: "Loading usage\u2026"
   }));
-  let snapshot2;
+  let snapshot;
   try {
-    snapshot2 = await getUsageSnapshot(startOfDayMs(), "provider", true);
+    snapshot = await getUsageSnapshot(startOfDayMs(), "provider", true);
   } catch (err) {
     const message = err instanceof Error ? err.message : String(err);
     dialog.replace(() => /* @__PURE__ */ jsx(Message, {
@@ -792,7 +792,7 @@ async function show(api, dialog) {
   }
   dialog.replace(() => /* @__PURE__ */ jsx(Table, {
     api,
-    snapshot: snapshot2
+    snapshot
   }));
 }
 var tui = async (api) => {
@@ -826,8 +826,8 @@ var tui = async (api) => {
 };
 var tui_default = { id: "opencode-usage", tui };
 export {
-  tui,
-  tui_default as default,
+  Message,
   Table,
-  Message
+  tui_default as default,
+  tui
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1930dev/opencode-usage",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Usage tracking, budget percentages and model ranking for opencode \u2014 CLI plus a /usage TUI plugin",
   "type": "module",
   "bin": {
@@ -45,6 +45,7 @@
   },
   "files": [
     "dist",
+    "LICENSE",
     "README.md"
   ],
   "publishConfig": {