@cabane/cli 0.1.11 → 0.2.0

package/README.md

@@ -1,4 +1,4 @@
-# cabane CLI
+# cabane-server CLI
 
 Run a self-hosted [Cabane](https://cabane.ai) on your own machine. `@cabane/cli`
 installs the Cabane server, runs the whole stack — server plus embedded Postgres —
@@ -13,12 +13,12 @@ itself and needs no model key of its own.
 The short version:
 
 ```sh
-npm i -g @cabane/cli                 # install the CLI (bin: `cabane`)
-cabane init                          # first-run wizard (data location, port, URL)
-cabane install --token cabdist_…     # fetch + verify + unpack the server
-cabane up --daemon                   # run the stack
+npm i -g @cabane/cli                        # install the CLI (bin: `cabane-server`)
+cabane-server init                          # first-run wizard (data location, port, URL)
+cabane-server install --token cabdist_…     # fetch + verify + unpack the server
+cabane-server up --daemon                   # run the stack
 # open http://localhost:3000, sign up
-cabane setup-agent                   # confirm your account + how to pair a companion
+cabane-server setup-agent                   # confirm your account + how to pair a companion
 ```
 
 Each step, in order, below.
@@ -33,26 +33,26 @@ Each step, in order, below.
 
 ## Getting started
 
-1. **Install the CLI.** `npm i -g @cabane/cli` — installs the `cabane` binary.
+1. **Install the CLI.** `npm i -g @cabane/cli` — installs the `cabane-server` binary.
 
-2. **Run `cabane init`** — the interactive first-run wizard. It asks where your
+2. **Run `cabane-server init`** — the interactive first-run wizard. It asks where your
    data lives (and shows the resolved paths — `data/storage` for uploads,
    `data/pg` for the database), the port, and an optional public URL. Everything
-   persists to config, so a later `cabane up` needs no flags. Re-run it any time to
+   persists to config, so a later `cabane-server up` needs no flags. Re-run it any time to
    reconfigure, or skip it and pass flags directly if you prefer.
 
-3. **Run `cabane install --token cabdist_…`** — fetches the server artifact with
+3. **Run `cabane-server install --token cabdist_…`** — fetches the server artifact with
    your distribution token, verifies its sha256, and unpacks it. (Have a local
-   tarball instead? `cabane install --from <artifact.tgz>` works offline.)
+   tarball instead? `cabane-server install --from <artifact.tgz>` works offline.)
 
-4. **Run `cabane up --daemon`** — starts and supervises the stack: embedded
+4. **Run `cabane-server up --daemon`** — starts and supervises the stack: embedded
    Postgres and the server. Leave off `--daemon` to run it in the foreground.
 
 5. **Sign up.** Open <http://localhost:3000> and create your account and first
    workspace.
 
 6. **Pair a companion.** Your workspace seeds an agent, but it has nowhere to run
-   until you pair a device. `cabane setup-agent` (mint an access token in
+   until you pair a device. `cabane-server setup-agent` (mint an access token in
    **Settings → Developer**, paste it at the prompt) confirms your account and
    prints the steps: install the Companion (desktop app, or the headless
    `@cabane/companion`), sign in against this instance, pair it, then assign the
@@ -64,7 +64,7 @@ see the [Cabane docs](https://app.cabane.ai/docs).
 
 ## What it supervises
 
-`cabane up` runs two children in order, with a clean SIGTERM teardown:
+`cabane-server up` runs two children in order, with a clean SIGTERM teardown:
 
 1. **Embedded Postgres** — the `embedded-postgres` binaries (pinned pg 16.14) run
    as a child on a local off-5432 port; data in `<CABANE_HOME>/data/pg`. No system
@@ -72,7 +72,7 @@ see the [Cabane docs](https://app.cabane.ai/docs).
 2. **The server** — the artifact's single-process API+SPA (`server.js`, filesystem
    storage, the bundled SPA served via `WEB_DIST`), env composed automatically
    (`NODE_ENV=production`, `http://localhost:<port>`, generated-once vision
-   secret, any persisted `cabane set-env` creds). Migrations apply on boot.
+   secret, any persisted `cabane-server set-env` creds). Migrations apply on boot.
 
 Agents don't run here — they run on a companion you pair (a separate process on a
 device you control), the same as hosted Cabane.
