@rama_nigg/open-cursor 2.1.6 → 2.2.0

package/README.md

@@ -15,20 +15,18 @@ No prompt limits. No broken streams. Full thinking + tool support in Opencode. Y
 curl -fsSL https://raw.githubusercontent.com/Nomadcxx/opencode-cursor/main/install.sh | bash
 ```
 
-Note: if `npm` is available, `install.sh` installs/upgrades `@rama_nigg/open-cursor` and configures OpenCode automatically. Otherwise it falls back to building from source.
-
 **Option B: npm Package (Recommended)**
 
 ```bash
 npm install -g @rama_nigg/open-cursor
-npm exec -- @rama_nigg/open-cursor install
+open-cursor install
 ```
 
 Upgrade later with:
 
 ```bash
 npm update -g @rama_nigg/open-cursor
-npm exec -- @rama_nigg/open-cursor install
+open-cursor install
 ```
 
 **Option C: TUI Installer**
@@ -48,7 +46,7 @@ Install the cursor-acp plugin for OpenCode:
 
 1. Preferred install (npm):
    npm install -g @rama_nigg/open-cursor
-   npm exec -- @rama_nigg/open-cursor install
+   open-cursor install
 
 2. Fallback (build from source):
    git clone https://github.com/Nomadcxx/opencode-cursor.git
@@ -89,7 +87,39 @@ Or if you'd rather do it by hand, add this to `~/.config/opencode/opencode.json`
       "npm": "@ai-sdk/openai-compatible",
       "options": { "baseURL": "http://127.0.0.1:32124/v1" },
       "models": {
-        "auto": { "name": "Auto" }
+        "auto": { "name": "Auto" },
+        "composer-1.5": { "name": "Composer 1.5" },
+        "composer-1": { "name": "Composer 1" },
+        "gpt-5.3-codex": { "name": "GPT-5.3 Codex" },
+        "gpt-5.3-codex-low": { "name": "GPT-5.3 Codex Low" },
+        "gpt-5.3-codex-high": { "name": "GPT-5.3 Codex High" },
+        "gpt-5.3-codex-xhigh": { "name": "GPT-5.3 Codex Extra High" },
+        "gpt-5.3-codex-fast": { "name": "GPT-5.3 Codex Fast" },
+        "gpt-5.3-codex-low-fast": { "name": "GPT-5.3 Codex Low Fast" },
+        "gpt-5.3-codex-high-fast": { "name": "GPT-5.3 Codex High Fast" },
+        "gpt-5.3-codex-xhigh-fast": { "name": "GPT-5.3 Codex Extra High Fast" },
+        "gpt-5.2": { "name": "GPT-5.2" },
+        "gpt-5.2-codex": { "name": "GPT-5.2 Codex" },
+        "gpt-5.2-codex-high": { "name": "GPT-5.2 Codex High" },
+        "gpt-5.2-codex-low": { "name": "GPT-5.2 Codex Low" },
+        "gpt-5.2-codex-xhigh": { "name": "GPT-5.2 Codex Extra High" },
+        "gpt-5.2-codex-fast": { "name": "GPT-5.2 Codex Fast" },
+        "gpt-5.2-codex-high-fast": { "name": "GPT-5.2 Codex High Fast" },
+        "gpt-5.2-codex-low-fast": { "name": "GPT-5.2 Codex Low Fast" },
+        "gpt-5.2-codex-xhigh-fast": { "name": "GPT-5.2 Codex Extra High Fast" },
+        "gpt-5.1-codex-max": { "name": "GPT-5.1 Codex Max" },
+        "gpt-5.1-codex-max-high": { "name": "GPT-5.1 Codex Max High" },
+        "opus-4.6-thinking": { "name": "Claude 4.6 Opus (Thinking)" },
+        "sonnet-4.5-thinking": { "name": "Claude 4.5 Sonnet (Thinking)" },
+        "gpt-5.2-high": { "name": "GPT-5.2 High" },
+        "opus-4.6": { "name": "Claude 4.6 Opus" },
+        "opus-4.5": { "name": "Claude 4.5 Opus" },
+        "opus-4.5-thinking": { "name": "Claude 4.5 Opus (Thinking)" },
+        "sonnet-4.5": { "name": "Claude 4.5 Sonnet" },
+        "gpt-5.1-high": { "name": "GPT-5.1 High" },
+        "gemini-3-pro": { "name": "Gemini 3 Pro" },
+        "gemini-3-flash": { "name": "Gemini 3 Flash" },
+        "grok": { "name": "Grok" }
       }
     }
   }
@@ -131,28 +161,6 @@ opencode run "your prompt" --model cursor-acp/auto
 opencode run "your prompt" --model cursor-acp/sonnet-4.5
 ```
 
