opencode-sync-plugin 0.1.1 → 0.1.5

package/README.md

@@ -49,7 +49,16 @@ No browser authentication required.
 
 ### 3. Add to OpenCode
 
-Add the plugin to your `opencode.json`:
+**Quick setup (global config, works for all projects):**
+
+```bash
+mkdir -p ~/.config/opencode && echo '{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["opencode-sync-plugin"]
+}' > ~/.config/opencode/opencode.json
+```
+
+**Or manually add** to your `opencode.json`:
 
 ```json
 {
@@ -58,7 +67,34 @@ Add the plugin to your `opencode.json`:
 }
 ```
 
-Or add globally at `~/.config/opencode/opencode.json`.
+**Config locations:**
+
+- Global: `~/.config/opencode/opencode.json` (applies to all projects)
+- Per-project: `./opencode.json` in your project root
+
+> **Note:** If you already have an `opencode.json` with other settings, edit the file manually and add `"plugin": ["opencode-sync-plugin"]` to preserve your existing configuration. OpenCode merges configs, so you can keep your theme, model, and other settings.
+
+### 4. Verify installation
+
+```bash
+opencode-sync verify
+```
+
+This checks that both your credentials and OpenCode config are set up correctly. You should see:
+
+```
+  OpenSync Setup Verification
+
+  Credentials: OK
+  Convex URL: https://your-project.convex.cloud
+  API Key: osk_****...****
+
+  OpenCode Config: OK
+  Config file: ~/.config/opencode/opencode.json
+  Plugin registered: opencode-sync-plugin
+
+  Ready! Start OpenCode and the plugin will load automatically.
+```
 
 ## How it works
 
@@ -79,6 +115,7 @@ Data is stored in your Convex deployment. You can view, search, and share sessio
 | Command | Description |
 |---------|-------------|
 | `opencode-sync login` | Configure with Convex URL and API Key |
+| `opencode-sync verify` | Verify credentials and OpenCode config |
 | `opencode-sync logout` | Clear stored credentials |
 | `opencode-sync status` | Show authentication status |
 | `opencode-sync config` | Show current configuration |
