opencode-plugin-boops 2.0.0 → 2.1.1

package/README.md

@@ -13,19 +13,27 @@ Sound notifications for OpenCode - plays pleasant "boop" sounds when tasks compl
 
 ## Installation
 
-Add to your OpenCode config file:
+### Quick Install (Recommended)
 
-**Global installation** (recommended):
 ```bash
-# Edit ~/.config/opencode/opencode.json
+npx opencode-plugin-boops install
 ```
 
-**Per-project installation**:
-```bash
-# Edit opencode.json in your project root
+This automatically adds the plugin to your OpenCode config. Then restart OpenCode.
+
+### Manual Installation
+
+Add the plugin to your OpenCode config file:
+
+**Global** (`~/.config/opencode/opencode.json`):
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["opencode-plugin-boops"]
+}
 ```
 
-Add the plugin to the config:
+**Per-project** (`opencode.json` in project root):
 ```json
 {
   "$schema": "https://opencode.ai/config.json",
@@ -35,21 +43,21 @@ Add the plugin to the config:
 
 Then restart OpenCode. The plugin will be automatically downloaded and installed from npm.
 
-### Quick setup
-
-If you don't have an OpenCode config yet:
+## CLI Commands
 
 ```bash
-# Create global config
-mkdir -p ~/.config/opencode
-echo '{"$schema":"https://opencode.ai/config.json","plugin":["opencode-plugin-boops"]}' > ~/.config/opencode/opencode.json
-```
+# Install plugin (adds to OpenCode config)
+npx opencode-plugin-boops install
 
-Or for a specific project:
+# Uninstall plugin (removes from config)
+npx opencode-plugin-boops uninstall        # Interactive - asks about data cleanup
+npx opencode-plugin-boops uninstall --full # Remove plugin + data
 
-```bash
-# In your project directory
-echo '{"$schema":"https://opencode.ai/config.json","plugin":["opencode-plugin-boops"]}' > opencode.json
+# Browse 448 sounds with semantic tags
+npx opencode-plugin-boops browse
+
+# Show help
+npx opencode-plugin-boops
 ```
 
 ## How it works
@@ -64,30 +72,27 @@ Sounds are downloaded once on first use and cached in `~/.cache/opencode/boops/`
 
 ## Configuration
 
-The plugin uses a TOML configuration file located at `~/.config/opencode/boops.toml`.
+The plugin automatically creates a configuration file at `~/.config/opencode/plugins/boops/boops.toml` on first install.
 
-### Create your config
+### Customize your config
 
-Copy the default configuration:
+The config is automatically created from `boops.default.toml` when you install the plugin. Edit it to customize your sounds:
 
 ```bash
-# Get the default config template
-curl -o ~/.config/opencode/boops.toml https://raw.githubusercontent.com/towc/opencode-plugin-boops/main/boops.default.toml
+# Edit your config
+$EDITOR ~/.config/opencode/plugins/boops/boops.toml
 ```
 
-Or create it manually:
+Example configuration:
 
 ```toml
-# ~/.config/opencode/boops.toml
+# ~/.config/opencode/plugins/boops/boops.toml
 
 [sounds]
-# Simple: Use notificationsounds.com IDs (recommended)
-"session.idle" = "1150-pristine"
-"permission.asked" = "1217-relax"
-"session.error" = "1219-magic"
-
-# Or search by name (finds first match):
-# "session.idle" = "pristine"
+# Use sound names from sounds.json (recommended)
+"session.idle" = "pristine"
+"permission.asked" = "relax"
+"session.error" = "magic"
 
 # Or use full URLs:
 # "session.idle" = "https://example.com/sound.ogg"
@@ -100,13 +105,14 @@ Or create it manually:
 
 The plugin supports multiple ways to specify sounds:
 
-**1. notificationsounds.com IDs (easiest):**
+**1. Sound names from sounds.json (easiest):**
 ```toml
-"session.idle" = "1150-pristine"  # Direct ID (fast)
-"session.idle" = "pristine"       # Search by name (slower, first match)
+"session.idle" = "pristine"
+"permission.asked" = "relax"
+"session.error" = "magic"
 ```
 
