Install the Docker Sandboxes SDK

Note

The Docker Sandboxes API and SDK are experimental. Features, interfaces, and behavior may change.

Use the Docker Sandboxes SDK to create and manage cloud sandboxes from JavaScript or TypeScript. The SDK includes methods for running commands, transferring files, and waiting for a sandbox to start or stop.

You don't need the Docker CLI to use the SDK.

Install the SDK

With Node.js 20 or later, install the SDK in your project:

$ npm install @docker/sandboxes

Import Sandboxes from @docker/sandboxes.

Connect to Cloud Sandboxes

Before connecting, activate a Docker Agentic Platform subscription for your Docker account.

Configure your client with browser sign-in for interactive use or a personal access token for automation. The SDK supplies the service URL and manages access tokens. See Authentication and authorization for setup instructions.

Follow Run your first cloud sandbox for a complete TypeScript example that creates a sandbox, runs a command, and deletes it.