@@ -93,35 +93,35 @@ which a standalone `@cabane/companion` user companion already keys off, so a
 self-host install can never clobber a companion's device pairing on a shared box.
 Override the whole root with the **`CABANE_HOME`** env var (the multi-instance
 lever); a pre-existing self-host install still living at `~/.cabane` is adopted in
-place, so no data moves. A `cabane install` / `set-env` pointed (via `CABANE_HOME`)
+place, so no data moves. A `cabane-server install` / `set-env` pointed (via `CABANE_HOME`)
 at a directory that holds a companion config refuses rather than overwrite it.
 
-**Relocating just the data.** `cabane init` can point the **data** leg (pg +
+**Relocating just the data.** `cabane-server init` can point the **data** leg (pg +
 storage) at any path you choose while `config.json` + `app/` stay under the root —
 handy for putting bulky uploads on a bigger disk. The default is still
 `<root>/data`; the chosen location persists in config, so `up` finds it with no
 env var or flag.
 
 **Your data is safe across upgrades.** `data/` (pg + storage) sits apart from the
-versioned `app/<version>/` tree, so `cabane install`, `cabane update`, and a
+versioned `app/<version>/` tree, so `cabane-server install`, `cabane-server update`, and a
 same-version reinstall only ever touch the app tree — your account, files, and
-conversations persist untouched. `cabane status` prints the `home` + `data`
+conversations persist untouched. `cabane-server status` prints the `home` + `data`
 paths so you can see it.
 
 ## Commands
 
-| Command              | What it does                                                                                  |
-| -------------------- | --------------------------------------------------------------------------------------------- |
-| `cabane init`        | interactive first-run wizard: data location, port, public URL                                 |
-| `cabane install`     | fetch (token → gated artifact) or `--from` a local tarball; unpack + `npm install --omit=dev` |
-| `cabane up`          | start + supervise the stack (`--daemon` for background)                                       |
-| `cabane setup-agent` | after signup: confirm your account + print companion-pairing guidance                         |
-| `cabane update`      | install a newer published artifact (keeps N-1 for rollback)                                   |
-| `cabane set-env`     | persist generic `KEY=VALUE` server env forwarded to the server (`--list` / `--unset`)         |
-| `cabane down`        | stop a running stack                                                                          |
-| `cabane status`      | what's installed + running                                                                    |
-| `cabane logs`        | tail the server log                                                                           |
-| `cabane doctor`      | preflight: diagnose common self-host failure classes (runs with the stack down)               |
+| Command                     | What it does                                                                                  |
+| --------------------------- | --------------------------------------------------------------------------------------------- |
+| `cabane-server init`        | interactive first-run wizard: data location, port, public URL                                 |
+| `cabane-server install`     | fetch (token → gated artifact) or `--from` a local tarball; unpack + `npm install --omit=dev` |
+| `cabane-server up`          | start + supervise the stack (`--daemon` for background)                                       |
+| `cabane-server setup-agent` | after signup: confirm your account + print companion-pairing guidance                         |
+| `cabane-server update`      | install a newer published artifact (keeps N-1 for rollback)                                   |
+| `cabane-server set-env`     | persist generic `KEY=VALUE` server env forwarded to the server (`--list` / `--unset`)         |
+| `cabane-server down`        | stop a running stack                                                                          |
+| `cabane-server status`      | what's installed + running                                                                    |
+| `cabane-server logs`        | tail the server log                                                                           |
+| `cabane-server doctor`      | preflight: diagnose common self-host failure classes (runs with the stack down)               |
 
 ## Running agents
 
@@ -134,9 +134,9 @@ against the login or key already there; the server never sees the credential. Fo
 single-box setup, the companion can run on the same machine as the server (point it
 at `http://localhost:3000`).
 
-## Troubleshooting — `cabane doctor`
+## Troubleshooting — `cabane-server doctor`
 
-When something won't start, run `cabane doctor` **first**. It's a standalone
+When something won't start, run `cabane-server doctor` **first**. It's a standalone
 preflight (no server needed — it's what you reach for precisely when things are
 broken) that checks the common self-host failure classes and prints a legible
 pass/fail/warn report, each with a one-line fix, then exits non-zero if any hard
@@ -149,29 +149,29 @@ check fails. It's strictly local — nothing phones home. Checks:
 - **Disk space** for the data dir.
 - **macOS Gatekeeper** — quarantine on the Postgres binaries (macOS only).
 
-## Server env — `cabane set-env`
+## Server env — `cabane-server set-env`
 
-The self-hosted server needs no model credential of its own. `cabane set-env` stays
+The self-hosted server needs no model credential of its own. `cabane-server set-env` stays
 for any generic server env you _do_ want to persist:
 
 ```sh
 # persisted — save once; every future `up` (fresh shell, reboot) picks it up.
 # A bare KEY prompts for the value (hidden); `KEY=VALUE` still works for scripting.
-cabane set-env SOME_KEY
-cabane down && cabane up --daemon
+cabane-server set-env SOME_KEY
+cabane-server down && cabane-server up --daemon
 ```
 
 It stores generic `KEY=VALUE` pairs in `<CABANE_HOME>/config.json` and layers them
 into the server's env on every `up` — beneath the composed infra vars, so an
 operator key reaches the server but can never clobber `DATABASE_URL` / `NODE_ENV` /
-`STORAGE_*`. A bare `cabane set-env KEY` (no `=value`) prompts for the value without
+`STORAGE_*`. A bare `cabane-server set-env KEY` (no `=value`) prompts for the value without
 echoing, so a secret never lands on the command line. Inspect with
-`cabane set-env --list` (values masked), remove with `cabane set-env --unset KEY`.
+`cabane-server set-env --list` (values masked), remove with `cabane-server set-env --unset KEY`.
 A live shell export takes precedence over a persisted value. Apply a change to an
-already-running stack with `cabane down && cabane up`.
+already-running stack with `cabane-server down && cabane-server up`.
 
 ## Notes
 
 - **macOS Gatekeeper** may quarantine the unsigned Postgres binaries. If pg
   fails to exec on first run, clear the quarantine xattr and retry —
-  `cabane doctor` detects this and prints the fix.
+  `cabane-server doctor` detects this and prints the fix.

package/dist/cli.js

@@ -224,7 +224,7 @@ async function checkPort(ctx) {
     "port",
     "Port",
     `:${port} is occupied by another process`,
-    `Free port ${port}, or install on another with \`cabane install --port <n>\`, then retry.`
+    `Free port ${port}, or install on another with \`cabane-server install --port <n>\`, then retry.`
   );
 }
 function ownSupervisorPid(paths) {
@@ -275,7 +275,7 @@ function checkStorage(ctx) {
       `Make ${target} writable, or point Cabane elsewhere with \`CABANE_HOME=<dir>\`.`
     );
   }
