@claudecollab/cli 0.1.3 → 0.2.1

package/README.md

@@ -7,22 +7,77 @@
 (you run Claude)  <-->  (passes messages)   <-->  (open a link)
 ```
 
-Your terminal looks like normal Claude, just one extra line at the bottom. All the sharing happens in the web browser.
+Before you go live, your terminal is *exactly* normal Claude — nothing added. The moment you go live, one status line shows up at the bottom, and all the sharing itself happens in the web browser.
 
 ## Start a session
 
 ```bash
+npx @claudecollab/cli        # try it right now, nothing to install
+# liked it? make it permanent:
 npm install -g @claudecollab/cli
 collab
 ```
 
-That's it. Run `collab` instead of `claude`. It works the same, but now it makes two links:
+The first npx run downloads for ~10–20 seconds; after that it's fast.
 
-- A **private link** — that's your control panel (you let people in and manage them).
-- A **share link** — this one gets copied for you. Send it to your friends.
+Run `collab` instead of `claude`. It looks and works **exactly** like Claude — because at this point it *is* just Claude. It is not sharing anything yet. You go live only when you decide to.
+
+## The first time you run it
+
+The very first time you run `collab`, you'll see a quick one-screen setup. You only see it once. It does two things for you:
+
+1. Adds the `/collab` command to Claude Code — this is the whole point; it's how you go live.
+2. Makes your normal `claude` command shareable too, so you can just keep typing `claude` and still get `/collab`.
+
+It also asks one optional thing: do you want `/collab @name` to deliver your join link through **Slack**, **Gmail**, or **Discord**? Pick any, or none. You turn these on in your Claude account (at `claude.ai/customize/connectors`) — the screen tells you how, and you can change your mind anytime.
+
+Then it starts Claude like normal.
+
+Changed your mind, or want to run it again?
+
+- `collab setup` — show the setup screen again.
+- `collab setup --undo` — put your normal `claude` back (removes the shim and the plugin).
+- `collab --yes` — skip the setup screen this time (or set `CLAUDE_SHARE_SKIP_SETUP=1`).
+
+## Go live with `/collab`
+
+The first-run setup already added `/collab` for you. (Skipped it? Add it by hand:)
+
+```
+/plugin marketplace add ir272/claudecollab
+/plugin install collab@claudecollab
+```
+
+Whenever you want people to join, just type this inside your session:
+
+```
+/collab
+```
+
+Claude opens a room and hands you the invite link to share. A few handy shortcuts:
+
+- `/collab @sam` — go live *and* DM the link to Sam (if you have a messaging tool like Slack connected).
+- `/collab viewer` or `/collab max 3` or `/collab password hunter2` — set the guest role, a size limit, or a join password.
+- `/collab off` — stop sharing. The room closes and the link dies.
+- `/collab status` — check whether you're live and see the link again.
+
+Prefer to be live the second you start (no plugin needed)? Run `collab --live` and it makes the room right away. `collab off` stops it.
+
+### The two links
+
+Once you're live you get two links — **don't mix them up**:
+
+- A **private link** — your control panel (you let people in and manage them). Stays on your own screen.
+- A **share link** — this is the one you send. `/collab` prints it and the Invite button copies it.
 
 Your friends just open the share link in a browser. They don't install anything.
 
+## Works on
+
+macOS and Linux (Windows counts too, if you use WSL). Native Windows isn't tested yet — if you try it, please open an issue and tell us how it went.
+
+You need Node 22 or newer. If you installed Claude Code with its native installer (not npm), you might not have Node yet — install it first.
+
 ## Two links — don't mix them up
 
 | Link | Who it's for |
@@ -60,7 +115,7 @@ When a friend types something, **it runs on your computer, as if you typed it.**
 By default, `collab` uses our free server at claudecollab.org. Want to run your own instead? The same install includes it:
 
 ```bash
-collab-relay                              # start your own server
+collab relay                              # start your own server
 collab --relay ssh://127.0.0.1:2222       # use it
 ```
 
@@ -68,7 +123,7 @@ To put your server online for good (on Fly.io or any host — see `fly.toml`):
 
 ```bash
 fly launch --no-deploy
-fly secrets set HOST_KEY="$(collab-relay --make-key)"
+fly secrets set HOST_KEY="$(collab relay --make-key)"
 fly secrets set ROOM_SECRET="$(openssl rand -hex 16)"   # optional lock (see below)
 fly deploy
 ```
@@ -83,12 +138,14 @@ Two safety features come built in:
 | Option | What it does |
 |---|---|
 | `--relay <url>` | which server to use; defaults to ours |
-| `--no-relay` | go solo — just Claude, no room, no sharing |
+| `--live` | go live at startup instead of waiting for `/collab` |
+| `--no-relay` | go solo — just Claude, no room, no sharing (and no `/collab`) |
 | `--room-password <pw>` | friends must type this before they can ask to join |
 | `--guests <role>` | what new people can do when let in (default: prompter) |
 | `--secret <s>` | the password for a locked server (or use `CLAUDE_SHARE_SECRET`) |
 | `--fingerprint <fp>` | lock onto a specific server's ID |
 | `--cmd <program>` | run something other than `claude` |
+| `--yes` | skip the first-run setup screen |
 | `-- <args…>` | anything after `--` is passed to the program you're running |
 
 <details>
@@ -104,6 +161,12 @@ packages/cli/      the main program you run — the brain
 
 </details>
 
+## Support this project
+
+It's free and open source, and the community server costs a little to keep running. If it saved you some time, please consider chipping in — every bit helps keep it open ♥
+
+**[github.com/sponsors/ir272](https://github.com/sponsors/ir272)**
+
 ## License
 
 [MIT](LICENSE) — free to use and change. This is an independent project, not made or approved by Anthropic.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@claudecollab/cli",
-  "version": "0.1.3",
+  "version": "0.2.1",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -9,8 +9,7 @@
   "homepage": "https://claudecollab.org",
   "type": "module",
   "bin": {
-    "collab": "packages/cli/bin/claude-share.js",
-    "collab-relay": "packages/relay/bin/serve.js"
+    "collab": "packages/cli/bin/claude-share.js"
   },
   "files": [
     "packages/cli",