Overview
The BoxLite Node.js SDK provides a TypeScript-first API for creating and managing lightweight virtual machine sandboxes. It supports multiple box types for different use cases — from simple command execution to full desktop automation.Installation
Install the SDK via npm:BoxLite requires Node.js 18 or later. The native binary is bundled for macOS (Apple Silicon) and Linux (x86_64, ARM64).
Runtime Management
JsBoxlite / Boxlite
The main runtime for creating and managing boxes.
Constructor
Static Methods
Instance Methods
Example
Options
JsOptions
Runtime configuration options.
JsBoxOptions
Configuration options for creating a box.
JsEnvVar
JsVolumeSpec
JsPortSpec
Constants
Default values used by BoxLite.Resource Defaults
ComputerBox Defaults
BrowserBox Defaults
See Also
- Getting Started with Node.js — Installation and quickstart
- Box Types — SimpleBox, CodeBox, BrowserBox, ComputerBox, InteractiveBox
- Execution — Command execution and streams
- Errors & Metrics — Error handling and resource metrics
- Python SDK — Python SDK reference

