opencode-agy-bridge 0.1.0 → 0.2.1

package/README.md

@@ -21,26 +21,44 @@ opencode TUI
 2. **Node.js ≥ 18** or **Bun ≥ 1.0**.
 3. **OpenCode** `>= 1.15.x` (uses Vercel AI SDK v3).
 
-## Installation (local development)
+## Installation
+
+### 1. Automatic Installation (Recommended)
+
+If you are using OpenCode's built-in plugin manager, **you do not need to run any commands** in your terminal. OpenCode can automatically fetch and install the package from npm if you specify the package name with its version in your `opencode.json` configuration file.
+
+See the [Configuration](#configuration) section below for details.
+
+### 2. Manual Global Installation
+
+If you prefer to install it globally yourself using a package manager:
 
 ```bash
-git clone <this-repo>
+# Using npm
+npm install -g opencode-agy-bridge
+
+# Using Bun
+bun install -g opencode-agy-bridge
+
+# Using pnpm
+pnpm add -g opencode-agy-bridge
+```
+
+### 3. Local Development Installation
+
+If you prefer to build from source:
+
+```bash
+git clone https://github.com/raultov/opencode-agy-bridge.git
 cd opencode-agy-bridge
 
 # Using Bun (recommended)
 bun install
 bun run build
-bun test       # verify 42 tests pass
-
-# Or using pnpm
-pnpm install
-pnpm run build
-pnpm test
+bun test       # verify all tests pass
 
-# Or using npm
-npm install
-npm run build
-npm test
+# Or using pnpm/npm
+pnpm install && pnpm run build && pnpm test
 ```
 
 ## Features
@@ -49,7 +67,68 @@ npm test
 
 ## Configuration
 
-Add to your `~/.config/opencode/opencode.json`:
+Add the plugin and provider to your `~/.config/opencode/opencode.json` configuration file:
+
+### For Automatic Installation (Hands-free)
+
+Just add the package directly with the desired version tag. OpenCode will download and resolve it automatically from npm:
+
+```jsonc
+{
+  "plugin": [
+    // ...your existing plugins...
+    "opencode-agy-bridge@0.2.1"
+  ],
+  "provider": {
+    // ...your existing providers...
+    "agy": {
+      "npm": "opencode-agy-bridge/provider",
+      "name": "Google Antigravity (via agy CLI)",
+      "options": {
+        "binary": "agy",
+        "timeoutMs": 300000
+      },
+      "models": {
+        "antigravity": {
+          "name": "Antigravity (server-selected Gemini)"
+        }
+      }
+    }
+  }
+}
+```
+
+### For Manual Global Installation
+
+```jsonc
+{
+  "plugin": [
+    // ...your existing plugins...
+    "opencode-agy-bridge"
+  ],
+  "provider": {
+    // ...your existing providers...
+    "agy": {
+      "npm": "opencode-agy-bridge/provider",
+      "name": "Google Antigravity (via agy CLI)",
+      "options": {
+        "binary": "agy",
+        "timeoutMs": 300000
+      },
+      "models": {
+        "antigravity": {
+          "name": "Antigravity (server-selected Gemini)"
+        }
+      }
+    }
+  }
+}
+```
+
+> [!NOTE]
+> If OpenCode has trouble resolving the global module name directly, you can replace the module names with their absolute paths pointing to your global `node_modules` folder (e.g., `"/usr/local/lib/node_modules/opencode-agy-bridge/dist/plugin.js"` for the plugin and `"/usr/local/lib/node_modules/opencode-agy-bridge/dist/provider.js"` for the provider).
+
+### For Local Development / Manual Installation
 
 ```jsonc
 {
@@ -127,7 +206,7 @@ npm test
 The project includes two GitHub Actions workflows:
 
 - **CI (`ci.yml`):** Runs on push and pull requests to `main` or `master` to compile the project and execute all unit tests using Bun.
-- **Release (`release.yml`):** Runs when a new GitHub Release is created. It automatically installs dependencies, builds, tests, and publishes the package to the public npm registry.
+- **Release (`release.yml`):** Runs automatically when a new version tag matching `v*` (e.g., `v0.2.1`) is pushed to the repository. It automatically installs dependencies, builds, tests, and publishes the package to the public npm registry.
 
 Note that both `npm` and `pnpm` share the same public registry (`registry.npmjs.org`), so a single publish step makes the package installable by both package managers.
 

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "opencode-agy-bridge",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "type": "module",
+  "main": "./plugin.js",
   "license": "MIT",
   "description": "OpenCode plugin + provider that routes LLM prompts to agy (Google Antigravity CLI)",
   "exports": {
-    ".": "./dist/provider.js",
-    "./plugin": "./dist/plugin.js"
+    ".": "./dist/plugin.js",
+    "./provider": "./dist/provider.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "plugin.js",
+    "provider.js"
   ],
   "scripts": {
     "build": "tsc",

package/plugin.js

@@ -0,0 +1,2 @@
+export { default } from "./dist/plugin.js";
+export * from "./dist/plugin.js";

package/provider.js

@@ -0,0 +1,2 @@
+export { default } from "./dist/provider.js";
+export * from "./dist/provider.js";