-## Models
-
-Models are pulled from `cursor-agent models` and written to your config during installation. If Cursor adds new models later:
-
-```bash
-npm exec -- @rama_nigg/open-cursor install
-```
-
-Or, if you installed from source (no npm CLI):
-
-```bash
-./scripts/sync-models.sh
-```
-
-The proxy also exposes a `/v1/models` endpoint that fetches models in real-time:
-
-```bash
-curl http://127.0.0.1:32124/v1/models
-```
-
-Common models: `auto`, `composer-1.5`, `gpt-5.3-codex`, `opus-4.6-thinking`, `sonnet-4.5`, `gemini-3-pro`, `grok`
-
 ## Architecture
 
 ```mermaid
@@ -196,15 +204,6 @@ Detailed architecture: [docs/architecture/runtime-tool-loop.md](docs/architectur
 | **Dependencies**  |      bun, cursor-agent      |                                              npm                                               |                                  bun, cursor-agent                                   |                               Node.js 18+                                |
 | **Port**          |            32124            |                                             18741                                              |                                        32123                                         |                                   4141                                   |
 
-**Key advantages of cursor-acp:**
-
-- Avoids E2BIG errors with large prompts (uses HTTP body, not CLI args)
-- Structured error parsing with actionable suggestions
-- Cross-platform (not locked to macOS Keychain)
-- TUI installer for easy setup
-- Native tool calling with 10 built-in tools, SDK/MCP executor support, and a skills/alias system
-- Uses official cursor-agent CLI (more stable than reverse-engineering Connect-RPC)
-
 ## Prerequisites
 
 - [Bun](https://bun.sh/)
@@ -247,10 +246,6 @@ Integration CI pins OpenCode-owned loop mode to deterministic settings:
 - `CURSOR_ACP_FORWARD_TOOL_CALLS=false`
 - `CURSOR_ACP_EMIT_TOOL_UPDATES=false`
 
-## Publishing
-
-For maintainers, release and npm publish steps are documented in [docs/PUBLISHING.md](docs/PUBLISHING.md).
-
 ## Troubleshooting
 
 **"fetch() URL is invalid"** - Run `opencode auth login` without arguments
@@ -271,26 +266,10 @@ Common causes:
 
 ### Debug Logging
 
-Set the log level via environment variable:
-- `CURSOR_ACP_LOG_LEVEL=debug` - Verbose output for troubleshooting
-- `CURSOR_ACP_LOG_LEVEL=info` - Default level
-- `CURSOR_ACP_LOG_LEVEL=warn` - Warnings and errors only
-- `CURSOR_ACP_LOG_LEVEL=error` - Errors only
-
-Provider-boundary rollout:
-- Default: `CURSOR_ACP_PROVIDER_BOUNDARY=v1`
-- Default: `CURSOR_ACP_PROVIDER_BOUNDARY_AUTOFALLBACK=true`
-- `CURSOR_ACP_PROVIDER_BOUNDARY=legacy` - Original provider/runtime boundary behavior
-- `CURSOR_ACP_PROVIDER_BOUNDARY=v1` - Shared boundary/interception path
-- `CURSOR_ACP_PROVIDER_BOUNDARY_AUTOFALLBACK=false` - Disable fallback and keep strict `v1` behavior
-- `CURSOR_ACP_TOOL_LOOP_MAX_REPEAT=3` - Max repeated failing tool-call fingerprints before guard termination (or fallback when enabled)
-
-Auto-fallback trigger conditions:
-- Only active when `CURSOR_ACP_PROVIDER_BOUNDARY=v1`
-- Triggered when `v1` boundary extraction throws during tool-call interception
-- Triggered when the tool-loop guard threshold is reached (same tool + arg shape + error class)
-- Does not trigger for normal cases like disallowed tools or no tool call
-- Does not trigger for unrelated runtime errors (for example, tool mapper/tool execution failures)
+Enable verbose logs:
+```bash
+CURSOR_ACP_LOG_LEVEL=debug opencode run "your prompt" --model cursor-acp/auto
+```
 
 Disable log output entirely:
 ```bash

