@drawsy/companion 0.0.0-stage → 0.1.28

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Drawsy AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,99 @@
-# Temporary Holding Version
+# Drawsy Companion from your terminal
 
-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 CLI runs the same local Companion server without the desktop app. It connects Drawsy to your existing Codex/OpenCode installation. It does not install either engine, sign you in, or change their authentication settings.
+
+## Requirements
+
+- 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 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.
+
+## Install permanently
+
+After the availability conditions above are met, install the public npm package:
+
+```sh
+npm install --global --ignore-scripts @drawsy/companion
+```
+
+This installs the CLI globally; npx is not needed. npm must be configured so your user account can install global packages; this flow does not request administrator access.
+
+Once installed, run:
+
+```sh
+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.
+
+To install and set up in one line, after the public npm package is published and the `@drawsy` scope ownership is confirmed:
+
+macOS/Linux:
+
+```sh
+npm install --global --ignore-scripts @drawsy/companion && drawsy-companion setup
+```
+
+Windows PowerShell:
+
+```powershell
+npm.cmd install --global --ignore-scripts @drawsy/companion; if ($LASTEXITCODE -eq 0) { drawsy-companion.cmd setup }
+```
+
+The Windows `.cmd` commands avoid requiring a PowerShell script execution policy change.
+
+### 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:
+
+```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
+```
+
+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.
+
+## Commands
+
+```sh
+drawsy-companion start
+drawsy-companion stop
+drawsy-companion status
+drawsy-companion logs
+drawsy-companion serve
+drawsy-companion autostart enable
+drawsy-companion autostart disable
+```
+
+`serve` keeps the server visible in your current terminal. Press Ctrl+C to stop it. `status` reports whether the local server is running. Startup at login uses Windows Task Scheduler, macOS launchd, or Linux's user systemd service; Linux requires a working user systemd session. `start` alone does not enable startup at login.
+
+The desktop app and CLI use the same local server address. Quit the desktop app before switching to the CLI; an existing server is not silently replaced or stopped.
+
+## Update or remove
+
+Run `drawsy-companion autostart disable`, then `drawsy-companion stop` before updating from the public npm registry:
+
+```sh
+npm install --global --ignore-scripts @drawsy/companion@latest
+```
+
+Run `drawsy-companion setup` after installation to restore background startup. This also refreshes the saved Node.js executable path if your Node installation changed.
+
+Before removing the package, disable startup at login, stop Companion, and remove the package:
+
+```sh
+drawsy-companion autostart disable
+drawsy-companion stop
+npm uninstall --global @drawsy/companion
+```
+
+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 **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.
+
+The package contains the compiled local server, bundled Drawsy skills, and npm runtime dependency declarations. It excludes Electron, the desktop UI, build dependencies, personal configuration, and credentials. npm installs the declared runtime dependencies when installing the tarball.

package/dist/drawsy/bridge-main.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { createDrawsyBridge } from "./bridge.js";
+import { loadDrawsyEnvironment } from "./environment.js";
+const mode = loadDrawsyEnvironment();
+const bridge = createDrawsyBridge({
+    host: process.env.HOST || "127.0.0.1"
+});
+await bridge.listen();
+console.log(`Drawsy AI bridge listening on ${bridge.address}`);
+const shutdown = async () => {
+    await bridge.close();
+    process.exit(0);
+};
+process.on("SIGINT", shutdown);
+process.on("SIGTERM", shutdown);