@memoryrelay/plugin-memoryrelay-ai 0.2.3 → 0.3.0

package/README.md

@@ -28,6 +28,51 @@ npm install -g @memoryrelay/plugin-memoryrelay-ai
 
 ## Quick Start
 
+### 1. Install the plugin
+
+```bash
+openclaw plugins install @memoryrelay/plugin-memoryrelay-ai
+```
+
+### 2. Configure API credentials
+
+**Option A: Config file** (recommended)
+```bash
+cat ~/.openclaw/openclaw.json | jq '.plugins.entries."plugin-memoryrelay-ai".config = {
+  "apiKey": "YOUR_API_KEY",
+  "agentId": "YOUR_AGENT_ID",
+  "autoRecall": true,
+  "autoCapture": false
+}' > /tmp/config.json && \
+mv /tmp/config.json ~/.openclaw/openclaw.json && \
+chmod 600 ~/.openclaw/openclaw.json
+```
+
+**Option B: Environment variables**
+```bash
+export MEMORYRELAY_API_KEY="YOUR_API_KEY"
+export MEMORYRELAY_AGENT_ID="YOUR_AGENT_ID"
+```
+
+### 3. Restart the gateway
+
+```bash
+openclaw gateway restart
+```
+
+### 4. Verify it's working
+
+```bash
+openclaw status
+# Should show: Memory | enabled (plugin plugin-memoryrelay-ai)
+
+# Check logs
+journalctl -u openclaw-gateway --since '1 minute ago' | grep memory-memoryrelay
+# Should show: "connected to api.memoryrelay.net"
+```
+
+Get your API key from [memoryrelay.ai](https://memoryrelay.ai).
+
 ### 1. Get API Key
 
 Sign up at [memoryrelay.io](https://memoryrelay.io) or use the public demo API.
@@ -396,6 +441,32 @@ MIT © 2026 MemoryRelay
 
 ## Changelog
 
+### v0.3.0 (2026-02-13) - Better Installation UX
+
+**Improved Installation Experience:**
+- ✅ API key can now come from `MEMORYRELAY_API_KEY` env var
+- ✅ Agent ID can come from `MEMORYRELAY_AGENT_ID` env var or defaults to "default"
+- ✅ Clear error message with setup instructions when config is missing
+- ✅ Comprehensive installation guide in README
+- ✅ No more silent failures - helpful error messages
+
+**Breaking Change:**
+- Debug logging removed (replaced with helpful error messages)
+
+**Migration:**
+Works out of the box with env vars, or add config after install:
+```bash
+cat ~/.openclaw/openclaw.json | jq '.plugins.entries."plugin-memoryrelay-ai".config = {"apiKey": "YOUR_KEY", "agentId": "YOUR_AGENT"}' > /tmp/config.json && mv /tmp/config.json ~/.openclaw/openclaw.json
+```
+
+### v0.2.4 (2026-02-13)
+
+**Debug Logging:**
+- Added detailed logging to diagnose config loading issues
+- Logs pluginConfig type, keys, and specific missing fields
+- Helps identify why apiKey/agentId aren't being read
+- Better error messages for troubleshooting
+
 ### v0.2.3 (2026-02-13)
 
 **Critical Fix:**

package/index.ts

@@ -152,16 +152,34 @@ function shouldCapture(text: string): boolean {
 // ============================================================================
 
 export default async function plugin(api: OpenClawPluginApi): Promise<void> {
+  // Debug: log what config we're receiving
+  api.logger.info(`memory-memoryrelay: plugin loaded, checking config...`);
+  api.logger.info(`memory-memoryrelay: pluginConfig type: ${typeof api.pluginConfig}`);
+  api.logger.info(`memory-memoryrelay: pluginConfig keys: ${api.pluginConfig ? Object.keys(api.pluginConfig).join(', ') : 'null'}`);
+  
   const cfg = api.pluginConfig as MemoryRelayConfig | undefined;
-  if (!cfg?.apiKey || !cfg?.agentId) {
-    api.logger.warn("memory-memoryrelay: missing apiKey or agentId, plugin disabled");
+  
+  // Try to get config from multiple sources
+  const apiKey = cfg?.apiKey || process.env.MEMORYRELAY_API_KEY;
+  const agentId = cfg?.agentId || process.env.MEMORYRELAY_AGENT_ID || "default";
+  
+  if (!apiKey) {
+    api.logger.error(
+      "memory-memoryrelay: missing API key. Configure in one of these ways:\n" +
+      "  1. Add to config: plugins.entries.\"plugin-memoryrelay-ai\".config.apiKey\n" +
+      "  2. Set environment variable: MEMORYRELAY_API_KEY\n" +
+      "  3. Run: cat ~/.openclaw/openclaw.json | jq '.plugins.entries.\"plugin-memoryrelay-ai\".config = {\"apiKey\": \"YOUR_KEY\", \"agentId\": \"YOUR_AGENT\"}' > /tmp/config.json && mv /tmp/config.json ~/.openclaw/openclaw.json\n" +
+      "Get your API key from: https://memoryrelay.ai"
+    );
     return;
   }
+  
+  api.logger.info(`memory-memoryrelay: using agentId: ${agentId}`);
 
   const client = new MemoryRelayClient(
-    cfg.apiKey,
-    cfg.agentId,
-    cfg.apiUrl || "https://api.memoryrelay.net",
+    apiKey,
+    agentId,
+    cfg?.apiUrl || "https://api.memoryrelay.net",
   );
 
   // Verify connection on startup

package/openclaw.plugin.json

@@ -3,7 +3,7 @@
   "kind": "memory",
   "name": "MemoryRelay AI",
   "description": "AI memory service using MemoryRelay API (api.memoryrelay.net)",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "uiHints": {
     "apiKey": {
       "label": "MemoryRelay API Key",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memoryrelay/plugin-memoryrelay-ai",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "OpenClaw memory plugin for MemoryRelay API - long-term memory with semantic search",
   "type": "module",
   "main": "index.ts",