TypeScript SDK

npm install @nullspace/sdk@<version>

import { NullspaceClient } from "@nullspace/sdk";

const client = new NullspaceClient({ apiKey: "ns_live_..." });

import { Machine } from "@nullspace/sdk";

await using machine = await Machine.create();

const result = await machine.commands.run("echo 'Hello!'", { shell: true });
console.log(result.stdout);

await machine.files.write("/hello.txt", "world");
console.log(await machine.files.read("/hello.txt"));
// `await using` destroys the machine when the scope exits.

const child = await machine.fork();            // copy-on-write fork
const snap = await machine.createSnapshot();   // durable snapshot
const resumed = await client.snapshots.resume(snap.id);
const preview = await machine.createSignedPreviewUrl(8080);

const vol = await client.volumes.create("data");
await machine.attachVolume(vol.id, "/data");

const template = await client.templates
  .builder()
  .fromUbuntuImage("22.04")
  .aptInstall(["curl"])
  .build({ name: "my-template" });

import { NotFoundError } from "@nullspace/sdk";

try {
  await client.machines.get("mch_missing");
} catch (err) {
  if (err instanceof NotFoundError) {
    // ...
  }
}