auto-model-router 0.1.4 → 0.2.1

package/.omp-plugin/marketplace.json

@@ -7,14 +7,14 @@
   },
   "metadata": {
     "description": "auto-model-router: a local cost/complexity-aware model router for Oh My Pi, backed by OpenRouter",
-    "version": "0.1.0",
+    "version": "0.2.1",
     "pluginRoot": "."
   },
   "plugins": [
     {
       "name": "auto-model-router",
       "description": "Local cost/complexity-aware model router for Oh My Pi, backed by OpenRouter. Runs in-process, routes per turn by price and task complexity, with budget caps, mid-stream escalation, and cache-aware hysteresis.",
-      "version": "0.1.0",
+      "version": "0.2.1",
       "author": {
         "name": "drewappling",
         "email": "drewappling@gmail.com"

package/README.md

@@ -74,9 +74,10 @@ without touching routing.
 - **Reported** — `usage.cost` from OpenRouter, authoritative after the fact.
   Drives the ledger, `stats`, and prediction-error calibration.
 
-  it. No separate Bun install is needed for the embedded path. The standalone
-  `serve` binary (`npm install -g auto-model-router`) bundles Bun.
-  it. No separate Bun install is needed for the embedded path.
+## Installing
+
+No separate Bun install is needed for the embedded path. The standalone
+`serve` binary (`npm install -g auto-model-router`) bundles Bun.
 
 Two ways to get the router into omp. The **npm package** is the modern path —
 it installs the `auto-model-router` binary and wires the omp extensions; the
@@ -137,45 +138,6 @@ or install it from the marketplace (see below). The plugin declares all three
 extensions (`router-embed`, `router-toast`, `router-configure`), so installing
 it wires the router in without editing `config.yml` by hand.
 
-There is nothing to install system-wide. Run the cross-platform installer
-(Windows, macOS, Linux) from the repo:
-
-```bash
-bun tools/install.ts
-```
-
-It wires the auto-model-router extensions into omp's `~/.omp/agent/config.yml`
-(`$PI_CODING_AGENT_DIR/config.yml` when that env var relocates the agent dir),
-backing up the previous file first. It is idempotent — re-running is a no-op.
-
-Options:
-
-```bash
-bun tools/install.ts --no-toast --no-configure   # only the required embed extension
-```
-
-The installer adds:
-
-- `router-embed.ts` — **required**; runs the router in-process.
-- `router-toast.ts` — optional; chosen-model toasts.
-- `router-configure.ts` — optional; the `/router` command.
-
-Or add the paths by hand to omp's `~/.omp/agent/config.yml`:
-
-```yaml
-# ~/.omp/agent/config.yml
-extensions:
-  - /path/to/auto-model-router/omp-extension/router-embed.ts
-  - /path/to/auto-model-router/omp-extension/router-toast.ts      # optional: chosen-model toasts
-  - /path/to/auto-model-router/omp-extension/router-configure.ts # optional: /router command
-```
-
-Then restart the omp session (extensions load at session start).
-
-or install it from the marketplace (see below). The plugin declares all three
-extensions (`router-embed`, `router-toast`, `router-configure`), so installing
-it wires the router in without editing `config.yml` by hand.
-
 ### Install from the marketplace
 
 This repo doubles as its own marketplace: it ships a catalog at
@@ -194,6 +156,9 @@ or in the TUI:
 /marketplace install auto-model-router@auto-model-router
 ```
 
+After installing, restart the omp session (extensions load at session start),
+then `/model` and pick `auto-model-router/auto`.
+
 ### Install from the Pi package marketplace
 
 The repo is also a Pi package (see the `pi` manifest and `pi-package` keyword
@@ -210,12 +175,23 @@ or from git:
 pi install git:github.com/drewappling/auto-model-router
 ```
 
-To publish to npm (which auto-indexes on pi.dev/packages):
+#### Releasing
+
+Cut releases with `npm version` (or `bun run release <patch|minor|major>`), not a
+bare `npm publish`:
 
 ```bash
-npm publish
+npm version patch && git push --follow-tags   # or: bun run release patch
 ```
 
+`npm version` runs the `version` lifecycle script
+(`tools/sync-marketplace-version.ts`), which rewrites the Git-marketplace
+catalog (`.omp-plugin/marketplace.json`) to the new version and stages it into
+the version commit — so the npm package and the marketplace catalog can never
+drift. Pushing the `vX.Y.Z` tag triggers the release workflow (npm publish,
+which auto-indexes on pi.dev/packages, plus a GitHub Release). A bare
+`npm publish` skips both the catalog sync and the tag, so avoid it.
+
 ### Hermes
 
 Install the router globally (puts the `serve` binary on PATH) and
@@ -279,17 +255,29 @@ providers:
 
 ### The OpenRouter key
 
-There should be exactly one OpenRouter key on the machine, and omp already owns
-a credential store. Resolution order:
-
-1. `openrouter.apiKey` in `$AUTO_MODEL_ROUTER_HOME/config.yml`
-2. `OPENROUTER_API_KEY` (including any `.env` omp loaded into the environment)
-3. **omp's own auth store** — `~/.omp/agent/agent.db`, provider `openrouter`
-
-So `/login openrouter` inside omp is sufficient setup; nothing needs copying.
-The store is opened read-only and never written: omp owns it, including OAuth
-refresh. An expired OAuth access token is rejected rather than sent, because
-refreshing is omp's job and a stale bearer just burns a turn on a 401. Under
+**omp does not need to be authenticated to OpenRouter.** On a routed turn omp
+never calls OpenRouter directly: the embed extension registers the
+`auto-model-router` provider with a placeholder bearer (`embedded`) pointing at
+the in-process router, and the router holds the real OpenRouter key and makes
+the upstream call. omp only needs to see that the provider "has credentials",
+which the placeholder satisfies.
+
+There should be exactly one OpenRouter key on the machine. The router resolves
+it in this order:
+
+1. `openrouter.apiKey` in `$AUTO_MODEL_ROUTER_HOME/config.yml` — router-owned,
+   never enters omp's environment. Set it with `auto-model-router config` or by
+   hand.
+2. `OPENROUTER_API_KEY` in the environment omp launches from (including any
+   `.env` omp loaded).
+3. **omp's own auth store** — `~/.omp/agent/agent.db`, provider `openrouter`, so
+   `/login openrouter` inside omp is sufficient and nothing needs copying.
+
+Options 1–2 give the router its own key with omp left unauthenticated; option 3
+is a zero-config convenience for when you *have* logged omp in. The store is
+opened read-only and never written: omp owns it, including OAuth refresh. An
+expired OAuth access token is rejected rather than sent, because refreshing is
+omp's job and a stale bearer just burns a turn on a 401. Under
 `OMP_AUTH_BROKER_URL` the local store is not consulted at all, since a broker
 replaces it.