firecracker-sdk

TypeScript client for the Firecracker HTTP API. This package version tracks the Firecracker release whose API it implements.

Install

bun add firecracker-sdk

Quick start (Bun + Unix socket)

import { createFirecrackerClient } from "firecracker-sdk";

const client = createFirecrackerClient({
    socketPath: "/path/to/firecracker.socket",
});

const info = await client.instance.describe();
console.log(info);

The package root exports only createFirecrackerClient and the FirecrackerClient type.

Subpath imports

Resource handlers and non-root utilities live under subpaths:

import { createRequestClient } from "firecracker-sdk/http";
import { handleDrives } from "firecracker-sdk/drives";

const request = createRequestClient({
    socketPath: "/path/to/firecracker.socket",
});

const drives = handleDrives(request);

License

MIT. See LICENSE.