@multiplayer-app/sandbox 1.0.0-wip-yjs-state-changes.0 → 3.0.0-wip-yjs-state-changes.0

package/README.md

@@ -8,12 +8,39 @@ WebSocket, so the worker needs **no inbound ports**.
 Supported engines (auto-detected): `qemu`, `firecracker`, `docker`, `docker-sandbox`,
 `lambda-microvm`, `fargate`, `remote`, and `mock`.
 
-`vm-gateway` imports this package directly and runs the worker in-process (see
-`services/vm-gateway/src/index.ts`) — there is no standalone worker service or CLI
-`start` command. Engine configuration is entirely env-driven and auto-detected —
+`vm-gateway` can import this package directly and run the worker in-process (see
+`services/vm-gateway/src/index.ts`). The published package also installs a standalone
+`sandbox` executable. Engine configuration is env-driven and auto-detected —
 `WORKER_ID`, `WORKER_TOKEN`, `SANDBOX_URL`, `MAX_VMS`, `WORKER_REGION`, plus per-engine
 vars like `QEMU_IMAGES_DIR`, `DOCKER_STACK_IMAGES`, `MICROVM_IMAGE_ARN`,
 `FARGATE_CLUSTER`, `AGENT_URL` — see `src/config.ts` for the full list.
+`WORKER_TOKEN` is required. `WORKER_ID` is optional and defaults to the machine
+hostname; set it explicitly when multiple workers could report the same hostname.
+`SANDBOX_URL` is optional and defaults to
+`https://api.sandbox.filingramp.com`; set it explicitly for local or self-hosted
+control planes.
+
+## Start a worker
+
+Install the package globally and start the worker with its authentication token:
+
+```sh
+npm install --global @multiplayer-app/sandbox
+WORKER_TOKEN=<token> sandbox start
+```
+
+The published runtime bundles the repository's internal `builder-types` and
+`logger` libraries, so installing the CLI does not require those workspace
+packages to be published separately.
+
+The worker ID defaults to the hostname and the control-plane URL defaults to
+`https://api.sandbox.filingramp.com`. Both can be overridden with environment
+variables or flags:
+
+```sh
+sandbox start --token <token> --worker-id worker-eu-01 \
+  --sandbox-url http://localhost:3011 --max-vms 5
+```
 
 For the `qemu` engine, the host needs QEMU (`qemu-system-*`) installed; for
 `firecracker`, a Linux host with `/dev/kvm`; for `docker`, just a running Docker

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAKA,OAAO,eAAe,CAAA"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAIA,OAAO,eAAe,CAAA"}