Package OpenCode plugin for npm and add release workflow (#11)

benvinegar · web-flow · commit d9c709d7ae96 · 2026-03-08T09:25:58.000-04:00
diff --git a/.github/workflows/release-opencode.yml b/.github/workflows/release-opencode.yml
@@ -0,0 +1,75 @@
+name: Release opencode package
+
+on:
+  push:
+    tags:
+      - 'opencode-v*'
+  workflow_dispatch:
+    inputs:
+      publish:
+        description: Publish to npm (unchecked = dry run only)
+        type: boolean
+        required: false
+        default: false
+
+permissions:
+  contents: read
+  id-token: write
+
+concurrency:
+  group: release-opencode
+  cancel-in-progress: false
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+
+      - name: Read package metadata
+        id: pkg
+        run: |
+          name=$(node -p "require('./opencode/package.json').name")
+          version=$(node -p "require('./opencode/package.json').version")
+          echo "name=$name" >> "$GITHUB_OUTPUT"
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+
+      - name: Validate release tag matches package version
+        if: github.event_name == 'push'
+        run: |
+          expected="opencode-v${{ steps.pkg.outputs.version }}"
+          if [ "${GITHUB_REF_NAME}" != "$expected" ]; then
+            echo "::error title=Tag/version mismatch::Expected tag $expected for version ${{ steps.pkg.outputs.version }}, got ${GITHUB_REF_NAME}."
+            exit 1
+          fi
+
+      - name: Ensure npm version is not already published
+        if: github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.publish)
+        run: |
+          if npm view "${{ steps.pkg.outputs.name }}@${{ steps.pkg.outputs.version }}" version >/dev/null 2>&1; then
+            echo "::error title=Version already published::${{ steps.pkg.outputs.name }}@${{ steps.pkg.outputs.version }} already exists on npm."
+            exit 1
+          fi
+
+      - name: Validate package contents
+        working-directory: opencode
+        run: npm pack --dry-run
+
+      - name: Publish to npm
+        if: github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.publish)
+        working-directory: opencode
+        run: npm publish --access public --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Dry-run summary
+        if: github.event_name == 'workflow_dispatch' && !inputs.publish
+        run: |
+          echo "Dry run complete for ${{ steps.pkg.outputs.name }}@${{ steps.pkg.outputs.version }}."
+          echo "Re-run this workflow with publish=true to publish." 
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ Paste a screenshot in your browser, your agent gets the URL instantly.
 | Agent | Directory | npm package | Install |
 |---|---|---|---|
 | [pi](https://github.com/mariozechner/pi) | [`pi/`](pi/) | `@modemdev/glance-pi` | `pi install npm:@modemdev/glance-pi` |
-| [OpenCode](https://github.com/anomalyco/opencode) | [`opencode/`](opencode/) | — | See [`opencode/README.md`](opencode/README.md) |
+| [OpenCode](https://github.com/anomalyco/opencode) | [`opencode/`](opencode/) | `@modemdev/glance-opencode` | Add `"@modemdev/glance-opencode"` to `opencode.json` `plugin` list |
 
 ## How it works
 
diff --git a/opencode/README.md b/opencode/README.md
@@ -7,12 +7,67 @@
 Maintains a **persistent background session** on glance.sh. Paste an image anytime — the agent receives it instantly.
 
 - **Background listener** — starts when OpenCode launches, reconnects automatically, refreshes sessions before they expire.
-- **`glance` tool** — the LLM calls it when it needs to see something visual. Surfaces the session URL and waits for the next paste.
+- **`glance` tool** — the LLM calls it when it needs to see something visual. Surfaces the session URL.
+- **`glance_wait` tool** — waits for the next paste and returns the image URL.
 - **Multiple images** — paste as many images as you want during a session.
 
 ## Install
 
-Symlink or copy `glance.ts` into your OpenCode plugins directory:
+Recommended (npm package):
+
+Add the plugin to your global `~/.config/opencode/opencode.json` or project `opencode.json`:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["@modemdev/glance-opencode"]
+}
+```
+
+Restart OpenCode. The background session starts automatically.
+
+Optional: pin a specific version:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["@modemdev/glance-opencode@0.1.0"]
+}
+```
+
+## Verify
+
+Ask the agent to call the `glance` tool. You should get a session URL like `https://glance.sh/s/<id>`.
+
+Then call `glance_wait` and paste an image in the browser tab — it should return a `Screenshot: https://glance.sh/<token>.<ext>` URL.
+
+## Update / remove
+
+- If you use `@modemdev/glance-opencode` without pinning, OpenCode checks for newer versions at startup.
+- If you pin a version, bump it in your `plugin` list when you want to upgrade.
+- To remove, delete the package from your `plugin` list and restart OpenCode.
+
+## Publishing (maintainers)
+
+Releases are automated via GitHub Actions.
+
+Prerequisite: configure `NPM_TOKEN` in the `glance-agent-plugins` repository with publish access to `@modemdev/glance-opencode`.
+
+1. Bump `version` in `opencode/package.json`.
+2. Commit and push to `main`.
+3. Create and push a matching tag:
+
+```bash
+git tag opencode-v0.1.0
+git push origin opencode-v0.1.0
+```
+
+The `Release opencode package` workflow validates the tag/version match and publishes with npm provenance.
+You can also run the workflow manually in dry-run mode from Actions.
+
+## Manual install (legacy)
+
+If you prefer local file management, symlink or copy `glance.ts` into your OpenCode plugins directory:
 
 ```bash
 # symlink (recommended — stays up to date with git pulls)
@@ -22,22 +77,22 @@ ln -s "$(pwd)/glance.ts" ~/.config/opencode/plugins/glance.ts
 ln -s "$(pwd)/glance.ts" .opencode/plugins/glance.ts
 ```
 
-Restart OpenCode. The background session starts automatically.
-
 ## How it works
 
-```
+```text
 opencode starts
   └─▶ plugin creates session on glance.sh
   └─▶ connects SSE (background, auto-reconnect)
 
 LLM calls glance tool
   └─▶ surfaces session URL
+
+LLM calls glance_wait tool
   └─▶ waits for image paste
 
 user pastes image at /s/<id>
   └─▶ SSE emits "image" event
-  └─▶ tool returns image URL to LLM
+  └─▶ glance_wait returns image URL to LLM
 
 session expires (~10 min)
   └─▶ plugin creates new session, reconnects
diff --git a/opencode/glance.ts b/opencode/glance.ts
@@ -9,8 +9,9 @@
  * screenshot; it surfaces the existing session URL and waits for a
  * paste.
  *
- * Install: symlink or copy this file into your opencode plugins
- * directory, e.g. .opencode/plugins/glance.ts or
+ * Install: add "@modemdev/glance-opencode" to the `plugin` list in
+ * opencode.json (recommended), or symlink/copy this file into your
+ * plugins directory, e.g. .opencode/plugins/glance.ts or
  * ~/.config/opencode/plugins/glance.ts
  */
 
diff --git a/opencode/package.json b/opencode/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "@modemdev/glance-opencode",
+  "version": "0.1.0",
+  "description": "glance.sh plugin package for OpenCode",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/modem-dev/glance-agent-plugins.git",
+    "directory": "opencode"
+  },
+  "homepage": "https://github.com/modem-dev/glance-agent-plugins/tree/main/opencode",
+  "bugs": {
+    "url": "https://github.com/modem-dev/glance-agent-plugins/issues"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "glance",
+    "screenshot",
+    "agent"
+  ],
+  "files": [
+    "glance.ts",
+    "README.md"
+  ],
+  "exports": {
+    ".": "./glance.ts"
+  },
+  "dependencies": {
+    "@opencode-ai/plugin": "^1.0.0"
+  }
+}
