opencode-supermemory 0.1.1 → 0.1.2

package/README.md

@@ -2,45 +2,123 @@
 
 OpenCode plugin for persistent memory using [Supermemory](https://supermemory.ai).
 
+Your agent remembers what you tell it - across sessions, across projects.
+
 ## Installation
 
+### For Humans
+
 ```bash
-npx opencode-supermemory setup
+bunx opencode-supermemory install
+```
+
+Then get your API key from [console.supermemory.ai](https://console.supermemory.ai) and set it:
+
+```bash
+export SUPERMEMORY_API_KEY="sm_..."
+```
+
+**Or let your agent do it** - paste this into OpenCode:
+```
+Install opencode-supermemory by following https://raw.githubusercontent.com/supermemoryai/opencode-supermemory/main/README.md
 ```
 
-Interactive wizard that:
-1. Installs plugin globally
-2. Creates `/supermemory-init` command
-3. Adds plugin to OpenCode config
+### For LLM Agents
+
+<details>
+<summary>Instructions for LLM Agents (click to expand)</summary>
+
+If you're an LLM agent helping set up opencode-supermemory, follow these steps:
 
-Then set your API key:
+#### Step 1: Run the installer
 
 ```bash
-# Add to your shell profile (.zshrc, .bashrc, etc.)
-echo 'export SUPERMEMORY_API_KEY="your-api-key"' >> ~/.zshrc
-source ~/.zshrc
+bunx opencode-supermemory install --no-tui
+```
+
+This will:
+- Register the plugin in `~/.config/opencode/opencode.jsonc`
+- Create the `/supermemory-init` command
+
+#### Step 2: Verify the config
 
-# Or set temporarily for current session
-export SUPERMEMORY_API_KEY="your-api-key"  # from console.supermemory.ai
+```bash
+cat ~/.config/opencode/opencode.jsonc
+```
+
+Should contain:
+```json
+{
+  "plugin": ["opencode-supermemory"]
+}
 ```
 
-Make sure `~/.config/opencode/opencode.json` contains the plugin:
+If not, add it manually:
 
+**JSONC:**
+```jsonc
+{
+  "plugin": [
+    "opencode-supermemory"
+    // ... other plugins
+  ]
+}
+```
+
+**JSON:**
 ```json
 {
   "plugin": ["opencode-supermemory"]
 }
 ```
 
+#### Step 3: Configure API key
+
+Ask the user to get their API key from [console.supermemory.ai](https://console.supermemory.ai).
+
+Then set it via environment variable:
+
+```bash
+export SUPERMEMORY_API_KEY="sm_..."
+```
+
+Or create `~/.config/opencode/supermemory.jsonc`:
+
+```jsonc
+{
+  "apiKey": "sm_..."
+}
+```
+
+#### Step 4: Verify setup
+
+Tell the user to restart OpenCode and run:
+
+```bash
+opencode -c
+```
+
+They should see `supermemory` in the tools list. If not, check:
+1. Is `SUPERMEMORY_API_KEY` set?
+2. Is the plugin in `opencode.jsonc`?
+3. Check logs: `tail ~/.opencode-supermemory.log`
+
+#### Step 5: Initialize codebase memory (optional)
+
+Run `/supermemory-init` to have the agent explore and memorize the codebase.
+
+</details>
+
 ## Features
 
 ### Context Injection
 
-On first message, injects:
+On first message, the agent receives (invisible to user):
 - User profile (cross-project preferences)
 - Project memories (all project knowledge)
 - Relevant user memories (semantic search)
 
+Example of what the agent sees:
 ```
 [SUPERMEMORY]
 
@@ -56,6 +134,8 @@ Relevant Memories:
 - [82%] Build fails if .env.local missing
 ```
 
+The agent uses this context automatically - no manual prompting needed.
+
 ### Keyword Detection
 
 Say "remember", "save this", "don't forget" etc. and the agent auto-saves to memory.
@@ -134,17 +214,12 @@ Create `~/.config/opencode/supermemory.jsonc`:
   "injectProfile": true,
   
   // Prefix for container tags
-  "containerTagPrefix": "opencode",
-  
-  // LLM filter prompt for memory relevance
-  "filterPrompt": "You are a stateful coding agent. Remember all the information, including but not limited to user's coding preferences, tech stack, behaviours, workflows, and any other relevant details."
+  "containerTagPrefix": "opencode"
 }
 ```
 
 All fields optional. Env var `SUPERMEMORY_API_KEY` takes precedence over config file.
 
-API timeout: 30s
-
 ## Usage with Oh My OpenCode
 
 If you're using [Oh My OpenCode](https://github.com/code-yeongyu/oh-my-opencode), disable its built-in auto-compact hook to let supermemory handle context compaction:
@@ -157,14 +232,6 @@ Add to `~/.config/opencode/oh-my-opencode.json`:
 }
 ```
 
-This ensures supermemory's preemptive compaction (which preserves memories across sessions) works correctly instead of oh-my-opencode's default compaction.
-
-## Hooks
-
-Registered in `package.json`:
-- `chat.message` - Context injection on first message, keyword detection
-- `event` - Compaction monitoring and summary capture
-
 ## Development
 
 ```bash

package/dist/cli.js

@@ -1,22 +1,4 @@
 #!/usr/bin/env node
-import { createRequire } from "node:module";
-var __create = Object.create;
-var __getProtoOf = Object.getPrototypeOf;
-var __defProp = Object.defineProperty;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __toESM = (mod, isNodeMode, target) => {
-  target = mod != null ? __create(__getProtoOf(mod)) : {};
-  const to = isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target;
-  for (let key of __getOwnPropNames(mod))
-    if (!__hasOwnProp.call(to, key))
-      __defProp(to, key, {
-        get: () => mod[key],
-        enumerable: true
-      });
-  return to;
-};
-var __require = /* @__PURE__ */ createRequire(import.meta.url);
 
 // src/cli.ts
 import { mkdirSync, writeFileSync, readFileSync, existsSync } from "node:fs";
@@ -25,7 +7,7 @@ import { homedir } from "node:os";
 import * as readline from "node:readline";
 var OPENCODE_CONFIG_DIR = join(homedir(), ".config", "opencode");
 var OPENCODE_COMMAND_DIR = join(OPENCODE_CONFIG_DIR, "command");
-var PLUGIN_NAME = "opencode-supermemory@latest";
+var PLUGIN_NAME = "opencode-supermemory";
 var SUPERMEMORY_INIT_COMMAND = `---
 description: Initialize Supermemory with comprehensive codebase knowledge
 ---
@@ -190,42 +172,10 @@ async function confirm(rl, question) {
     });
   });
 }
