JS/TS SDK overview

npm install sandkiln

Everything this SDK wraps is listed under Sandbox (including remote storage mounts — mount()/listMounts()/unmount()), Image, Drive, and Pool. Two daemon features have no wrapper in any client yet, reachable only over the raw daemon HTTP API: snapshot lineage filtering (?parent_snapshot_id=) and time-travel restore (GET /snapshots/history, POST /snapshots/history/:id/restore) — see Sandboxes.

Configuration

Daemon URL: pass baseUrl to any method, or set SANDKILN_DAEMON_URL. Defaults to http://127.0.0.1:7777.
Auth: pass authToken, or set SANDKILN_AUTH_TOKEN. Omit entirely for an unauthenticated local daemon.

import { Sandbox } from "sandkiln";

// Explicit per-call config...
const sandbox = await Sandbox.create({
  baseUrl: "https://daemon.internal:7777",
  authToken: process.env.SANDKILN_TOKEN,
});

// ...or set both as environment variables once and omit them everywhere:
// SANDKILN_DAEMON_URL=https://daemon.internal:7777
// SANDKILN_AUTH_TOKEN=...
const sameSandbox = await Sandbox.create();

HTTP API

JS/TS SDK

Python SDK

CLI (kiln)

JS/TS SDK overview

Configuration

​Configuration

Configuration