wirl 0.2.0 → 0.2.2

package/README.md

@@ -3,17 +3,16 @@
 Deploy an internal app somewhere real, privately. One command puts the folder you are in on a URL that only your company can open.
 
 ```bash
-npm install -g https://app.wirl.dev/cli/wirl.tgz
-wirl login                # a link and a code; approve in the browser
-wirl init my-tool --server
+npx wirl login            # a link and a code; approve in the browser
+npx wirl init my-tool --server
 cd my-tool
-wirl dev                  # runs it here, signed in as a stub user
-wirl preview              # a private address to look at it before it is live
-wirl deploy               # builds, scans, deploys; prints the URL
-wirl share dana@company.com
+npx wirl dev              # runs it here, signed in as a stub user
+npx wirl preview          # a private address to look at it before it is live
+npx wirl deploy           # builds, scans, deploys; prints the URL
+npx wirl share dana@company.com
 ```
 
-Install it from wirl itself, as above, and run plain `wirl`. Do not run `npx wirl`: that name on npm belongs to an unrelated older package today, and `npx` would fetch that one.
+`npx` fetches the CLI from npm the first time and needs no install beyond Node 22.13 or later; in a terminal npm first asks "Ok to proceed? (y)": answer y. Elsewhere in this README a command is written `wirl <command>`, for short: run it as `npx wirl <command>`, or run `npm install -g wirl` once and use plain `wirl`. If your npm registry does not carry wirl, or to run exactly the build app.wirl.dev serves, install from app.wirl.dev instead: `npm install -g https://app.wirl.dev/cli/wirl.tgz`, and run plain `wirl`.
 
 Sign in with your work Google account and you are in your company's workspace. Anything a colleague deploys there is yours to open, and nobody outside the company can. A personal account gets a space of its own.
 
@@ -36,16 +35,20 @@ A static folder needs nothing. A server-side app is one JavaScript module export
 claude mcp add --transport http wirl https://app.wirl.dev/mcp
 ```
 
-That opens the browser once to sign in. The token an agent gets can deploy, roll back and pull, and cannot share apps, change who can open them, or touch connections, members or tokens. Ticking one box at consent grants full access. See the docs for what each scope covers.
+`claude mcp add` only saves the server's configuration. Then sign in: run `/mcp` inside Claude Code and follow the steps in the browser, or run `claude mcp login wirl` in a terminal. The token an agent gets can deploy, roll back and pull, and cannot share apps, change who can open them, or touch connections, members or tokens. Ticking one box at consent grants full access. See the docs for what each scope covers.
 
 ## Everything else
 
 ```bash
-wirl --help
+npx wirl --help
 ```
 
 Orgs, members, connections, transfer, move, versions, rollback, pull, previews, logs, schedules, run.
 
+## Versions
+
+The npm package and the control plane are versioned separately. `npx wirl` runs the latest CLI published to npm, and app.wirl.dev runs the build it was last deployed with, so either can be the newer. A CLI newer than the control plane says so where it can tell: `its control plane is older than this copy of wirl` (from `wirl migrations` and `wirl migrations adopt`), or `this control plane is older than sending wirl.json in the body, so it cannot take it` when a `wirl.json` is too large for a header. A CLI older than the control plane sends your whole `wirl.json` and says of a key it does not read that it `is not a key this version of wirl reads, so it is ignored`, though the control plane may read it; it checks `wirl.json` against its own rules before it uploads, so update the CLI (`npm install -g wirl@latest`, or `npx wirl@latest <command>`) when a deploy is refused on your machine for something the docs allow.
+
 ## Requirements
 
 Node 22.13 or later. Credentials live in `~/.config/wirl/credentials.json` after `wirl login`, or in `WIRL_TOKEN` for CI and sandboxes.