@cc-soul/openclaw 1.0.0 → 1.0.1

package/README.md

@@ -259,19 +259,28 @@ All data in `~/.openclaw/hooks/cc-soul/data/` (survives updates):
 
 ---
 
-## Self-Upgrade System
+## Telemetry
 
-⚠️ **Default: OFF.** Enable with `开启 self_upgrade` or set `"self_upgrade": true` in features.json.
+cc-soul collects **anonymous usage statistics** to help improve the product. No chat content, no personal information — only aggregate numbers.
 
-When enabled, cc-soul can modify its own code:
+**What's sent (once per day):**
+- Hashed instance ID (not your real ID)
+- Total message count, memory count
+- Average quality score, correction count
+- Number of enabled features
+- Days active
 
-1. **Analyze** — Reviews eval data, epistemic calibration, correction attributions
-2. **Propose** — Suggests improvements, notifies owner for approval
-3. **Execute** — 3-agent pipeline: analyze → design+review → execute
-4. **Verify** — esbuild syntax check + 3-day observation period
-5. **Rollback** — Auto-rollback if quality drops
+**What's NOT sent:**
+- ❌ Chat messages or conversation content
+- ❌ Memory contents
+- ❌ User profiles or personal info
+- ❌ API keys or credentials
 
-Protected by 21 architecture rules (cannot modify upgrade.ts itself, cannot add dependencies, cannot delete data, etc.).
+**Disable anytime:**
+```
+关闭 telemetry
+```
+Or set `"telemetry": false` in `data/features.json`.
 
 ---
 

package/cc-soul/features.js