-Browse sounds at [notificationsounds.com](https://notificationsounds.com/notification-sounds) to find IDs.
+Use the TUI browser (`~/.config/opencode/plugins/boops/browse`) to explore all 448 sounds with semantic tags!
 
 **2. Full URLs:**
 ```toml
@@ -177,7 +183,7 @@ For advanced use cases, you can add filters to play sounds only when certain con
 
 ```toml
 [sounds.session.idle]
-sound = "https://notificationsounds.com/storage/sounds/file-sounds-1150-pristine.ogg"
+sound = "pristine"
 not_if = { agent = "explore" }  # Skip subagent completions
 ```
 
@@ -208,8 +214,9 @@ You can test sounds without restarting OpenCode using the custom tool:
 test-sound session.idle
 
 # Test a sound ID directly
+# Test by sound name
 test-sound pristine
-test-sound 1150-pristine
+test-sound "access granted computer voice"
 
 # Test a URL directly  
 test-sound https://example.com/sound.ogg
@@ -231,11 +238,11 @@ The test command automatically reloads your config file, so you can edit `boops.
 The plugin includes a beautiful TUI for browsing and assigning sounds:
 
 ```bash
-# If plugin is installed
-~/.config/opencode/plugins/boops/browse
-
-# Or try it with npx (browse-only, saving disabled)
+# Browse and test sounds
 npx opencode-plugin-boops browse
+
+# Or after installation:
+~/.config/opencode/plugins/boops/browse
 ```
 
 Features:

package/boops.default.toml

@@ -4,20 +4,19 @@
 # player = "paplay"  # Auto-detected if not set (paplay/aplay/afplay)
 
 [sounds]
-"session.idle" = "1150-pristine"  # AI completes response
-"permission.asked" = "1217-relax"  # AI needs permission
-"session.error" = "1219-magic"  # Error occurs
+"session.idle" = "pristine"  # AI completes response
+"permission.asked" = "relax"  # AI needs permission
+"session.error" = "magic"  # Error occurs
 
 # You can use:
-# - Sound IDs: "pristine" (searches notificationsounds.com)
-# - Numeric IDs: "1150-pristine" (direct match, faster)
+# - Sound names: "pristine" (searches sounds.json by name)
 # - Full URLs: "https://example.com/sound.ogg"
 # - Local paths: "/usr/share/sounds/..."
 
 # Advanced: Event filters (play sound only when conditions match)
 # Uncomment and adjust after checking logs to see available properties
 # [sounds.session.idle]
-# sound = "1150-pristine"
+# sound = "pristine"
 # not_if = { agent = "explore" }  # Don't play for subagent completions
 
 # Optional events (uncomment to enable):

package/cli/browse

@@ -58,7 +58,7 @@ const PLUGIN_INSTALLED = isPluginInstalled();
 
 // Load current boops.toml config
 function loadCurrentConfig() {
-  const configPath = join(homedir(), ".config", "opencode", "boops.toml");
+  const configPath = join(homedir(), ".config", "opencode", "plugins", "boops", "boops.toml");
   if (!existsSync(configPath)) {
     return {};
   }
@@ -105,7 +105,7 @@ function saveConfig(config) {
     return false;
   }
   
-  const configPath = join(homedir(), ".config", "opencode", "boops.toml");
+  const configPath = join(homedir(), ".config", "opencode", "plugins", "boops", "boops.toml");
   let content = "# OpenCode Boops Plugin Configuration\n\n[sounds]\n";
   
   if (config.sounds) {

package/cli/install

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+/**
+ * OpenCode Boops Plugin - Installer
+ * Automatically adds the plugin to your OpenCode config
+ */
+
+import { existsSync, readFileSync, writeFileSync, mkdirSync } from "fs";
+import { join } from "path";
+import { homedir } from "os";
+
+const CONFIG_DIR = join(homedir(), ".config", "opencode");
+const CONFIG_PATH = join(CONFIG_DIR, "opencode.json");
+const PLUGIN_NAME = "opencode-plugin-boops";
+
+console.log("🔊 OpenCode Boops Plugin Installer\n");
+
+// Ensure config directory exists
+mkdirSync(CONFIG_DIR, { recursive: true });
+
+// Read or create config
+let config;
+if (existsSync(CONFIG_PATH)) {
+  console.log("📝 Found existing OpenCode config");
+  try {
+    const content = readFileSync(CONFIG_PATH, "utf-8");
+    config = JSON.parse(content);
+  } catch (error) {
+    console.error("❌ Failed to parse opencode.json:", error.message);
+    console.log("Please fix your config manually at:", CONFIG_PATH);
+    process.exit(1);
+  }
+} else {
+  console.log("📝 Creating new OpenCode config");
+  config = {
+    "$schema": "https://opencode.ai/config.json",
+  };
+}
+
+// Add plugin if not already present
+if (!config.plugin) {
+  config.plugin = [];
+} else if (typeof config.plugin === "string") {
+  config.plugin = [config.plugin];
+}
+
+if (config.plugin.includes(PLUGIN_NAME)) {
+  console.log("✓ Plugin already installed in config");
+} else {
+  config.plugin.push(PLUGIN_NAME);
+  writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2) + "\n");
+  console.log("✓ Added plugin to OpenCode config");
+}
+
+console.log("\n📍 Config location:", CONFIG_PATH);
+console.log("\n🎵 Next steps:");
+console.log("  1. Restart OpenCode (the plugin will auto-install)");
+console.log("  2. Browse sounds: npx opencode-plugin-boops browse");
+console.log("  3. Customize config: $EDITOR ~/.config/opencode/plugins/boops/boops.toml");
+console.log("\n✨ Done!");

package/cli/main

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+/**
+ * OpenCode Boops Plugin - CLI Entry Point
+ */
+
+import { spawn } from "child_process";
+import { fileURLToPath } from "url";
+import { dirname, join } from "path";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const command = process.argv[2] || "browse";
+const args = process.argv.slice(3);
+
+const commands = {
+  install: join(__dirname, "install"),
+  uninstall: join(__dirname, "uninstall"),
+  browse: join(__dirname, "browse"),
+};
+
+if (!commands[command]) {
+  console.log("OpenCode Boops Plugin\n");
+  console.log("Usage:");
+  console.log("  npx opencode-plugin-boops install    - Add plugin to OpenCode config");
+  console.log("  npx opencode-plugin-boops uninstall  - Remove plugin from config");
+  console.log("  npx opencode-plugin-boops browse     - Browse and test sounds (default)");
+  console.log("  npx opencode-plugin-boops            - Same as browse");
+  process.exit(1);
+}
+
+const child = spawn(commands[command], args, {
+  stdio: "inherit",
+});
+
+child.on("exit", (code) => {
+  process.exit(code || 0);
+});

package/cli/uninstall

@@ -0,0 +1,118 @@
+#!/usr/bin/env node
+/**
+ * OpenCode Boops Plugin - Uninstaller
+ * Removes the plugin from OpenCode config and optionally cleans up data
+ */
+
+import { existsSync, readFileSync, writeFileSync, rmSync } from "fs";
+import { join } from "path";
+import { homedir } from "os";
+import { createInterface } from "readline";
+
+const CONFIG_DIR = join(homedir(), ".config", "opencode");
+const CONFIG_PATH = join(CONFIG_DIR, "opencode.json");
+const PLUGIN_NAME = "opencode-plugin-boops";
+const PLUGIN_DIR = join(CONFIG_DIR, "plugins", "boops");
+const CACHE_DIR = join(homedir(), ".cache", "opencode", "boops");
+
+console.log("🔊 OpenCode Boops Plugin Uninstaller\n");
+
+// Remove from config
+if (existsSync(CONFIG_PATH)) {
+  try {
+    const content = readFileSync(CONFIG_PATH, "utf-8");
+    const config = JSON.parse(content);
+    
+    if (config.plugin) {
+      if (typeof config.plugin === "string") {
+        if (config.plugin === PLUGIN_NAME) {
+          delete config.plugin;
+          console.log("✓ Removed plugin from config");
+        } else {
+          console.log("ℹ Plugin not found in config");
+        }
+      } else if (Array.isArray(config.plugin)) {
+        const index = config.plugin.indexOf(PLUGIN_NAME);
+        if (index > -1) {
+          config.plugin.splice(index, 1);
+          if (config.plugin.length === 0) {
+            delete config.plugin;
+          }
+          console.log("✓ Removed plugin from config");
+        } else {
+          console.log("ℹ Plugin not found in config");
+        }
+      }
+      
+      writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2) + "\n");
+    } else {
+      console.log("ℹ No plugins in config");
+    }
+  } catch (error) {
+    console.error("❌ Failed to update config:", error.message);
+    process.exit(1);
+  }
+} else {
+  console.log("ℹ No OpenCode config found");
+}
+
+// Ask about cleaning up data
+const rl = createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+const shouldCleanup = process.argv.includes("--full") || process.argv.includes("-f");
+
+if (shouldCleanup) {
+  cleanup();
+} else {
+  console.log("\n📦 Plugin data locations:");
+  if (existsSync(PLUGIN_DIR)) {
+    console.log("  • Config & data:", PLUGIN_DIR);
+  }
+  if (existsSync(CACHE_DIR)) {
+    console.log("  • Cached sounds:", CACHE_DIR);
+  }
+  
+  console.log("\n🗑️  Clean up plugin data?");
+  console.log("  This will remove your custom config and cached sounds.");
+  
+  rl.question("\n  Remove data? [y/N] ", (answer) => {
+    if (answer.toLowerCase() === "y" || answer.toLowerCase() === "yes") {
+      cleanup();
+    } else {
+      console.log("\n✓ Kept plugin data (you can remove manually later)");
+      console.log("  rm -rf", PLUGIN_DIR);
+      console.log("  rm -rf", CACHE_DIR);
+    }
+    rl.close();
+  });
+}
+
+function cleanup() {
+  let removed = false;
+  
+  if (existsSync(PLUGIN_DIR)) {
+    rmSync(PLUGIN_DIR, { recursive: true, force: true });
+    console.log("✓ Removed plugin directory");
+    removed = true;
+  }
+  
+  if (existsSync(CACHE_DIR)) {
+    rmSync(CACHE_DIR, { recursive: true, force: true });
+    console.log("✓ Removed cached sounds");
+    removed = true;
+  }
+  
+  if (!removed) {
+    console.log("ℹ No plugin data found");
+  }
+  
+  console.log("\n✨ Uninstall complete!");
+  console.log("\n💡 Restart OpenCode to complete the removal");
+  
+  if (!shouldCleanup) {
+    rl.close();
+  }
+}