-  const note = existsSync2(root) ? "" : " (will be created on first `cabane up`)";
+  const note = existsSync2(root) ? "" : " (will be created on first `cabane-server up`)";
   return pass("storage", "Storage root", `${root} \u2014 writable${note}`);
 }
 async function resolvePgBinaries(platform, arch) {
@@ -328,7 +328,7 @@ async function checkPostgres(ctx) {
     return pass(
       "postgres",
       "Embedded Postgres",
-      `binaries present; data dir uninitialised \u2014 first \`cabane up\` will init it (${dataDir})`
+      `binaries present; data dir uninitialised \u2014 first \`cabane-server up\` will init it (${dataDir})`
     );
   }
   const stale = stalePostmaster(dataDir);
@@ -337,7 +337,7 @@ async function checkPostgres(ctx) {
       "postgres",
       "Embedded Postgres",
       `data dir initialised but holds a stale postmaster.pid (pid ${stale}, not running) \u2014 ${dataDir}`,
-      "Harmless \u2014 Postgres clears it on the next `cabane up`; remove data/pg/postmaster.pid if start still refuses."
+      "Harmless \u2014 Postgres clears it on the next `cabane-server up`; remove data/pg/postmaster.pid if start still refuses."
     );
   }
   return pass("postgres", "Embedded Postgres", `binaries present; data dir healthy \u2014 ${dataDir}`);
