@mdrv/opencode-quota 262.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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,189 @@
+# opencode-quota
+
+## [![npm version](https://img.shields.io/npm/v/opencode-glm-quota.svg)](https://www.npmjs.com/package/opencode-glm-quota) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Build Status](https://github.com/guyinwonder168/opencode-glm-quota/workflows/CI/badge.svg)](https://github.com/guyinwonder168/opencode-glm-quota/actions) [![SonarQube Cloud](https://sonarcloud.io/images/project_badges/sonarcloud-light.svg)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
+
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=guyinwonder168_opencode-glm-quota&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=guyinwonder168_opencode-glm-quota&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=guyinwonder168_opencode-glm-quota&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=guyinwonder168_opencode-glm-quota&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
+
+OpenCode plugin for querying Z.ai GLM, GitHub Copilot, and Kimi usage statistics. Check quota limits, model usage, and MCP tool usage with manual commands.
+
+## Features
+
+- 📊 **Multi-Platform Support**: Query GLM, GitHub Copilot, and Kimi Coding Plans.
+- 🖱️ **Manual-Only**: Plugin only runs when you ask (no periodic background checks).
+- ⏱️ **Human Durations**: Clear reset timers (e.g., `24d 13h 6m 12s`), hiding zero values.
+- 🔐 **Secure Credential Discovery**: Automatically fetches tokens from OpenCode auth context.
+- 📈 **Visual Progress**: Plain text progress bars and usage percentages.
+- ⚡ **Fail-Fast**: Direct reporting without hidden retry loops.
+
+## Installation
+
+### Option 1: npm (Recommended)
+
+```bash
+# Install package
+npm install opencode-glm-quota
+
+# Run installer to configure OpenCode
+npx opencode-glm-quota install
+```
+
+**What the installer does:**
+
+- Copies `/glm_quota`, `/copilot_quota`, and `/kimi_quota` commands to your OpenCode config.
+- Configures skill documentation in `~/.config/opencode/skills/`.
+- Automatically adds the plugin to your OpenCode configuration.
+
+### Uninstall
+
+```bash
+npx opencode-glm-quota uninstall
+```
+
+## Quick Start
+
+Run any of the following commands in OpenCode:
+
+```bash
+/glm_quota      # Z.AI GLM Coding Plan statistics
+/copilot_quota  # GitHub Copilot usage statistics
+/kimi_quota    # Kimi Coding Plan usage statistics
+```
+
+## CLI Usage
+
+Check your quota directly from the terminal using the provided binaries:
+
+```bash
+# Check GLM quota
+bun run bin/glm-quota.ts
+
+# Check GitHub Copilot quota
+bun run bin/copilot-quota.ts
+
+# Check Kimi quota
+bun run bin/kimi-quota.ts
+```
+
+### CLI Flags
+
+| Flag      | Shorthand | Description                              |
+| --------- | --------- | ---------------------------------------- |
+| `--debug` | `-d`      | Enable debug logging (hidden by default) |
+| `--raw`   |           | Output raw JSON (useful for scripting)   |
+| `--help`  | `-h`      | Show help message                        |
+
+## Platform Features
+
+### Z.AI GLM
+
+- Shows **TIME_LIMIT** (1-month) and **TOKENS_LIMIT** (5-hour rolling window).
+- Detailed model usage counts and MCP tool usage statistics.
+
+### GitHub Copilot
+
+- Displays user login, subscription plan, and reset dates.
+- Shows usage for Chat, Completions, and Premium features.
+- Indicates if usage is "Unlimited".
+
+### Kimi
+
+- Shows total usage and 5-hour rolling window usage.
+- Displays specific "Time to Reset" for each quota window.
+
+## Output Example
+
+```text
+--------------------------------------------------------
+           Z.ai GLM Coding Plan Usage Statistics
+--------------------------------------------------------
+  Platform: Z.AI
+  Period:   2026-02-22 09:00:00 -> 2026-02-23 08:59:59
+--------------------------------------------------------
+  QUOTA LIMITS
+  - Token usage(5 Hour)      [###################--------]  40.5%
+  - MCP usage(1 Month)       [####-----------------------]  12.3%
+       Used: 123/1,000
+       Reset in: 12d 4h 15m
+--------------------------------------------------------
+  MODEL USAGE (24h)
+  - Total Tokens (24h): 12,500,000 (31% of 5h limit)
+  - 5h Window Usage: 40.5% of 40,000,000
+  - Total Calls: 1,234
+--------------------------------------------------------
+  TOOL/MCP USAGE (24h)
+  - Network Searches: 5,678
+  - Web Reads: 2,345
+  - ZRead Calls: 890
+--------------------------------------------------------
+```
+
+## Error Handling
+
+The plugin uses fail-fast error handling. If an API request fails or credentials are missing, it displays a plain text error message immediately.
+
+```text
+--------------------------------------------------------
+  ERROR: Z.ai Credentials Not Found
+--------------------------------------------------------
+  Please authenticate first:
+  1. Run /connect in OpenCode TUI
+  2. Select "Z.AI Coding Plan" or "Z.AI"
+--------------------------------------------------------
+```
+
+## API Reference
+
+| Platform           | Endpoint                                       |
+| ------------------ | ---------------------------------------------- |
+| **Z.AI GLM**       | `https://api.z.ai/api/monitor/usage/*`         |
+| **GitHub Copilot** | `https://api.github.com/copilot_internal/user` |
+| **Kimi**           | `https://api.kimi.com/coding/v1/usages`        |
+
+## Development
+
+### Build & Test
+
+```bash
+# Build TypeScript
+bun run build
+
+# Run all tests
+bun run test
+
+# Format code
+bun run fmt
+```
+
+### Project Structure
+
+```text
+src/
+  index.ts              # Main plugin entry point
+  api/
+    client.ts           # Shared HTTPS client
+    endpoints.ts        # Endpoint definitions
+  utils/
+    duration.ts         # d h m s formatting logic
+    progress-bar.ts     # Plain text bar rendering
+bin/
+  glm-quota.ts          # CLI binary for GLM
+  copilot-quota.ts      # CLI binary for Copilot
+  kimi-quota.ts         # CLI binary for Kimi
+  install.js            # Installation script
+integration/
+  command/              # /command slash commands
+  skills/               # OpenCode skill docs
+```
+
+## License
+
+MIT © 2026
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history.
+
+- **v2.62.0**: Removed auto quota features; Added Copilot & Kimi support; Plain text output; CLI binaries.

