vibeusage 0.2.21 → 0.2.22

package/README.md

@@ -4,18 +4,19 @@
 
 # 🟢 VIBEUSAGE
 
-**QUANTIFY YOUR AI OUTPUT**  
-_Real-time AI Analytics for Codex CLI_
+**QUANTIFY YOUR AI OUTPUT**
+_Track AI Token Usage Across All Your CLI Tools_
 
 [**www.vibeusage.cc**](https://www.vibeusage.cc)
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
-[![Node.js Support](https://img.shields.io/badge/Node.js-%3E%3D18-brightgreen.svg)](https://nodejs.org/)
+[![npm version](https://img.shields.io/npm/v/vibeusage.svg)](https://www.npmjs.com/package/vibeusage)
+[![Node.js Support](https://img.shields.io/badge/Node.js-20.x-brightgreen.svg)](https://nodejs.org/)
 [![Platform](https://img.shields.io/badge/Platform-macOS-lightgrey.svg)](https://www.apple.com/macos/)
 
 [**English**](README.md) • [**中文说明**](README.zh-CN.md)
 
-[**Documentation**](docs/) • [**Dashboard**](dashboard/) • [**Backend API**](BACKEND_API.md)
+[**Documentation**](docs/) • [**Dashboard**](https://www.vibeusage.cc) • [**Backend API**](BACKEND_API.md)
 
 <br/>
 
@@ -25,127 +26,231 @@ _Real-time AI Analytics for Codex CLI_
 
 ---
 
+## 🚀 Quick Start
+
+Get started in 30 seconds:
+
+```bash
+npx vibeusage init
+```
+
+That's it! Your AI token usage will now automatically sync to the [Dashboard](https://www.vibeusage.cc) 🎉
+
+## ✨ Why VibeUsage?
+
+- 📡 **Multi-Source Unified Tracking** - Support for Codex CLI, Every Code, Gemini CLI, Claude Code, Opencode, OpenClaw, and more
+- 🤖 **Multi-Model Statistics** - Unified tracking for GPT-4, Claude, Gemini, o1, and all AI models
+- 📁 **Project AI Footprint** - Track and publicly display token usage per repository, proving AI-assisted development
+- 🏆 **Global Leaderboard** - Weekly/monthly/all-time rankings, grow with the global developer community
+- 🌐 **Public Profiles** - Share your AI usage journey, optionally participate in leaderboards
+- 🔒 **Privacy-First** - Only track numbers, never upload your code or conversations
+- ⚡ **Zero-Config Auto-Sync** - Set up once, sync forever
+- 🎨 **Matrix-A Design** - Cyberpunk-style high-fidelity dashboard
+- 📈 **Deep Analytics** - Cost insights, trend forecasting, activity heatmaps
+
+## 🧰 Supported AI CLIs
+
+| CLI Tool | Auto-Detection | Status |
+|----------|----------------|--------|
+| **Codex CLI** | ✅ | Full Support |
+| **Every Code** | ✅ | Full Support |
+| **Gemini CLI** | ✅ | Full Support |
+| **Claude Code** | ✅ | Full Support |
+| **Opencode** | ✅ | Full Support |
+| **OpenClaw** | ✅ | Full Support |
+
+Whether you're using GPT-4, Claude 3.5 Sonnet, o1, or Gemini - all token consumption is unified and tracked.
+
 ## 🌌 Overview
 
-**VibeUsage** is an intelligent token usage tracking system designed specifically for macOS developers. Through the all-new **Matrix-A Design System**, it provides a high-fidelity cyberpunk-style dashboard that transforms your **AI Output** into quantifiable metrics, supported by the **Neural Divergence Map** for real-time monitoring of multi-model compute distribution.
+**VibeUsage** is an intelligent token usage tracking system designed for macOS developers. Through the all-new **Matrix-A Design System**, it provides a high-fidelity cyberpunk-style dashboard that transforms your **AI Output** into quantifiable metrics, supported by the **Neural Divergence Map** for real-time monitoring of multi-model compute distribution.
 
-> [!TIP] > **Core Index**: Our signature metric that reflects your flow state by analyzing token consumption rates and patterns.
+> [!TIP]
+> **Core Index**: Our signature metric that reflects your flow state by analyzing token consumption rates and patterns.
 
-## 🔒 Privacy-First Architecture (Stealth Protocol)
+## 📊 Dashboard Features
 
-We believe your code and thoughts are your own. VibeUsage is built with strict privacy pillars to ensure your data never leaves your control.
+### 🎨 Matrix-A Design System
+High-performance dashboard built with React + Vite, featuring our cyberpunk-inspired design language with:
+- **Neural Divergence Map**: Visualize multi-engine load balancing and compute distribution
+- **Cost Intelligence**: Real-time, multi-dimensional cost breakdown and forecasting
+- **Activity Heatmap**: GitHub-style contribution graph with streak tracking
+- **Smart Notifications**: Non-intrusive system-level alerts with Golden visual style
+
+### 📈 Analytics & Insights
+- **AI Analytics**: Deep analysis of Input/Output tokens with dedicated tracking for Cached and Reasoning components
+- **Model Breakdown**: Per-model usage statistics and cost analysis
+- **Project Stats**: Track token usage by GitHub repository
+- **Trend Forecasting**: Predict future usage patterns
 
-- 🛡️ **No Content Upload**: We never upload prompts or responses. We only compute token counts locally and send counts plus minimal metadata (timestamps, model, device).
-- 📡 **Local Aggregation**: All token consumption analysis happens on your machine. We only relay quantized 30-minute usage buckets to the cloud.
-- 🔐 **Hashed Identity**: Device tokens are hashed using SHA-256 server-side. Your raw credentials never exist in our database.
-- 🔦 **Full Transparency**: Audit the sync logic yourself in `src/lib/rollout.js`. We literally only capture numbers and timestamps.
-
-## 🚀 Key Features
-
-- 📡 **Auto-Sync**: Real-time interception of AI CLI pipes with **automatic background synchronization**. Once initialized, your tokens are tracked and synced without any manual commands.
-- 🧭 **Universal-Sync**: Native support for multiple AI CLI tools:
-  - **Codex CLI** - OpenAI's official CLI
-  - **Every Code** - Community Codex alternative
-  - **Gemini CLI** - Google's AI CLI
-  - **Opencode** - AI coding assistant
-  - **Claude Code** - Anthropic's official CLI
-  - Whether it's GPT-4, Claude 3.5 Sonnet, or o1/Gemini, token consumption from all models is unified and counted.
-- 📊 **Matrix Dashboard**: High-performance dashboard built with React + Vite, featuring the new **Matrix-A** design language.
-  - **Neural Divergence Map**: Visualize multi-engine load balancing and compute distribution.
-  - **Cost Intelligence**: Real-time, multi-dimensional cost breakdown and forecasting.
-  - **Activity Heatmap**: GitHub-style contribution graph with streak tracking.
-  - **Smart Notifications**: Non-intrusive system-level alerts using a Golden (Gold/Amber) visual style for high-value information.
-- ⚡ **AI Analytics**: Deep analysis of Input/Output tokens, with dedicated tracking for Cached and Reasoning components.
-- 📈 **Leaderboard**: Daily, weekly, monthly, and all-time rankings with privacy-safe display names.
-- 🌐 **Public View**: Share your AI usage journey with a privacy-safe public profile.
-- 📁 **Project Stats**: Track token usage by project/repository across all time.
-- 🔒 **Identity Core**: Robust authentication and permission management to secure your development data.
-
-### 🌌 Visual Preview
+### 🏆 Community Features
+- **Global Leaderboard**: Daily, weekly, monthly, and all-time rankings with privacy-safe display names
+- **Public Profiles**: Share your AI usage journey with a privacy-safe public profile
+- **Leaderboard Categories**: Compete in overall rankings or by specific models (GPT, Claude, etc.)
 
 <img src="docs/screenshots/landing.png" width="900" alt="VibeUsage Landing Preview"/>
 
-## 🛠️ Quick Start
+## 🔒 Privacy Guarantee
+
+We believe your code and thoughts are your own. VibeUsage is built with strict privacy pillars to ensure your data never leaves your control.
+
+| Protection | Description |
+|------------|-------------|
+| 🛡️ **No Content Upload** | Never upload prompts or responses - only compute token counts locally |
+| 📡 **Local Aggregation** | All analysis happens on your machine - only send 30-minute usage buckets |
+| 🔐 **Hashed Identity** | Device tokens are SHA-256 hashed server-side - raw credentials never stored |
+| 🔦 **Full Transparency** | Audit the sync logic yourself in `src/lib/rollout.js` - literally only numbers and timestamps |
+
+## 📦 Installation
 
-### Installation
+### Standard Setup
 
-Initialize your environment once and forget it. VibeUsage handles all synchronization in the background automatically.
+Initialize your environment once - VibeUsage handles all synchronization automatically in the background:
 
 ```bash
-npx --yes vibeusage init
+npx vibeusage init
 ```
 
-**Authentication Methods:**
+### Authentication Methods
 
 1. **Browser Auth** (default) - Opens browser for secure authentication
 2. **Link Code** - Use `--link-code` to authenticate via dashboard-generated code
 3. **Password** - Direct password authentication (fallback)
 4. **Access Token** - For CI/automated environments
 
-**CLI Options:**
-- `--yes` - Skip consent prompts in non-interactive environments
-- `--dry-run` - Preview changes without writing files
-- `--link-code <code>` - Authenticate using a link code from dashboard
-- `--base-url <url>` - Override the default API endpoint
+### CLI Options
+
+```bash
+npx vibeusage init [options]
+
+Options:
+  --yes              Skip consent prompts (non-interactive environments)
+  --dry-run          Preview changes without writing files
+  --link-code <code> Authenticate using a link code from dashboard
+  --base-url <url>   Override the default API endpoint
+  --debug            Enable debug output
+```
+
+### Auto-Configuration
 
-**Supported CLI Tools Auto-Configuration:**
+Once `init` completes, all supported CLI tools are automatically configured for data sync:
 
 | Tool | Config Location | Method |
 |------|----------------|--------|
-| Codex CLI | `~/.codex/config.toml` | `notify` hook |
-| Every Code | `~/.code/config.toml` (or `CODE_HOME`) | `notify` hook |
-| Gemini CLI | `~/.gemini/settings.json` (or `GEMINI_HOME`) | `SessionEnd` hook |
-| Opencode | Global plugins | Message parser plugin |
-| Claude Code | `~/.claude/hooks/` | Hook configuration |
+| **Codex CLI** | `~/.codex/config.toml` | `notify` hook |
+| **Every Code** | `~/.code/config.toml` (or `CODE_HOME`) | `notify` hook |
+| **Gemini CLI** | `~/.gemini/settings.json` (or `GEMINI_HOME`) | `SessionEnd` hook |
+| **Opencode** | Global plugins | Message parser plugin |
+| **Claude Code** | `~/.claude/hooks/` | Hook configuration |
+| **OpenClaw** | Auto-links when installed | Gateway hook (requires restart) |
+
+No further intervention required! 🎉
 
-Once `init` completes, all supported CLI tools are automatically configured for data sync. No further intervention required.
+## 💡 Usage
 
-### Sync & Status
+### Manual Sync
 
-While sync happens automatically, you can manually trigger a synchronization or check status anytime:
+While sync happens automatically, you can manually trigger synchronization anytime:
 
 ```bash
-# Manually sync latest local session data (Optional)
-npx --yes vibeusage sync
+# Manually sync latest local session data
+npx vibeusage sync
 
 # Check current link status
-npx --yes vibeusage status
+npx vibeusage status
 ```
 
-### Doctor
+### Health Check
+
+Run comprehensive diagnostics to identify issues:
 
 ```bash
-# Run health checks
-npx --yes vibeusage doctor
+# Basic health check
+npx vibeusage doctor
 
-# Emit JSON report (and write to file)
-npx --yes vibeusage doctor --json --out doctor.json
+# JSON output for debugging
+npx vibeusage doctor --json --out doctor.json
 
-# Override base URL (diagnostics only)
-npx --yes vibeusage doctor --base-url https://example.invalid
+# Test against a different endpoint
+npx vibeusage doctor --base-url https://your-instance.insforge.app
+```
+
+### Debug Mode
+
+Enable debug output to see detailed request/response information:
+
+```bash
+VIBEUSAGE_DEBUG=1 npx vibeusage sync
+# or
+npx vibeusage sync --debug
 ```
 
 ### Uninstall
 
 ```bash
 # Standard uninstall (keeps data)
-npx --yes vibeusage uninstall
+npx vibeusage uninstall
 
 # Full purge - removes all data including config and cached sessions
-npx --yes vibeusage uninstall --purge
+npx vibeusage uninstall --purge
+```
+
+## 🏗️ Architecture
+
+```mermaid
+graph LR
+    A[Codex CLI] -->|Rollout Logs| G(Tracker CLI)
+    B[Every Code] -->|Rollout Logs| G
+    C[Gemini CLI] -->|Session Logs| G
+    D[Opencode] -->|Message Logs| G
+    E[Claude Code] -->|Hook Output| G
+    F[OpenClaw] -->|Gateway Hook| G
+    G -->|AI Tokens| H{Core Relay}
+    H --> I[VibeUsage Dashboard]
+    H --> J[AI Analytics Engine]
+    H --> K[Leaderboard Service]
+    H --> L[Public View API]
 ```
 
+### Tech Stack
+
+- **CLI**: Node.js 20.x, CommonJS
+- **Dashboard**: React 18 + Vite + TailwindCSS + TypeScript
+- **Backend**: InsForge Edge Functions (Deno)
+- **Database**: InsForge Database (PostgreSQL)
+- **Design**: Matrix-A Design System
+
+### Components
+
+- **Tracker CLI** (`src/`): Node.js CLI that parses logs from multiple AI tools and syncs token data
+- **Core Relay** (InsForge Edge Functions): Serverless backend handling ingestion, aggregation, and API
+- **Dashboard** (`dashboard/`): React + Vite frontend for visualization
+- **AI Analytics Engine**: Cost calculation, model breakdown, and usage forecasting
+
+### Data Flow
+
+1. AI CLI tools generate logs during usage
+2. Local `notify-handler` detects changes and triggers sync
+3. CLI incrementally parses logs, extracts token counts (whitelist fields only)
+4. Data aggregated into 30-minute UTC buckets locally
+5. Batch upload to InsForge with idempotent deduplication
+6. Dashboard queries aggregated results for visualization
+
 ### Log Sources
 
 | Tool | Log Location | Override Env |
 |------|-------------|--------------|
-| Codex CLI | `~/.codex/sessions/**/rollout-*.jsonl` | `CODEX_HOME` |
-| Every Code | `~/.code/sessions/**/rollout-*.jsonl` | `CODE_HOME` |
-| Gemini CLI | `~/.gemini/tmp/**/chats/session-*.json` | `GEMINI_HOME` |
-| Opencode | `~/.opencode/messages/*.json` | - |
-| Claude Code | Parsed from hook output | - |
+| **Codex CLI** | `~/.codex/sessions/**/rollout-*.jsonl` | `CODEX_HOME` |
+| **Every Code** | `~/.code/sessions/**/rollout-*.jsonl` | `CODE_HOME` |
+| **Gemini CLI** | `~/.gemini/tmp/**/chats/session-*.json` | `GEMINI_HOME` |
+| **Opencode** | `~/.opencode/messages/*.json` | - |
+| **Claude Code** | Parsed from hook output | - |
+| **OpenClaw** | Gateway hook integration | - |
+
+## ⚙️ Configuration
 
-## 🔧 Environment Variables
+<details>
+<summary><b>Environment Variables</b></summary>
 
 ### Core Settings
 
@@ -166,43 +271,28 @@ npx --yes vibeusage uninstall --purge
 | `CODE_HOME` | Every Code directory override | `~/.code` |
 | `GEMINI_HOME` | Gemini CLI directory override | `~/.gemini` |
 
-### Deprecated
-
-- `VIBEUSAGE_ROLLUP_ENABLED`: Currently ignored; rollup aggregation is disabled pending table deployment.
-
-## 🧰 Troubleshooting
-
-### Debug Mode
-
-Enable debug output to see detailed request/response information:
-
-```bash
-VIBEUSAGE_DEBUG=1 npx --yes vibeusage sync
-# or
-npx --yes vibeusage sync --debug
-```
+</details>
 
-### Health Check
+## 🔧 Troubleshooting
 
-Run the built-in doctor command to diagnose issues:
+<details>
+<summary><b>Data not appearing in Dashboard</b></summary>
 
-```bash
-# Basic health check
-npx --yes vibeusage doctor
+1. Check status: `npx vibeusage status`
+2. Force manual sync: `npx vibeusage sync`
+3. Verify CLI tool hooks are configured (re-run `init` if needed)
+4. Check debug output: `VIBEUSAGE_DEBUG=1 npx vibeusage sync`
 
-# JSON output for debugging
-npx --yes vibeusage doctor --json --out doctor.json
+</details>
 
-# Test against a different endpoint
-npx --yes vibeusage doctor --base-url https://your-instance.insforge.app
-```
+<details>
+<summary><b>Streak shows 0 days while totals look correct</b></summary>
 
-### Streak shows 0 days while totals look correct
+Streak is defined as consecutive days ending today. If today's total is 0, streak will be 0.
 
-- Streak is defined as consecutive days ending today. If today's total is 0, streak will be 0.
-- If you expect a non-zero streak, clear cached auth/heatmap data and sign in again:
+If you expect a non-zero streak, clear cached auth/heatmap data and sign in again:
 
-```js
+```javascript
 localStorage.removeItem("vibeusage.dashboard.auth.v1");
 Object.keys(localStorage)
   .filter((k) => k.startsWith("vibeusage.heatmap."))
@@ -210,115 +300,158 @@ Object.keys(localStorage)
 location.reload();
 ```
 
-- Complete the landing page sign-in flow again after reload.
-- Note: `insforge-auth-token` is not used by the dashboard; use `vibeusage.dashboard.auth.v1`.
-
-### Sync Issues
+Complete the landing page sign-in flow again after reload.
 
-If data isn't appearing in the dashboard:
+Note: `insforge-auth-token` is not used by the dashboard; use `vibeusage.dashboard.auth.v1`.
 
-1. Check status: `npx --yes vibeusage status`
-2. Force manual sync: `npx --yes vibeusage sync`
-3. Verify CLI tool hooks are configured (re-run `init` if needed)
-4. Check debug output: `VIBEUSAGE_DEBUG=1 npx vibeusage sync`
+</details>
 
-### Timeout Errors
+<details>
+<summary><b>Timeout errors on slow connections</b></summary>
 
 Increase HTTP timeout for slow connections:
 
 ```bash
-VIBEUSAGE_HTTP_TIMEOUT_MS=60000 npx --yes vibeusage sync
+VIBEUSAGE_HTTP_TIMEOUT_MS=60000 npx vibeusage sync
 ```
 
-## 🏗️ Architecture
+</details>
 
-```mermaid
-graph TD
-    A[Codex CLI] -->|Rollout Logs| F(Tracker CLI)
-    B[Every Code] -->|Rollout Logs| F
-    C[Gemini CLI] -->|Session Logs| F
-    D[Opencode] -->|Message Logs| F
-    E[Claude Code] -->|Hook Output| F
-    F -->|AI Tokens| G{Core Relay}
-    G --> H[VibeUsage Dashboard]
-    G --> I[AI Analytics Engine]
-    G --> J[Leaderboard Service]
-    G --> K[Public View API]
-```
+## 💻 Development
 
-### Components
-
-- **Tracker CLI** (`src/`): Node.js CLI that parses logs from multiple AI tools and syncs token data
-- **Core Relay** (InsForge Edge Functions): Serverless backend handling ingestion, aggregation, and API
-- **Dashboard** (`dashboard/`): React + Vite frontend for visualization
-- **AI Analytics Engine**: Cost calculation, model breakdown, and usage forecasting
-
-## 💻 Developer Guide
-
-To run locally or contribute:
-
-### Dashboard Development
+### Local Development
 
 ```bash
+# Clone the repository
+git clone https://github.com/your-username/vibeusage.git
+cd vibeusage
+
 # Install dependencies
-cd dashboard
 npm install
 
-# Start dev server
+# Start dashboard dev server
+cd dashboard
+npm install
 npm run dev
 ```
 
-### Debug Payload (Usage Endpoints)
-
-When `debug=1` is included in a usage endpoint request, the response adds a `debug` object that helps the dashboard attribute slow queries without relying on response headers.
-
-```ts
-const res = await fetch(
-  `${baseUrl}/functions/vibeusage-usage-summary?from=2025-12-30&to=2025-12-30&debug=1`,
-  {
-    headers: { Authorization: `Bearer ${userJwt}` }
-  }
-);
-const data = await res.json();
-
-if (data.debug) {
-  console.debug('usage debug', {
-    requestId: data.debug.request_id,
-    status: data.debug.status,
-    queryMs: data.debug.query_ms,
-    slowThresholdMs: data.debug.slow_threshold_ms,
-    slowQuery: data.debug.slow_query
-  });
-}
-```
-
-### Architecture Validation
+### Development Commands
 
 ```bash
-# Validate Copy Registry
+# Run tests
+npm test
+
+# Run local CI checks
+npm run ci:local
+
+# Validate copy registry
 npm run validate:copy
 
+# Validate UI hardcoded text
+npm run validate:ui-hardcode
+
+# Validate architecture guardrails
+npm run validate:guardrails
+
+# Build backend functions
+npm run build:insforge
+
+# Check backend build (no write)
+npm run build:insforge:check
+
 # Run smoke tests
 npm run smoke
 ```
 
-### Architecture Canvas Focus
+### OpenSpec Workflow
+
+This project uses **OpenSpec** for spec-driven development. Before making significant changes:
+
+1. Read [`openspec/project.md`](openspec/project.md) for project conventions
+2. Check [`openspec/AGENTS.md`](openspec/AGENTS.md) for the full OpenSpec workflow
+3. Run `openspec list` to see active changes
+4. Run `openspec list --specs` to see existing specifications
+
+See [CLAUDE.md](CLAUDE.md) for detailed guidelines.
+
+### Architecture Validation
 
 ```bash
-# Generate a focused canvas for a top-level module
-node scripts/ops/architecture-canvas.cjs --focus src
+# Validate Copy Registry
+npm run validate:copy
+
+# Generate architecture canvas
+npm run architecture:canvas
 
-# Alias: --module
-node scripts/ops/architecture-canvas.cjs --module dashboard
+# Generate focused canvas for a module
+npm run architecture:canvas:focus -- src
 ```
 
+## 🗺️ Roadmap
+
+- [ ] Windows support
+- [ ] Linux support
+- [ ] Enhanced project-level statistics
+- [ ] Team collaboration features
+- [ ] Custom report exports
+- [ ] Additional AI CLI support
+
+See [Issues](https://github.com/your-username/vibeusage/issues) for detailed plans.
+
+## 🤝 Contributing
+
+We welcome all forms of contributions!
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Create a Pull Request
+
+### Development Guidelines
+
+- All user-facing text must be registered in `dashboard/src/content/copy.csv`
+- Follow the OpenSpec proposal process for significant changes
+- Code must pass all tests and validations
+- See [CLAUDE.md](CLAUDE.md) for detailed conventions
+
 ## 📜 License
 
 This project is licensed under the [MIT License](LICENSE).
 
+## 🙏 Acknowledgments
+
+- [InsForge](https://insforge.app) - Backend infrastructure
+- [Matrix-A Design System](docs/dashboard/matrix-a.md) - UI framework
+- All our amazing contributors
+
 ---
 
 <div align="center">
-  <b>System_Ready // 2024 VibeUsage OS</b><br/>
-  <i>"More Tokens. More Vibe."</i>
+  <b>System_Ready // 2024-2026 VibeUsage</b><br/>
+  <i>"Quantify Your AI Output. Own Your Data."</i><br/><br/>
+
+  Made with 💚 by developers, for developers
+
+  [Website](https://www.vibeusage.cc) •
+  [Dashboard](https://www.vibeusage.cc) •
+  [Docs](docs/) •
+  [API](BACKEND_API.md)
 </div>
+
+
+## AI Agent 快速安装
+
+复制以下内容发送给你的 AI 助手：
+
+```
+请帮我安装 VibeUsage 来追踪 AI Token 用量。
+
+执行以下命令：
+npx --yes vibeusage init
+
+安装完成后验证：
+vibeusage status
+```
+
+或者查看完整指南: https://github.com/victorGPT/vibeusage/blob/main/docs/AI_AGENT_INSTALL.md