package/index.ts

@@ -62,7 +62,7 @@ export const BoopsPlugin: Plugin = async ({ client }) => {
     // Directory might already exist
   }
 
-  const configPath = join(homedir(), ".config", "opencode", "boops.toml")
+  const configPath = join(homedir(), ".config", "opencode", "plugins", "boops", "boops.toml")
 
   // Load configuration (can be called multiple times to reload)
   const loadConfig = async (): Promise<BoopsConfig> => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-plugin-boops",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Sound notifications for OpenCode - plays pleasant sounds when tasks complete or input is needed",
   "main": "index.ts",
   "type": "module",
@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/towc/opencode-plugin-boops#readme",
   "bin": {
-    "opencode-plugin-boops": "cli/browse"
+    "opencode-plugin-boops": "cli/main"
   },
   "peerDependencies": {
     "@opencode-ai/plugin": "^1.0.0"
@@ -33,12 +33,15 @@
     "smol-toml": "^1.3.1"
   },
   "scripts": {
-    "postinstall": "node -e \"const fs=require('fs'),p=require('path'),h=require('os').homedir(),d=p.join(h,'.config','opencode','plugins','boops');fs.mkdirSync(d,{recursive:true});fs.copyFileSync(p.join(__dirname,'cli','browse'),p.join(d,'browse'));fs.copyFileSync(p.join(__dirname,'sounds.json'),p.join(d,'sounds.json'));fs.chmodSync(p.join(d,'browse'),0o755);console.log('✓ Installed browse CLI to ~/.config/opencode/plugins/boops/browse')\""
+    "postinstall": "node -e \"const fs=require('fs'),p=require('path'),h=require('os').homedir(),d=p.join(h,'.config','opencode','plugins','boops');fs.mkdirSync(d,{recursive:true});const cfg=p.join(d,'boops.toml');if(!fs.existsSync(cfg))fs.copyFileSync(p.join(__dirname,'boops.default.toml'),cfg);fs.copyFileSync(p.join(__dirname,'cli','browse'),p.join(d,'browse'));fs.copyFileSync(p.join(__dirname,'sounds.json'),p.join(d,'sounds.json'));fs.chmodSync(p.join(d,'browse'),0o755);console.log('✓ Installed to ~/.config/opencode/plugins/boops/')\""
   },
   "files": [
     "index.ts",
     "sounds.json",
     "boops.default.toml",
+    "cli/main",
+    "cli/install",
+    "cli/uninstall",
     "cli/browse",
     "README.md",
     "LICENSE"