@@ -23,7 +23,9 @@ const DEFAULTS = {
   self_upgrade: false,
   // 默认关闭 — 用户需要显式开启才能让 cc 改自己的代码
   federation: true,
-  sync: true
+  sync: true,
+  telemetry: true
+  // 匿名使用统计，用户可关闭
 };
 let features = { ...DEFAULTS };
 function loadFeatures() {

package/cc-soul/handler.js

@@ -99,6 +99,7 @@ import { updateFingerprint, checkPersonaConsistency, loadFingerprint, getCachedD
 import { loadSyncConfig, autoSync, handleSyncCommand } from "./sync.ts";
 import { autoFederate, reportBadKnowledge } from "./federation.ts";
 import { loadFeatures, isEnabled, handleFeatureCommand } from "./features.ts";
+import { reportTelemetry } from "./telemetry.ts";
 const CJK_TOPIC_REGEX = /[\u4e00-\u9fff]{3,}/g;
 const CJK_WORD_REGEX = /[\u4e00-\u9fff]{2,4}/g;
 const stats = {
@@ -232,6 +233,9 @@ setInterval(async () => {
         generateSessionSummary(s.topic, s.turnCount, s.flowKey);
       }
     });
+    safe("telemetry", () => {
+      reportTelemetry(stats.totalMessages, stats.corrections, stats.firstSeen);
+    });
   } catch (e) {
     console.error(`[cc-soul][heartbeat] ${e.message}`);
   } finally {

package/cc-soul/telemetry.js

@@ -0,0 +1,49 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+import { memoryState } from "./memory.ts";
+import { evalMetrics } from "./quality.ts";
+import { getSyncConfig, getInstanceId } from "./sync.ts";
+import { getAllFeatures, isEnabled } from "./features.ts";
+import { createHash } from "crypto";
+let lastReport = 0;
+const REPORT_INTERVAL = 24 * 36e5;
+function hashId(id) {
+  return createHash("sha256").update(id).digest("hex").slice(0, 12);
+}
+__name(hashId, "hashId");
+async function reportTelemetry(totalMessages, corrections, firstSeen) {
+  if (!isEnabled("telemetry")) return;
+  const now = Date.now();
+  if (now - lastReport < REPORT_INTERVAL) return;
+  lastReport = now;
+  const config = getSyncConfig();
+  const hubUrl = config.hubUrl;
+  if (!hubUrl) return;
+  const features = getAllFeatures();
+  const enabledCount = Object.values(features).filter((v) => v === true).length;
+  const payload = {
+    id: hashId(getInstanceId()),
+    // anonymized
+    v: "1.0.0",
+    msgs: totalMessages,
+    mems: memoryState.memories.length,
+    quality: evalMetrics.avgQuality,
+    corrections,
+    features: enabledCount,
+    uptime: Math.floor((now - firstSeen) / 864e5)
+  };
+  try {
+    await fetch(`${hubUrl}/telemetry`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(payload)
+    });
+    console.log(`[cc-soul][telemetry] daily report sent (${payload.msgs} msgs, quality ${payload.quality})`);
+  } catch (e) {
+    console.log(`[cc-soul][telemetry] report failed (non-critical): ${e.message}`);
+  }
+}
+__name(reportTelemetry, "reportTelemetry");
+export {
+  reportTelemetry
+};

package/hub/server.ts

@@ -353,6 +353,43 @@ const server = createServer(async (req, res) => {
       return res.end(allData)
     }
 
+    // ── Telemetry: receive anonymous usage stats ──
+    if (method === 'POST' && path === '/telemetry') {
+      const body = await readBody(req)
+      let data: any
+      try { data = JSON.parse(body) } catch { return json(res, 400, { error: 'invalid JSON' }) }
+
+      // Store in telemetry table
+      try { db.exec(`CREATE TABLE IF NOT EXISTS telemetry (
+        id TEXT, version TEXT, messages INTEGER, memories INTEGER,
+        quality REAL, corrections INTEGER, features INTEGER, uptime INTEGER,
+        reported_at INTEGER
+      )`) } catch {}
+
+      db.prepare(`INSERT INTO telemetry (id, version, messages, memories, quality, corrections, features, uptime, reported_at)
+        VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`).run(
+        data.id || 'unknown', data.v || '?',
+        data.msgs || 0, data.mems || 0, data.quality || 0,
+        data.corrections || 0, data.features || 0, data.uptime || 0,
+        Date.now()
+      )
+
+      return json(res, 200, { ok: true })
+    }
+
+    // ── Telemetry: view stats (admin) ──
+    if (method === 'GET' && path === '/telemetry') {
+      try { db.exec(`CREATE TABLE IF NOT EXISTS telemetry (
+        id TEXT, version TEXT, messages INTEGER, memories INTEGER,
+        quality REAL, corrections INTEGER, features INTEGER, uptime INTEGER,
+        reported_at INTEGER
+      )`) } catch {}
+
+      const rows = db.prepare(`SELECT * FROM telemetry ORDER BY reported_at DESC LIMIT 100`).all()
+      const unique = new Set((rows as any[]).map(r => r.id)).size
+      return json(res, 200, { totalReports: rows.length, uniqueInstances: unique, recent: rows.slice(0, 20) })
+    }
+
     // ── Health check ──
     if (method === 'GET' && (path === '/' || path === '/health')) {
       return json(res, 200, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cc-soul/openclaw",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Give your AI a soul — cognitive architecture plugin for OpenClaw",
   "type": "module",
   "keywords": ["ai", "soul", "memory", "personality", "openclaw", "cognitive", "agent"],
@@ -8,7 +8,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/cc-soul/cc-soul"
+    "url": "https://github.com/wenroudeyu-collab/cc-soul"
   },
   "bin": {
     "cc-soul": "./scripts/cli.js"
@@ -16,7 +16,6 @@
   "files": [
     "cc-soul/",
     "hub/",
-    "data/.gitkeep",
     "scripts/",
     "README.md"
   ],

package/scripts/cli.js

@@ -1,136 +1,12 @@
 #!/usr/bin/env node
-/**
- * cc-soul CLI — enable/disable/status/config commands
- * Usage: cc-soul <command> [args]
- */
 import { existsSync, readFileSync, writeFileSync } from 'fs'
 import { resolve } from 'path'
 import { homedir } from 'os'
-
-const DATA_DIR = resolve(homedir(), '.openclaw/hooks/cc-soul/data')
-const FEATURES_PATH = resolve(DATA_DIR, 'features.json')
-const SYNC_PATH = resolve(DATA_DIR, 'sync_config.json')
-const AI_PATH = resolve(DATA_DIR, 'ai_config.json')
-
-function loadJson(path, fallback) {
-  try { return existsSync(path) ? JSON.parse(readFileSync(path, 'utf-8')) : fallback }
-  catch { return fallback }
-}
-
-const [,, cmd, ...args] = process.argv
-
-switch (cmd) {
-  case 'status': {
-    const features = loadJson(FEATURES_PATH, {})
-    const sync = loadJson(SYNC_PATH, {})
-    console.log('\n🧠 cc-soul status\n')
-    console.log('Features:')
-    for (const [k, v] of Object.entries(features)) {
-      if (k.startsWith('_')) continue
-      console.log(`  ${v ? '✅' : '❌'} ${k}`)
-    }
-    console.log(`\nSync: ${sync.enabled ? 'ON' : 'OFF'}`)
-    console.log(`Federation: ${sync.federationEnabled ? 'ON' : 'OFF'}`)
-    console.log(`Instance: ${sync.instanceId || 'not set'}`)
-    console.log(`Hub: ${sync.hubUrl || 'not configured'}`)
-    break
-  }
-
-  case 'enable': {
-    if (!args[0]) { console.log('Usage: cc-soul enable <feature>'); break }
-    const features = loadJson(FEATURES_PATH, {})
-    if (!(args[0] in features)) { console.log(`Unknown feature: ${args[0]}`); break }
-    features[args[0]] = true
-    writeFileSync(FEATURES_PATH, JSON.stringify(features, null, 2))
-    console.log(`✅ ${args[0]} enabled`)
-    console.log('Restart gateway: pkill -HUP -f "openclaw.*gateway"')
-    break
-  }
-
-  case 'disable': {
-    if (!args[0]) { console.log('Usage: cc-soul disable <feature>'); break }
-    const features = loadJson(FEATURES_PATH, {})
-    if (!(args[0] in features)) { console.log(`Unknown feature: ${args[0]}`); break }
-    features[args[0]] = false
-    writeFileSync(FEATURES_PATH, JSON.stringify(features, null, 2))
-    console.log(`❌ ${args[0]} disabled`)
-    console.log('Restart gateway: pkill -HUP -f "openclaw.*gateway"')
-    break
-  }
-
-  case 'config': {
-    const [subCmd, key, value] = args
-    if (subCmd === 'set' && key && value) {
-      if (['hub_url', 'hubUrl'].includes(key)) {
-        const sync = loadJson(SYNC_PATH, {})
-        sync.hubUrl = value
-        sync.enabled = true
-        writeFileSync(SYNC_PATH, JSON.stringify(sync, null, 2))
-        console.log(`✅ hubUrl = ${value}`)
-      } else if (['federation', 'federationEnabled'].includes(key)) {
-        const sync = loadJson(SYNC_PATH, {})
-        sync.federationEnabled = value === 'true'
-        writeFileSync(SYNC_PATH, JSON.stringify(sync, null, 2))
-        console.log(`✅ federation = ${value}`)
-      } else if (['ai_backend', 'backend'].includes(key)) {
-        const ai = loadJson(AI_PATH, {})
-        ai.backend = value
-        writeFileSync(AI_PATH, JSON.stringify(ai, null, 2))
-        console.log(`✅ AI backend = ${value}`)
-      } else if (['ai_api_base', 'api_base'].includes(key)) {
-        const ai = loadJson(AI_PATH, {})
-        ai.backend = 'openai-compatible'
-        ai.api_base = value
-        writeFileSync(AI_PATH, JSON.stringify(ai, null, 2))
-        console.log(`✅ API base = ${value}`)
-      } else if (['ai_api_key', 'api_key'].includes(key)) {
-        const ai = loadJson(AI_PATH, {})
-        ai.api_key = value
-        writeFileSync(AI_PATH, JSON.stringify(ai, null, 2))
-        console.log(`✅ API key set`)
-      } else if (['ai_model', 'model'].includes(key)) {
-        const ai = loadJson(AI_PATH, {})
-        ai.api_model = value
-        writeFileSync(AI_PATH, JSON.stringify(ai, null, 2))
-        console.log(`✅ model = ${value}`)
-      } else {
-        console.log(`Unknown config key: ${key}`)
-      }
-    } else {
-      console.log('Usage: cc-soul config set <key> <value>')
-      console.log('Keys: hub_url, federation, ai_backend, ai_api_base, ai_api_key, ai_model')
-    }
-    break
-  }
-
-  case 'install': {
-    console.log('Running install script...')
-    import('./install.js')
-    break
-  }
-
-  default:
-    console.log(`
-🧠 cc-soul — Give your AI a soul
-
-Commands:
-  cc-soul status                    Show features & sync status
-  cc-soul enable <feature>          Enable a feature
-  cc-soul disable <feature>         Disable a feature
-  cc-soul config set <key> <value>  Set configuration
-
-Config keys:
-  hub_url <url>         Knowledge Hub URL
-  federation true/false Enable/disable federation
-  ai_backend cli/openai-compatible
-  ai_api_base <url>     API base URL
-  ai_api_key <key>      API key
-  ai_model <model>      Model name
-
-Examples:
-  cc-soul enable dream_mode
-  cc-soul disable self_upgrade
-  cc-soul config set hub_url https://hub.example.com:9900
-  cc-soul config set ai_api_base https://api.openai.com/v1
-`)
-}
+const D = resolve(homedir(), '.openclaw/hooks/cc-soul/data')
+const F = resolve(D, 'features.json')
+const load = (p, f) => { try { return existsSync(p) ? JSON.parse(readFileSync(p,'utf-8')) : f } catch { return f } }
+const [,,cmd,...args] = process.argv
+if (cmd === 'status') { const f = load(F, {}); console.log('\n🧠 cc-soul features:\n'); for (const [k,v] of Object.entries(f)) { if (!k.startsWith('_')) console.log(`  ${v?'✅':'❌'} ${k}`) } }
+else if (cmd === 'enable' && args[0]) { const f = load(F, {}); f[args[0]] = true; writeFileSync(F, JSON.stringify(f,null,2)); console.log(`✅ ${args[0]} enabled`) }
+else if (cmd === 'disable' && args[0]) { const f = load(F, {}); f[args[0]] = false; writeFileSync(F, JSON.stringify(f,null,2)); console.log(`❌ ${args[0]} disabled`) }
+else console.log('🧠 cc-soul\n  cc-soul status\n  cc-soul enable <feature>\n  cc-soul disable <feature>')

package/scripts/install.js

@@ -1,106 +1,25 @@
 #!/usr/bin/env node
-/**
- * cc-soul postinstall — auto-deploy to OpenClaw hooks directory
- */
-import { existsSync, mkdirSync, cpSync, writeFileSync, readFileSync } from 'fs'
+import { existsSync, mkdirSync, cpSync, writeFileSync } from 'fs'
 import { resolve, dirname } from 'path'
 import { homedir } from 'os'
 
 const TARGET = resolve(homedir(), '.openclaw/hooks/cc-soul')
-const TARGET_SOUL = resolve(TARGET, 'cc-soul')
-const TARGET_DATA = resolve(TARGET, 'data')
 const SOURCE = resolve(dirname(new URL(import.meta.url).pathname), '..')
 
 console.log('🧠 cc-soul installing...')
-console.log(`   source: ${SOURCE}`)
-console.log(`   target: ${TARGET}`)
-
-// Create directories
-mkdirSync(TARGET_SOUL, { recursive: true })
-mkdirSync(TARGET_DATA, { recursive: true })
-
-// Copy cc-soul modules (JS files + HOOK.md)
-cpSync(resolve(SOURCE, 'cc-soul'), TARGET_SOUL, { recursive: true, force: true })
-console.log('   ✅ modules installed')
-
-// Copy hub (optional)
-const hubTarget = resolve(TARGET, 'hub')
+mkdirSync(resolve(TARGET, 'cc-soul'), { recursive: true })
+mkdirSync(resolve(TARGET, 'data'), { recursive: true })
+cpSync(resolve(SOURCE, 'cc-soul'), resolve(TARGET, 'cc-soul'), { recursive: true, force: true })
 if (existsSync(resolve(SOURCE, 'hub'))) {
-  mkdirSync(hubTarget, { recursive: true })
-  cpSync(resolve(SOURCE, 'hub'), hubTarget, { recursive: true, force: true })
-  console.log('   ✅ hub installed')
+  mkdirSync(resolve(TARGET, 'hub'), { recursive: true })
+  cpSync(resolve(SOURCE, 'hub'), resolve(TARGET, 'hub'), { recursive: true, force: true })
 }
-
-// Create package.json for OpenClaw hook discovery
 const hookPkg = resolve(TARGET, 'package.json')
 if (!existsSync(hookPkg)) {
-  writeFileSync(hookPkg, JSON.stringify({
-    name: "cc-soul",
-    version: "1.0.0",
-    type: "module",
-    openclaw: { hooks: ["./cc-soul"] }
-  }, null, 2))
-  console.log('   ✅ hook package.json created')
+  writeFileSync(hookPkg, JSON.stringify({ name: "cc-soul", version: "1.0.0", type: "module", openclaw: { hooks: ["./cc-soul"] } }, null, 2))
 }
-
-// Create default features.json (if not exists)
-const featuresFile = resolve(TARGET_DATA, 'features.json')
-if (!existsSync(featuresFile)) {
-  writeFileSync(featuresFile, JSON.stringify({
-    memory_active: true,
-    memory_consolidation: true,
-    memory_contradiction_scan: true,
-    memory_tags: true,
-    memory_associative_recall: true,
-    memory_predictive: true,
-    memory_session_summary: true,
-    lorebook: true,
-    skill_library: true,
-    persona_splitting: true,
-    emotional_contagion: true,
-    fingerprint: true,
-    metacognition: true,
-    dream_mode: true,
-    autonomous_voice: true,
-    web_rover: true,
-    structured_reflection: true,
-    plan_tracking: true,
-    self_upgrade: false,
-    federation: true,
-    sync: true,
-  }, null, 2))
-  console.log('   ✅ default features.json created')
-}
-
-// Create default sync_config.json (if not exists)
-const syncFile = resolve(TARGET_DATA, 'sync_config.json')
-if (!existsSync(syncFile)) {
-  const instanceId = 'cc-' + Date.now().toString(36) + Math.random().toString(36).slice(2, 6)
-  writeFileSync(syncFile, JSON.stringify({
-    enabled: false,
-    instanceId,
-    instanceName: 'unnamed',
-    method: 'file',
-    remote: '',
-    hubUrl: '',
-    hubApiKey: '',
-    federationEnabled: false,
-    syncIntervalMinutes: 0,
-    lastSync: 0,
-  }, null, 2))
-  console.log('   ✅ default sync_config.json created')
+const feat = resolve(TARGET, 'data/features.json')
+if (!existsSync(feat)) {
+  writeFileSync(feat, JSON.stringify({ memory_active:true, memory_consolidation:true, memory_contradiction_scan:true, memory_tags:true, memory_associative_recall:true, memory_predictive:true, memory_session_summary:true, lorebook:true, skill_library:true, persona_splitting:true, emotional_contagion:true, fingerprint:true, metacognition:true, dream_mode:true, autonomous_voice:true, web_rover:true, structured_reflection:true, plan_tracking:true, self_upgrade:false, federation:true, sync:true, telemetry:true }, null, 2))
 }
-
-console.log('')
-console.log('🎉 cc-soul installed successfully!')
-console.log('')
-console.log('   Next steps:')
-console.log('   1. Restart OpenClaw gateway:')
-console.log('      pkill -HUP -f "openclaw.*gateway"')
-console.log('')
-console.log('   2. Check logs for:')
-console.log('      [cc-soul] initialized (modular)')
-console.log('      [cc-soul][ai] auto-detected from openclaw.json')
-console.log('')
-console.log('   3. Send a message to your AI — cc-soul is now active!')
-console.log('')
+console.log('🎉 cc-soul installed! Restart gateway: pkill -HUP -f "openclaw.*gateway"')

package/hub/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "cc-soul-hub",
-  "version": "1.0.0",
-  "type": "module",
-  "scripts": {
-    "start": "tsx server.ts",
-    "dev": "tsx watch server.ts"
-  },
-  "dependencies": {
-    "better-sqlite3": "^11.0.0"
-  },
-  "devDependencies": {
-    "tsx": "^4.0.0",
-    "@types/better-sqlite3": "^7.6.0"
-  }
-}