opencode-copilot-statusline 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 lnwu
+
+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

@@ -0,0 +1,54 @@
+# 📊 opencode-copilot-statusline
+
+[![npm version](https://img.shields.io/npm/v/opencode-copilot-statusline)](https://www.npmjs.com/package/opencode-copilot-statusline)
+[![license](https://img.shields.io/npm/l/opencode-copilot-statusline)](https://github.com/lnwu/opencode-statusline-plugins/blob/main/packages/opencode-copilot-statusline/LICENSE)
+
+**English** | [简体中文](https://github.com/lnwu/opencode-statusline-plugins/blob/main/packages/opencode-copilot-statusline/README.zh-CN.md)
+
+Display your GitHub Copilot quota in the OpenCode TUI footer statusline.
+
+## ✨ Features
+
+- Live used-quota percentage in the prompt footer (`Copilot 87%`)
+- Monthly reset countdown when the footer details are expanded (or the terminal is wide enough)
+- Color feedback: subdued normally, info at ≥70%, error at ≥90%
+- Only appears for sessions whose model provider is `github-copilot`
+- Usage refreshes about once per minute
+
+## 📋 Requirements
+
+- OpenCode@2
+- A GitHub Copilot subscription connected to OpenCode (`opencode auth login github-copilot`)
+
+## 🚀 Install
+
+```sh
+opencode plugin add opencode-copilot-statusline
+```
+
+## 📈 What the percentage means
+
+The statusline picks the quota window that limits your plan:
+
+| Plan                                             | Source                                                 | Example        |
+| ------------------------------------------------ | ------------------------------------------------------ | -------------- |
+| Pro / Business / Enterprise                      | **premium requests** used this month                   | `Copilot 87%`  |
+| Copilot Free (no premium-request quota)          | **chat** allowance                                     | `Copilot 6%`   |
+| Unlimited premium requests                       | no finite quota                                        | `Copilot ∞`    |
+| Not signed in, credential unresolvable, API down | no data                                                | `Copilot —`    |
+
+The countdown targets the monthly quota reset date.
+
+## 🩺 Troubleshooting
+
+- **The statusline never shows up** — it is hidden unless the session's model provider is `github-copilot`. Switch to a GitHub Copilot model in the session.
+- **It shows `Copilot —` instead of numbers** — the `github-copilot` credential could not be resolved. Run `opencode auth login github-copilot`, then check the plugin is enabled again.
+- **It shows `Copilot ∞`** — your plan reports no finite premium-request limit.
+
+## 📜 Changelog
+
+See the [releases](https://github.com/lnwu/opencode-statusline-plugins/releases) for the release history.
+
+## 📄 License
+
+MIT

package/README.zh-CN.md

@@ -0,0 +1,54 @@
+# 📊 opencode-copilot-statusline
+
+[![npm version](https://img.shields.io/npm/v/opencode-copilot-statusline)](https://www.npmjs.com/package/opencode-copilot-statusline)
+[![license](https://img.shields.io/npm/l/opencode-copilot-statusline)](https://github.com/lnwu/opencode-statusline-plugins/blob/main/packages/opencode-copilot-statusline/LICENSE)
+
+[English](https://github.com/lnwu/opencode-statusline-plugins/blob/main/packages/opencode-copilot-statusline/README.md) | **简体中文**
+
+在 OpenCode TUI 底栏显示 GitHub Copilot 配额用量。
+
+## ✨ 功能
+
+- 在输入框底栏实时显示配额已用百分比（`Copilot 87%`）
+- 展开底栏详情（或终端足够宽）时显示每月重置倒计时
+- 颜色提示：正常为弱化色，≥70% 变提示色，≥90% 变错误色
+- 仅当会话模型 provider 为 `github-copilot` 时显示
+- 用量约每分钟自动刷新一次
+
+## 📋 环境要求
+
+- OpenCode@2
+- 已在 OpenCode 登录 GitHub Copilot（`opencode auth login github-copilot`）
+
+## 🚀 安装
+
+```sh
+opencode plugin add opencode-copilot-statusline
+```
+
+## 📈 百分比的含义
+
+状态栏会自动选取限制你当前计划的配额：
+
+| 计划                                        | 来源                          | 示例          |
+| ------------------------------------------- | ----------------------------- | ------------- |
+| Pro / Business / Enterprise                 | 本月已用的 **premium requests** | `Copilot 87%` |
+| Copilot Free（没有 premium requests 配额）  | **chat** 额度                  | `Copilot 6%`  |
+| premium requests 无限                       | 没有有限配额                   | `Copilot ∞`   |
+| 未登录、凭证无法解析、接口异常              | 无数据                         | `Copilot —`   |
+
+倒计时指向每月配额重置日期。
+
+## 🩺 疑难排查
+
+- **底栏始终不显示** —— 仅当会话模型 provider 为 `github-copilot` 时才显示，请先在会话中切换到 GitHub Copilot 模型。
+- **只显示 `Copilot —` 而没有数字** —— 无法解析 `github-copilot` 凭据。请运行 `opencode auth login github-copilot`，然后确认插件已重新启用。
+- **显示 `Copilot ∞`** —— 你的计划没有有限的 premium requests 上限。
+
+## 📜 变更日志
+
+完整发布历史见 [Releases](https://github.com/lnwu/opencode-statusline-plugins/releases)。
+
+## 📄 许可证
+
+MIT

package/dist/index.js

@@ -0,0 +1,139 @@
+// @bun
+// src/index.ts
+import { Plugin } from "@opencode/plugin";
+
+// src/rpc.ts
+import { Rpc } from "@opencode/plugin/rpc";
+var usageSchema = {
+  type: "object",
+  properties: {
+    usedPercent: { type: "number" },
+    remaining: { type: "number" },
+    entitlement: { type: "number" },
+    unlimited: { type: "boolean" },
+    resetsAt: { type: "string" }
+  },
+  required: ["usedPercent", "remaining", "entitlement", "unlimited"],
+  additionalProperties: false
+};
+var UsageRpc = Rpc.define({
+  id: "opencode-copilot-statusline",
+  methods: {
+    get: {
+      input: { type: "object", properties: {}, additionalProperties: false },
+      output: {
+        type: "object",
+        properties: { usage: usageSchema },
+        additionalProperties: false
+      }
+    }
+  },
+  events: {}
+});
+
+// src/usage.ts
+var WINDOW_IDS = ["premium_interactions", "chat"];
+function parseUsage(body) {
+  if (!isRecord(body))
+    return;
+  const snapshots = body.quota_snapshots;
+  if (!isRecord(snapshots))
+    return;
+  const resetsAt = typeof body.quota_reset_date_utc === "string" && body.quota_reset_date_utc || (typeof body.quota_reset_date === "string" ? body.quota_reset_date : undefined);
+  for (const id of WINDOW_IDS) {
+    const window = snapshots[id];
+    if (!isRecord(window))
+      continue;
+    const usage = toUsage(window, resetsAt);
+    if (usage)
+      return usage;
+  }
+  return;
+}
+function toUsage(window, resetsAt) {
+  const reset = resetsAt ? { resetsAt } : {};
+  if (window.unlimited === true) {
+    return { usedPercent: 0, remaining: 0, entitlement: 0, unlimited: true, ...reset };
+  }
+  if (window.has_quota === false)
+    return;
+  const entitlement = asNumber(window.entitlement);
+  if (entitlement !== undefined && entitlement <= 0)
+    return;
+  const remaining = asNumber(window.remaining);
+  let percent;
+  if (entitlement !== undefined && remaining !== undefined) {
+    percent = (1 - remaining / entitlement) * 100;
+  } else if (typeof window.percent_remaining === "number") {
+    percent = 100 - window.percent_remaining;
+  }
+  if (percent === undefined || !Number.isFinite(percent))
+    return;
+  return {
+    usedPercent: Math.min(100, Math.max(0, Math.round(percent))),
+    remaining: remaining ?? 0,
+    entitlement: entitlement ?? 0,
+    unlimited: false,
+    ...reset
+  };
+}
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function asNumber(value) {
+  return typeof value === "number" && Number.isFinite(value) ? value : undefined;
+}
+
+// src/index.ts
+var INTEGRATION_ID = "github-copilot";
+var GITHUB_API = "https://api.github.com";
+var API_VERSION = "2025-04-01";
+var FETCH_TIMEOUT_MS = 1e4;
+function apiBase(credential) {
+  const enterprise = credential.metadata?.enterpriseUrl;
+  if (typeof enterprise === "string" && enterprise) {
+    return `https://api.${enterprise.replace(/\/+$/, "")}`;
+  }
+  return GITHUB_API;
+}
+var src_default = Plugin.define({
+  id: "opencode-copilot-statusline",
+  async setup(ctx) {
+    async function fetchUsage() {
+      try {
+        const connection = await ctx.integration.connection.active(INTEGRATION_ID);
+        if (!connection)
+          return;
+        const credential = await ctx.integration.connection.resolve(connection);
+        if (credential?.type !== "oauth" && credential?.type !== "key")
+          return;
+        const token = credential.type === "oauth" ? credential.access || credential.refresh : credential.key;
+        if (!token)
+          return;
+        const res = await fetch(`${apiBase(credential)}/copilot_internal/user`, {
+          headers: {
+            Accept: "application/json",
+            Authorization: `Bearer ${token}`,
+            "X-GitHub-Api-Version": API_VERSION,
+            "User-Agent": "opencode-copilot-statusline"
+          },
+          signal: AbortSignal.timeout(FETCH_TIMEOUT_MS)
+        });
+        if (!res.ok)
+          return;
+        return parseUsage(await res.json());
+      } catch {
+        return;
+      }
+    }
+    await ctx.rpc.register(UsageRpc, {
+      get: async () => {
+        const usage = await fetchUsage();
+        return usage ? { usage } : {};
+      }
+    });
+  }
+});
+export {
+  src_default as default
+};

package/dist/rpc.js

@@ -0,0 +1,32 @@
+// @bun
+// src/rpc.ts
+import { Rpc } from "@opencode/plugin/rpc";
+var usageSchema = {
+  type: "object",
+  properties: {
+    usedPercent: { type: "number" },
+    remaining: { type: "number" },
+    entitlement: { type: "number" },
+    unlimited: { type: "boolean" },
+    resetsAt: { type: "string" }
+  },
+  required: ["usedPercent", "remaining", "entitlement", "unlimited"],
+  additionalProperties: false
+};
+var UsageRpc = Rpc.define({
+  id: "opencode-copilot-statusline",
+  methods: {
+    get: {
+      input: { type: "object", properties: {}, additionalProperties: false },
+      output: {
+        type: "object",
+        properties: { usage: usageSchema },
+        additionalProperties: false
+      }
+    }
+  },
+  events: {}
+});
+export {
+  UsageRpc
+};

package/dist/tui.js

@@ -0,0 +1,187 @@
+// @bun
+// src/tui.tsx
+import { createComponent as _$createComponent } from "@opentui/solid";
+import { createTextNode as _$createTextNode } from "@opentui/solid";
+import { insertNode as _$insertNode } from "@opentui/solid";
+import { effect as _$effect } from "@opentui/solid";
+import { insert as _$insert } from "@opentui/solid";
+import { setProp as _$setProp } from "@opentui/solid";
+import { createElement as _$createElement } from "@opentui/solid";
+import { Plugin, usePlugin } from "@opencode/plugin/tui";
+import { useTerminalDimensions } from "@opentui/solid";
+import { createEffect, createSignal, onCleanup, Show } from "solid-js";
+
+// src/rpc.ts
+import { Rpc } from "@opencode/plugin/rpc";
+var usageSchema = {
+  type: "object",
+  properties: {
+    usedPercent: { type: "number" },
+    remaining: { type: "number" },
+    entitlement: { type: "number" },
+    unlimited: { type: "boolean" },
+    resetsAt: { type: "string" }
+  },
+  required: ["usedPercent", "remaining", "entitlement", "unlimited"],
+  additionalProperties: false
+};
+var UsageRpc = Rpc.define({
+  id: "opencode-copilot-statusline",
+  methods: {
+    get: {
+      input: { type: "object", properties: {}, additionalProperties: false },
+      output: {
+        type: "object",
+        properties: { usage: usageSchema },
+        additionalProperties: false
+      }
+    }
+  },
+  events: {}
+});
+
+// src/tui.tsx
+var INTERVAL_MS = 60000;
+var DETAILED_WIDTH = 125;
+var COPILOT_PROVIDER_ID = "github-copilot";
+function countdown(resetsAt, now) {
+  const ms = new Date(resetsAt).getTime() - now;
+  if (!Number.isFinite(ms) || ms <= 0)
+    return;
+  const minutes = Math.ceil(ms / 60000);
+  const days = Math.floor(minutes / 1440);
+  const hours = Math.floor(minutes % 1440 / 60);
+  const mins = minutes % 60;
+  if (days > 0)
+    return `${days}d${hours}h`;
+  if (hours > 0)
+    return `${hours}h${mins}m`;
+  return `${mins}m`;
+}
+function Segment(props) {
+  const ctx = usePlugin();
+  const fg = () => {
+    const t = ctx.theme;
+    if (props.usage.unlimited)
+      return t.text.subdued;
+    if (props.usage.usedPercent >= 90)
+      return t.text.feedback.error.default;
+    if (props.usage.usedPercent >= 70)
+      return t.text.feedback.info.default;
+    return t.text.subdued;
+  };
+  const text = () => {
+    if (props.usage.unlimited)
+      return "\u221E";
+    const left = props.detailed && props.usage.resetsAt ? countdown(props.usage.resetsAt, Date.now()) : undefined;
+    return `${props.usage.usedPercent}%${left ? ` (${left})` : ""}`;
+  };
+  return (() => {
+    var _el$ = _$createElement("text");
+    _$setProp(_el$, "wrapMode", "none");
+    _$setProp(_el$, "flexShrink", 1);
+    _$insert(_el$, text);
+    _$effect((_$p) => _$setProp(_el$, "fg", fg(), _$p));
+    return _el$;
+  })();
+}
+function CopilotUsage(props) {
+  const ctx = usePlugin();
+  const [isCopilot, setIsCopilot] = createSignal(false);
+  const dims = useTerminalDimensions();
+  const detailed = () => props.showDetails() || dims().width >= DETAILED_WIDTH;
+  let generation = 0;
+  async function check(id) {
+    const current = ++generation;
+    setIsCopilot(false);
+    if (!id)
+      return;
+    try {
+      await ctx.data.session.sync(id);
+      if (current !== generation)
+        return;
+      setIsCopilot(ctx.data.session.get(id)?.model?.providerID === COPILOT_PROVIDER_ID);
+    } catch {
+      if (current === generation)
+        setIsCopilot(false);
+    }
+  }
+  createEffect(() => {
+    check(props.sessionID());
+  });
+  onCleanup(ctx.data.on("session.model.selected", (event) => {
+    if (event.data.sessionID === props.sessionID())
+      check(props.sessionID());
+  }));
+  return _$createComponent(Show, {
+    get when() {
+      return isCopilot();
+    },
+    get children() {
+      var _el$2 = _$createElement("box"), _el$3 = _$createElement("text"), _el$4 = _$createTextNode(`Copilot `);
+      _$insertNode(_el$2, _el$3);
+      _$setProp(_el$2, "flexDirection", "row");
+      _$setProp(_el$2, "flexShrink", 1);
+      _$setProp(_el$2, "minWidth", 0);
+      _$insertNode(_el$3, _el$4);
+      _$setProp(_el$3, "flexShrink", 0);
+      _$insert(_el$2, _$createComponent(Show, {
+        get when() {
+          return props.usage();
+        },
+        get fallback() {
+          return (() => {
+            var _el$6 = _$createElement("text");
+            _$insertNode(_el$6, _$createTextNode(`\u2014`));
+            _$setProp(_el$6, "flexShrink", 0);
+            _$effect((_$p) => _$setProp(_el$6, "fg", ctx.theme.text.subdued, _$p));
+            return _el$6;
+          })();
+        },
+        children: (u) => _$createComponent(Segment, {
+          get usage() {
+            return u();
+          },
+          get detailed() {
+            return detailed();
+          }
+        })
+      }), null);
+      _$effect((_$p) => _$setProp(_el$3, "fg", ctx.theme.text.subdued, _$p));
+      return _el$2;
+    }
+  });
+}
+var tui_default = Plugin.define({
+  id: "opencode-copilot-statusline.tui",
+  setup(context) {
+    const rpc = context.client.rpc(UsageRpc);
+    const [usage, setUsage] = createSignal();
+    let timer;
+    async function refresh() {
+      try {
+        const result = await rpc.get({});
+        if (result?.usage)
+          setUsage(result.usage);
+      } catch {}
+    }
+    refresh();
+    timer = setInterval(() => void refresh(), INTERVAL_MS);
+    const unregister = context.ui.slot({
+      append: "prompt.footer.status",
+      render: (input) => _$createComponent(CopilotUsage, {
+        sessionID: () => input.sessionID,
+        showDetails: () => input.showDetails,
+        usage
+      })
+    });
+    return () => {
+      if (timer)
+        clearInterval(timer);
+      unregister();
+    };
+  }
+});
+export {
+  tui_default as default
+};

package/package.json

@@ -1,10 +1,64 @@
 {
   "name": "opencode-copilot-statusline",
-  "version": "0.0.0",
-  "description": "Name reservation placeholder. Real releases are published from CI via npm trusted publishing.",
+  "version": "0.1.0",
+  "description": "OpenCode TUI plugin: display GitHub Copilot quota (premium requests, with a chat fallback for Copilot Free) in the footer statusline. V2-native, zero-config, no cookies.",
+  "type": "module",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/lnwu/opencode-statusline-plugins.git"
+    "url": "git+https://github.com/lnwu/opencode-statusline-plugins.git",
+    "directory": "packages/opencode-copilot-statusline"
+  },
+  "homepage": "https://github.com/lnwu/opencode-statusline-plugins/tree/main/packages/opencode-copilot-statusline#readme",
+  "bugs": {
+    "url": "https://github.com/lnwu/opencode-statusline-plugins/issues"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "github-copilot",
+    "copilot",
+    "statusline",
+    "usage",
+    "quota"
+  ],
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./rpc": "./dist/rpc.js",
+    "./tui": "./dist/tui.js"
+  },
+  "scripts": {
+    "build": "bun run scripts/build.ts",
+    "typecheck": "tsc --noEmit",
+    "pretest": "bun run build",
+    "test": "bun test test/usage.test.ts test/e2e",
+    "test:pack": "bun test test/pack.test.ts",
+    "prepack": "bun run build"
+  },
+  "dependencies": {
+    "@opencode/plugin": ">2.0.0"
+  },
+  "peerDependencies": {
+    "@opencode/theme": ">2.0.0",
+    "@opentui/core": ">=0.5.10",
+    "@opentui/solid": ">=0.5.10",
+    "solid-js": ">=1.9.0"
+  },
+  "peerDependenciesMeta": {
+    "@opencode/theme": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@opencode/theme": ">2.0.0",
+    "@opentui/core": "^0.5.11",
+    "@opentui/solid": "^0.5.11",
+    "bun-types": "^1.4.2",
+    "core": "*",
+    "solid-js": "^1.9.15",
+    "typescript": "^7.0.2"
   }
 }