Quickstart

Paperplanes quickstart

Paperplanes provides serverless desktop sandboxes for AI agents. A sandbox is a full GUI computer with browser, terminal, file manager, screenshots, input, snapshots, and forkable runtime state.

Private preview

The SDK and CLI are in this repository today. Public npm publishing and the public /v1/desktops route aliases are still being wired, so examples below describe the intended developer surface while the private preview uses the repository package directly.

# private preview, from this repo
npm install ./sdk/typescript

# planned public package
npm install @paperplanes/sdk

import { Sandbox } from "@paperplanes/sdk";

const sandbox = await Sandbox.create({
  image: "paperplanes://images/codex-multiapp-ubuntu-v1",
});

const stream = await sandbox.stream();
console.log(stream.wsUrl);

Lifecycle

1. Launch an isolated desktop sandbox.
2. Run browser, terminal, file, or GUI workflows.
3. Snapshot the live state at a decision point.
4. Fork variants or destroy the sandbox when work is done.

Current honesty notes

The SDK uses the live compatibility control-plane routes while public /v1/desktops aliases are still being routed. Preview DNS (https://<port>-<sandbox-id>.paperplanes.sh) is the planned shareable form; the current live path proxy remains the compatibility path until gateway Host routing lands.