@atolljs/cli 0.0.0-stage → 0.1.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Justin Henry
+
+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,43 @@
-# Temporary Holding Version
+# @atolljs/cli
 
-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.
+`atoll` — scaffold worker pools, shared-memory contracts, and framework
+islands into a new or existing app.
+
+> **Experimental.** The command grammar and generated code are still
+> evolving — expect breaking changes between minor releases.
+
+```
+npx @atolljs/cli <command>
+# or, once installed: atoll <command>
+```
+
+Requires Node ≥ 20.12. The published bin is a bundled `dist/cli.js` —
+Node refuses type stripping for `.ts` under `node_modules`, which is
+where `npx` installs packages. The TypeScript sources ship alongside it;
+`npm run build` (esbuild) regenerates the bundle, and `scripts/publish.mjs`
+builds it automatically before staging.
+
+## Commands
+
+```bash
+atoll new <dir> [--framework react|vue|solid|svelte|node] [--pm npm]
+    Scaffold a fresh app: vite shell with COOP/COEP headers, the
+    @atolljs/vite plugin (worker entries are dev-bundled — no
+    fast-refresh in workers), a worker-rendered counter island,
+    hardened .npmrc — or a tsx Node service with a pooled worker.
+
+atoll init
+    Wire Atoll into the current project: .npmrc, installs the @atolljs/*
+    packages your framework needs, and generates a working spine —
+    app.memory.ts + app.worker.ts + app.ts under src/atoll/.
+
+atoll add worker <name>   pooled worker + typed client (browser or node)
+atoll add memory <name>   shared-memory contract module
+atoll add island <name>   worker-rendered component for your framework
+
+atoll doctor [--fix]      verify deps, lockfile, .npmrc policy,
+                          worker-entry detectability, COOP/COEP headers
+```
+
+Existing files are never overwritten without `--force`; missing answers
+prompt interactively (or take defaults under `--yes` / no TTY).