@drawsy/companion 0.1.28 → 0.1.30

package/README.md

@@ -6,13 +6,13 @@ The CLI runs the same local Companion server without the desktop app. It connect
 
 - Windows, macOS, or Linux.
 - Node.js 22 or later with npm, installed for your user account.
-- The public npm package `@drawsy/companion`, once it has been published and Drawsy's ownership of the `@drawsy` npm scope is confirmed.
+- The public npm package [@drawsy/companion](https://www.npmjs.com/package/@drawsy/companion).
 
-The npm commands below are not live until the package is published to the public registry and scope ownership is confirmed. A public package does not require a paid private npm plan. No paid app signing certificate or Microsoft Store approval is required for this Node.js CLI package; the separate desktop app has its own release requirements.
+The package is published under Drawsy's npm account. A public package does not require a paid private npm plan. No paid app signing certificate or Microsoft Store approval is required for this Node.js CLI package; the separate desktop app has its own release requirements.
 
 ## Install permanently
 
-After the availability conditions above are met, install the public npm package:
+Install the public npm package:
 
 ```sh
 npm install --global --ignore-scripts @drawsy/companion
@@ -26,9 +26,9 @@ Once installed, run:
 drawsy-companion setup
 ```
 
-`setup` starts Companion in the background and enables startup when you sign in. Then open [Drawsy](https://drawsyai.com), the URL allowed by the Companion connection policy. For app details, see [app.drawsyai.com](https://app.drawsyai.com). Closing the terminal does not stop the background server.
+Running `drawsy-companion` by itself shows the local status without changing startup settings. `setup` starts Companion in the background and enables startup when you sign in. Then open [Drawsy](https://drawsyai.com), the URL allowed by the Companion connection policy. Closing the terminal does not stop the background server.
 
-To install and set up in one line, after the public npm package is published and the `@drawsy` scope ownership is confirmed:
+To install and set up in one line:
 
 macOS/Linux:
 
@@ -46,10 +46,10 @@ The Windows `.cmd` commands avoid requiring a PowerShell script execution policy
 
 ### Optional GitHub tarball source
 
-If you prefer to install a published GitHub release tarball, use its versioned `.tgz` asset. For CLI version 0.1.28:
+If you prefer to install a GitHub release tarball, use its versioned `.tgz` asset. For CLI version 0.1.30:
 
 ```sh
-npm install --global --ignore-scripts https://github.com/DrawsyAI/drawsy-ai-companion/releases/download/cli-v0.1.28/drawsy-companion-0.1.28.tgz
+npm install --global --ignore-scripts https://github.com/DrawsyAI/drawsy-ai-companion/releases/download/cli-v0.1.30/drawsy-companion-0.1.30.tgz
 ```
 
 The tarball is built by this repository's CLI release workflow and is available after its draft release is published. Use the tarball asset, not the desktop ZIP or AppX.
@@ -72,13 +72,15 @@ The desktop app and CLI use the same local server address. Quit the desktop app
 
 ## Update or remove
 
-Run `drawsy-companion autostart disable`, then `drawsy-companion stop` before updating from the public npm registry:
+The CLI does not update itself. npm distributes the package; Node runs it. To update, stop the running server first. If startup at sign-in is enabled, `autostart disable` also stops it:
 
 ```sh
+drawsy-companion autostart disable
 npm install --global --ignore-scripts @drawsy/companion@latest
+drawsy-companion setup
 ```
 
-Run `drawsy-companion setup` after installation to restore background startup. This also refreshes the saved Node.js executable path if your Node installation changed.
+Run `setup` after installation only if you want Companion to start at sign-in. Otherwise, run `drawsy-companion start` when you want it for the current login session. If startup was already disabled, use `drawsy-companion stop` before installing the update instead.
 
 Before removing the package, disable startup at login, stop Companion, and remove the package:
 
@@ -92,7 +94,7 @@ This does not uninstall your Codex/OpenCode installation.
 
 ## Release preparation
 
-Before the first public publication, a maintainer must control the npm account and `@drawsy` scope. Follow [the npm publishing guide](npm-publishing.md) to stage and approve the initial package, then configure GitHub trusted publishing. Future public package releases use this repository's **Publish Companion CLI to npm** GitHub workflow. It requires the current `main` commit, rejects a mismatched existing CLI version tag, builds and packages the CLI, and publishes the package with npm provenance. It runs no tests and launches no app or server.
+The first public version, 0.1.28, was built and uploaded by GitHub Actions and approved through npm's staged publication flow. Follow [the npm publishing guide](https://github.com/DrawsyAI/drawsy-ai-companion/blob/main/docs/npm-publishing.md) for GitHub trusted publishing setup. Future public package releases use this repository's **Publish Companion CLI to npm** GitHub workflow. It requires the current `main` commit, rejects a mismatched existing CLI version tag, builds and packages the CLI, and publishes the package with npm provenance. It runs no tests and launches no app or server.
 
 The **Build Companion CLI release** GitHub workflow builds and packages a selected commit, runs no tests, and launches no app or server. It uploads the tarball and `CLI-SHA256SUMS` to a draft release named `cli-v` followed by the package version. Review and manually verify the draft before publishing it; existing published releases are never replaced. This GitHub tarball is an optional install source.
 

package/dist/drawsy/cli-ui.js

@@ -0,0 +1,121 @@
+const colors = {
+    violet: "38;2;101;84;217",
+    coral: "38;2;255;125;136",
+    blue: "38;2;88;162;232",
+    orange: "38;2;245;119;45",
+    green: "38;2;55;153;80",
+    muted: "38;2;137;143;156",
+    amber: "38;2;210;153;34",
+};
+const canColor = () => Boolean(process.stdout.isTTY && !("NO_COLOR" in process.env) && process.env.TERM !== "dumb");
+const paint = (text, color, bold = false) => canColor() ? `\u001b[${bold ? "1;" : ""}${color}m${text}\u001b[0m` : text;
+const delay = (milliseconds) => new Promise((resolve) => setTimeout(resolve, milliseconds));
+function wordmark() {
+    return [
+        paint("D", colors.violet, true),
+        paint("r", colors.violet, true),
+        paint("a", colors.coral, true),
+        paint("w", colors.orange, true),
+        paint("s", colors.green, true),
+        paint("y", colors.blue, true),
+    ].join("");
+}
+async function printHeader(animate) {
+    const letters = ["D", "r", "a", "w", "s", "y"];
+    const letterColors = [colors.violet, colors.violet, colors.coral, colors.orange, colors.green, colors.blue];
+    const animated = animate && process.stdout.isTTY && !process.env.CI && process.env.TERM !== "dumb";
+    if (animated) {
+        let visible = "";
+        for (let index = 0; index < letters.length; index++) {
+            visible += paint(letters[index], letterColors[index], true);
+            process.stdout.write(`\r  ${visible} Companion`);
+            await delay(38);
+        }
+        process.stdout.write("\n");
+        return;
+    }
+    console.log(`\n  ${wordmark()} Companion`);
+}
+/** Animate one drawn stroke across the line only in an interactive terminal. */
+export function startDrawsyIndicator(label) {
+    if (!process.stdout.isTTY || process.env.CI || process.env.TERM === "dumb") {
+        return { stop: () => undefined };
+    }
+    const width = 9;
+    let position = 0;
+    let direction = 1;
+    const render = () => {
+        const stroke = `${"-".repeat(position)}${paint("/", colors.violet)}${"-".repeat(width - position - 1)}`;
+        process.stdout.write(`\r\u001b[2K  ${stroke}  ${label}`);
+        position += direction;
+        if (position === width - 1 || position === 0)
+            direction *= -1;
+    };
+    render();
+    const timer = setInterval(render, 75);
+    timer.unref();
+    return {
+        stop(message) {
+            clearInterval(timer);
+            process.stdout.write(`\r\u001b[2K  ${paint("OK", colors.green, true)}  ${message}\n`);
+        },
+    };
+}
+export async function printDashboard(state, animate = false) {
+    await printHeader(animate);
+    console.log(`  ${paint("Local bridge", colors.muted)}  ${paint(`v${state.version}`, colors.muted)}`);
+    console.log("");
+    const companionLabel = {
+        running: ["Running", colors.green],
+        starting: ["Starting", colors.amber],
+        stopped: ["Not running", colors.muted],
+        other: ["Another Companion is running", colors.amber],
+    };
+    const [companionText, companionColor] = companionLabel[state.companion];
+    const companionVersion = state.companionVersion ? ` · v${state.companionVersion}` : "";
+    console.log(`  ${"Companion".padEnd(12)} ${paint(`${companionText}${companionVersion}`, companionColor)}`);
+    for (const engine of state.engines) {
+        let label;
+        let color;
+        if (!engine.installed) {
+            label = "Not found";
+            color = colors.muted;
+        }
+        else if (engine.id === "opencode" && process.platform === "win32") {
+            label = "Installed · unavailable on Windows";
+            color = colors.amber;
+        }
+        else {
+            label = `Available${engine.version ? ` · v${engine.version}` : ""}`;
+            color = colors.green;
+        }
+        console.log(`  ${engine.name.padEnd(12)} ${paint(label, color)}`);
+    }
+    if (state.autostart !== undefined) {
+        console.log(`  ${"At sign-in".padEnd(12)} ${paint(state.autostart ? "Enabled" : "Off", state.autostart ? colors.green : colors.muted)}`);
+    }
+    if (state.includeLinks) {
+        console.log("");
+        console.log(`  Open Drawsy  ${paint("https://drawsyai.com", colors.blue)}`);
+        console.log(`  Plans        ${paint("https://app.drawsyai.com/pricing", colors.muted)}`);
+    }
+    if (state.hint) {
+        console.log("");
+        console.log(`  ${paint(state.hint, colors.muted)}`);
+    }
+    console.log("");
+}
+export async function printHelp(version) {
+    await printHeader(false);
+    console.log(`  ${paint(`v${version}`, colors.muted)} · local canvas bridge`);
+    console.log("");
+    console.log("  no command          Show status and links");
+    console.log("  setup              Start now and at sign-in");
+    console.log("  start              Start for this login session");
+    console.log("  serve              Run in this terminal");
+    console.log("  status | stop | logs");
+    console.log("  autostart enable | disable");
+    console.log("");
+    console.log("  Update: npm install --global --ignore-scripts @drawsy/companion@latest");
+    console.log("");
+}

package/dist/drawsy/cli.js

@@ -11,6 +11,7 @@ import { createWriteStream } from "node:fs";
 import { createDrawsyBridge } from "./bridge.js";
 import { readLocalEngineStatus } from "./engine-status.js";
 import { enableAutostart, disableAutostart, autostartEnabled } from "./cli-autostart.js";
+import { printDashboard, printHelp, startDrawsyIndicator } from "./cli-ui.js";
 const directory = path.join(homedir(), ".drawsy-companion");
 const lockDirectory = path.join(directory, "runtime.lock");
 const recordPath = path.join(lockDirectory, "runtime.json");
@@ -67,6 +68,29 @@ const bridgePresent = async () => {
         return null;
     }
 };
+const showStatus = async (options = {}) => {
+    const running = await control("status");
+    const other = running ? null : await bridgePresent();
+    const autostart = await autostartEnabled();
+    const companion = running ? "running" : other ? "other" : options.missingState ?? "stopped";
+    const hint = options.hint ?? (other
+        ? "Quit the desktop app before starting CLI mode."
+        : running
+            ? autostart ? "Ready for Drawsy." : "Run drawsy-companion setup to keep it ready at sign-in."
+            : companion === "starting"
+                ? "Startup is enabled; run drawsy-companion status to check readiness."
+                : "Run drawsy-companion setup to start now and at sign-in.");
+    await printDashboard({
+        version: manifest.version,
+        companion,
+        companionVersion: running?.version ?? other?.version,
+        autostart,
+        engines: readLocalEngineStatus(),
+        includeLinks: options.includeLinks,
+        hint,
+    }, options.animate);
+    return { running, other, autostart };
+};
 const acquire = async () => {
     await mkdir(directory, { recursive: true, mode: 0o700 });
     try {
@@ -148,7 +172,14 @@ const serve = async (backgroundLog) => {
         await writeFile(recordPath, JSON.stringify({ pid: process.pid, port: address.port, token, version: manifest.version }), { mode: 0o600 });
         process.once("SIGINT", () => { void shutdown(); });
         process.once("SIGTERM", () => { void shutdown(); });
-        console.log(`Drawsy Companion ${manifest.version} running at ${bridge.address}`);
+        await printDashboard({
+            version: manifest.version,
+            companion: "running",
+            companionVersion: manifest.version,
+            engines: readLocalEngineStatus(),
+            includeLinks: !backgroundLog,
+            hint: backgroundLog ? `Local bridge ready at ${bridge.address}.` : "Press Ctrl+C to stop.",
+        });
         process.send?.({ ready: true });
         process.disconnect?.();
     }
@@ -165,13 +196,14 @@ const serve = async (backgroundLog) => {
 const start = async () => {
     const existing = await control("status");
     if (existing) {
-        console.log(`Companion ${existing.version} is already running.`);
+        await showStatus({ includeLinks: true });
         return;
     }
     if (await bridgePresent())
         throw new Error("The desktop app or another Companion server is running. Quit it first; this command will not replace it.");
     await mkdir(directory, { recursive: true, mode: 0o700 });
     const output = await open(logPath, "a", 0o600);
+    const indicator = startDrawsyIndicator("Starting local Companion");
     try {
         await new Promise((resolve, reject) => {
             const child = spawn(process.execPath, [entry, "serve"], {
@@ -192,30 +224,27 @@ const start = async () => {
             });
         });
     }
+    catch (error) {
+        indicator.stop("Startup did not finish.");
+        throw error;
+    }
     finally {
         await output.close();
     }
-    console.log(`Companion ${manifest.version} is running in the background. Open https://drawsyai.com`);
+    indicator.stop("Local Companion started.");
+    await showStatus({ includeLinks: true });
 };
-const help = () => console.log(`Drawsy Companion ${manifest.version}
-
-  setup              Start now and automatically when you sign in
-  start              Start in the background for this login session
-  serve              Run visibly in this terminal (Ctrl+C stops it)
-  stop               Stop the CLI server; keep login startup configured
-  status             Show server and automatic startup status
-  logs               Show the latest local log output
-  autostart enable   Enable startup at login
-  autostart disable  Disable startup at login and stop its managed job
-
-Requires Node.js 22 or later. Codex/OpenCode installation and login stay unchanged.
-Update or remove the package with npm after disabling automatic startup.
-Only the CLI's authenticated process is stopped; the desktop app is never killed.`);
 try {
-    const [command = "help", option, ...extra] = process.argv.slice(2);
+    const [command = "welcome", option, ...extra] = process.argv.slice(2);
     if (extra.length || (option && command !== "autostart" && !(command === "serve" && option === "--background-log")))
         throw new Error("Unexpected arguments. Use drawsy-companion help.");
     switch (command) {
+        case "welcome":
+            await showStatus({
+                includeLinks: true,
+                animate: true,
+            });
+            break;
         case "serve":
             await serve(option === "--background-log");
             break;
@@ -230,17 +259,11 @@ try {
                 if (alive(running.pid))
                     throw new Error("Shutdown is still in progress. Check status before restarting.");
             }
-            console.log(running ? "Companion CLI stopped." : "Companion CLI is not running.");
+            await showStatus({ hint: running ? "Companion CLI stopped." : "Companion CLI is not running." });
             break;
         }
         case "status": {
-            const running = await control("status");
-            const other = running ? null : await bridgePresent();
-            console.log(running ? `Companion CLI ${running.version} running.` : other ? `Another Companion server ${other.version ?? ""} is running.` : "Companion is not running.");
-            console.log(`Startup at login: ${await autostartEnabled() ? "enabled" : "disabled"}.`);
-            for (const engine of readLocalEngineStatus()) {
-                console.log(`${engine.name}: ${engine.id === "opencode" && process.platform === "win32" ? "not supported by Companion on Windows" : engine.installed ? `available${engine.version ? ` (${engine.version})` : ""}` : "not found"}.`);
-            }
+            await showStatus();
             break;
         }
         case "logs": {
@@ -269,18 +292,29 @@ try {
             if (action === "disable") {
                 await control("stop");
                 await disableAutostart();
-                console.log("Startup at login disabled; CLI shutdown requested.");
+                await showStatus({ hint: "Startup at sign-in disabled." });
             }
             else if (action === "enable") {
                 if (await autostartEnabled() && await control("status")) {
-                    console.log("Companion running; startup at login enabled.");
+                    await showStatus({ includeLinks: true, hint: "Ready at sign-in." });
                     break;
                 }
                 if (await control("status") || await bridgePresent())
                     throw new Error("Stop Companion first, then run setup. Existing sessions will not be interrupted automatically.");
                 await mkdir(directory, { recursive: true, mode: 0o700 });
-                await enableAutostart(process.execPath, entry);
-                console.log("Startup at login enabled. Run drawsy-companion status to check readiness; open https://drawsyai.com when running.");
+                const indicator = startDrawsyIndicator("Setting up sign-in startup");
+                try {
+                    await enableAutostart(process.execPath, entry);
+                }
+                catch (error) {
+                    indicator.stop("Setup could not be completed.");
+                    throw error;
+                }
+                indicator.stop("Startup at sign-in enabled.");
+                await showStatus({
+                    includeLinks: true,
+                    missingState: "starting",
+                });
             }
             else
                 throw new Error("Use autostart enable or autostart disable.");
@@ -289,7 +323,7 @@ try {
         case "help":
         case "--help":
         case "-h":
-            help();
+            await printHelp(manifest.version);
             break;
         case "--version":
             console.log(manifest.version);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drawsy/companion",
-  "version": "0.1.28",
+  "version": "0.1.30",
   "private": false,
   "type": "module",
   "description": "Drawsy's local Companion server and background command-line controls",