openclaw-smartmeter 0.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,148 @@
+# Contributing to SmartMeter
+
+Thank you for your interest in contributing to SmartMeter. This guide will help you get started.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js 18+
+- npm 9+
+- Git
+
+### Setup
+
+```bash
+git clone https://github.com/vajih/openclaw-smartmeter.git
+cd openclaw-smartmeter
+npm install
+npm test
+```
+
+All 93+ tests should pass before you begin making changes.
+
+## Development Workflow
+
+### 1. Create a Branch
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+Use descriptive branch names:
+- `feature/` for new features
+- `fix/` for bug fixes
+- `docs/` for documentation changes
+- `refactor/` for code restructuring
+
+### 2. Make Changes
+
+Follow existing code patterns:
+- **ESM modules** (`import`/`export`, not `require`)
+- **Async/await** for all asynchronous operations
+- **Node.js built-in test runner** (`node:test` and `node:assert/strict`)
+- **No unnecessary dependencies** - prefer Node.js built-ins where possible
+
+### 3. Write Tests
+
+Every new feature or bug fix should include tests:
+
+```javascript
+import test from "node:test";
+import assert from "node:assert/strict";
+
+test("descriptive test name", async () => {
+  // Arrange
+  // Act
+  // Assert
+});
+```
+
+Run tests with:
+```bash
+npm test                          # All tests
+node --test tests/parser.test.js  # Single file
+```
+
+### 4. Submit a Pull Request
+
+- Ensure all tests pass
+- Write a clear PR description explaining the change
+- Reference any related issues
+
+## Project Structure
+
+```
+src/
+  analyzer/         # Phase 1: Analysis engine
+    parser.js       #   JSONL session parser
+    classifier.js   #   Task classification
+    aggregator.js   #   Statistics aggregation
+    recommender.js  #   Optimization recommendations
+    storage.js      #   Analysis persistence
+  generator/        # Phase 2: Config generator
+    config-builder.js
+    agent-creator.js
+    merger.js
+    validator.js
+  canvas/           # Canvas dashboard
+    deployer.js     #   Dashboard deployment
+  cli/              # Phase 3: CLI interface
+    index.js        #   Commander.js entry point
+    commands.js     #   Command handlers
+    utils.js        #   Formatting helpers
+tests/              # Test files (mirror src/ structure)
+canvas-template/    # Dashboard HTML/JS/CSS templates
+docs/               # Documentation
+examples/           # Sample data files
+```
+
+## Code Style
+
+- Use `const` by default, `let` when reassignment is needed
+- Prefer early returns over deep nesting
+- Keep functions small and focused
+- No semicolons are fine, but be consistent within a file (this project uses semicolons)
+- No comments for self-explanatory code; add JSDoc for public APIs
+
+## Architecture Guidelines
+
+### SPEC.md is the Source of Truth
+
+All feature work should align with `SPEC.md`. Before adding new functionality:
+
+1. Check `docs/SPEC_ALIGNMENT.md` to see what's implemented
+2. Check `docs/backlog.md` for deferred items
+3. If your feature isn't in the SPEC, open an issue to discuss it first
+
+### Pipeline Pattern
+
+The analysis pipeline flows in one direction:
+
+```
+parser -> classifier -> aggregator -> recommender -> storage
+```
+
+Each module receives data from the previous stage and returns a new object (no mutation). This makes testing and debugging straightforward.
+
+### Testability
+
+Command handlers accept an `opts` parameter for dependency injection:
+
+```javascript
+// Production: uses default paths
+await cmdAnalyze();
+
+// Testing: uses temp directories
+await cmdAnalyze({ baseDir: tmpDir, storageDir: tmpStorage });
+```
+
+## Reporting Issues
+
+- Use GitHub Issues for bug reports and feature requests
+- Include Node.js version, OS, and steps to reproduce
+- For security issues, see [SECURITY.md](SECURITY.md)
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Vajih Khan
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,275 @@
+<p align="center">
+  <h1 align="center">SmartMeter</h1>
+  <p align="center">
+    <strong>AI cost optimization for OpenClaw</strong>
+  </p>
+  <p align="center">
+    Analyze your AI usage patterns. Generate optimized configs. Cut costs by 48%+.
+  </p>
+  <p align="center">
+    <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License: Apache 2.0"></a>
+    <a href="#"><img src="https://img.shields.io/badge/Node.js-18%2B-green.svg" alt="Node.js 18+"></a>
+    <a href="#"><img src="https://img.shields.io/badge/Tests-93%20passing-brightgreen.svg" alt="Tests: 93 passing"></a>
+  </p>
+</p>
+
+---
+
+## What is SmartMeter?
+
+SmartMeter is a cost optimization skill for [OpenClaw](https://openclaw.ai) that analyzes your AI agent usage and generates optimized configurations to reduce API spending — without sacrificing quality.
+
+It parses your session logs, classifies tasks by type, identifies which models are overkill for routine work, and generates a tuned `openclaw.json` that routes the right tasks to the right models.
+
+### Real-World Results
+
+Tested on live OpenClaw data (288 tasks across 9 sessions):
+
+| Metric | Value |
+|---|---|
+| Current monthly projection | $59.97 |
+| Optimized monthly projection | $31.14 |
+| **Potential savings** | **$28.82/month (48.1%)** |
+| Models analyzed | DeepSeek Chat, Claude Sonnet 4.5, Claude Opus 4.5 |
+| Confidence | Optimistic (2 days of data; improves with 14+ days) |
+
+The key insight: DeepSeek Chat handled 69% of tasks at 1/5th the cost of premium models, while Opus was only needed for 15% of complex work.
+
+## Features
+
+- **Usage Analysis** — Parse JSONL session logs, extract model usage, token counts, costs, and cache performance across all agents
+- **Task Classification** — Automatically categorize tasks into code, writing, research, config, and other using keyword-based classification
+- **Cost Optimization** — Identify where expensive models are being used for simple tasks and recommend cheaper alternatives
+- **Config Generation** — Generate production-ready `openclaw.json` with primary model, fallback chains, specialized agents, budget controls, and caching settings
+- **Live Dashboard** — Interactive web dashboard deployed to OpenClaw Canvas with auto-refresh, charts, and actionable recommendations
+- **Safe Rollback** — Every config change creates a timestamped backup; one command to roll back
+- **CLI Interface** — 8 commands covering the full workflow from analysis to deployment
+
+## Installation
+
+```bash
+git clone https://github.com/vajih/openclaw-smartmeter.git
+cd openclaw-smartmeter
+npm install
+```
+
+To make the `smartmeter` command available globally:
+
+```bash
+npm link
+```
+
+## Quick Start
+
+### 1. Analyze your usage
+
+```bash
+# Analyze default OpenClaw data (~/.openclaw)
+smartmeter analyze
+
+# Or point to a specific data directory
+smartmeter analyze --data-dir ~/my-openclaw-data
+```
+
+Output:
+```
+Analysis: 2026-02-04 to 2026-02-05 (2 days)
+
+  Total tasks               288
+  Total cost                $4.00
+  Monthly cost (projected)  $59.97
+  Optimized monthly cost    $31.14
+  Potential savings         $28.82/month (48.1%)
+  Confidence                optimistic
+```
+
+### 2. Preview recommended changes
+
+```bash
+smartmeter preview --data-dir ~/my-openclaw-data
+```
+
+```
+Proposed changes:
+  - Primary model: (none) -> deepseek/deepseek-chat
+  - Fallback chain: delivery-mirror -> anthropic/claude-sonnet-4.5 -> anthropic/claude-opus-4.5
+  - New agents: code-reviewer
+  - Budget: $2.40/day, $16.80/week
+```
+
+### 3. View the full generated config
+
+```bash
+smartmeter show --data-dir ~/my-openclaw-data
+```
+
+### 4. Apply the optimized config
+
+```bash
+smartmeter apply --data-dir ~/my-openclaw-data
+```
+
+This creates a backup of your current config before writing the new one.
+
+### 5. Launch the dashboard
+
+```bash
+smartmeter dashboard
+```
+
+Opens an interactive web dashboard in your browser with:
+- Cost savings overview with confidence indicators
+- Model usage breakdown (bar chart)
+- Task classification distribution (doughnut chart)
+- Actionable recommendations with impact estimates
+- Auto-refresh every 5 seconds
+
+### 6. Roll back if needed
+
+```bash
+smartmeter rollback
+```
+
+## CLI Reference
+
+| Command | Description |
+|---|---|
+| `smartmeter analyze` | Run full analysis pipeline and save results |
+| `smartmeter show` | Display the generated optimized config as JSON |
+| `smartmeter preview` | Show what would change without applying |
+| `smartmeter apply` | Apply optimized config (creates backup first) |
+| `smartmeter rollback` | Restore the most recent backup config |
+| `smartmeter status` | Show current optimization status from stored analysis |
+| `smartmeter report` | Detailed breakdown: models, categories, temporal, caching |
+| `smartmeter dashboard` | Deploy and open the web dashboard |
+
+**Global options** for commands that run analysis:
+- `-d, --data-dir <path>` — OpenClaw data directory (default: `~/.openclaw`)
+
+**Dashboard options:**
+- `-p, --port <number>` — OpenClaw gateway port (default: 8080)
+- `--no-open` — Don't open browser automatically
+
+## Screenshots
+
+### Dashboard Overview
+![SmartMeter Dashboard](docs/screenshots/dashboard-overview.png)
+*Live-updating dashboard with cost savings, model breakdown, and actionable recommendations*
+
+### Cost Savings Analysis
+![Cost Savings](docs/screenshots/dashboard-hero.png)
+*Real-time savings calculation showing 48% cost reduction with confidence indicators*
+
+### Interactive Analytics
+![Analytics Charts](docs/screenshots/dashboard-charts.png)
+*Model usage breakdown and task classification powered by Chart.js*
+
+## How It Works
+
+SmartMeter processes your data through a four-stage pipeline:
+
+```
+Session Logs (.jsonl)
+        |
+   [ Parser ]          Stream-parse JSONL, extract assistant messages,
+        |               pair with user prompts, normalize content formats
+        v
+  [ Classifier ]        Keyword-based task categorization into
+        |               code / write / research / config / other
+        v
+  [ Aggregator ]        Per-model and per-category statistics,
+        |               temporal patterns, caching metrics
+        v
+  [ Recommender ]       Per-category model recommendations,
+        |               savings calculations, confidence scoring
+        v
+  [ Config Generator ]  Optimized openclaw.json with model routing,
+                        agents, budgets, caching, fallback chains
+```
+
+### What gets optimized
+
+1. **Primary Model** — Switch to the cheapest model that handles your dominant workload
+2. **Specialized Agents** — Auto-create agents for high-volume categories (e.g., a `code-reviewer` agent using DeepSeek for code tasks)
+3. **Fallback Chains** — Ordered by cost so expensive models are only used when needed
+4. **Budget Controls** — Daily/weekly caps with alert thresholds to prevent runaway costs
+5. **Caching** — Long retention and heartbeat settings for burst usage patterns
+6. **Skill Routing** — Ready for per-skill model assignment (awaiting skill log format)
+
+## Architecture
+
+```
+src/
+  analyzer/             # Phase 1: Analysis engine
+    parser.js           #   JSONL stream parser with content normalization
+    classifier.js       #   Keyword-based task classifier
+    aggregator.js       #   Statistics aggregation
+    recommender.js      #   Optimization recommendations
+    storage.js          #   Analysis persistence
+  generator/            # Phase 2: Config generator
+    config-builder.js   #   Main orchestrator
+    agent-creator.js    #   Specialized agent creation
+    merger.js           #   Deep merge utility
+    validator.js        #   Config validation
+  canvas/               # Canvas dashboard
+    deployer.js         #   Dashboard deployment and public data generation
+  cli/                  # Phase 3: CLI interface
+    index.js            #   Commander.js entry point (8 commands)
+    commands.js         #   Command handlers
+    utils.js            #   Formatting helpers
+tests/                  # 93 tests across all modules
+canvas-template/        # Dashboard HTML/JS/CSS
+docs/                   # SPEC alignment, backlog, dashboard docs
+```
+
+## Testing
+
+```bash
+# Run all tests
+npm test
+
+# Run a specific test file
+node --test tests/parser.test.js
+
+# Run with verbose output
+node --test --reporter spec tests/*.test.js
+```
+
+93 tests covering parser, classifier, aggregator, recommender, storage, config generator, and CLI commands.
+
+## Documentation
+
+- [SPEC.md](SPEC.md) — Full project specification (source of truth)
+- [docs/SPEC_ALIGNMENT.md](docs/SPEC_ALIGNMENT.md) — Implementation status for each SPEC requirement
+- [docs/backlog.md](docs/backlog.md) — Deferred features and future phases
+- [docs/CANVAS_DASHBOARD.md](docs/CANVAS_DASHBOARD.md) — Dashboard quick start guide
+- [docs/CANVAS_BUILD_NOTES.md](docs/CANVAS_BUILD_NOTES.md) — Dashboard build notes
+- [CONTRIBUTING.md](CONTRIBUTING.md) — Contribution guidelines
+- [SECURITY.md](SECURITY.md) — Security policy
+
+## Roadmap
+
+- [x] **Phase 1** — Analysis Engine (parser, classifier, aggregator, recommender)
+- [x] **Phase 2** — Config Generator (model optimization, agents, budgets, caching)
+- [x] **Phase 3** — CLI Interface (8 commands with `--data-dir` support)
+- [x] **Canvas Dashboard** — Interactive web dashboard with charts and recommendations
+- [ ] **Phase 4** — OpenRouter API integration for live pricing
+- [ ] **Phase 5** — Telegram alerts and notifications
+- [ ] **Phase 6** — Chrome extension for real-time monitoring
+
+## Author
+
+**Vajih Khan**
+- LinkedIn: [linkedin.com/in/vajihkhan](https://www.linkedin.com/in/vajihkhan/)
+- Twitter: [@vajih](https://twitter.com/vajih)
+- GitHub: [@vajih](https://github.com/vajih)
+
+Built with 30+ years of experience in technology innovation, product development, and AI optimization.
+
+## License
+
+[Apache License 2.0](LICENSE)
+
+---
+
+Built with [OpenClaw](https://openclaw.ai) and [Claude Code](https://claude.ai/claude-code)