@getroomi/cli 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,31 @@
-# Temporary Holding Version
+# roomi
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The command line for [Roomi](https://getroomi.com): deploy a working
+demo, rehearsed on your machine first, into a pitch room, and send each viewer
+their own link.
+
+```sh
+npm install -g @getroomi/cli
+roomi login          # in the browser; the token goes in the macOS Keychain (elsewhere, a file only you can read)
+roomi init           # reads the repository and writes pitch.json
+roomi deploy         # a rehearsal: builds, scans, runs, and says what would go live
+roomi deploy --commit
+roomi link "Tom"     # a link for one viewer, printed for you to send
+roomi link copy Tom  # the same link again, if Tom loses it
+roomi logs -f        # what the live build's server is printing, redacted
+roomi rollback       # which build would go live; --commit makes it so
+```
+
+In CI, set `ROOMI_TOKEN` to an API token made in the app's Settings.
+
+Or run it without installing: `npx @getroomi/cli deploy`. The package also installs
+`pitch`, the command's name before Roomi, which does the same.
+
+Node 24 or later. A container build needs Docker running; its rehearsal builds
+the platform's runner locally (the `node` base image is pulled from Docker Hub
+the first time). `gitleaks` scans every deploy for secrets
+(`brew install gitleaks`).
+
+`roomi --help` lists every command. `roomi whoami` says which platform roomi is
+talking to: https://api.getroomi.com unless `roomi config set api <url>` or
+`PP_API` says otherwise. Docs: https://getroomi.com/docs

package/package.json

@@ -1,6 +1,21 @@
 {
   "name": "@getroomi/cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "roomi: deploy a working demo to Roomi, rehearsed on your machine first, and send each viewer their own link.",
+  "type": "module",
+  "bin": {
+    "roomi": "roomi.js",
+    "pitch": "roomi.js"
+  },
+  "files": [
+    "roomi.js",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "dependencies": {},
+  "publishConfig": {
+    "access": "public"
+  }
+}