package/dist/cli/opencode-cursor.js

@@ -177,18 +177,170 @@ function fallbackModels() {
 }
 
 // src/cli/opencode-cursor.ts
+var BRANDING_HEADER = `
+ ▄▄▄  ▄▄▄▄  ▄▄▄▄▄ ▄▄  ▄▄      ▄▄▄  ▄▄ ▄▄ ▄▄▄▄   ▄▄▄▄   ▄▄▄   ▄▄▄▄
+██ ██ ██ ██ ██▄▄  ███▄██ ▄▄▄ ██ ▀▀ ██ ██ ██ ██ ██▄▄▄  ██ ██  ██ ██
+▀█▄█▀ ██▀▀  ██▄▄▄ ██ ▀██     ▀█▄█▀ ▀█▄█▀ ██▀█▄ ▄▄▄█▀  ▀█▄█▀  ██▀█▄
+`;
+function getBrandingHeader() {
+  return BRANDING_HEADER.trim();
+}
+function checkBun() {
+  try {
+    const version = execFileSync2("bun", ["--version"], { encoding: "utf8" }).trim();
+    return { name: "bun", passed: true, message: `v${version}` };
+  } catch {
+    return {
+      name: "bun",
+      passed: false,
+      message: "not found - install with: curl -fsSL https://bun.sh/install | bash"
+    };
+  }
+}
+function checkCursorAgent() {
+  try {
+    const output = execFileSync2("cursor-agent", ["--version"], { encoding: "utf8" }).trim();
+    const version = output.split(`
+`)[0] || "installed";
+    return { name: "cursor-agent", passed: true, message: version };
+  } catch {
+    return {
+      name: "cursor-agent",
+      passed: false,
+      message: "not found - install with: curl -fsS https://cursor.com/install | bash"
+    };
+  }
+}
+function checkCursorAgentLogin() {
+  try {
+    execFileSync2("cursor-agent", ["models"], { encoding: "utf8", stdio: ["ignore", "pipe", "pipe"] });
+    return { name: "cursor-agent login", passed: true, message: "logged in" };
+  } catch {
+    return {
+      name: "cursor-agent login",
+      passed: false,
+      message: "not logged in - run: cursor-agent login",
+      warning: true
+    };
+  }
+}
+function checkOpenCode() {
+  try {
+    const version = execFileSync2("opencode", ["--version"], { encoding: "utf8" }).trim();
+    return { name: "OpenCode", passed: true, message: version };
+  } catch {
+    return {
+      name: "OpenCode",
+      passed: false,
+      message: "not found - install with: curl -fsSL https://opencode.ai/install | bash"
+    };
+  }
+}
+function checkPluginFile(pluginPath) {
+  try {
+    if (!existsSync(pluginPath)) {
+      return {
+        name: "Plugin file",
+        passed: false,
+        message: "not found - run: open-cursor install"
+      };
+    }
+    const stat = lstatSync(pluginPath);
+    if (stat.isSymbolicLink()) {
+      const target = readFileSync(pluginPath, "utf8");
+      return { name: "Plugin file", passed: true, message: `symlink → ${target}` };
+    }
+    return { name: "Plugin file", passed: true, message: "file (copy)" };
+  } catch {
+    return {
+      name: "Plugin file",
+      passed: false,
+      message: "error reading plugin file"
+    };
+  }
+}
+function checkProviderConfig(configPath) {
+  try {
+    if (!existsSync(configPath)) {
+      return {
+        name: "Provider config",
+        passed: false,
+        message: "config not found - run: open-cursor install"
+      };
+    }
+    const config = readConfig(configPath);
+    const provider = config.provider?.["cursor-acp"];
+    if (!provider) {
+      return {
+        name: "Provider config",
+        passed: false,
+        message: "cursor-acp provider missing - run: open-cursor install"
+      };
+    }
+    const modelCount = Object.keys(provider.models || {}).length;
+    return { name: "Provider config", passed: true, message: `${modelCount} models` };
+  } catch {
+    return {
+      name: "Provider config",
+      passed: false,
+      message: "error reading config"
+    };
+  }
+}
+function checkAiSdk(opencodeDir) {
+  try {
+    const sdkPath = join(opencodeDir, "node_modules", "@ai-sdk", "openai-compatible");
+    if (existsSync(sdkPath)) {
+      return { name: "AI SDK", passed: true, message: "@ai-sdk/openai-compatible installed" };
+    }
+    return {
+      name: "AI SDK",
+      passed: false,
+      message: "not installed - run: open-cursor install"
+    };
+  } catch {
+    return {
+      name: "AI SDK",
+      passed: false,
+      message: "error checking AI SDK"
+    };
+  }
+}
+function runDoctorChecks(configPath, pluginPath) {
+  const opencodeDir = dirname(configPath);
+  return [
+    checkBun(),
+    checkCursorAgent(),
+    checkCursorAgentLogin(),
+    checkOpenCode(),
+    checkPluginFile(pluginPath),
+    checkProviderConfig(configPath),
+    checkAiSdk(opencodeDir)
+  ];
+}
 var PROVIDER_ID = "cursor-acp";
 var DEFAULT_BASE_URL = "http://127.0.0.1:32124/v1";
 function printHelp() {
   const binName = basename(process.argv[1] || "open-cursor");
+  console.log(getBrandingHeader());
   console.log(`${binName}
 
-Usage:
-  ${binName} install [--config <path>] [--plugin-dir <path>] [--base-url <url>] [--copy] [--skip-models] [--no-backup]
-  ${binName} sync-models [--config <path>] [--no-backup]
-  ${binName} uninstall [--config <path>] [--plugin-dir <path>] [--no-backup]
-  ${binName} status [--config <path>] [--plugin-dir <path>]
-  ${binName} help
+Commands:
+  install     Configure OpenCode for Cursor (idempotent, safe to re-run)
+  sync-models Refresh model list from cursor-agent
+  status      Show current configuration state
+  doctor      Diagnose common issues
+  uninstall   Remove cursor-acp from OpenCode config
+  help        Show this help message
+
+Options:
+  --config <path>       Path to opencode.json (default: ~/.config/opencode/opencode.json)
+  --plugin-dir <path>   Path to plugin directory (default: ~/.config/opencode/plugin)
+  --base-url <url>      Proxy base URL (default: http://127.0.0.1:32124/v1)
+  --copy                Copy plugin instead of symlink
+  --skip-models         Skip model sync during install
+  --no-backup           Don't create config backup
+  --json                Output in JSON format (status command only)
 `);
 }
 function parseArgs(argv) {
@@ -212,6 +364,8 @@ function parseArgs(argv) {
     } else if (arg === "--base-url" && rest[i + 1]) {
       options.baseUrl = rest[i + 1];
       i += 1;
+    } else if (arg === "--json") {
+      options.json = true;
     } else {
       throw new Error(`Unknown argument: ${arg}`);
     }
@@ -219,13 +373,14 @@ function parseArgs(argv) {
   return { command, options };
 }
 function normalizeCommand(value) {
-  switch ((value || "install").toLowerCase()) {
+  switch ((value || "help").toLowerCase()) {
     case "install":
     case "sync-models":
     case "uninstall":
     case "status":
+    case "doctor":
     case "help":
-      return value ? value.toLowerCase() : "install";
+      return value ? value.toLowerCase() : "help";
     default:
       throw new Error(`Unknown command: ${value}`);
   }
@@ -377,21 +532,97 @@ function commandUninstall(options) {
   console.log(`Removed plugin link: ${pluginPath}`);
   console.log(`Removed provider "${PROVIDER_ID}" from ${configPath}`);
 }
-function commandStatus(options) {
-  const { configPath, pluginPath } = resolvePaths(options);
-  const pluginExists = existsSync(pluginPath);
-  const pluginType = pluginExists ? lstatSync(pluginPath).isSymbolicLink() ? "symlink" : "file" : "missing";
-  let providerExists = false;
-  let pluginEnabled = false;
+function getStatusResult(configPath, pluginPath) {
+  let pluginType = "missing";
+  let pluginTarget;
+  if (existsSync(pluginPath)) {
+    const stat = lstatSync(pluginPath);
+    pluginType = stat.isSymbolicLink() ? "symlink" : "file";
+    if (pluginType === "symlink") {
+      try {
+        pluginTarget = readFileSync(pluginPath, "utf8");
+      } catch {
+        pluginTarget = undefined;
+      }
+    }
+  }
+  let providerEnabled = false;
+  let baseUrl = "http://127.0.0.1:32124/v1";
+  let modelCount = 0;
   if (existsSync(configPath)) {
     const config = readConfig(configPath);
-    providerExists = Boolean(config.provider?.[PROVIDER_ID]);
-    pluginEnabled = Array.isArray(config.plugin) && config.plugin.includes(PROVIDER_ID);
+    const provider = config.provider?.["cursor-acp"];
+    providerEnabled = !!provider;
+    if (provider?.options?.baseURL) {
+      baseUrl = provider.options.baseURL;
+    }
+    modelCount = Object.keys(provider?.models || {}).length;
+  }
+  const opencodeDir = dirname(configPath);
+  const sdkPath = join(opencodeDir, "node_modules", "@ai-sdk", "openai-compatible");
+  const aiSdkInstalled = existsSync(sdkPath);
+  return {
+    plugin: {
+      path: pluginPath,
+      type: pluginType,
+      target: pluginTarget
+    },
+    provider: {
+      configPath,
+      name: "cursor-acp",
+      enabled: providerEnabled,
+      baseUrl,
+      modelCount
+    },
+    aiSdk: {
+      installed: aiSdkInstalled
+    }
+  };
+}
+function commandStatus(options) {
+  const { configPath, pluginPath } = resolvePaths(options);
+  const result = getStatusResult(configPath, pluginPath);
+  if (options.json) {
+    console.log(JSON.stringify(result, null, 2));
+    return;
+  }
+  console.log("");
+  console.log("Plugin");
+  console.log(`  Path: ${result.plugin.path}`);
+  if (result.plugin.type === "symlink" && result.plugin.target) {
+    console.log(`  Type: symlink → ${result.plugin.target}`);
+  } else if (result.plugin.type === "file") {
+    console.log(`  Type: file (copy)`);
+  } else {
+    console.log(`  Type: missing`);
+  }
+  console.log("");
+  console.log("Provider");
+  console.log(`  Config: ${result.provider.configPath}`);
+  console.log(`  Name: ${result.provider.name}`);
+  console.log(`  Enabled: ${result.provider.enabled ? "yes" : "no"}`);
+  console.log(`  Base URL: ${result.provider.baseUrl}`);
+  console.log(`  Models: ${result.provider.modelCount}`);
+  console.log("");
+  console.log("AI SDK");
+  console.log(`  @ai-sdk/openai-compatible: ${result.aiSdk.installed ? "installed" : "not installed"}`);
+}
+function commandDoctor(options) {
+  const { configPath, pluginPath } = resolvePaths(options);
+  const checks = runDoctorChecks(configPath, pluginPath);
+  console.log("");
+  for (const check of checks) {
+    const symbol = check.passed ? "✓" : check.warning ? "⚠" : "✗";
+    const color = check.passed ? "\x1B[32m" : check.warning ? "\x1B[33m" : "\x1B[31m";
+    console.log(` ${color}${symbol}\x1B[0m ${check.name}: ${check.message}`);
+  }
+  const failed = checks.filter((c) => !c.passed && !c.warning);
+  console.log("");
+  if (failed.length === 0) {
+    console.log("All checks passed!");
+  } else {
+    console.log(`${failed.length} check(s) failed. See messages above.`);
   }
-  console.log(`Plugin file: ${pluginPath} (${pluginType})`);
-  console.log(`Provider in config: ${providerExists ? "yes" : "no"}`);
-  console.log(`Plugin enabled in config: ${pluginEnabled ? "yes" : "no"}`);
-  console.log(`Config path: ${configPath}`);
 }
 function main() {
   let parsed;
@@ -418,6 +649,9 @@ function main() {
       case "status":
         commandStatus(parsed.options);
         return;
+      case "doctor":
+        commandDoctor(parsed.options);
+        return;
       case "help":
         printHelp();
         return;
@@ -429,3 +663,11 @@ function main() {
   }
 }
 main();
+export {
+  runDoctorChecks,
+  getStatusResult,
+  getBrandingHeader,
+  checkCursorAgentLogin,
+  checkCursorAgent,
+  checkBun
+};