@hippodid/openclaw-plugin 1.0.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 HippoDid
+
+   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,141 @@
+# HippoDid — Cloud Character Memory for OpenClaw
+
+> Your MEMORY.md survives context compaction. Zero-config cloud sync with structured character memory.
+
+## The Problem
+
+OpenClaw's own docs warn: **memory dies on context compaction.** Your agent accumulates context over a session — preferences, project knowledge, debugging history. Then compaction triggers, and that context is gone. Next session starts from scratch.
+
+HippoDid syncs your memory files to cloud **before** compaction destroys them. Next session, they're back — automatically.
+
+## Install
+
+```bash
+openclaw plugins install @hippodid/openclaw-plugin
+```
+
+Add to your `openclaw.json`:
+
+```json
+{
+  "plugins": {
+    "hippodid": {
+      "enabled": true,
+      "apiKey": "hd_sk_...",
+      "characterId": "my-dev-agent"
+    }
+  }
+}
+```
+
+Restart the gateway:
+
+```bash
+openclaw gateway restart
+```
+
+## How It Works
+
+```
+1. Install → Plugin auto-detects your workspace memory directory
+2. File watcher → Monitors MEMORY.md + memory/*.md for changes
+3. Pre-compaction flush → Syncs to cloud BEFORE context compaction (the critical hook)
+4. Session start → Hydrates files from cloud so memory survives across sessions
+```
+
+The plugin runs as a **non-slot plugin** — it doesn't replace your existing memory backend. It adds cloud persistence on top of whatever memory system you already use.
+
+## Import Existing Memory
+
+Already have memory files from previous sessions?
+
+```bash
+openclaw run hippodid:import --workspace ~/.openclaw/workspace
+```
+
+This uploads all `MEMORY.md` + `memory/*.md` files to your HippoDid character in one pass.
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `hippodid:status` | Show tier, sync status, watched paths |
+| `hippodid:sync` | Trigger immediate sync of all watched files |
+| `hippodid:import` | Import existing workspace memory |
+
+## HippoDid vs Mem0 vs memory-lancedb
+
+| Feature | HippoDid | Mem0 Plugin | memory-lancedb |
+|---------|----------|-------------|----------------|
+| MEMORY.md sync | Bidirectional cloud sync | Ignores MEMORY.md entirely | Separate vector store |
+| Import existing memory | One command, full history | Start from zero | Start from zero |
+| Survives compaction | Pre-compaction flush hook | Partial (AUDN capture only) | Local vector DB persists |
+| Cross-machine sync | Cloud-based | Mem0 cloud | Local only |
+| Data portability | Export to Markdown anytime | Locked in Mem0 format | LanceDB binary format |
+| Structured character model | Categories, profiles, decay | Flat user_id memories | Flat key-value |
+| Free tier cost | $0 (file sync only, no AI) | Requires OPENAI_API_KEY | Requires embedding API key |
+| Multi-agent isolation | Character-scoped by design | Known bleed bug (#3998) | Agent scope option |
+
+## Configuration Reference
+
+```json
+{
+  "plugins": {
+    "hippodid": {
+      "enabled": true,
+      "apiKey": "hd_sk_...",
+      "characterId": "my-dev-agent",
+      "baseUrl": "https://api.hippodid.com",
+      "syncIntervalSeconds": 300,
+      "autoRecall": false,
+      "autoCapture": false,
+      "additionalPaths": [
+        { "path": "./notes/project.md", "label": "project-notes" }
+      ]
+    }
+  }
+}
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `apiKey` | string | *required* | HippoDid API key (`hd_sk_...`) |
+| `characterId` | string | *required* | Target character ID |
+| `baseUrl` | string | `https://api.hippodid.com` | API endpoint |
+| `syncIntervalSeconds` | number | `300` | Debounce interval for file sync (min: 60s) |
+| `autoRecall` | boolean | `false` | Inject relevant memories before each turn (paid tier) |
+| `autoCapture` | boolean | `false` | Extract and store facts after each turn (paid tier) |
+| `additionalPaths` | array | `[]` | Extra files/directories to watch |
+
+## Free vs Paid Tiers
+
+**Free tier** (no credit card):
+- File watcher with SHA-256 diff sync
+- Pre-compaction flush (the critical feature)
+- Session-start hydration from cloud
+- Manual sync and import commands
+
+**Paid tiers** add:
+- **Auto-Recall**: Relevant memories injected as context before each agent turn
+- **Auto-Capture**: Facts automatically extracted from conversations via AUDN pipeline
+- Lower sync interval minimums
+
+## Workspace Auto-Detection
+
+The plugin automatically finds your memory files by searching:
+
+1. `$OPENCLAW_WORKSPACE/memory/` and `$OPENCLAW_WORKSPACE/MEMORY.md`
+2. `~/.openclaw/workspace/memory/` and `~/.openclaw/workspace/MEMORY.md`
+3. Current working directory `./memory/` and `./MEMORY.md`
+
+Add `additionalPaths` in config to watch extra files or directories.
+
+## Requirements
+
+- OpenClaw 2026.1.x+
+- Node.js 22+
+- HippoDid account (free at hippodid.dev)
+
+## License
+
+Apache 2.0

package/openclaw.plugin.json

@@ -0,0 +1,57 @@
+{
+  "id": "hippodid",
+  "name": "HippoDid — Cloud Character Memory",
+  "description": "Cloud sync for MEMORY.md with structured character memory. Survives context compaction.",
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "apiKey": {
+        "type": "string",
+        "description": "HippoDid API key (hd_sk_...)"
+      },
+      "characterId": {
+        "type": "string",
+        "description": "Target character ID or name"
+      },
+      "baseUrl": {
+        "type": "string",
+        "default": "https://api.hippodid.com"
+      },
+      "syncIntervalSeconds": {
+        "type": "number",
+        "default": 300,
+        "minimum": 60
+      },
+      "autoRecall": {
+        "type": "boolean",
+        "default": false
+      },
+      "autoCapture": {
+        "type": "boolean",
+        "default": false
+      },
+      "additionalPaths": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "path": { "type": "string" },
+            "label": { "type": "string" }
+          },
+          "required": ["path"]
+        },
+        "default": []
+      }
+    },
+    "required": ["apiKey", "characterId"]
+  },
+  "uiHints": {
+    "apiKey": { "label": "HippoDid API Key", "sensitive": true, "placeholder": "hd_sk_..." },
+    "characterId": { "label": "Character ID", "placeholder": "my-dev-agent" },
+    "baseUrl": { "label": "API Base URL", "advanced": true },
+    "syncIntervalSeconds": { "label": "Sync Interval (seconds)", "advanced": true },
+    "autoRecall": { "label": "Auto-Recall (Paid tier)", "help": "Inject relevant memories before each turn" },
+    "autoCapture": { "label": "Auto-Capture (Paid tier)", "help": "Extract and store facts after each turn" }
+  }
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@hippodid/openclaw-plugin",
+  "version": "1.0.0",
+  "description": "Cloud sync for MEMORY.md with structured character memory. Survives context compaction.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SameThoughts/hippodid-openclaw-plugin.git"
+  },
+  "keywords": [
+    "openclaw",
+    "openclaw-plugin",
+    "memory",
+    "character-memory",
+    "cloud-sync",
+    "hippodid",
+    "ai-memory"
+  ],
+  "main": "src/index.ts",
+  "files": [
+    "src/",
+    "openclaw.plugin.json",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  }
+}

