@sohcah/sbox

Public Node.js API and sbox CLI for configuration-driven Microsandbox workflows. License: MIT.

Includes local and remote Hosts: createLocalHost, createRemoteHost, and foreground createSboxServer / sbox serve (bearer token via SBOX_SERVE_TOKEN). Protocol version is SBOX_PROTOCOL_VERSION (1). Health is unauthenticated; all other routes and WebSocket upgrades require Bearer auth.

CLI highlights: init, config, doctor, serve, build, up, run, list, inspect, stop, remove, exec, shell, image, volume. shell [profile] opens an interactive PTY; use exec --shell -- <expression> for non-interactive guest-shell syntax.

doctor reports required checks (Node, protocol, target/handshake) and informational tooling (Docker, qemu-img, formatter image) so remote-client hosts without local virtualization still succeed.

Collected stdout/stderr default to 10 MiB each. Streaming sessions use a bounded pull-driven queue; callers must consume events or cancel. Non-zero guest exit is a ProcessResult. Operational failures throw SboxError. Microsandbox SDK types are never part of this package's public surface. Disposal of clients and handles never changes sandbox lifecycle.

See the repository docs/ tree for API, CLI, configuration, remote, volumes, and troubleshooting references.