robot-resources 1.6.1 → 1.7.1

package/README.md

@@ -1,73 +1,105 @@
-# robot-resources — Unified Installer
+# Robot Resources
 
-One command to install all Robot Resources tools:
+> Tools for AI agents. Humans have HR. Agents have RR.
 
-```
+Robot Resources builds tools for AI agents and any software that makes LLM API calls — chatbots, RAG pipelines, AI-powered apps, internal tools. Two products today: **Router** (intelligent model routing, 60-90% cost savings) and **Scraper** (token compression for web content, median 91% token reduction). Both run locally, both free.
+
+## Quick Start
+
+```bash
 npx robot-resources
 ```
 
-## What the wizard does
-
-1. **GitHub OAuth** — authenticates via PKCE, saves API key to `~/.robot-resources/config.json`
-2. **Router install** — detects Python 3.10+, creates venv, pip installs `robot-resources-router`
-3. **Service registration** — registers router as launchd (macOS) or systemd (Linux) service
-4. **Scraper** — installs @robot-resources/scraper for token-efficient web compression
+One command: authenticates via GitHub OAuth, installs Router as an always-on service, registers Scraper as the default web compression tool, and configures your agent automatically.
 
-## Adding a new tool
+## Products
 
-When you build a new product for RR, follow this checklist:
+### Router
 
-### 1. Create the npx entry point
+Intelligent LLM routing proxy. Classifies each prompt by task type, filters by model capability, routes to the cheapest model that qualifies.
 
-Your tool needs an npm package with a `bin` entry that runs a setup wizard. Two patterns:
+- Hybrid classification: keyword detection (~5ms) + LLM fallback for ambiguous prompts (~200ms)
+- Dynamic thresholds: simple tasks open cheap models (0.60), complex tasks require top models (0.85)
+- 11 models across OpenAI, Anthropic, and Google — routes within your available providers
+- 60-90% cost savings with zero quality loss
+- OpenAI-compatible API on localhost:3838 — change your base_url and you're done
+- OpenClaw compatible — plugin auto-installs, works with API keys and subscriptions
 
-- **Node.js tool:** Add `bin` to your package.json pointing to a setup script
-- **Python tool:** Create a thin npm wrapper (like `router/packages/router/`) that handles pip install
+```bash
+npx @robot-resources/router
+```
 
-The wizard should:
-- Check `~/.robot-resources/config.json` — offer login if missing
-- Install the tool
-- Configure MCP if applicable
-- Print usage instructions
+### Scraper
 
-### 2. Update the unified wizard
+Token compression for web content. Fetches any URL, strips noise, returns clean markdown with token count.
 
-Edit `packages/cli/lib/wizard.js` to add your tool as a new step between service registration and MCP config.
+- Mozilla Readability extraction (0.97 F1 accuracy)
+- Content-aware token estimation (±15% of actual BPE)
+- 3-tier fetch: fast, stealth (TLS fingerprint), render (headless browser)
+- Multi-page BFS crawl with robots.txt compliance
+- Median 91% token reduction per page
 
-### 3. Update the landing page
+Installed automatically via `npx robot-resources`. Available as MCP tool `scraper_compress_url(url)` in your agent.
 
-| File | What to change |
-|------|---------------|
-| `web/src/pages/Landing/types.ts` | Add install subsection if new section |
-| `web/src/pages/Landing/components/ContentPanel/animatedContentScreens.ts` | Add install screen (desktop + mobile) |
-| `web/src/pages/Landing/components/TerminalPanel/terminalCommands.ts` | Add install subcommand output |
+### Dashboard
 
-### 4. Update agent-facing content
+Usage dashboard with real-time telemetry. Auth via GitHub OAuth, KPI panels, routing stats, cost savings tracking. Mobile-responsive.
 
-| File | What to change |
-|------|---------------|
-| `web/public/llms.txt` | Add tool with `npx @robot-resources/<tool>` |
-| `web/public/llms-full.txt` | Add detailed section with npx install |
-| `web/public/.well-known/ai-resources.json` | Add SoftwareApplication entry with InstallAction |
+### MCP Servers
 
-### 5. Update the publish workflow
+Both products include MCP servers for AI agent integration:
 
-Add your package.json path to `.github/workflows/publish.yml` triggers and add a publish step.
+```bash
+npx -y @robot-resources/router-mcp    # Router stats + config
+npx -y @robot-resources/scraper-mcp   # Scraper compression
+```
 
-### 6. Add to root workspaces
+## Pricing
 
-Add your package directory to the `workspaces` array in the root `package.json`.
+Free. Unlimited. No tiers. Both tools run locally — you pay your AI providers directly. No markup, no rate limits, no quotas. Your API keys never leave your machine.
 
-## Architecture
+## Monorepo Structure
 
 ```