@@ -428,7 +428,7 @@ var STATUS_GLYPH = {
 };
 var NAME_WIDTH = 22;
 function reportLines(summary) {
-  const lines = ["cabane doctor", ""];
+  const lines = ["cabane-server doctor", ""];
   for (const r of summary.results) {
     lines.push(`${STATUS_GLYPH[r.status]} ${r.name.padEnd(NAME_WIDTH)} ${r.detail}`);
     if (r.fix) lines.push(`  ${" ".repeat(NAME_WIDTH)} \u21B3 fix: ${r.fix}`);
@@ -565,7 +565,7 @@ async function down() {
   rmSync2(paths.supervisorPidFile, { force: true });
   rmSync2(paths.stateFile, { force: true });
   if (free) ok("stopped");
-  else warn2(`stopped, but port ${port} still looks busy \u2014 check \`cabane status\`.`);
+  else warn2(`stopped, but port ${port} still looks busy \u2014 check \`cabane-server status\`.`);
 }
 async function killPid(pid) {
   try {
@@ -666,7 +666,7 @@ async function promptSecret(question) {
 async function init() {
   if (!isInteractive()) {
     throw new Error(
-      "`cabane init` is an interactive wizard \u2014 run it in a terminal, or configure non-interactively with `cabane install --port \u2026` + `cabane set-env KEY=VALUE`."
+      "`cabane-server init` is an interactive wizard \u2014 run it in a terminal, or configure non-interactively with `cabane-server install --port \u2026` + `cabane-server set-env KEY=VALUE`."
     );
   }
   assertNotForeignCompanion();
@@ -716,9 +716,13 @@ async function init() {
   info("");
   const installed = config.currentVersion && isInstalled(appDirFor(paths, config.currentVersion));
   if (installed) {
-    info("next: `cabane up` (no flags needed), then sign up and `cabane setup-agent`.");
+    info(
+      "next: `cabane-server up` (no flags needed), then sign up and `cabane-server setup-agent`."
+    );
   } else {
-    info("next: `cabane install` to fetch the server, then `cabane up` (no flags needed).");
+    info(
+      "next: `cabane-server install` to fetch the server, then `cabane-server up` (no flags needed)."
+    );
   }
 }
 function expandPath(input, root) {
@@ -736,7 +740,7 @@ async function promptPort(current) {
     if (Number.isInteger(n) && n > 0 && n <= 65535) return n;
     warn2(`invalid port: ${answer} \u2014 enter a number between 1 and 65535.`);
   }
-  throw new Error("no valid port after several tries \u2014 re-run `cabane init`.");
+  throw new Error("no valid port after several tries \u2014 re-run `cabane-server init`.");
 }
 
 // src/commands/install.ts
@@ -759,7 +763,7 @@ async function fetchManifest(distBase, token, version) {
   if (res.status === 404) return null;
   if (res.status === 401) {
     throw new Error(
-      "distribution token rejected (401) \u2014 check the token passed to `cabane install`"
+      "distribution token rejected (401) \u2014 check the token passed to `cabane-server install`"
     );
   }
   if (!res.ok) {
@@ -846,7 +850,7 @@ async function install(opts) {
     } else {
       info(`data will live at ${paths.dataDir} (pg + storage) \u2014 preserved across upgrades`);
     }
-    info("next: cabane up");
+    info("next: cabane-server up");
   } finally {
     cleanup?.();
   }
@@ -878,7 +882,7 @@ async function logs(opts) {
   const paths = resolvePaths();
   const n = String(opts.lines ?? 80);
   if (!existsSync6(paths.serverLog)) {
-    info("no logs yet \u2014 start the stack with `cabane up`.");
+    info("no logs yet \u2014 start the stack with `cabane-server up`.");
     return;
   }
   const args = opts.follow ? ["-n", n, "-F", paths.serverLog] : ["-n", n, paths.serverLog];
@@ -895,7 +899,7 @@ function printList() {
   const env = loadConfig().companionEnv ?? {};
   const keys = Object.keys(env);
   if (keys.length === 0) {
-    info("no persisted server env. Add one: `cabane set-env KEY=VALUE`");
+    info("no persisted server env. Add one: `cabane-server set-env KEY=VALUE`");
     return;
   }
   step("persisted server env:");
@@ -941,7 +945,7 @@ async function setEnv(pairs, opts) {
       config.companionEnv = { ...config.companionEnv ?? {}, ...parsed };
     });
     for (const key of Object.keys(parsed)) ok(`set ${key}=${mask(parsed[key])}`);
-    info("restart to apply: `cabane down && cabane up --daemon`");
+    info("restart to apply: `cabane-server down && cabane-server up --daemon`");
   }
 }
 
@@ -1025,7 +1029,7 @@ async function setupAgent(opts) {
   const base = localBaseUrl(config.port);
   const instanceUrl = config.publicUrl ?? base;
   if (!await healthy(config.port)) {
-    throw new Error(`server is not up on ${base} \u2014 run \`cabane up\` and sign up first.`);
+    throw new Error(`server is not up on ${base} \u2014 run \`cabane-server up\` and sign up first.`);
   }
   const token = await resolvePat(opts, base);
   const client = makeClient(base, token);
@@ -1099,7 +1103,7 @@ async function status() {
     process.stdout.write(`  ${label.padEnd(12)}${value}
 `);
   };
-  process.stdout.write("cabane\n");
+  process.stdout.write("cabane-server\n");
   line("version", config.currentVersion ?? "(not installed)");
   if (config.previousVersion) line("previous", config.previousVersion);
   line("port", String(config.port));
@@ -1107,7 +1111,7 @@ async function status() {
   line("data", `${paths.dataDir} (pg + storage \xB7 kept across upgrades)`);
   line("supervisor", supervisorUp ? `up (pid ${supervisorPid})` : "down");
   line("server", serverUp ? `up \xB7 http://localhost:${config.port}` : "down");
-  if (!supervisorUp) info("start it: cabane up");
+  if (!supervisorUp) info("start it: cabane-server up");
 }
 function readState2(file) {
   try {
@@ -1281,7 +1285,7 @@ async function up(opts) {
   const paths = pathsFor(config);
   if (opts.port) config.port = opts.port;
   if (!config.currentVersion) {
-    throw new Error("nothing installed yet \u2014 run `cabane install` first.");
+    throw new Error("nothing installed yet \u2014 run `cabane-server install` first.");
   }
   const appDir = appDirFor(paths, config.currentVersion);
   if (!isInstalled(appDir)) {
@@ -1296,7 +1300,7 @@ async function up(opts) {
   }
   if (await portInUse(config.port)) {
     throw new Error(
-      `port ${config.port} is already in use. If cabane is running, use \`cabane down\`; otherwise a stale process is holding it \u2014 free it and retry.`
+      `port ${config.port} is already in use. If cabane is running, use \`cabane-server down\`; otherwise a stale process is holding it \u2014 free it and retry.`
     );
   }
   if (opts.daemon) {
@@ -1309,7 +1313,7 @@ async function launchDaemon(paths, config) {
   if (existsSync8(paths.supervisorPidFile)) {
     const pid = Number(readFileSync6(paths.supervisorPidFile, "utf8").trim());
     if (pid && pidAlive(pid)) {
-      warn2(`already running (supervisor pid ${pid}). Use \`cabane down\` to stop it.`);
+      warn2(`already running (supervisor pid ${pid}). Use \`cabane-server down\` to stop it.`);
       return;
     }
   }
@@ -1342,8 +1346,8 @@ async function launchDaemon(paths, config) {
 }
 function daemonFooter() {
   return [
-    "next: open the URL, sign up, then pair a companion so your agents can answer \u2014 `cabane setup-agent` explains how",
-    "logs: cabane logs \xB7 stop: cabane down"
+    "next: open the URL, sign up, then pair a companion so your agents can answer \u2014 `cabane-server setup-agent` explains how",
+    "logs: cabane-server logs \xB7 stop: cabane-server down"
   ];
 }
 var Supervisor = class {
@@ -1369,7 +1373,7 @@ var Supervisor = class {
       visionSecret: config.visionSecret,
       ...config.credentialKey ? { credentialKey: config.credentialKey } : {},
       ...config.publicUrl ? { publicBaseUrl: config.publicUrl } : {},
-      // Persisted `cabane set-env` creds (generic server env) are layered beneath
+      // Persisted `cabane-server set-env` creds (generic server env) are layered beneath
       // the composed infra vars.
       ...config.companionEnv ? { persistedEnv: config.companionEnv } : {},
       // The artifact's build version → the server reports it on the companion
@@ -1473,8 +1477,9 @@ async function update(opts) {
   const distBase = (opts.distBase ?? config.distBase).replace(/\/$/, "");
   const token = opts.token ?? config.distToken;
   if (!token)
-    throw new Error("no distribution token stored \u2014 run `cabane install --token \u2026` first.");
-  if (!config.currentVersion) throw new Error("nothing installed \u2014 run `cabane install` first.");
+    throw new Error("no distribution token stored \u2014 run `cabane-server install --token \u2026` first.");
+  if (!config.currentVersion)
+    throw new Error("nothing installed \u2014 run `cabane-server install` first.");
   step(`checking ${distBase} for updates\u2026`);
   const manifest = await fetchManifest(distBase, token, opts.version);
   if (!manifest) throw new Error("no artifact available from the distribution endpoint.");
@@ -1490,12 +1495,12 @@ async function update(opts) {
   }
   await install({ token, distBase, version: target });
   ok(`installed ${target} (previous kept for rollback)`);
-  info("restart to run it: cabane down && cabane up");
+  info("restart to run it: cabane-server down && cabane-server up");
 }
 
 // src/cli.ts
 var program = new Command();
-program.name("cabane").description("Run a self-hosted Cabane on your own machine \u2014 no docker, no repo.").version("0.1.2");
+program.name("cabane-server").description("Run a self-hosted Cabane on your own machine \u2014 no docker, no repo.").version("0.2.0");
 var parsePort = (raw) => {
   const n = Number(raw);
   if (!Number.isInteger(n) || n <= 0 || n > 65535) throw new Error(`invalid port: ${raw}`);
@@ -1503,7 +1508,7 @@ var parsePort = (raw) => {
 };
 program.command("init").description("interactive first-run wizard: data location, port, and public URL").action(init);
 program.command("install").description("install the server artifact (token \u2192 gated download, or --from a local tarball)").option("--token <token>", "distribution token (cabdist_\u2026) \u2014 prompted if omitted").option("--from <tarball>", "install from a local artifact tarball instead of downloading").option("--dist-base <url>", "distribution origin to fetch from (default https://dist.cabane.ai)").option("--version <version>", "install a specific published version (default: latest)").option("--port <port>", "local port the server will listen on (default 3000)", parsePort).option("--force", "reinstall even if this version is already present").action(install);
-program.command("up").description("start + supervise the stack (Postgres + server)").option("--daemon", "run in the background (terminal returns; stop with `cabane down`)").option("--port <port>", "override the configured port", parsePort).action(up);
+program.command("up").description("start + supervise the stack (Postgres + server)").option("--daemon", "run in the background (terminal returns; stop with `cabane-server down`)").option("--port <port>", "override the configured port", parsePort).action(up);
 program.command("setup-agent").description("after browser signup: confirm your account and print companion-pairing guidance").option("--token <token>", "a Cabane access token (cab_\u2026) \u2014 prompted if omitted").action(setupAgent);
 program.command("update").description("install a newer published artifact (keeps the previous for rollback)").option("--token <token>", "distribution token (cabdist_\u2026) \u2014 defaults to the stored one").option("--dist-base <url>", "distribution origin to fetch from").option("--version <version>", "install a specific version instead of latest").action(update);
 program.command("set-env [pairs...]").description(

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@cabane/cli",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "type": "module",
-  "description": "The cabane CLI — install, run, and update a self-hosted Cabane on your own machine (server + embedded Postgres; agents run on a companion you pair).",
+  "description": "The cabane-server CLI — install, run, and update a self-hosted Cabane on your own machine (server + embedded Postgres; agents run on a companion you pair).",
   "license": "UNLICENSED",
   "homepage": "https://cabane.ai",
   "repository": {
@@ -16,7 +16,7 @@
     "cli"
   ],
   "bin": {
-    "cabane": "dist/cli.js"
+    "cabane-server": "dist/cli.js"
   },
   "main": "./dist/cli.js",
   "files": [