Choose a mode
Use local mode and the managed launcher on a trusted single-user machine; see local workspace operations. Use hosted mode for an explicitly addressed deployment with configured identity, storage, and stable credential ingress. Publicly binding local management is not a substitute for hosted identity setup. A deployment needs Node 22.19+, PostgreSQL, the matching encryption key, API/Console, worker, separate preview ingress, and a separate credential listener. The current main entry assembles API and worker together; there is no assumed separate worker CLI.Source and compiled distribution
Install source dependencies withnpm ci. Maintainers can build:
npm ci --omit=dev installs production dependencies. Local-mode management uses the included local scripts. The artifact includes compiled code, Runtime/Console assets, and locked dependencies, not your database or credentials. Building does not publish it.
Hosted prerequisites
Supply secrets through private deployment configuration. Do not put actual values in examples or shell history. The bootstrap Token is not an arbitrary string: startup authenticates its existing owner identity. Hosted mode has no complete organization/login provisioning service; prepare identity through an appropriate supported migration or deployment process. An empty database and random Token are insufficient.
With identity, key, ingress, and database prepared, a source deployment runs:
Start and check in dependency order
- Prepare the intended database, matching encryption key and existing owner identity. Run migrations against that target before serving traffic.
- Route the stable credential origin to the credential listener. Keep API/Console and preview origins separate; do not expose management through the credential route.
- Start the entry under your process supervisor. Check authenticated health for database, worker and credential-backend state, not merely whether a socket listens.
- Configure and validate Sandbox/model connections, then run the required cloud task with each SDK. Check required preview behavior and retained artifacts separately.
- After settling work and confirming cloud cleanup, restart the same deployment and verify retained records and credential decryption. Keep backup and recovery records before upgrades.