@swirls/cli 0.1.5 → 0.1.9

package/README.md

@@ -1,84 +1,14 @@
 # @swirls/cli
 
-Swirls command line application for authentication, project setup, code generation, and storage.
+Swirls command line application. https://swirls.ai/docs/docs/references/cli
 
-## Usage
-
-The Swirls CLI can be executed remotely or installed on your machine. Use `swirls` or `npx @swirls/cli` depending on what you choose.
-
-### Remote
-
-Run with `npx`
-```sh
-npx @swirls/cli <command> [options]
-```
-
-### Local
-
-Install globally with npm or Bun.
+## Install
 
 ```sh
 npm install -g @swirls/cli
-# or
-bun add -g @swirls/cli
-```
-
-Run with `swirls`
-```sh
-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.
-
-```sh
-# local
-swirls --help
-# remote
-npx @swirls/cli --help
-```
-
-## Commands
-
-The Swirls CLI provides the following namespaces. For each, run its `--help` to see commands and options (examples below).
+### Supported Platforms
 
-### Auth
-
-Log in and out of Swirls.
-
-```sh
-swirls auth --help
-```
-
-### Dev
-
-Configure Swirls and generate code.
-
-```sh
-swirls dev --help
-```
-
-### Project
-
-Create and manage Swirls projects.
-
-```sh
-swirls project --help
-```
-
-### Storage
-
-Manage file storage for your Swirls project.
-
-```sh
-swirls storage --help
-```
+- **macOS** — Apple Silicon (arm64), Intel (x64)
+- **Linux** — x64 (amd64), arm64 (aarch64)

package/bin/README.txt

@@ -0,0 +1,7 @@
+The 'swirls' file is a placeholder for the platform-specific binary, which is
+replaced by the 'postinstall' script.
+
+Do not use '--ignore-scripts' when installing.
+
+This approach avoids invoking the Node.js installation wrapper on every
+invocation of the CLI.

package/bin/swirls

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+echo "Error: Swirls CLI 'postinstall' script was not run." >&2
+echo "" >&2
+echo "This occurs when using '--ignore-scripts' during installation, or when using a" >&2
+echo "package manager that does not run 'postinstall' scripts by default." >&2
+echo "" >&2
+echo "To fix this, reinstall without the '--ignore-scripts' flag:" >&2
+echo "  npm install -g @swirls/cli" >&2
+echo "" >&2
+echo "Or run the install script directly: curl -fsSL https://swirls.ai/install | bash" >&2
+exit 1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swirls/cli",
-  "version": "0.1.5",
+  "version": "0.1.9",
   "description": "Swirls command line application",
   "author": {
     "name": "Swirls",
@@ -8,16 +8,17 @@
   },
   "type": "module",
   "bin": {
-    "cli": "./launcher/cli.js",
-    "swirls": "./launcher/cli.js"
+    "swirls": "./bin/swirls"
   },
   "files": [
-    "launcher"
+    "bin",
+    "scripts/install.js"
   ],
   "scripts": {
     "build": "bun run scripts/build.ts",
     "db:studio": "drizzle-kit studio",
     "dev": "bun run --watch src/bin/cli.ts",
+    "postinstall": "node scripts/install.js",
     "publish": "echo 'Publishing is performed by the CI/CD pipeline, not manually.'",
     "publish:dry": "SWIRLS_ENV=production bun run build && bun publish --ignore-scripts --dry-run",
     "version": "bun run scripts/version.ts"

package/scripts/install.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+
+/**
+ * Runs the install script for platform detection and binary
+ * download, then copies the binary into bin/ so `swirls` runs the real
+ * binary (no Node wrapper).
+ *
+ * Skips installation in the following cases:
+ * - CI environment
+ * - Not installed globally
+ * - Windows (no curl/bash)
+ */
+
+import { execSync } from 'node:child_process'
+import { chmodSync, copyFileSync, existsSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const INSTALL_URL = 'https://swirls.ai/install'
+
+const SCRIPT_DIR =
+  typeof import.meta.dir === 'string'
+    ? import.meta.dir
+    : dirname(fileURLToPath(import.meta.url))
+
+const PACKAGE_ROOT = join(SCRIPT_DIR, '..')
+
+const INSTALLED_BINARY = join(
+  process.env.HOME || process.env.USERPROFILE || '',
+  '.swirls',
+  'bin',
+  'swirls',
+)
+
+const BIN_SWIRLS = join(PACKAGE_ROOT, 'bin', 'swirls')
+
+if (process.env.CI === 'true' || process.env.CI === '1') {
+  process.exit(0)
+}
+if (process.platform === 'win32') {
+  process.exit(0)
+}
+if (!process.env.npm_config_global && !process.env.BUN_INSTALL_GLOBAL) {
+  process.exit(0)
+}
+
+try {
+  execSync(`curl -fsSL ${INSTALL_URL} | bash`, {
+    stdio: 'inherit',
+    shell: true,
+  })
+} catch (_err) {
+  process.exit(1)
+}
+
+if (existsSync(INSTALLED_BINARY)) {
+  copyFileSync(INSTALLED_BINARY, BIN_SWIRLS)
+  chmodSync(BIN_SWIRLS, 0o755)
+}

package/launcher/README.md

@@ -1,17 +0,0 @@
-# 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

@@ -1,45 +0,0 @@
-#!/usr/bin/env node
-
-import { execFileSync } from 'node:child_process'
-import { createRequire } from 'node:module'
-import { dirname, join } from 'node:path'
-import { platforms } from './platforms.js'
-
-const require = createRequire(import.meta.url)
-
-const key = `${process.platform}-${process.arch}`
-const pkg = platforms[key]
-
-// handle unsupported platform
-if (!pkg) {
-  printUnsupportedPlatform(key)
-  process.exit(1)
-}
-
-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/launcher/platforms.js

@@ -1,10 +0,0 @@
-// Generated during build from `platforms.ts`. Do not edit manually.
-//
-// biome-ignore-all format: generated file
-
-export const platforms = {
-  "darwin-arm64": "@swirls/cli-darwin-arm64",
-  "darwin-x64": "@swirls/cli-darwin-x64",
-  "linux-arm64": "@swirls/cli-linux-arm64",
-  "linux-x64": "@swirls/cli-linux-x64",
-}