@rama_nigg/open-cursor 2.3.0 → 2.3.2

package/README.md

@@ -9,27 +9,63 @@ No prompt limits. No broken streams. Full thinking + tool support in Opencode. Y
 
 ## Installation
 
-**Option A: One-Line Install**
+**Option A — Add to opencode.json (Recommended)**
+
+The simplest approach—just add the npm package to your OpenCode config:
+
+```json
+{
+  "plugin": ["@rama_nigg/open-cursor@latest"],
+  "provider": {
+    "cursor-acp": {
+      "name": "Cursor ACP",
+      "npm": "@ai-sdk/openai-compatible",
+      "models": {
+        "cursor-acp/claude-sonnet": { "name": "Claude Sonnet" },
+        "cursor-acp/gpt-4o": { "name": "GPT-4o" },
+        "cursor-acp/gemini-2.5-pro": { "name": "Gemini 2.5 Pro" },
+        "cursor-acp/cursor-small": { "name": "Cursor Small" }
+      }
+    }
+  }
+}
+```
+
+> **Note:** The model identifiers shown above are examples. Run `cursor-agent models` after authentication to see the full list of models available for your account.
+
+After authenticating with `cursor-agent login`, run `cursor-agent models` to see the full model list, or use one of the automated installers below to auto-discover models.
+
+**Prerequisites:** OpenCode and cursor-agent required. Install cursor-agent with: `curl -fsSL https://cursor.com/install | bash && cursor-agent login`. OpenCode's Bun runtime resolves the npm package automatically.
+
+**Option B — One-line installer (curl)**
 
 ```bash
 curl -fsSL https://raw.githubusercontent.com/Nomadcxx/opencode-cursor/main/install.sh | bash
 ```
 
-**Option B: npm Package (Recommended)**
+This automated installer detects your environment and chooses the best installation method.
+
+**Option C — npm global install + CLI symlink**
+
+Installs globally via npm and creates a symlink in the OpenCode plugin directory:
 
 ```bash
 npm install -g @rama_nigg/open-cursor
 open-cursor install
 ```
 
+The `open-cursor install` command creates a symlink at `~/.config/opencode/plugin/cursor-acp.js` pointing to the npm package's entry file.
+
 Upgrade later with:
 
 ```bash
 npm update -g @rama_nigg/open-cursor
-open-cursor install
+# Symlink automatically uses updated files
 ```
 
-**Option C: TUI Installer**
+**Option D — Go TUI installer**
+
+Interactive visual installer with dual-mode support (quick install or build from source):
 
 ```bash
 git clone https://github.com/Nomadcxx/opencode-cursor.git
@@ -37,46 +73,55 @@ cd opencode-cursor
 go build -o ./installer ./cmd/installer && ./installer
 ```
 
-**Option D: Let an LLM do it**
+**Option E — LLM instructions**
 
 Paste this into any LLM agent (Claude Code, OpenCode, Cursor, etc.):
 
 ```
-Install the cursor-acp plugin for OpenCode:
-
-1. Preferred install (npm):
-   npm install -g @rama_nigg/open-cursor
-   open-cursor install
-
-2. Fallback (build from source):
-   git clone https://github.com/Nomadcxx/opencode-cursor.git
-   cd opencode-cursor
-   bun install && bun run build
-   mkdir -p ~/.config/opencode/plugin
-   ln -sf $(pwd)/dist/plugin-entry.js ~/.config/opencode/plugin/cursor-acp.js
-   ./scripts/sync-models.sh
-
-3. Verify:
-   opencode models | grep cursor-acp
+Install the cursor-acp plugin for OpenCode using the npm package approach:
+
+1. Edit your opencode.json config file (usually at ~/.config/opencode/opencode.json)
+2. Add "@rama_nigg/open-cursor@latest" to the plugin array
+3. Add the cursor-acp provider configuration with models
+4. Restart OpenCode
+
+Example configuration:
+{
+  "plugin": ["@rama_nigg/open-cursor@latest"],
+  "provider": {
+    "cursor-acp": {
+      "name": "Cursor ACP",
+      "npm": "@ai-sdk/openai-compatible",
+      "models": {
+        "cursor-acp/claude-sonnet": { "name": "Claude Sonnet" }
+      }
+    }
+  }
+}
+
+5. Authenticate: cursor-agent login
+6. Verify: opencode models | grep cursor-acp
 ```
 
