@ekworp/opencode-mystatus 0.0.0-stage → 1.2.8

package/LICENSE

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

@@ -1,3 +1,241 @@
-# Temporary Holding Version
+# opencode-mystatus
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm version](https://img.shields.io/npm/v/%40ekworp%2Fopencode-mystatus.svg)](https://www.npmjs.com/package/@ekworp/opencode-mystatus)
+[![npm downloads](https://img.shields.io/npm/dm/%40ekworp%2Fopencode-mystatus)](https://www.npmjs.com/package/@ekworp/opencode-mystatus)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+An [OpenCode](https://opencode.ai) plugin to query account quota usage for multiple AI platforms.
+
+[中文文档](./README.zh-CN.md)
+
+![Check AI Quota in One Click](./assets/mystatus-banner-en.jpeg)
+
+## Supported Platforms
+
+| Platform     | Account Type      | Data Source                                    |
+| ------------ | ----------------- | ---------------------------------------------- |
+| OpenAI       | Plus / Team / Pro | `~/.local/share/opencode/opencode.db`         |
+| Zhipu AI     | Coding Plan       | `~/.local/share/opencode/opencode.db`         |
+| Z.ai         | Coding Plan       | `~/.local/share/opencode/opencode.db`         |
+| DeepSeek     | API balance       | `~/.local/share/opencode/opencode.db`         |
+| GitHub Copilot | Individual / Business | `~/.local/share/opencode/opencode.db`      |
+| Google Cloud | Antigravity       | `~/.config/opencode/antigravity-accounts.json` |
+
+## Installation
+
+### Let an LLM do it
+
+Paste this into any LLM agent (Claude Code, OpenCode, Cursor, etc.):
+
+```
+Install the opencode-mystatus plugin by following: https://raw.githubusercontent.com/vbgate/opencode-mystatus/main/README.md
+```
+
+<details>
+<summary><b>Instructions for LLM agents</b></summary>
+
+To install this plugin, perform these steps:
+
+1. Add `"@ekworp/opencode-mystatus"` to the `plugins` array in `~/.config/opencode/opencode.json`:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugins": ["@ekworp/opencode-mystatus"]
+}
+```
+
+2. Optionally copy `command/mystatus.md` to `~/.config/opencode/commands/` to enable `/mystatus`.
+
+3. Restart OpenCode.
+
+</details>
+
+### Manual Installation
+
+1. Add the plugin and slash command to your `~/.config/opencode/opencode.json`:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugins": ["@ekworp/opencode-mystatus"]
+}
+```
+
+2. Optionally copy `command/mystatus.md` to `~/.config/opencode/commands/` to enable `/mystatus`.
+3. Restart OpenCode
+
+### From Local Files
+
+Copy the plugin files to your project's OpenCode directory:
+
+1. Copy `plugin/mystatus.ts` and `plugin/lib/` to `.opencode/plugins/`
+2. Install the project dependencies with `pnpm install`.
+3. Optionally copy `command/mystatus.md` to `.opencode/commands/` to enable `/mystatus`.
+4. Restart OpenCode
+
+### GitHub Release
+
+Every `v*` tag publishes a single-file V2 plugin build to GitHub Releases:
+
+```text
+https://github.com/ekworp/opencode-mystatus/releases/latest/download/opencode-mystatus.js
+```
+
+Download the file to `.opencode/plugins/mystatus.js` before starting OpenCode. The
+release file still expects OpenCode V2 to provide `@opencode/plugin`.
+
+## Usage
+
+### Option 1: Slash Command
+
+Use the `/mystatus` command to get complete quota information:
+
+```
+/mystatus
+```
+
+### Option 2: Natural Language
+
+Simply ask in natural language, for example:
+
+- "Check my OpenAI quota"
+- "How much Codex quota do I have left?"
+- "Show my AI account status"
+
+OpenCode will automatically use the mystatus tool to answer your question.
+
+## Output Example
+
+```
+## OpenAI Account Quota
+
+Account:        user@example.com (team)
+
+3-hour limit
+██████████████████████████████ 85% remaining
+Resets in: 2h 30m
+
+## Zhipu AI Account Quota
+
+Account:        9c89****AQVM (Coding Plan)
+
+5-hour token limit
+██████████████████████████████ 95% remaining
+Used: 0.5M / 10.0M
+Resets in: 4h
+
+## Z.ai Account Quota
+
+Account:        9c89****AQVM (Z.ai)
+
+5-hour token limit
+██████████████████████████████ 95% remaining
+Used: 0.5M / 10.0M
+Resets in: 4h
+
+## GitHub Copilot Account Quota
+
+Account:        GitHub Copilot (individual)
+
+Premium        ████░░░░░░░░░░░░░░░░ 24% (229/300)
+
+Quota resets: 19d 0h (2026-02-01)
+
+## Google Cloud Account Quota
+
+### user@gmail.com
+
+G3 Pro     4h 59m     ████████████████████ 100%
+G3 Image   4h 59m     ████████████████████ 100%
+G3 Flash   4h 59m     ████████████████████ 100%
+Claude     2d 9h      ░░░░░░░░░░░░░░░░░░░░ 0%
+```
+
+## Features
+
+- Query quota usage across multiple AI platforms in one command
+- Visual progress bars showing remaining quota
+- Reset time countdown
+- Multi-language support (Chinese / English)
+- Multiple Google Cloud accounts support
+- API key masking for security
+
+## Configuration
+
+No additional configuration required. The plugin automatically reads credentials from:
+
+- **OpenAI, Zhipu AI, Z.ai, DeepSeek & GitHub Copilot**: `~/.local/share/opencode/opencode.db`
+- **Google Cloud**: `~/.config/opencode/antigravity-accounts.json`
+
+### Disable providers
+
+Create `~/.config/opencode/mystatus.json` to skip selected providers:
+
+```json
+{
+  "disabledProviders": ["deepseek", "google"]
+}
+```
+
+Available names: `openai`, `zhipuai-coding-plan`, `zai-coding-plan`, `deepseek`, `google`, `github-copilot`.
+
+### Google Cloud Setup
+
+To query Google Cloud (Antigravity) account quota, you need to install the [opencode-antigravity-auth](https://github.com/NoeFabris/opencode-antigravity-auth) plugin first to authenticate your Google account.
+
+## Security
+
+This plugin is safe to use:
+
+**Local Files Accessed (read-only):**
+
+- `~/.local/share/opencode/opencode.db` - OpenCode V2's official credential storage
+- `~/.config/opencode/antigravity-accounts.json` - Antigravity plugin's account storage
+
+**API Endpoints (all official):**
+
+- `https://chatgpt.com/backend-api/wham/usage` - OpenAI official quota API
+- `https://bigmodel.cn/api/monitor/usage/quota/limit` - Zhipu AI official quota API
+- `https://api.z.ai/api/monitor/usage/quota/limit` - Z.ai official quota API
+- `https://api.github.com/copilot_internal/user` - GitHub Copilot official API
+- `https://oauth2.googleapis.com/token` - Google official OAuth API
+- `https://cloudcode-pa.googleapis.com/v1internal:fetchAvailableModels` - Google Cloud official API
+
+**Privacy:**
+
+- No data is stored, uploaded, or cached by this plugin
+- Sensitive information (API keys) is automatically masked in output
+- Source code is fully open for review
+
+## Google Cloud Models
+
+The plugin displays quota for these models:
+
+| Display Name | Model Key                                      |
+| ------------ | ---------------------------------------------- |
+| G3 Pro       | `gemini-3-pro-high` / `gemini-3-pro-low`       |
+| G3 Image     | `gemini-3-pro-image`                           |
+| G3 Flash     | `gemini-3-flash`                               |
+| Claude       | `claude-opus-4-5-thinking` / `claude-opus-4-5` |
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Check the code
+pnpm run typecheck
+pnpm run lint
+
+# Build the TypeScript distribution
+pnpm run build
+```
+
+Git hooks run the lint and typecheck automatically before commits.
+They are installed by `pnpm install` through Husky.
+
+## License
+
+MIT

package/README.zh-CN.md

@@ -0,0 +1,239 @@
+# opencode-mystatus
+
+[![npm version](https://img.shields.io/npm/v/%40ekworp%2Fopencode-mystatus.svg)](https://www.npmjs.com/package/@ekworp/opencode-mystatus)
+[![npm 总下载量](https://img.shields.io/npm/dm/%40ekworp%2Fopencode-mystatus)](https://www.npmjs.com/package/@ekworp/opencode-mystatus)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+[OpenCode](https://opencode.ai) 插件，用于查询多个 AI 平台的账号额度使用情况。
+
+[English](./README.md)
+
+![AI额度一键查](./assets/mystatus-banner-zh.jpeg)
+
+## 支持的平台
+
+| 平台         | 账号类型          | 数据来源                                       |
+| ------------ | ----------------- | ---------------------------------------------- |
+| OpenAI       | Plus / Team / Pro | `~/.local/share/opencode/opencode.db`         |
+| 智谱 AI      | Coding Plan       | `~/.local/share/opencode/opencode.db`         |
+| Z.ai         | Coding Plan       | `~/.local/share/opencode/opencode.db`         |
+| DeepSeek     | API 余额          | `~/.local/share/opencode/opencode.db`         |
+| GitHub Copilot | Individual / Business | `~/.local/share/opencode/opencode.db`      |
+| Google Cloud | Antigravity       | `~/.config/opencode/antigravity-accounts.json` |
+
+## 安装
+
+### 让 AI 帮你安装
+
+将以下内容粘贴到任意 AI 代理（Claude Code、OpenCode、Cursor 等）：
+
+```
+Install the opencode-mystatus plugin by following: https://raw.githubusercontent.com/vbgate/opencode-mystatus/main/README.md
+```
+
+<details>
+<summary><b>AI 代理安装指令</b></summary>
+
+安装此插件需要执行以下步骤：
+
+1. 在 `~/.config/opencode/opencode.json` 的 `plugins` 数组中添加 `"@ekworp/opencode-mystatus"`：
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugins": ["@ekworp/opencode-mystatus"]
+}
+```
+
+2. 如需启用 `/mystatus`，将 `command/mystatus.md` 复制到 `~/.config/opencode/commands/`。
+3. 重启 OpenCode。
+
+</details>
+
+### 手动安装
+
+1. 在 `~/.config/opencode/opencode.json` 中添加插件和斜杠命令：
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugins": ["@ekworp/opencode-mystatus"]
+}
+```
+
+2. 如需启用 `/mystatus`，将 `command/mystatus.md` 复制到 `~/.config/opencode/commands/`。
+3. 重启 OpenCode
+
+### 从本地文件安装
+
+将插件文件复制到 OpenCode 配置目录：
+
+1. 将 `plugin/mystatus.ts` 和 `plugin/lib/` 复制到项目的 `.opencode/plugins/`
+2. 执行 `pnpm install` 安装依赖。
+3. 如需启用 `/mystatus`，将 `command/mystatus.md` 复制到 `.opencode/commands/`。
+4. 重启 OpenCode
+
+### GitHub Release
+
+每个 `v*` 标签都会在 GitHub Release 中发布单文件 V2 插件：
+
+```text
+https://github.com/ekworp/opencode-mystatus/releases/latest/download/opencode-mystatus.js
+```
+
+启动 OpenCode 前，将文件下载到项目的 `.opencode/plugins/mystatus.js`。
+该文件依赖 OpenCode V2 提供的 `@opencode/plugin`。
+
+## 使用方法
+
+### 方式一：斜杠命令
+
+使用 `/mystatus` 命令获取完整的额度信息：
+
+```
+/mystatus
+```
+
+### 方式二：自然语言
+
+直接用自然语言提问，例如：
+
+- "帮我查看 Codex 的额度"
+- "我的 OpenAI 还剩多少额度？"
+- "查看 AI 账号状态"
+
+OpenCode 会自动调用 mystatus 工具来回答你的问题。
+
+## 输出示例
+
+```
+## OpenAI 账号额度
+
+Account:        user@example.com (team)
+
+3小时限额
+██████████████████████████████ 剩余 85%
+重置: 2小时30分钟后
+
+## 智谱 AI 账号额度
+
+Account:        9c89****AQVM (Coding Plan)
+
+5 小时 Token 限额
+██████████████████████████████ 剩余 95%
+已用: 0.5M / 10.0M
+重置: 4小时后
+
+## Z.ai 账号额度
+
+Account:        9c89****AQVM (Z.ai)
+
+5 小时 Token 限额
+██████████████████████████████ 剩余 95%
+已用: 0.5M / 10.0M
+重置: 4小时后
+
+## GitHub Copilot Account Quota
+
+Account:        GitHub Copilot (individual)
+
+Premium        ████░░░░░░░░░░░░░░░░ 24% (229/300)
+
+Quota resets: 19d 0h (2026-02-01)
+
+## Google Cloud 账号额度
+
+### user@gmail.com
+
+G3 Pro     4h 59m     ████████████████████ 100%
+G3 Image   4h 59m     ████████████████████ 100%
+G3 Flash   4h 59m     ████████████████████ 100%
+Claude     2d 9h      ░░░░░░░░░░░░░░░░░░░░ 0%
+```
+
+## 功能特性
+
+- 一条命令查询多个 AI 平台的额度使用情况
+- 可视化进度条显示剩余额度
+- 重置时间倒计时
+- 多语言支持（中文 / 英文）
+- 支持多个 Google Cloud 账号
+- API Key 脱敏显示，保护安全
+
+## 配置
+
+插件自动从以下位置读取认证信息：
+
+- **OpenAI、智谱 AI、Z.ai、DeepSeek 和 GitHub Copilot**: `~/.local/share/opencode/opencode.db`
+- **Google Cloud**: `~/.config/opencode/antigravity-accounts.json`
+
+### 禁用平台
+
+可创建 `~/.config/opencode/mystatus.json`，过滤不需要查询的平台：
+
+```json
+{
+  "disabledProviders": ["deepseek", "google"]
+}
+```
+
+可用名称：`openai`、`zhipuai-coding-plan`、`zai-coding-plan`、`deepseek`、`google`、`github-copilot`。
+
+### Google Cloud 设置
+
+如需查询 Google Cloud (Antigravity) 账号额度，需要先安装 [opencode-antigravity-auth](https://github.com/NoeFabris/opencode-antigravity-auth) 插件来完成 Google 账号认证。
+
+## 安全性
+
+本插件可以安全放心使用：
+
+**读取的本地文件（只读）：**
+
+- `~/.local/share/opencode/opencode.db` - OpenCode V2 官方认证存储
+- `~/.config/opencode/antigravity-accounts.json` - Antigravity 插件的账号存储
+
+**请求的 API 接口（均为官方接口）：**
+
+- `https://chatgpt.com/backend-api/wham/usage` - OpenAI 官方额度查询接口
+- `https://bigmodel.cn/api/monitor/usage/quota/limit` - 智谱 AI 官方额度查询接口
+- `https://api.z.ai/api/monitor/usage/quota/limit` - Z.ai 官方额度查询接口
+- `https://api.github.com/copilot_internal/user` - GitHub Copilot 官方 API
+- `https://oauth2.googleapis.com/token` - Google 官方 OAuth 接口
+- `https://cloudcode-pa.googleapis.com/v1internal:fetchAvailableModels` - Google Cloud 官方接口
+
+**隐私保护：**
+
+- 插件不会保存、上传或缓存任何用户数据
+- 敏感信息（API Key）在输出时自动脱敏显示
+- 源代码完全开源，可随时审查
+
+## Google Cloud 模型
+
+插件显示以下模型的额度：
+
+| 显示名称 | 模型 Key                                       |
+| -------- | ---------------------------------------------- |
+| G3 Pro   | `gemini-3-pro-high` / `gemini-3-pro-low`       |
+| G3 Image | `gemini-3-pro-image`                           |
+| G3 Flash | `gemini-3-flash`                               |
+| Claude   | `claude-opus-4-5-thinking` / `claude-opus-4-5` |
+
+## 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 检查代码
+pnpm run typecheck
+pnpm run lint
+
+# 编译 TypeScript
+pnpm run build
+```
+
+Git hook 会在提交前自动执行 lint 与类型检查，执行 `pnpm install` 时由 Husky 自动安装。
+
+## 许可证
+
+MIT

package/command/mystatus.md

@@ -0,0 +1,5 @@
+---
+description: Query quota usage for all AI accounts
+---
+
+Use the mystatus tool to query quota usage. Return the result as-is without modification.

package/dist/plugin/lib/config.d.ts

@@ -0,0 +1,6 @@
+export type ProviderId = "openai" | "zhipuai-coding-plan" | "zai-coding-plan" | "deepseek" | "google" | "github-copilot";
+declare const CONFIG_PATH: string;
+/** Read optional provider filters. Invalid or missing config means enabled all. */
+export declare function readMystatusConfig(): Promise<Set<ProviderId>>;
+export declare function isProviderEnabled(disabledProviders: Set<ProviderId>, provider: ProviderId): boolean;
+export { CONFIG_PATH };

package/dist/plugin/lib/config.js

@@ -0,0 +1,29 @@
+import { readFile } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+const CONFIG_PATH = join(homedir(), ".config/opencode/mystatus.json");
+/** Read optional provider filters. Invalid or missing config means enabled all. */
+export async function readMystatusConfig() {
+    try {
+        const content = await readFile(CONFIG_PATH, "utf8");
+        const config = JSON.parse(content);
+        if (!Array.isArray(config.disabledProviders))
+            return new Set();
+        const validProviders = [
+            "openai",
+            "zhipuai-coding-plan",
+            "zai-coding-plan",
+            "deepseek",
+            "google",
+            "github-copilot",
+        ];
+        return new Set(config.disabledProviders.filter((provider) => validProviders.includes(provider)));
+    }
+    catch {
+        return new Set();
+    }
+}
+export function isProviderEnabled(disabledProviders, provider) {
+    return !disabledProviders.has(provider);
+}
+export { CONFIG_PATH };

package/dist/plugin/lib/copilot.d.ts

@@ -0,0 +1,20 @@
+/**
+ * GitHub Copilot Premium Requests Quota Module
+ *
+ * [Input]: GitHub token from ~/.local/share/opencode/auth.json (github-copilot provider)
+ * [Output]: Formatted quota usage information with progress bars
+ * [Location]: Called by mystatus.ts to handle GitHub Copilot accounts
+ * [Sync]: mystatus.ts, types.ts, utils.ts, i18n.ts
+ *
+ * [Updated]: Jan 2026 - Handle new OpenCode official partnership auth flow
+ * The new OAuth tokens (gho_) need to be exchanged for Copilot session tokens
+ * before calling the internal quota API.
+ */
+import type { CopilotAuthData, QueryResult } from "./types";
+export type { CopilotAuthData };
+/**
+ * Query GitHub Copilot account quota
+ * @param authData GitHub Copilot authentication data (optional if using PAT config)
+ * @returns Query result, null if no account configured
+ */
+export declare function queryCopilotUsage(authData: CopilotAuthData | undefined): Promise<QueryResult | null>;

package/dist/plugin/lib/copilot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copilot.d.ts","sourceRoot":"","sources":["../../../plugin/lib/copilot.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAMH,OAAO,KAAK,EACV,eAAe,EAGf,WAAW,EACZ,MAAM,SAAS,CAAC;AAmcjB,YAAY,EAAE,eAAe,EAAE,CAAC;AAEhC;;;;GAIG;AACH,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,eAAe,GAAG,SAAS,GACpC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAuC7B"}