package/bin/copilot-quota.ts

@@ -0,0 +1,374 @@
+#!/usr/bin/env -S bun
+
+/**
+ * GitHub Copilot quota CLI tool
+ * Fetches and displays GitHub Copilot usage statistics from command line
+ * Credentials are fetched from OpenCode's auth.json
+ */
+
+import * as https from 'https'
+import * as os from 'os'
+import * as path from 'path'
+import { configureLogging, getLogger } from '../src/shared/logging.js'
+
+const COMMAND_NAME = 'opencode-copilot-quota'
+const AUTH_JSON_PATH = path.join(os.homedir(), '.local', 'share', 'opencode', 'auth.json')
+
+/**
+ * Type definitions
+ */
+interface Credentials {
+	token: string
+}
+
+type AuthJson = Record<string, { access?: string; refresh?: string; token?: string }>
+
+// Copilot API response types
+interface CopilotQuotaSnapshot {
+	unlimited: boolean
+	percent_remaining?: number
+	entitlement?: number
+	quota_remaining?: number
+}
+
+interface CopilotResponse {
+	login: string
+	copilot_plan: string
+	quota_reset_date_utc: string
+	quota_snapshots: {
+		chat: CopilotQuotaSnapshot
+		completions: CopilotQuotaSnapshot
+		premium_interactions: CopilotQuotaSnapshot
+	}
+}
+
+// Global logger, assigned after configureLogging()
+let logger: ReturnType<typeof getLogger>
+
+/**
+ * Calculate duration until reset date
+ * @param resetDate - Reset date string (ISO 8601)
+ * @returns Human-readable duration (e.g., "7d 4h 32m 15s", "2h 57m 31s", "5m")
+ */
+function calculateDurationToReset(resetDate: string): string {
+	const now = new Date()
+	const reset = new Date(resetDate)
+	const diffMs = reset.getTime() - now.getTime()
+
+	// If reset date is in the past, show "0d 0h 0m 0s"
+	if (diffMs <= 0) {
+		return '0d 0h 0m 0s'
+	}
+
+	const diffDays = Math.floor(diffMs / (1000 * 60 * 60 * 24))
+	const diffHours = Math.floor((diffMs % (1000 * 60 * 60 * 24)) / (1000 * 60 * 60))
+	const diffMinutes = Math.floor((diffMs % (1000 * 60 * 60)) / (1000 * 60))
+	const diffSeconds = Math.floor((diffMs % (1000 * 60)) / 1000)
+
+	// Build duration string, hiding zero values
+	const parts: string[] = []
+	if (diffDays > 0) parts.push(`${diffDays}d`)
+	if (diffHours > 0) parts.push(`${diffHours}h`)
+	if (diffMinutes > 0) parts.push(`${diffMinutes}m`)
+	if (diffSeconds > 0) parts.push(`${diffSeconds}s`)
+
+	return parts.length > 0 ? parts.join(' ') : '0s'
+}
+
+/**
+ * Parse Copilot response and format output
+ * @param response - Raw JSON response string
+ * @returns Formatted output string
+ */
+function parseCopilotResponse(response: string): string {
+	const data = JSON.parse(response) as CopilotResponse
+
+	const { login, copilot_plan, quota_reset_date_utc, quota_snapshots } = data
+
+	// Format reset date and duration
+	const resetDate = new Date(quota_reset_date_utc)
+		.toLocaleDateString('en-US', {
+			year: 'numeric',
+			month: '2-digit',
+			day: '2-digit',
+		})
+	const duration = calculateDurationToReset(quota_reset_date_utc)
+
+	// Build formatted output (plain text, no boxes)
+	let output = ''
+	output += `GitHub Copilot Usage Statistics\n`
+	output += `\n`
+	output += `User: ${login}\n`
+	output += `Plan: ${copilot_plan}\n`
+	output += `Reset: ${resetDate} (${duration})\n`
+	output += `\n`
+	output += `QUOTA USAGE\n`
+	output += `\n`
+
+	// Chat
+	if (quota_snapshots.chat.unlimited) {
+		output += `Chat: Unlimited\n`
+	} else {
+		const remaining = quota_snapshots.chat.percent_remaining ?? 0
+		const used = 100 - remaining
+		output += `Chat: ${used}% used\n`
+	}
+
+	// Completions
+	if (quota_snapshots.completions.unlimited) {
+		output += `Completions: Unlimited\n`
+	} else {
+		const remaining = quota_snapshots.completions.percent_remaining ?? 0
+		const used = 100 - remaining
+		output += `Completions: ${used}% used\n`
+	}
+
+	// Premium
+	const premium = quota_snapshots.premium_interactions
+	if (premium.unlimited) {
+		output += `Premium: Unlimited\n`
+	} else {
+		const remaining = premium.quota_remaining ?? 0
+		const entitlement = premium.entitlement ?? 0
+		const used = entitlement - remaining
+		const percentUsed = entitlement > 0 ? ((used / entitlement) * 100).toFixed(1) : '0.0'
+		output += `Premium: ${used.toFixed(2)} / ${entitlement} (${percentUsed}% used)\n`
+	}
+
+	return output
+}
+
+/**
+ * Make HTTPS request with timeout
+ */
+function makeRequest(
+	url: string,
+	token: string,
+	headers: Record<string, string> = {},
+): Promise<string> {
+	logger.debug(`Making request to ${url}`)
+	logger.debug(`Using token: ${token.slice(0, 8)}...${token.slice(-4)}`)
+
+	return new Promise((resolve, reject) => {
+		const timeout = 10000 // 10 seconds
+		const timer = setTimeout(() => {
+			req.destroy()
+			logger.error(`Request timeout for ${url}`)
+			reject(new Error('Request timeout'))
+		}, timeout)
+
+		const urlObj = new URL(url)
+		const options = {
+			hostname: urlObj.hostname,
+			port: urlObj.port || 443,
+			path: urlObj.pathname + urlObj.search,
+			method: 'GET',
+			headers: {
+				'Authorization': `token ${token}`,
+				'Accept': 'application/json',
+				'Content-Type': 'application/json',
+				...headers,
+			},
+		}
+
+		logger.debug(`Request options: ${
+			JSON.stringify({
+				hostname: options.hostname,
+				path: options.path,
+				method: options.method,
+				headers: Object.fromEntries(
+					Object.entries(options.headers).map(([k, v]) => [
+						k,
+						k === 'Authorization' ? `${v.slice(0, 13)}...${v.slice(-4)}` : v,
+					]),
+				),
+			})
+		}`)
+
+		const req = https.request(options, (res) => {
+			let data = ''
+
+			logger.debug(`Response status: ${res.statusCode} ${res.statusMessage}`)
+
+			res.on('data', chunk => {
+				data += chunk
+			})
+
+			res.on('end', () => {
+				clearTimeout(timer)
+				if (res.statusCode && res.statusCode >= 200 && res.statusCode < 300) {
+					logger.debug(`Response received: ${data.slice(0, 100)}... (${data.length} bytes)`)
+					resolve(data)
+				} else {
+					logger.error(`HTTP error: ${res.statusCode} ${res.statusMessage}`)
+					logger.debug(`Error response: ${data}`)
+					reject(new Error(`HTTP ${res.statusCode}: ${res.statusMessage}`))
+				}
+			})
+		})
+
+		req.on('error', (err) => {
+			clearTimeout(timer)
+			logger.error(`Request error: ${err.message}`)
+			reject(err)
+		})
+
+		req.end()
+	})
+}
+
+/**
+ * Get credentials from OpenCode auth.json
+ */
+function getCredentials(): Credentials | null {
+	logger.debug(`Looking for credentials at ${AUTH_JSON_PATH}`)
+
+	try {
+		const fs = require('fs')
+		if (!fs.existsSync(AUTH_JSON_PATH)) {
+			logger.debug('auth.json does not exist')
+			return null
+		}
+
+		const content = fs.readFileSync(AUTH_JSON_PATH, 'utf-8')
+		const auth = JSON.parse(content) as AuthJson
+
+		logger.debug(`auth.json loaded with ${Object.keys(auth).length} providers`)
+
+		const copilotToken = auth['github-copilot']?.access ?? auth['github-copilot']?.refresh
+		if (copilotToken) {
+			logger.info('Found credentials for provider: github-copilot')
+			return { token: copilotToken }
+		}
+
+		logger.debug('No credentials found for github-copilot provider')
+		return null
+	} catch (error) {
+		logger.error(`Error reading auth.json: ${error}`)
+		return null
+	}
+}
+
+/**
+ * Display help message
+ */
+function showHelp() {
+	console.log(`
+${COMMAND_NAME} - Check GitHub Copilot quota from terminal
+
+USAGE:
+  bun run bin/copilot-quota.ts [--raw] [--debug]
+
+OPTIONS:
+  --raw        Output raw JSON (default: formatted output)
+  --debug, -d   Enable debug logging (logs hidden by default)
+  --help, -h    Display this help message
+
+AUTHENTICATION:
+  Reads credentials from ~/.local/share/opencode/auth.json
+  Provider: github-copilot
+
+EXAMPLES:
+  bun run bin/copilot-quota.ts
+  bun run bin/copilot-quota.ts --debug
+  bun run bin/copilot-quota.ts --raw
+`)
+}
+
+/**
+ * Main CLI entry point
+ */
+async function main() {
+	const args = process.argv.slice(2)
+
+	// Check for help flag first (before logging config)
+	if (args.includes('--help') || args.includes('-h')) {
+		showHelp()
+		process.exit(0)
+	}
+
+	// Check for debug flag before configuring logging
+	const debugMode = args.includes('--debug') || args.includes('-d')
+
+	// Only configure logging when --debug is present
+	if (debugMode) {
+		await configureLogging('debug')
+	}
+
+	// Create logger after configureLogging (or with no-op if not configured)
+	if (debugMode) {
+		logger = getLogger(['opencode-quota', 'cli', 'copilot'])
+	} else {
+		// No-op logger when debug mode is off
+		logger = {
+			debug: () => {},
+			info: () => {},
+			warn: () => {},
+			error: () => {},
+		} as unknown as ReturnType<typeof getLogger>
+	}
+
+	logger.info(`${COMMAND_NAME} starting...`)
+
+	const rawOutput = args.includes('--raw')
+
+	logger.debug(`Arguments: ${args.join(' ')}`)
+	logger.debug(`Raw output: ${rawOutput}`)
+
+	try {
+		// Get credentials from OpenCode auth.json
+		const credentials = getCredentials()
+
+		if (!credentials) {
+			logger.error('No credentials found')
+			console.error(`\n${COMMAND_NAME}: Not configured.\nPlease connect to GitHub Copilot in OpenCode first.\n`)
+			process.exit(1)
+		}
+
+		// Query GitHub Copilot internal API
+		const customHeaders = {
+			'X-GitHub-Api-Version': '2025-04-01',
+			'User-Agent': 'GitHubCopilotChat/0.26.7',
+			'Editor-Version': 'vscode/1.96.2',
+		}
+
+		logger.info('Querying GitHub Copilot internal API...')
+
+		const response = await makeRequest(
+			'https://api.github.com/copilot_internal/user',
+			credentials.token,
+			customHeaders,
+		)
+
+		logger.info('Received response from GitHub API')
+
+		if (!rawOutput) {
+			// Parse and display formatted output
+			try {
+				const formatted = parseCopilotResponse(response)
+				console.log(formatted)
+			} catch (error) {
+				logger.error(`Failed to parse Copilot response: ${error}`)
+				logger.debug(`Invalid response: ${response}`)
+				throw new Error(`Parse error: ${error instanceof Error ? error.message : String(error)}`)
+			}
+		} else {
+			// Print raw response
+			console.log(response)
+		}
+
+		logger.info('Completed successfully')
+	} catch (error) {
+		if (error instanceof Error) {
+			logger.error(`${error.name}: ${error.message}`)
+			console.error(`\n${COMMAND_NAME}: ${error.message}\n`)
+		} else {
+			logger.error(`Unknown error: ${String(error)}`)
+			console.error(`\n${COMMAND_NAME}: Unknown error occurred\n`)
+		}
+		process.exit(1)
+	}
+}
+
+// Run CLI
+main()