-**Option E: Manual Install**
+**Option F — Manual (from source)**
+
+For developers and contributors who want full control:
 
 ```bash
+git clone https://github.com/Nomadcxx/opencode-cursor.git
+cd opencode-cursor
 bun install && bun run build
 mkdir -p ~/.config/opencode/plugin
 ln -sf $(pwd)/dist/plugin-entry.js ~/.config/opencode/plugin/cursor-acp.js
 ```
 
-The installers handle the rest automatically. If you're doing a manual install, you'll need to do the following steps yourself.
-
-Easiest way is to run the sync script, which populates everything for you:
+The automated installers handle configuration automatically. For manual installs, run the sync script to populate models:
 
 ```bash
 ./scripts/sync-models.sh
 ```
 
-Or if you'd rather do it by hand, add this to `~/.config/opencode/opencode.json` (then run `./scripts/sync-models.sh` to populate models):
+Or configure manually by adding this to `~/.config/opencode/opencode.json` (then run `./scripts/sync-models.sh` to populate models):
 
 ```json
 {
@@ -126,6 +171,22 @@ Or if you'd rather do it by hand, add this to `~/.config/opencode/opencode.json`
 }
 ```
 
+### Plugin Configuration Reference
+
+Depending on your installation method, use the appropriate plugin identifier:
+
+**npm package (recommended for production):**
+```json
+"plugin": ["@rama_nigg/open-cursor@latest"]
+```
+
+**Local build (for development):**
+```json
+"plugin": ["cursor-acp"]
+```
+
+Both approaches work—the npm package is resolved automatically by OpenCode's Bun runtime, while the local build requires the symlink setup shown in Option F above.
+
 ## Authentication
 
 ### Option 1: Via OpenCode (Recommended)