-packages/cli-core/    Shared auth, config, login (private — never published)
-packages/cli/         This package (published as "robot-resources" on npm)
-  bin/setup.js        Entry point
-  lib/wizard.js       Orchestrator — add new tools here
-  lib/service.js      launchd + systemd service registration
-  lib/python-bridge.js  Python venv management
-  lib/detect.js       Environment detection
-  lib/tool-config.js  OpenClaw plugin + model activation
-  lib/ui.js           Terminal formatting
+robot-resources/
+├── router/         # LLM routing proxy (Python + TypeScript MCP)
+├── scraper/        # Token compression (TypeScript)
+├── web/            # Landing page + dashboard (React/Vite)
+├── platform/       # Backend API — auth, telemetry (Hono/Cloudflare Workers)
+├── packages/       # Unified CLI installer (npx robot-resources)
+├── skills/         # Agent skills (ClawHub)
+├── _orchestrator/  # Business coordination
+└── _brand/         # Brand assets and design system
 ```
+
+## Development
+
+Each product has its own setup:
+
+- [Router](./router/README.md)
+- [Scraper](./scraper/packages/scraper/README.md)
+- [Platform](./platform/README.md)
+- [CLI](./packages/cli/README.md)
+
+## CI/CD
+
+Unified pipeline on push/PR to main:
+
+- **Router**: ruff, mypy, pytest
+- **Scraper**: tsc, vitest
+- **Web**: tsc, eslint
+- **Publish**: 7 npm packages via OIDC (`router`, `router-mcp`, `scraper`, `scraper-mcp`, `scraper-tracking`, `cli-core`, `cli`)
+
+## Links
+
+- Website: https://robotresources.ai
+- GitHub: https://github.com/robot-resources
+- npm: `npx robot-resources`
+- Twitter/X: https://x.com/robotresources
+- Discord: https://robotresources.ai/discord
+- Contact: agent@robotresources.ai
+- Agent docs: https://robotresources.ai/llms.txt
+
+## License
+
+MIT

package/lib/wizard.js

@@ -69,14 +69,12 @@ export async function runWizard({ nonInteractive = false } = {}) {
 
         if (res.ok) {
           const { data } = await res.json();
-          if (data.api_key !== 'existing') {
-            writeConfig({
-              api_key: data.api_key,
-              key_id: data.key_id,
-              claim_url: data.claim_url,
-              signup_source: 'auto',
-            });
-          }
+          writeConfig({
+            api_key: data.api_key,
+            key_id: data.key_id,
+            claim_url: data.claim_url,
+            signup_source: 'auto',
+          });
           results.auth = true;
           results.authMethod = 'auto';
           results.claimUrl = data.claim_url;
@@ -267,6 +265,38 @@ export async function runWizard({ nonInteractive = false } = {}) {
     }
   }
 
+  // ── Install Complete Telemetry ───────────────────────────────────────────
+  //
+  // Fire once after install, using the API key directly (not from config read-back).
+  // This immediately populates last_used_at and proves the key works end-to-end.
+
+  if (results.auth) {
+    try {
+      const config = readConfig();
+      const platformUrl = process.env.RR_PLATFORM_URL || 'https://api.robotresources.ai';
+      await fetch(`${platformUrl}/v1/telemetry`, {
+        method: 'POST',
+        headers: {
+          'Authorization': `Bearer ${config.api_key}`,
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+          product: 'cli',
+          event_type: 'install_complete',
+          payload: {
+            router: results.router || false,
+            service: results.service || false,
+            scraper: results.scraper || false,
+            source: 'wizard',
+          },
+        }),
+        signal: AbortSignal.timeout(5_000),
+      });
+    } catch {
+      // Non-fatal — install_complete is best-effort
+    }
+  }
+
   // ── Summary ─────────────────────────────────────────────────────────────
 
   const somethingInstalled = results.router || results.service || results.scraper;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "robot-resources",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "Robot Resources — AI agent runtime tools. One command to install everything.",
   "type": "module",
   "bin": {
@@ -19,7 +19,7 @@
   "dependencies": {
     "@robot-resources/cli-core": "*",
     "@robot-resources/openclaw-plugin": "*",
-    "@robot-resources/scraper": "^0.2.0"
+    "@robot-resources/scraper": "^0.3.0"
   },
   "devDependencies": {
     "vitest": "^1.2.0"