@vidit19sharma/opencode-cursor-auth 0.3.1 → 0.3.2

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project are documented here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## 0.3.2 — 2026-10-16
+
+### Added
+
+- `npx @vidit19sharma/opencode-cursor-auth setup` — adds the plugin to opencode config idempotently (`--dry-run`, `--config`).
+
+### Fixed
+
+- The first request before `opencode auth login` hung in opencode's connect loop: without a `cursor` auth entry opencode skips the plugin's auth loader and dials the dummy `http://cursor.local/v1`. The plugin now seeds its auth entry (only when none exists), so the loader runs and returns a clear 401 telling you to run `opencode auth login`.
+
+### Changed
+
+- Docs no longer claim the Cursor CLI (`cursor-agent`) is required; `@cursor/sdk` talks to Cursor's backend directly.
+
 ## 0.3.1 — 2026-10-16
 
 ### Fixed

package/README.md

@@ -23,18 +23,22 @@ The plugin bridges opencode's OpenAI-style chat requests to the official [`@curs
 ## Requirements
 
 - Node >= 22.13 (opencode runs plugins on Bun, which also works)
-- [`cursor-agent` CLI](https://cursor.com/docs/cli) installed (`curl https://cursor.com/install -fsS | bash`) — the SDK's local executor uses it
 - A Cursor subscription
 
 ## Install
 
-For AI agents — paste this into any LLM agent:
+All three methods end with `opencode auth login` (next section).
 
-```
-Install the @vidit19sharma/opencode-cursor-auth plugin and configure it by following: https://raw.githubusercontent.com/vidit19sharma/opencode-cursor-auth/main/installation.md
+### 1. One command (npx)
+
+```sh
+npx @vidit19sharma/opencode-cursor-auth setup
 ```
 
-See [installation.md](installation.md) for the step-by-step agent instructions.
+Adds the plugin to the `plugin` array of your opencode config (`~/.config/opencode/opencode.json[c]`, or creates `opencode.json`); running it again is a no-op.
+`--dry-run` shows the change without writing; `--config <path>` targets a specific file. A `.jsonc` file with comments is never rewritten — you get the one-line manual edit instead.
+
+### 2. Manual
 
 Add the plugin to `~/.config/opencode/opencode.json`:
 
@@ -44,7 +48,17 @@ Add the plugin to `~/.config/opencode/opencode.json`:
 }
 ```
 
-The plugin auto-registers a `cursor` provider — no manual provider config needed.
+The plugin auto-registers the `cursor` provider — no manual provider config needed.
+
+### 3. Let an AI agent do it
+
+Paste this into any LLM agent:
+
+```
+Install the @vidit19sharma/opencode-cursor-auth plugin and configure it by following: https://raw.githubusercontent.com/vidit19sharma/opencode-cursor-auth/main/installation.md
+```
+
+See [installation.md](installation.md) for the step-by-step agent instructions.
 
 ## Authenticate
 
@@ -115,7 +129,7 @@ The models cache is refetched once on upgrade.
 ## How it works
 
 ```
-opencode ──(OpenAI chat JSON)──> plugin fetch() ──> @cursor/sdk Agent ──> cursor-agent ──> Cursor backend
+opencode ──(OpenAI chat JSON)──> plugin fetch() ──> @cursor/sdk Agent ──> Cursor backend
          <─(SSE stream)────────  bridge  <──(typed deltas: text / thinking / tool calls)
 ```
 
@@ -147,6 +161,8 @@ bun install
 bun run build        # tsc → dist/
 bun run test         # end-to-end bridge tests (requires Cursor login, uses real Cursor usage)
 bun run spike        # raw @cursor/sdk validation
+bun run test:cli     # exercises the npx setup command against temp config dirs (7 cases)
+bun run smoke        # packs the plugin and loads it in a pristine HOME (startup, auth login, first request before login)
 ```
 
 The test suite runs 13 scenarios: plain streaming, a full tool loop on one held run, in-memory and disk-persisted session resume, AGENTS.md system-prompt delivery, mid-stream abort, error statuses, session scoping, context limits and key checks, model variants, the concurrency cap, retry semantics, and blocked models.
@@ -154,7 +170,6 @@ The test suite runs 13 scenarios: plain streaming, a full tool loop on one held
 ## Known limitations
 
 - `systemPrompt` as a true harness replacement is feature-gated server-side by Cursor; system text is applied via `AGENTS.md` as a project rule (merged under Cursor's harness prompt).
-- The SDK spawns a `cursor-agent` worker per turn (~1–2 s startup on resume).
 - Cursor's catalog has no entitlement info, so models your plan or team blocks only disappear after the first 403.
 - `limit.context` is per model, not per variant: picking a smaller-context variant (e.g. gpt-5.5 `272k`) keeps the base model's 1M limit in opencode's context indicator and auto-compaction.
 - A run parked waiting for a tool result keeps its slot. Cursor-model sessions that spawn Cursor-model sub-agents nested deeper than `OPENCODE_CURSOR_MAX_ACTIVE` will stall; raise the limit if you fan out.

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,112 @@
+#!/usr/bin/env node
+import { existsSync, mkdirSync, readFileSync, renameSync, writeFileSync } from "node:fs";
+import { homedir } from "node:os";
+import { dirname, join, resolve } from "node:path";
+import process from "node:process";
+const PKG = "@vidit19sharma/opencode-cursor-auth";
+const ENTRY = `${PKG}@latest`;
+const HELP = `Usage: npx ${PKG} [setup] [--dry-run] [--config <path>]
+
+Adds "${ENTRY}" to the "plugin" array of your opencode config.
+Idempotent: does nothing if any ${PKG} entry is already present.
+
+  --dry-run        print what would change, write nothing
+  --config <path>  edit this file instead of the auto-detected one
+  --help           show this help
+
+Config lookup: --config, $OPENCODE_CONFIG, then opencode.jsonc / opencode.json in
+$OPENCODE_CONFIG_DIR, $XDG_CONFIG_HOME/opencode or ~/.config/opencode.
+
+Exit codes: 0 ok or already installed, 2 cannot edit safely (manual edit printed), 1 error.`;
+const NEXT = `Next steps:
+  1. Restart opencode
+  2. opencode auth login -> Cursor -> Log in with Cursor (browser)
+  3. opencode models | grep cursor/`;
+const MANUAL = `Add this to the top-level "plugin" array of your opencode config (create it if missing):
+  "plugin": ["${ENTRY}"]`;
+// Strips // and /* */ comments and trailing commas outside double-quoted strings; does not handle single-quoted strings or other JSON5 syntax.
+const stripJsonc = (s) => s
+    .replace(/("(?:\\.|[^"\\])*")|\/\/[^\n]*|\/\*[\s\S]*?\*\//g, (_m, str) => str ?? "")
+    .replace(/("(?:\\.|[^"\\])*")|,(\s*[}\]])/g, (_m, str, close) => str ?? close);
+function tryParse(s) {
+    try {
+        return JSON.parse(s);
+    }
+    catch {
+        return undefined;
+    }
+}
+function main(argv) {
+    let dryRun = false;
+    let explicit;
+    for (let i = 0; i < argv.length; i++) {
+        const a = argv[i];
+        if (a === "--help" || a === "-h")
+            return console.log(HELP), 0;
+        else if (a === "--dry-run")
+            dryRun = true;
+        else if (a === "--config")
+            explicit = argv[++i];
+        else if (a !== "setup")
+            return console.error(`Unknown argument: ${a}\n\n${HELP}`), 1;
+    }
+    if (argv.includes("--config") && !explicit)
+        return console.error("--config needs a path"), 1;
+    const env = process.env;
+    const dir = env.OPENCODE_CONFIG_DIR || join(env.XDG_CONFIG_HOME || join(homedir(), ".config"), "opencode");
+    const file = resolve(explicit ||
+        env.OPENCODE_CONFIG ||
+        ["opencode.jsonc", "opencode.json"].map((f) => join(dir, f)).find((f) => existsSync(f)) ||
+        join(dir, "opencode.json"));
+    const exists = existsSync(file);
+    const original = exists ? readFileSync(file, "utf8") : "";
+    const strict = exists ? tryParse(original) : { $schema: "https://opencode.ai/config.json" };
+    const config = (strict ?? tryParse(stripJsonc(original)));
+    console.log(`Config: ${file}${exists ? "" : " (will be created)"}`);
+    if (!config || typeof config !== "object" || Array.isArray(config)) {
+        console.error(`Cannot parse ${file}; not editing it.\n${MANUAL}`);
+        return 2;
+    }
+    const leftovers = [];
+    const provider = config.provider;
+    if (provider && typeof provider === "object" && "cursor-acp" in provider)
+        leftovers.push(`  - remove the "cursor-acp" block under "provider" in ${file}`);
+    const acp = join(dir, "plugin", "cursor-acp.js");
+    if (existsSync(acp))
+        leftovers.push(`  - rm ${JSON.stringify(acp)}`);
+    if (leftovers.length)
+        console.log(`Notice: old open-cursor setup found (nothing was deleted). To remove it:\n${leftovers.join("\n")}\n  - npm uninstall -g @rama_nigg/open-cursor`);
+    const plugins = config.plugin ?? [];
+    if (!Array.isArray(plugins)) {
+        console.error(`"plugin" in ${file} is not an array; not editing it.\n${MANUAL}`);
+        return 2;
+    }
+    if (plugins.some((p) => typeof p === "string" && p.startsWith(PKG))) {
+        console.log(`Already installed: ${PKG} is in "plugin". File left untouched.\n\n${NEXT}`);
+        return 0;
+    }
+    if (strict === undefined) {
+        console.error(`${file} has comments or trailing commas; not rewriting it (that would drop them).\n${MANUAL}`);
+        return 2;
+    }
+    config.plugin = [...plugins, ENTRY];
+    const next = JSON.stringify(config, null, 2) + "\n";
+    if (dryRun) {
+        console.log(`Dry run: would ${exists ? "update" : "create"} ${file} with:\n${next}`);
+        return 0;
+    }
+    mkdirSync(dirname(file), { recursive: true });
+    if (exists)
+        writeFileSync(`${file}.bak-cursor-auth`, original);
+    writeFileSync(`${file}.tmp`, next);
+    renameSync(`${file}.tmp`, file);
+    console.log(`Added "${ENTRY}" to "plugin"${exists ? ` (backup: ${file}.bak-cursor-auth)` : ""}.\n\n${NEXT}`);
+    return 0;
+}
+try {
+    process.exitCode = main(process.argv.slice(2));
+}
+catch (e) {
+    console.error(`Unexpected error: ${e instanceof Error ? e.message : e}`);
+    process.exitCode = 1;
+}

package/dist/plugin.js

@@ -1,6 +1,9 @@
 import { Cursor } from "@cursor/sdk";
 import { errorResponse, handleChatCompletion } from "./bridge.js";
 import { currentModels } from "./models.js";
+import { readFile } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
 export { parseContext } from "./models.js";
 const BASE_URL = "http://cursor.local/v1";
 // Cursor publishes no output limit and the bridge never passes max_tokens to Cursor, so output is only an accounting reserve for opencode.
@@ -67,7 +70,17 @@ async function cursorFetch(input, init) {
     }
     return Response.json({ error: { message: `unsupported endpoint: ${url}` } }, { status: 404 });
 }
-export const CursorAuthPlugin = async () => {
+async function seedAuthEntry(client) {
+    if (!client?.auth?.set)
+        return;
+    const file = join(process.env.XDG_DATA_HOME || join(homedir(), ".local", "share"), "opencode", "auth.json");
+    const entries = await readFile(file, "utf8").then(JSON.parse, (err) => (err.code === "ENOENT" ? {} : undefined));
+    if (!entries || typeof entries !== "object" || "cursor" in entries)
+        return;
+    await client.auth.set({ path: { id: "cursor" }, body: { type: "api", key: "cursor-sdk-store" } });
+}
+export const CursorAuthPlugin = async (input) => {
+    seedAuthEntry(input?.client).catch(() => { });
     return {
         config: async (config) => {
             const providers = (config.provider ??= {});

package/installation.md

@@ -20,23 +20,9 @@ You should see `1.19` or newer. If older or missing, ask the user to install or
 node --version
 ```
 
-You should see `v22.13` or newer. opencode installs plugins with Bun, but `@cursor/sdk` spawns the `cursor-agent` binary and requires Node >= 22.13. If older, ask the user to upgrade Node.
+You should see `v22.13` or newer. `@cursor/sdk` requires Node >= 22.13. If older, ask the user to upgrade Node.
 
-### Check the Cursor CLI
-
-```bash
-cursor-agent --version
-```
-
-If this prints a version, continue. If it fails with `command not found`, install it:
-
-```bash
-curl https://cursor.com/install -fsS | bash
-```
-
-Then open a new shell, or add `~/.local/bin` to `PATH`, and re-run `cursor-agent --version`.
-
-A Cursor subscription (Pro, Business, or team) is required. `cursor-agent login` is not required (the plugin has its own login) but is harmless.
+A Cursor subscription (Pro, Business, or team) is required.
 
 ## Installation
 
@@ -52,7 +38,15 @@ Skip this step if none of these exist.
 
 ### Step 2: Add the plugin to the opencode config
 
-The config file is `~/.config/opencode/opencode.json`. Some users have `~/.config/opencode/opencode.jsonc` instead; edit whichever exists.
+**Preferred, if you can run shell commands:**
+
+```bash
+npx @vidit19sharma/opencode-cursor-auth setup
+```
+
+It adds the plugin idempotently (exit 0 = added or already present) and lists any open-cursor leftovers from Step 1 without deleting them. Exit 2 means it could not edit the file safely (e.g. a `.jsonc` with comments); it prints the exact edit, which you then make by hand as described below. Use `--dry-run` to preview.
+
+**Fallback: edit the file by hand.** The config file is `~/.config/opencode/opencode.json`. Some users have `~/.config/opencode/opencode.jsonc` instead; edit whichever exists.
 
 If neither exists, create `~/.config/opencode/opencode.json`:
 
@@ -123,9 +117,8 @@ The plugin is installed. Every model the user's Cursor plan includes is availabl
 - **401 `Cursor SDK key missing/expired`**: run `opencode auth login`.
 - **403 `permission_error` "Model Blocked"**: a team admin disabled that model for the account. It is hidden from `opencode models` from then on; delete `~/.cache/opencode-cursor-auth/models.json` to re-check.
 - **400 `Cannot use this model`**: the model id is not in Cursor's catalog for this account.
-- **`cursor-agent: command not found` at request time**: install the Cursor CLI (see Prerequisites) and make sure it is on `PATH` for the shell that launches opencode.
+- **Request hangs with no error**: `opencode auth login` was never run for Cursor; run it (0.3.2+ seeds the entry automatically so you get a 401 message instead).
 - **Model list empty or only `cursor/auto`**: the catalog fetch failed (offline or not logged in). Fix auth, delete `~/.cache/opencode-cursor-auth/models.json`, restart opencode.
-- **Stray `cursor-agent` processes**: check with `pgrep -fl cursor-agent`. A single `worker-server` is the SDK's idle singleton and is normal.
 
 ### Paths
 

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@vidit19sharma/opencode-cursor-auth",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "OpenCode plugin that uses your Cursor subscription via the official @cursor/sdk \u2014 no proxy server, no separate login.",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "bin": {
+    "opencode-cursor-auth": "dist/cli.js"
+  },
   "files": [
     "dist",
     "README.md",
@@ -31,10 +34,12 @@
     "auth"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && chmod +x dist/cli.js",
     "test": "bun spike/e2e-bridge.ts",
     "spike": "bun spike/validate-sdk.ts",
-    "prepublishOnly": "tsc"
+    "smoke": "bash scripts/fresh-home-smoke.sh",
+    "prepublishOnly": "npm run build",
+    "test:cli": "npm run build && bash spike/cli-setup.test.sh"
   },
   "dependencies": {
     "@cursor/sdk": "^1.0.36"