@@ -206,12 +267,15 @@ Detailed architecture: [docs/architecture/runtime-tool-loop.md](docs/architectur
 
 ## Prerequisites
 
+**For Option A (npm-direct):** [OpenCode](https://opencode.ai/) and [cursor-agent](https://cursor.com/) required. The npm package is resolved by OpenCode's Bun runtime, but cursor-agent handles the actual API communication.
+
+**For Options B-F:**
 - [Bun](https://bun.sh/)
 - [cursor-agent](https://cursor.com/) - `curl -fsSL https://cursor.com/install | bash`
 
-**Option A (one-line install):** If Go is installed, the script runs the TUI installer; otherwise it performs a shell-only install (Bun + cursor-agent required). For syncing models without the TUI, install [jq](https://jq.org/) or run `./scripts/sync-models.sh` after install.
+**Option B (one-line install):** If Go is installed, the script runs the TUI installer; otherwise it performs a shell-only install (OpenCode + cursor-agent required). For syncing models without the TUI, install [jq](https://jq.org/) or run `./scripts/sync-models.sh` after install.
 
-**Option B (TUI installer):** Go 1.21+ required to build the installer.
+**Option D (TUI installer):** Go 1.21+ required to build the installer.
 
 ## Features
 

package/dist/cli/opencode-cursor.js

@@ -236,9 +236,24 @@ function checkOpenCode() {
     };
   }
 }
-function checkPluginFile(pluginPath) {
+function isNpmDirectInstalled(config) {
+  if (!config || typeof config !== "object")
+    return false;
+  const plugins = config.plugin;
+  if (!Array.isArray(plugins))
+    return false;
+  return plugins.some((p) => typeof p === "string" && p.startsWith(NPM_PACKAGE_PREFIX));
+}
+function checkPluginFile(pluginPath, config) {
   try {
     if (!existsSync(pluginPath)) {
+      if (isNpmDirectInstalled(config)) {
+        return {
+          name: "Plugin file",
+          passed: true,
+          message: "Installed via npm package (no symlink needed)"
+        };
+      }
       return {
         name: "Plugin file",
         passed: false,
@@ -308,17 +323,24 @@ function checkAiSdk(opencodeDir) {
 }
 function runDoctorChecks(configPath, pluginPath) {
   const opencodeDir = dirname(configPath);
+  let config;
+  try {
+    config = readConfig(configPath);
+  } catch {
+    config = undefined;
+  }
   return [
     checkBun(),
     checkCursorAgent(),
     checkCursorAgentLogin(),
     checkOpenCode(),
-    checkPluginFile(pluginPath),
+    checkPluginFile(pluginPath, config),
     checkProviderConfig(configPath),
     checkAiSdk(opencodeDir)
   ];
 }
 var PROVIDER_ID = "cursor-acp";
+var NPM_PACKAGE_PREFIX = "@rama_nigg/open-cursor";
 var DEFAULT_BASE_URL = "http://127.0.0.1:32124/v1";
 function printHelp() {
   const binName = basename(process.argv[1] || "open-cursor");
@@ -527,13 +549,20 @@ function commandSyncModels(options) {
   console.log(`Models synced: ${models.length}`);
   console.log(`Config path: ${configPath}`);
 }
+var NPM_PACKAGE = "@rama_nigg/open-cursor";
 function commandUninstall(options) {
   const { configPath, pluginPath } = resolvePaths(options);
   rmSync(pluginPath, { force: true });
   if (existsSync(configPath)) {
     const config = readConfig(configPath);
     if (Array.isArray(config.plugin)) {
-      config.plugin = config.plugin.filter((name) => name !== PROVIDER_ID);
+      config.plugin = config.plugin.filter((name) => {
+        if (name === PROVIDER_ID)
+          return false;
+        if (typeof name === "string" && name.startsWith(NPM_PACKAGE))
+          return false;
+        return true;
+      });
     }
     if (config.provider && typeof config.provider === "object") {
       delete config.provider[PROVIDER_ID];
@@ -565,22 +594,32 @@ function getStatusResult(configPath, pluginPath) {
       pluginTarget = undefined;
     }
   }
+  let config;
   let providerEnabled = false;
   let baseUrl = "http://127.0.0.1:32124/v1";
   let modelCount = 0;
   if (existsSync(configPath)) {
-    const config = readConfig(configPath);
+    config = readConfig(configPath);
     const provider = config.provider?.["cursor-acp"];
     providerEnabled = !!provider;
     if (provider?.options?.baseURL) {
       baseUrl = provider.options.baseURL;
     }
     modelCount = Object.keys(provider?.models || {}).length;
+  } else {
+    config = undefined;
   }
   const opencodeDir = dirname(configPath);
   const sdkPath = join(opencodeDir, "node_modules", "@ai-sdk", "openai-compatible");
   const aiSdkInstalled = existsSync(sdkPath);
+  let installMethod = "none";
+  if (pluginType !== "missing") {
+    installMethod = "symlink";
+  } else if (isNpmDirectInstalled(config)) {
+    installMethod = "npm-direct";
+  }
   return {
+    installMethod,
     plugin: {
       path: pluginPath,
       type: pluginType,
@@ -615,6 +654,7 @@ function commandStatus(options) {
   } else {
     console.log(`  Type: missing`);
   }
+  console.log(`  Install method: ${result.installMethod}`);
   console.log("");
   console.log("Provider");
   console.log(`  Config: ${result.provider.configPath}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rama_nigg/open-cursor",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "No prompt limits. No broken streams. Full thinking + tool support. Your Cursor subscription, properly integrated.",
   "type": "module",
   "main": "dist/index.js",

package/src/cli/opencode-cursor.ts

@@ -37,6 +37,7 @@ type CheckResult = {
 };
 
 type StatusResult = {
+  installMethod: "symlink" | "npm-direct" | "none";
   plugin: {
     path: string;
     type: "symlink" | "file" | "missing";
@@ -110,9 +111,23 @@ function checkOpenCode(): CheckResult {
   }
 }
 
-function checkPluginFile(pluginPath: string): CheckResult {
+function isNpmDirectInstalled(config: unknown): boolean {
+  if (!config || typeof config !== "object") return false;
+  const plugins = (config as Record<string, unknown>).plugin;
+  if (!Array.isArray(plugins)) return false;
+  return plugins.some((p) => typeof p === "string" && p.startsWith(NPM_PACKAGE_PREFIX));
+}
+
+function checkPluginFile(pluginPath: string, config: unknown): CheckResult {
   try {
     if (!existsSync(pluginPath)) {
+      if (isNpmDirectInstalled(config)) {
+        return {
+          name: "Plugin file",
+          passed: true,
+          message: "Installed via npm package (no symlink needed)",
+        };
+      }
       return {
         name: "Plugin file",
         passed: false,
@@ -185,12 +200,18 @@ function checkAiSdk(opencodeDir: string): CheckResult {
 
 export function runDoctorChecks(configPath: string, pluginPath: string): CheckResult[] {
   const opencodeDir = dirname(configPath);
+  let config: unknown;
+  try {
+    config = readConfig(configPath);
+  } catch {
+    config = undefined;
+  }
   return [
     checkBun(),
     checkCursorAgent(),
     checkCursorAgentLogin(),
     checkOpenCode(),
-    checkPluginFile(pluginPath),
+    checkPluginFile(pluginPath, config),
     checkProviderConfig(configPath),
     checkAiSdk(opencodeDir),
   ];
@@ -209,6 +230,7 @@ type Options = {
 };
 
 const PROVIDER_ID = "cursor-acp";
+const NPM_PACKAGE_PREFIX = "@rama_nigg/open-cursor";
 const DEFAULT_BASE_URL = "http://127.0.0.1:32124/v1";
 
 function printHelp() {
@@ -443,6 +465,8 @@ function commandSyncModels(options: Options) {
   console.log(`Config path: ${configPath}`);
 }
 
+const NPM_PACKAGE = "@rama_nigg/open-cursor";
+
 function commandUninstall(options: Options) {
   const { configPath, pluginPath } = resolvePaths(options);
   rmSync(pluginPath, { force: true });
@@ -450,7 +474,12 @@ function commandUninstall(options: Options) {
   if (existsSync(configPath)) {
     const config = readConfig(configPath);
     if (Array.isArray(config.plugin)) {
-      config.plugin = config.plugin.filter((name: string) => name !== PROVIDER_ID);
+      // Remove both cursor-acp (symlink) and @rama_nigg/open-cursor (npm-direct) entries
+      config.plugin = config.plugin.filter((name: string) => {
+        if (name === PROVIDER_ID) return false;
+        if (typeof name === "string" && name.startsWith(NPM_PACKAGE)) return false;
+        return true;
+      });
     }
     if (config.provider && typeof config.provider === "object") {
       delete config.provider[PROVIDER_ID];
@@ -487,17 +516,20 @@ export function getStatusResult(configPath: string, pluginPath: string): StatusR
   }
 
   // Provider
+  let config: any;
   let providerEnabled = false;
   let baseUrl = "http://127.0.0.1:32124/v1";
   let modelCount = 0;
   if (existsSync(configPath)) {
-    const config = readConfig(configPath);
+    config = readConfig(configPath);
     const provider = config.provider?.["cursor-acp"];
     providerEnabled = !!provider;
     if (provider?.options?.baseURL) {
       baseUrl = provider.options.baseURL;
     }
     modelCount = Object.keys(provider?.models || {}).length;
+  } else {
+    config = undefined;
   }
 
   // AI SDK
@@ -505,7 +537,15 @@ export function getStatusResult(configPath: string, pluginPath: string): StatusR
   const sdkPath = join(opencodeDir, "node_modules", "@ai-sdk", "openai-compatible");
   const aiSdkInstalled = existsSync(sdkPath);
 
+  let installMethod: "symlink" | "npm-direct" | "none" = "none";
+  if (pluginType !== "missing") {
+    installMethod = "symlink";
+  } else if (isNpmDirectInstalled(config)) {
+    installMethod = "npm-direct";
+  }
+
   return {
+    installMethod,
     plugin: {
       path: pluginPath,
       type: pluginType,
@@ -543,6 +583,7 @@ function commandStatus(options: Options) {
   } else {
     console.log(`  Type: missing`);
   }
+  console.log(`  Install method: ${result.installMethod}`);
 
   console.log("");
   console.log("Provider");