Cubicle documentation

Cubicle runs Boxes: QEMU/KVM virtual machines, each with its own kernel and a persistent disk. You manage them from the TypeScript SDK, the HTTP API or the cubicle CLI, and reach them over SSH and a private network.

npm install @cubicle/sdk

import { Cubicle } from "@cubicle/sdk"

const cubicle = new Cubicle() // reads CB_SDK_API_URL and CB_SDK_API_KEY
const box = await cubicle.boxes.create({ name: "job-1" }) // resolves when the Box is ready
const result = await box.exec(["uname", "-a"])
console.log(result.stdout) // => "Linux box-job-1 … x86_64 GNU/Linux"
await box.delete() // resolves when the Box is gone

The Quickstart gets you an API key and runs a program like this one.

Building blocksCopy Anchor Link

• Box: a virtual machine in an organization, with its own kernel, persistent disk and private IPv4 address.
• Snapshot: a copy of a stopped Box's disk, which you restore in place or create new Boxes from.
• Organization: owns Boxes, members and service accounts; a member needs a grant, a per-Box permission, to run commands in a Box or reach it.
• Service account: a non-interactive member of one organization, whose API keys authenticate programs such as CI jobs and agents.
• Private network: a WireGuard tunnel from your computer to the Boxes you have grants on, for SSH and other traffic to their private addresses.

Concepts defines these and every other term the docs use.

Choose your pathCopy Anchor Link

AI coding tools can read these docs as plain text: start with llms.txt or see Docs for AI tools.