package/src/file-sync.ts

@@ -0,0 +1,250 @@
+import { createHash } from 'node:crypto';
+import { readFile, writeFile, readdir, stat } from 'node:fs/promises';
+import { watch, type FSWatcher } from 'node:fs';
+import { resolve, join, extname } from 'node:path';
+import type { HippoDidClient } from './hippodid-client.js';
+import type { PluginConfig, FileTrackingEntry, WatchPath } from './types.js';
+
+export interface FileSync {
+  start(): void;
+  stop(): void;
+  flushNow(): Promise<{ synced: number; changed: number }>;
+  hydrateFromCloud(): Promise<number>;
+}
+
+interface Logger {
+  info(message: string): void;
+  warn(message: string): void;
+}
+
+export function createFileSync(
+  client: HippoDidClient,
+  config: PluginConfig,
+  watchPaths: WatchPath[],
+  logger: Logger,
+  effectiveSyncIntervalSeconds?: number,
+): FileSync {
+  const syncIntervalMs = (effectiveSyncIntervalSeconds ?? config.syncIntervalSeconds) * 1000;
+  const tracking = new Map<string, FileTrackingEntry>();
+  const watchers: FSWatcher[] = [];
+  let debounceTimer: ReturnType<typeof setTimeout> | null = null;
+  let pendingChanges = new Set<string>();
+
+  async function computeHash(filePath: string): Promise<string> {
+    const content = await readFile(filePath);
+    return createHash('sha256').update(content).digest('hex');
+  }
+
+  function toBase64(buffer: Buffer): string {
+    return buffer.toString('base64');
+  }
+
+  function fromBase64(content: string): string {
+    return Buffer.from(content, 'base64').toString('utf-8');
+  }
+
+  async function resolveFilesForPath(wp: WatchPath): Promise<string[]> {
+    try {
+      const s = await stat(wp.path);
+      if (s.isDirectory()) {
+        const entries = await readdir(wp.path);
+        return entries
+          .filter((e) => extname(e) === '.md')
+          .map((e) => resolve(join(wp.path, e)));
+      }
+      return [resolve(wp.path)];
+    } catch {
+      return [];
+    }
+  }
+
+  async function resolveAllFiles(): Promise<
+    Array<{ filePath: string; label: string }>
+  > {
+    const files: Array<{ filePath: string; label: string }> = [];
+    const seen = new Set<string>();
+
+    for (const wp of watchPaths) {
+      const resolved = await resolveFilesForPath(wp);
+      for (const filePath of resolved) {
+        if (!seen.has(filePath)) {
+          seen.add(filePath);
+          files.push({ filePath, label: wp.label });
+        }
+      }
+    }
+    return files;
+  }
+
+  async function syncFile(
+    filePath: string,
+    label: string,
+  ): Promise<boolean> {
+    try {
+      const content = await readFile(filePath);
+      const hash = createHash('sha256').update(content).digest('hex');
+      const existing = tracking.get(filePath);
+
+      if (existing && existing.hash === hash) {
+        return false;
+      }
+
+      const base64Content = toBase64(content);
+      const result = await client.syncFile(
+        config.characterId,
+        filePath,
+        label,
+        base64Content,
+        hash,
+      );
+
+      if (result.ok) {
+        tracking.set(filePath, { hash, lastSyncedAt: new Date() });
+        return result.value.changed;
+      }
+
+      logger.warn(`hippodid: sync failed for ${filePath}: ${result.error.message}`);
+      return false;
+    } catch (e) {
+      logger.warn(
+        `hippodid: error syncing ${filePath}: ${e instanceof Error ? e.message : 'unknown'}`,
+      );
+      return false;
+    }
+  }
+
+  async function runSync(): Promise<{ synced: number; changed: number }> {
+    const files = await resolveAllFiles();
+    let synced = 0;
+    let changed = 0;
+
+    for (const { filePath, label } of files) {
+      const wasChanged = await syncFile(filePath, label);
+      synced++;
+      if (wasChanged) changed++;
+    }
+
+    logger.info(
+      `hippodid: synced ${synced} files (${changed} changed, ${synced - changed} unchanged)`,
+    );
+    return { synced, changed };
+  }
+
+  function scheduleDebouncedSync(): void {
+    if (debounceTimer) {
+      clearTimeout(debounceTimer);
+    }
+    debounceTimer = setTimeout(
+      () => {
+        debounceTimer = null;
+        runSync().catch((e) => {
+          logger.warn(
+            `hippodid: debounced sync error: ${e instanceof Error ? e.message : 'unknown'}`,
+          );
+        });
+      },
+      syncIntervalMs,
+    );
+  }
+
+  function onFileChange(filePath: string): void {
+    pendingChanges.add(filePath);
+    scheduleDebouncedSync();
+  }
+
+  return {
+    start(): void {
+      for (const wp of watchPaths) {
+        try {
+          const watcher = watch(wp.path, { persistent: false }, (_event, filename) => {
+            if (filename && extname(filename) === '.md') {
+              const fullPath = resolve(
+                join(
+                  wp.path.endsWith('.md') ? resolve(wp.path, '..') : wp.path,
+                  filename,
+                ),
+              );
+              onFileChange(fullPath);
+            } else if (wp.path.endsWith('.md')) {
+              onFileChange(resolve(wp.path));
+            }
+          });
+          watcher.on('error', (err) => {
+            logger.warn(
+              `hippodid: watcher error for ${wp.path}: ${err instanceof Error ? err.message : 'unknown'}`,
+            );
+          });
+          watchers.push(watcher);
+        } catch (e) {
+          logger.warn(
+            `hippodid: failed to watch ${wp.path}: ${e instanceof Error ? e.message : 'unknown'}`,
+          );
+        }
+      }
+
+      scheduleDebouncedSync();
+    },
+
+    stop(): void {
+      for (const w of watchers) {
+        w.close();
+      }
+      watchers.length = 0;
+
+      if (debounceTimer) {
+        clearTimeout(debounceTimer);
+        debounceTimer = null;
+      }
+
+      pendingChanges.clear();
+    },
+
+    async flushNow(): Promise<{ synced: number; changed: number }> {
+      if (debounceTimer) {
+        clearTimeout(debounceTimer);
+        debounceTimer = null;
+      }
+      return runSync();
+    },
+
+    async hydrateFromCloud(): Promise<number> {
+      const files = await resolveAllFiles();
+      let hydrated = 0;
+
+      for (const { filePath } of files) {
+        try {
+          const result = await client.getLatestSync(
+            config.characterId,
+            filePath,
+          );
+          if (!result.ok) {
+            logger.warn(
+              `hippodid: hydration lookup failed for ${filePath}: ${result.error.message}`,
+            );
+            continue;
+          }
+
+          if (result.value === null) {
+            continue;
+          }
+
+          const cloudContent = fromBase64(result.value.fileContent);
+          await writeFile(filePath, cloudContent, 'utf-8');
+
+          const hash = createHash('sha256')
+            .update(Buffer.from(cloudContent))
+            .digest('hex');
+          tracking.set(filePath, { hash, lastSyncedAt: new Date() });
+          hydrated++;
+        } catch (e) {
+          logger.warn(
+            `hippodid: hydration error for ${filePath}: ${e instanceof Error ? e.message : 'unknown'}`,
+          );
+        }
+      }
+
+      logger.info(`hippodid: hydrated ${hydrated} files from cloud`);
+      return hydrated;
+    },
+  };
+}