-async function installPlugin() {
-  const { execSync } = await import("node:child_process");
-  let pm = "npm";
-  try {
-    execSync("bun --version", { stdio: "ignore" });
-    pm = "bun";
-  } catch {
-    try {
-      execSync("pnpm --version", { stdio: "ignore" });
-      pm = "pnpm";
-    } catch {}
-  }
-  console.log(`Installing ${PLUGIN_NAME} with ${pm}...`);
-  try {
-    execSync(`${pm} install -g ${PLUGIN_NAME}`, { stdio: "inherit" });
-    return true;
-  } catch {
-    console.error("Failed to install plugin globally.");
-    return false;
-  }
-}
-function createCommand() {
-  mkdirSync(OPENCODE_COMMAND_DIR, { recursive: true });
-  const commandPath = join(OPENCODE_COMMAND_DIR, "supermemory-init.md");
-  if (existsSync(commandPath)) {
-    console.log(`Command already exists at ${commandPath}`);
-    return true;
-  }
-  writeFileSync(commandPath, SUPERMEMORY_INIT_COMMAND);
-  console.log(`Created /supermemory-init command`);
-  return true;
-}
 function findOpencodeConfig() {
   const candidates = [
-    join(OPENCODE_CONFIG_DIR, "config.jsonc"),
-    join(OPENCODE_CONFIG_DIR, "config.json")
+    join(OPENCODE_CONFIG_DIR, "opencode.jsonc"),
+    join(OPENCODE_CONFIG_DIR, "opencode.json")
   ];
   for (const path of candidates) {
     if (existsSync(path)) {
@@ -238,7 +188,7 @@ function addPluginToConfig(configPath) {
   try {
     const content = readFileSync(configPath, "utf-8");
     if (content.includes("opencode-supermemory")) {
-      console.log("Plugin already in config");
+      console.log("✓ Plugin already registered in config");
       return true;
     }
     const jsonContent = content.replace(/\/\/.*$/gm, "").replace(/\/\*[\s\S]*?\*\//g, "");
@@ -246,7 +196,7 @@ function addPluginToConfig(configPath) {
     try {
       config = JSON.parse(jsonContent);
     } catch {
-      console.error("Failed to parse config file");
+      console.error("✗ Failed to parse config file");
       return false;
     }
     const plugins = config.plugin || [];
@@ -274,91 +224,124 @@ function addPluginToConfig(configPath) {
     } else {
       writeFileSync(configPath, JSON.stringify(config, null, 2));
     }
-    console.log(`Added ${PLUGIN_NAME} to ${configPath}`);
+    console.log(`✓ Added plugin to ${configPath}`);
     return true;
   } catch (err) {
-    console.error("Failed to update config:", err);
+    console.error("✗ Failed to update config:", err);
     return false;
   }
 }
 function createNewConfig() {
-  const configPath = join(OPENCODE_CONFIG_DIR, "config.jsonc");
+  const configPath = join(OPENCODE_CONFIG_DIR, "opencode.jsonc");
   mkdirSync(OPENCODE_CONFIG_DIR, { recursive: true });
-  const config = {
-    plugin: [PLUGIN_NAME]
-  };
-  writeFileSync(configPath, JSON.stringify(config, null, 2));
-  console.log(`Created ${configPath} with plugin registered`);
+  const config = `{
+  "plugin": ["${PLUGIN_NAME}"]
+}
+`;
+  writeFileSync(configPath, config);
+  console.log(`✓ Created ${configPath}`);
   return true;
 }
-async function setup() {
-  const rl = createReadline();
+function createCommand() {
+  mkdirSync(OPENCODE_COMMAND_DIR, { recursive: true });
+  const commandPath = join(OPENCODE_COMMAND_DIR, "supermemory-init.md");
+  writeFileSync(commandPath, SUPERMEMORY_INIT_COMMAND);
+  console.log(`✓ Created /supermemory-init command`);
+  return true;
+}
+async function install(options) {
   console.log(`
-opencode-supermemory setup
+\uD83E\uDDE0 opencode-supermemory installer
 `);
-  const shouldInstall = await confirm(rl, "Install opencode-supermemory globally?");
-  if (!shouldInstall) {
-    console.log("Aborted.");
-    rl.close();
-    process.exit(0);
-  }
-  const installed = await installPlugin();
-  if (!installed) {
-    console.log("Aborted.");
-    rl.close();
-    process.exit(1);
-  }
-  const shouldCreateCommand = await confirm(rl, "Add /supermemory-init command?");
-  if (!shouldCreateCommand) {
-    console.log("Aborted.");
-    rl.close();
-    process.exit(0);
-  }
-  createCommand();
+  const rl = options.tui ? createReadline() : null;
+  console.log("Step 1: Register plugin in OpenCode config");
   const configPath = findOpencodeConfig();
   if (configPath) {
-    const shouldModifyConfig = await confirm(rl, `Add plugin to ${configPath}?`);
-    if (!shouldModifyConfig) {
-      console.log("Aborted.");
-      rl.close();
-      process.exit(0);
+    if (options.tui) {
+      const shouldModify = await confirm(rl, `Add plugin to ${configPath}?`);
+      if (!shouldModify) {
+        console.log("Skipped.");
+      } else {
+        addPluginToConfig(configPath);
+      }
+    } else {
+      addPluginToConfig(configPath);
     }
-    addPluginToConfig(configPath);
   } else {
-    const shouldCreateConfig = await confirm(rl, "No OpenCode config found. Create one?");
-    if (!shouldCreateConfig) {
-      console.log("Aborted.");
-      rl.close();
-      process.exit(0);
+    if (options.tui) {
+      const shouldCreate = await confirm(rl, "No OpenCode config found. Create one?");
+      if (!shouldCreate) {
+        console.log("Skipped.");
+      } else {
+        createNewConfig();
+      }
+    } else {
+      createNewConfig();
+    }
+  }
+  console.log(`
+Step 2: Create /supermemory-init command`);
+  if (options.tui) {
+    const shouldCreate = await confirm(rl, "Add /supermemory-init command?");
+    if (!shouldCreate) {
+      console.log("Skipped.");
+    } else {
+      createCommand();
     }
-    createNewConfig();
+  } else {
+    createCommand();
   }
   console.log(`
-Setup complete!`);
-  console.log("Set SUPERMEMORY_API_KEY and restart OpenCode.");
-  rl.close();
+` + "─".repeat(50));
+  console.log(`
+\uD83D\uDD11 Final step: Set your API key
+`);
+  console.log("Get your API key from: https://console.supermemory.ai");
+  console.log(`
+Then add to your shell profile:
+`);
+  console.log('  export SUPERMEMORY_API_KEY="sm_..."');
+  console.log(`
+Or create ~/.config/opencode/supermemory.jsonc:
+`);
+  console.log('  { "apiKey": "sm_..." }');
+  console.log(`
+` + "─".repeat(50));
+  console.log(`
+✓ Setup complete! Restart OpenCode to activate.
+`);
+  if (rl)
+    rl.close();
+  return 0;
 }
 function printHelp() {
   console.log(`
-opencode-supermemory CLI
+opencode-supermemory - Persistent memory for OpenCode agents
 
 Commands:
-  setup    Interactive setup wizard
+  install          Install and configure the plugin
+    --no-tui       Run in non-interactive mode (for LLM agents)
 
 Examples:
-  npx opencode-supermemory setup
-  bunx opencode-supermemory setup
+  bunx opencode-supermemory install
+  bunx opencode-supermemory install --no-tui
 `);
 }
 var args = process.argv.slice(2);
-if (args.length === 0 || args[0] === "help" || args[0] === "--help") {
+if (args.length === 0 || args[0] === "help" || args[0] === "--help" || args[0] === "-h") {
   printHelp();
   process.exit(0);
 }
-if (args[0] === "setup") {
-  setup();
+if (args[0] === "install") {
+  const noTui = args.includes("--no-tui");
+  install({ tui: !noTui }).then((code) => process.exit(code));
+} else if (args[0] === "setup") {
+  console.log(`Note: 'setup' is deprecated. Use 'install' instead.
+`);
+  const noTui = args.includes("--no-tui");
+  install({ tui: !noTui }).then((code) => process.exit(code));
 } else {
-  console.error(`Unknown command: ${args.join(" ")}`);
+  console.error(`Unknown command: ${args[0]}`);
   printHelp();
   process.exit(1);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-supermemory",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "OpenCode plugin that gives coding agents persistent memory using Supermemory",
   "type": "module",
   "main": "dist/index.js",