@@ -123,6 +160,35 @@ export const OpenCodeSyncPlugin: Plugin = async ({ project, client, $, directory
 
 ## Troubleshooting
 
+### OpenCode won't start or shows blank screen
+
+If OpenCode hangs or shows a blank screen after adding the plugin, remove the plugin config:
+
+**Step 1: Open a new terminal window**
+
+**Step 2: Remove the plugin from your config**
+
+```bash
+# Option A: Delete the entire config (if you only have the plugin configured)
+rm ~/.config/opencode/opencode.json
+
+# Option B: Edit the file to remove the plugin line
+nano ~/.config/opencode/opencode.json
+# Remove the "plugin": ["opencode-sync-plugin"] line and save
+```
+
+**Step 3: Clear the plugin cache**
+
+```bash
+rm -rf ~/.cache/opencode/node_modules/opencode-sync-plugin
+```
+
+**Step 4: Restart OpenCode**
+
+```bash
+opencode
+```
+
 ### "Not authenticated" errors
 
 ```bash

package/dist/{chunk-LXC2JAKD.js → chunk-PAZWJPY7.js}

@@ -2,23 +2,32 @@
 import Conf from "conf";
 import { homedir } from "os";
 import { join } from "path";
-var config = new Conf({
-  projectName: "opencode-sync",
-  cwd: join(homedir(), ".config", "opencode-sync"),
-  configName: "config"
-});
+var _config = null;
+function getConfInstance() {
+  if (!_config) {
+    _config = new Conf({
+      projectName: "opencode-sync",
+      cwd: join(homedir(), ".config", "opencode-sync"),
+      configName: "config"
+    });
+  }
+  return _config;
+}
 function getConfig() {
-  const url = config.get("convexUrl");
-  const key = config.get("apiKey");
+  const conf = getConfInstance();
+  const url = conf.get("convexUrl");
+  const key = conf.get("apiKey");
   if (!url) return null;
   return { convexUrl: url, apiKey: key || "" };
 }
 function setConfig(cfg) {
-  config.set("convexUrl", cfg.convexUrl);
-  config.set("apiKey", cfg.apiKey);
+  const conf = getConfInstance();
+  conf.set("convexUrl", cfg.convexUrl);
+  conf.set("apiKey", cfg.apiKey);
 }
 function clearConfig() {
-  config.clear();
+  const conf = getConfInstance();
+  conf.clear();
 }
 function getApiKey() {
   const cfg = getConfig();

package/dist/cli.js

@@ -3,9 +3,12 @@ import {
   clearConfig,
   getConfig,
   setConfig
-} from "./chunk-LXC2JAKD.js";
+} from "./chunk-PAZWJPY7.js";
 
 // src/cli.ts
+import { readFileSync, existsSync } from "fs";
+import { homedir } from "os";
+import { join } from "path";
 var args = process.argv.slice(2);
 var command = args[0];
 async function main() {
@@ -13,6 +16,9 @@ async function main() {
     case "login":
       await login();
       break;
+    case "verify":
+      verify();
+      break;
     case "logout":
       logout();
       break;
@@ -59,8 +65,16 @@ async function login() {
     console.log("\nLogin successful!\n");
     console.log("  Convex URL:", convexUrl);
     console.log("  API Key:", apiKey.slice(0, 8) + "..." + apiKey.slice(-4));
-    console.log("\n  Add the plugin to your opencode.json:");
-    console.log('  { "plugin": ["opencode-sync-plugin"] }\n');
+    console.log("\n  Next step: Add the plugin to OpenCode\n");
+    console.log("  Run this command (copy/paste into terminal):\n");
+    console.log(`  mkdir -p ~/.config/opencode && echo '{
+    "$schema": "https://opencode.ai/config.json",
+    "plugin": ["opencode-sync-plugin"]
+  }' > ~/.config/opencode/opencode.json`);
+    console.log("\n  Then verify your setup:\n");
+    console.log("  opencode-sync verify\n");
+    console.log("  Note: If you have existing opencode.json settings, manually add");
+    console.log('  "plugin": ["opencode-sync-plugin"] to preserve your config.\n');
   } catch (e) {
     console.error("\nFailed to connect to OpenSync backend.");
     console.error("Please verify your Convex URL is correct.");
@@ -71,6 +85,66 @@ function logout() {
   clearConfig();
   console.log("\nLogged out successfully\n");
 }
+function verify() {
+  console.log("\n  OpenSync Setup Verification\n");
+  let hasErrors = false;
+  const config = getConfig();
+  if (!config || !config.apiKey) {
+    console.log("  Credentials: MISSING");
+    console.log("  Run: opencode-sync login\n");
+    hasErrors = true;
+  } else {
+    console.log("  Credentials: OK");
+    console.log("  Convex URL:", config.convexUrl);
+    console.log("  API Key:", config.apiKey.slice(0, 8) + "..." + config.apiKey.slice(-4));
+    console.log();
+  }
+  const opencodeConfigPath = join(homedir(), ".config", "opencode", "opencode.json");
+  const projectConfigPath = join(process.cwd(), "opencode.json");
+  let configFound = false;
+  let configPath = "";
+  let pluginRegistered = false;
+  for (const path of [opencodeConfigPath, projectConfigPath]) {
+    if (existsSync(path)) {
+      configFound = true;
+      configPath = path;
+      try {
+        const content = readFileSync(path, "utf8");
+        const parsed = JSON.parse(content);
+        if (parsed.plugin && Array.isArray(parsed.plugin) && parsed.plugin.includes("opencode-sync-plugin")) {
+          pluginRegistered = true;
+          break;
+        }
+      } catch {
+      }
+    }
+  }
+  if (!configFound) {
+    console.log("  OpenCode Config: MISSING");
+    console.log("  Run this command to create it:\n");
+    console.log(`  mkdir -p ~/.config/opencode && echo '{
+    "$schema": "https://opencode.ai/config.json",
+    "plugin": ["opencode-sync-plugin"]
+  }' > ~/.config/opencode/opencode.json
+`);
+    hasErrors = true;
+  } else if (!pluginRegistered) {
+    console.log("  OpenCode Config: FOUND but plugin not registered");
+    console.log("  Config file:", configPath);
+    console.log('  Add "plugin": ["opencode-sync-plugin"] to your config\n');
+    hasErrors = true;
+  } else {
+    console.log("  OpenCode Config: OK");
+    console.log("  Config file:", configPath);
+    console.log("  Plugin registered: opencode-sync-plugin");
+    console.log();
+  }
+  if (hasErrors) {
+    console.log("  Setup incomplete. Fix the issues above and run verify again.\n");
+  } else {
+    console.log("  Ready! Start OpenCode and the plugin will load automatically.\n");
+  }
+}
 function status() {
   const config = getConfig();
   console.log("\n  OpenSync Status\n");
@@ -110,6 +184,7 @@ function help() {
 
   Commands:
     login   Configure with Convex URL and API Key
+    verify  Verify credentials and OpenCode config
     logout  Clear stored credentials
     status  Show current authentication status
     config  Show current configuration
@@ -119,7 +194,8 @@ function help() {
     2. Generate an API Key (starts with osk_)
     3. Run: opencode-sync login
     4. Enter your Convex URL and API Key
-    5. Add plugin to opencode.json: { "plugin": ["opencode-sync-plugin"] }
+    5. Add plugin to opencode.json (see instructions after login)
+    6. Run: opencode-sync verify
 `);
 }
 function prompt(question) {

package/dist/index.js

@@ -3,7 +3,7 @@ import {
   clearConfig,
   getConfig,
   setConfig
-} from "./chunk-LXC2JAKD.js";
+} from "./chunk-PAZWJPY7.js";
 export {
   OpenCodeSyncPlugin,
   clearConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-sync-plugin",
-  "version": "0.1.1",
+  "version": "0.1.5",
   "description": "Sync your OpenCode sessions to the cloud",
   "type": "module",
   "main": "dist/index.js",