@swirls/cli 0.1.0 → 0.1.1

package/README.md

@@ -28,6 +28,14 @@ Run with `swirls`
 swirls <command> [options]
 ```
 
+## Installation and how it works
+
+The published package is a **launcher**: the `swirls` / `cli` bin points at `launcher/cli.js`, which runs on **every** CLI invocation (not at install time).
+
+On install, the package manager installs the launcher plus **one** platform-specific binary. That binary is provided by an optional dependency (`@swirls/cli-darwin-arm64`, etc.). The package manager installs only the optional dependency whose `os` and `cpu` match the host, so you only get the binary for your platform.
+
+At run time, the launcher looks up the current platform, resolves that optional dependency's binary, and exec's it with your arguments.
+
 ## Reference
 
 Run `--help` for a reference guide; use `-v` or `--version` to print the CLI version.

package/launcher/README.md

@@ -0,0 +1,17 @@
+# Launcher
+
+The launcher is the Node entry point for `@swirls/cli`. It runs on every `swirls` invocation, resolves the current platform's optional dependency, and exec's that package's `swirls` binary.
+
+## Files
+
+- **cli.js** — Entry script. Resolves `platform-arch`, looks up the package in `platforms.js`, and exec's the binary with the user's arguments.
+- **platforms.js** — Generated during build from the repo root `platforms.ts`. Do not edit by hand.
+
+## Adding a platform
+
+1. Add an entry to [platforms.ts](../platforms.ts).
+2. Run the build (which regenerates `launcher/platforms.js`).
+3. Add or update the package under `packages/<pkgDir>/` and its `package.json` (with `os` and `cpu`).
+4. Add the npm package to `optionalDependencies` in [package.json](../package.json).
+
+See [AGENTS.md](../AGENTS.md) "Adding a new platform" for detailed build and publish steps.

package/launcher/cli.js

@@ -3,7 +3,6 @@
 import { execFileSync } from 'node:child_process'
 import { createRequire } from 'node:module'
 import { dirname, join } from 'node:path'
-import { Table } from 'console-table-printer'
 import { platforms } from './platforms.js'
 
 const require = createRequire(import.meta.url)
@@ -13,25 +12,7 @@ const pkg = platforms[key]
 
 // handle unsupported platform
 if (!pkg) {
-  console.warn(`\n⚠️  Your platform is not currently supported: ${key}\n`)
-
-  // list supported platforms
-  const table = new Table({
-    columns: [
-      { name: 'Platform', alignment: 'left' },
-      { name: 'Package', alignment: 'left' },
-    ],
-    rows: Object.entries(platforms).map(([platform, pkg]) => ({
-      Platform: platform,
-      Package: pkg,
-    })),
-  })
-  table.printTable()
-
-  console.info(
-    '\nTo request support for your platform, send us an email at help@swirls.ai\n',
-  )
-
+  printUnsupportedPlatform(key)
   process.exit(1)
 }
 
@@ -39,3 +20,26 @@ const pkgDir = dirname(require.resolve(`${pkg}/package.json`))
 const binary = join(pkgDir, 'swirls')
 
 execFileSync(binary, process.argv.slice(2), { stdio: 'inherit' })
+
+function printUnsupportedPlatform(key) {
+  const noColor = 'NO_COLOR' in process.env
+  const reset = noColor ? '' : '\x1b[0m'
+  const yellow = noColor ? '' : '\x1b[33m'
+  // const bold = noColor ? '' : '\x1b[1m'
+  const cyan = noColor ? '' : '\x1b[36m'
+  const blue = noColor ? '' : '\x1b[34m'
+  const dim = noColor ? '' : '\x1b[2m'
+
+  console.warn(
+    `\n${yellow}Your platform is not currently supported:${reset} ${key}\n`,
+  )
+  console.log('Supported platforms:')
+  for (const [platform, pkgName] of Object.entries(platforms)) {
+    console.log(
+      `  ${cyan}${platform.padEnd(16)}${reset}\t${dim}${pkgName}${reset}`,
+    )
+  }
+  console.log(
+    `\nTo request support for your platform, send us an email at ${blue}help@swirls.ai${reset}\n`,
+  )
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swirls/cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Swirls command line application",
   "author": {
     "name": "Swirls",
@@ -17,8 +17,8 @@
   "scripts": {
     "build": "bun run ci/build.ts",
     "dev": "bun run --watch src/bin/cli.ts",
-    "pkg:publish": "SWIRLS_ENV=production bun run build && bun run cd/publish.ts",
-    "pkg:publish:dry": "SWIRLS_ENV=production bun run build && bun run cd/publish.ts --dry-run"
+    "publish": "SWIRLS_ENV=production bun run build && bun run cd/publish.ts",
+    "publish:dry": "SWIRLS_ENV=production bun run build && bun run cd/publish.ts --dry-run"
   },
   "devDependencies": {
     "@byteslice/result": "0.3.0",
@@ -35,15 +35,14 @@
     "console-table-printer": "2.15.0",
     "dotenv": "16.4.7",
     "open": "10.2.0",
-    "sucrase": "3.35.1",
     "typescript": "5.9.3",
     "zod": "4.3.5"
   },
   "optionalDependencies": {
-    "@swirls/cli-darwin-arm64": "0.1.0",
-    "@swirls/cli-darwin-x64": "0.1.0",
-    "@swirls/cli-linux-arm64": "0.1.0",
-    "@swirls/cli-linux-x64": "0.1.0"
+    "@swirls/cli-darwin-arm64": "0.1.1",
+    "@swirls/cli-darwin-x64": "0.1.1",
+    "@swirls/cli-linux-arm64": "0.1.1",
+    "@swirls/cli-linux-x64": "0.1.1"
   },
   "engines": {
     "node": ">=22"