@lizard-build/sdk 0.1.7 → 0.1.15

package/README.md

@@ -21,8 +21,8 @@ pip install lizard-sdk
 ```ts
 import { Sandbox } from '@lizard-build/sdk'
 
-// Boot a Node.js microVM from the 'node22' template
-const sandbox = await Sandbox.create('node22')
+// Boot a microVM from the 'base' template (Debian + Node.js 20)
+const sandbox = await Sandbox.create('base')
 
 // Write a file directly into the microVM filesystem
 await sandbox.fs.write('/app/server.js', `
@@ -46,8 +46,8 @@ await sandbox.kill()
 ```python
 from lizard import Sandbox
 
-# Boot a Python microVM from the 'python312' template
-sandbox = Sandbox.create("python312")
+# Boot a Python microVM from the 'code-interpreter-v1' template
+sandbox = Sandbox.create("code-interpreter-v1")
 
 # Write a script into the microVM filesystem
 sandbox.fs.write("/app/main.py", """
@@ -77,7 +77,7 @@ Sandboxes can be snapshotted mid-execution and resumed exactly where they left o
 
 ```ts
 // Boot and set up the environment once
-const sandbox = await Sandbox.create('python312')
+const sandbox = await Sandbox.create('code-interpreter-v1')
 await sandbox.process.exec('pip install numpy pandas scikit-learn')
 const id = sandbox.sandboxId
 await sandbox.pause()
@@ -92,7 +92,7 @@ await resumed.kill()
 ```python
 from lizard import Sandbox
 
-sandbox = Sandbox.create("python312")
+sandbox = Sandbox.create("code-interpreter-v1")
 sandbox.process.exec_("pip install numpy pandas scikit-learn")
 sandbox_id = sandbox.sandbox_id
 sandbox.pause()
@@ -108,11 +108,11 @@ resumed.kill()
 
 ### `Sandbox.create(template?, opts?)`
 
-Boot a new Lizard microVM. Built-in templates: `base`, `node22`, `python312`. Custom templates can be pushed via `lizard push`.
+Boot a new Lizard microVM. Built-in templates: `base` (Debian + Node.js 20) and `code-interpreter-v1` (Python 3.11 + Node.js 20). Custom templates can be pushed via `lizard push`.
 
 ```ts
-const sandbox = await Sandbox.create('node22')
-const sandbox = await Sandbox.create('python312', { timeoutMs: 10 * 60 * 1000 })
+const sandbox = await Sandbox.create('base')
+const sandbox = await Sandbox.create('code-interpreter-v1', { timeoutMs: 10 * 60 * 1000 })
 ```
 
 ### `Sandbox.connect(sandboxId, opts?)`
@@ -154,7 +154,7 @@ Returns a public HTTPS URL for a port listening inside the microVM — no tunnel
 ```ts
 await sandbox.process.exec('npx -y serve -p 3000 &')
 const url = sandbox.getHost(3000)
-// https://{sandboxId}-3000.sandbox.lizard.run
+// https://{sandboxId}-3000.sandbox.{region}.onlizard.com
 ```
 
 ### `sandbox.pause()` / `sandbox.resume()`
@@ -175,8 +175,8 @@ Extend or reduce the sandbox timeout.
 
 | Variable | Description |
 |---|---|
-| `LIZARD_API_KEY` | API key (required — get one at [lizard.run](https://lizard.run)) |
-| `LIZARD_API_URL` | Override the API base URL (default: `https://api.lizard.run`) |
+| `LIZARD_API_KEY` | API key (required — get one at [lizard.build](https://lizard.build)) |
+| `LIZARD_API_URL` | Override the API base URL (default: `https://lizard.build`) |
 
 The `X-API-Key` header is used for all authenticated requests.
 

package/dist/index.d.mts

@@ -141,6 +141,7 @@ interface SandboxOpts extends ConnectionOpts {
     metadata?: Record<string, string>;
     envs?: Record<string, string>;
     timeoutMs?: number;
+    volumeId?: string;
 }
 /**
  * Low-level HTTP client for the Lizard sandbox API.
@@ -174,7 +175,7 @@ declare class SandboxClient {
  * ```ts
  * import { Sandbox } from 'lizard'
  *
- * const sandbox = await Sandbox.create('node22')
+ * const sandbox = await Sandbox.create('base')
  * await sandbox.fs.write('/app/index.js', 'console.log("hello world")')
  * const result = await sandbox.process.exec('node /app/index.js')
  * console.log(result.stdout) // "hello world"
@@ -183,7 +184,7 @@ declare class SandboxClient {
  *
  * @example Pause and resume a long-running session:
  * ```ts
- * const sandbox = await Sandbox.create('python312')
+ * const sandbox = await Sandbox.create('code-interpreter-v1')
  * await sandbox.process.exec('pip install numpy')
  * const id = sandbox.sandboxId
  * await sandbox.pause()
@@ -235,15 +236,16 @@ declare class Sandbox extends SandboxClient {
     /**
      * Create a new Lizard sandbox from the specified template.
      *
-     * Available templates include `base`, `node22`, and `python312`. Custom
-     * templates can be built and pushed via `lizard push`.
+     * Available templates: `base` (Debian + Node.js 20) and `code-interpreter-v1`
+     * (Python 3.11 + Node.js 20). Custom templates can be built and pushed via
+     * `lizard push`.
      *
      * @param template Name of the sandbox template to boot from.
      *
      * @example
      * ```ts
-     * const sandbox = await Sandbox.create('node22')
-     * const sandbox = await Sandbox.create('python312', { timeoutMs: 10 * 60 * 1000 })
+     * const sandbox = await Sandbox.create('base')
+     * const sandbox = await Sandbox.create('code-interpreter-v1', { timeoutMs: 10 * 60 * 1000 })
      * ```
      */
     static create(template: string, opts?: SandboxOpts): Promise<Sandbox>;
@@ -309,7 +311,7 @@ declare class Sandbox extends SandboxClient {
      * ```ts
      * await sandbox.process.exec('npx -y serve -p 3000 &')
      * const url = sandbox.getHost(3000)
-     * // https://{sandboxId}-3000.sandbox.lizard.run
+     * // https://{sandboxId}-3000.sandbox.{region}.onlizard.com
      * ```
      */
     getHost(port: number, opts?: ConnectionOpts): Promise<string>;
@@ -480,4 +482,34 @@ declare class CodeSandbox extends Sandbox {
     static connect(sandboxId: string, opts?: ConnectionOpts): Promise<CodeSandbox>;
 }
 
-export { AuthenticationError, type CodeContext, CodeSandbox, type ConnectionOpts, type CreateContextOpts, Execution, ExecutionError, type FileInfo, type FsOpts, LizardError, NotFoundError, type ProcessOpts, type ProcessResult, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, TimeoutError };
+interface VolumeInfo {
+    id: string;
+    projectId: string;
+    name: string;
+    sizeGb: number;
+    sizeMb?: number;
+    status: string;
+    attachedTo?: string | null;
+    createdAt: number;
+}
+interface CreateVolumeOpts extends ConnectionOpts {
+    sizeGb?: number;
+}
+/**
+ * A persistent volume that outlives sandboxes.
+ * Mount it to a sandbox via `Sandbox.create({ volumeId: volume.volumeId })`.
+ */
+declare class Volume {
+    readonly volumeId: string;
+    private readonly config;
+    constructor(opts: {
+        volumeId: string;
+    } & ConnectionOpts);
+    static create(projectId: string, name: string, opts?: CreateVolumeOpts): Promise<Volume>;
+    static get(projectId: string, volumeId: string, opts?: ConnectionOpts): Promise<Volume>;
+    static list(projectId: string, opts?: ConnectionOpts): Promise<VolumeInfo[]>;
+    getInfo(projectId: string): Promise<VolumeInfo>;
+    delete(projectId: string): Promise<void>;
+}
+
+export { AuthenticationError, type CodeContext, CodeSandbox, type ConnectionOpts, type CreateContextOpts, type CreateVolumeOpts, Execution, ExecutionError, type FileInfo, type FsOpts, LizardError, NotFoundError, type ProcessOpts, type ProcessResult, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, TimeoutError, Volume, type VolumeInfo };

package/dist/index.d.ts

@@ -141,6 +141,7 @@ interface SandboxOpts extends ConnectionOpts {
     metadata?: Record<string, string>;
     envs?: Record<string, string>;
     timeoutMs?: number;
+    volumeId?: string;
 }
 /**
  * Low-level HTTP client for the Lizard sandbox API.
@@ -174,7 +175,7 @@ declare class SandboxClient {
  * ```ts
  * import { Sandbox } from 'lizard'
  *
- * const sandbox = await Sandbox.create('node22')
+ * const sandbox = await Sandbox.create('base')
  * await sandbox.fs.write('/app/index.js', 'console.log("hello world")')
  * const result = await sandbox.process.exec('node /app/index.js')
  * console.log(result.stdout) // "hello world"
@@ -183,7 +184,7 @@ declare class SandboxClient {
  *
  * @example Pause and resume a long-running session:
  * ```ts
- * const sandbox = await Sandbox.create('python312')
+ * const sandbox = await Sandbox.create('code-interpreter-v1')
  * await sandbox.process.exec('pip install numpy')
  * const id = sandbox.sandboxId
  * await sandbox.pause()
@@ -235,15 +236,16 @@ declare class Sandbox extends SandboxClient {
     /**
      * Create a new Lizard sandbox from the specified template.
      *
-     * Available templates include `base`, `node22`, and `python312`. Custom
-     * templates can be built and pushed via `lizard push`.
+     * Available templates: `base` (Debian + Node.js 20) and `code-interpreter-v1`
+     * (Python 3.11 + Node.js 20). Custom templates can be built and pushed via
+     * `lizard push`.
      *
      * @param template Name of the sandbox template to boot from.
      *
      * @example
      * ```ts
-     * const sandbox = await Sandbox.create('node22')
-     * const sandbox = await Sandbox.create('python312', { timeoutMs: 10 * 60 * 1000 })
+     * const sandbox = await Sandbox.create('base')
+     * const sandbox = await Sandbox.create('code-interpreter-v1', { timeoutMs: 10 * 60 * 1000 })
      * ```
      */
     static create(template: string, opts?: SandboxOpts): Promise<Sandbox>;
@@ -309,7 +311,7 @@ declare class Sandbox extends SandboxClient {
      * ```ts
      * await sandbox.process.exec('npx -y serve -p 3000 &')
      * const url = sandbox.getHost(3000)
-     * // https://{sandboxId}-3000.sandbox.lizard.run
+     * // https://{sandboxId}-3000.sandbox.{region}.onlizard.com
      * ```
      */
     getHost(port: number, opts?: ConnectionOpts): Promise<string>;
@@ -480,4 +482,34 @@ declare class CodeSandbox extends Sandbox {
     static connect(sandboxId: string, opts?: ConnectionOpts): Promise<CodeSandbox>;
 }
 
-export { AuthenticationError, type CodeContext, CodeSandbox, type ConnectionOpts, type CreateContextOpts, Execution, ExecutionError, type FileInfo, type FsOpts, LizardError, NotFoundError, type ProcessOpts, type ProcessResult, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, TimeoutError };
+interface VolumeInfo {
+    id: string;
+    projectId: string;
+    name: string;
+    sizeGb: number;
+    sizeMb?: number;
+    status: string;
+    attachedTo?: string | null;
+    createdAt: number;
+}
+interface CreateVolumeOpts extends ConnectionOpts {
+    sizeGb?: number;
+}
+/**
+ * A persistent volume that outlives sandboxes.
+ * Mount it to a sandbox via `Sandbox.create({ volumeId: volume.volumeId })`.
+ */
+declare class Volume {
+    readonly volumeId: string;
+    private readonly config;
+    constructor(opts: {
+        volumeId: string;
+    } & ConnectionOpts);
+    static create(projectId: string, name: string, opts?: CreateVolumeOpts): Promise<Volume>;
+    static get(projectId: string, volumeId: string, opts?: ConnectionOpts): Promise<Volume>;
+    static list(projectId: string, opts?: ConnectionOpts): Promise<VolumeInfo[]>;
+    getInfo(projectId: string): Promise<VolumeInfo>;
+    delete(projectId: string): Promise<void>;
+}
+
+export { AuthenticationError, type CodeContext, CodeSandbox, type ConnectionOpts, type CreateContextOpts, type CreateVolumeOpts, Execution, ExecutionError, type FileInfo, type FsOpts, LizardError, NotFoundError, type ProcessOpts, type ProcessResult, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, TimeoutError, Volume, type VolumeInfo };

package/dist/index.js

@@ -25,12 +25,13 @@ __export(index_exports, {
   LizardError: () => LizardError,
   NotFoundError: () => NotFoundError,
   Sandbox: () => Sandbox,
-  TimeoutError: () => TimeoutError
+  TimeoutError: () => TimeoutError,
+  Volume: () => Volume
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/config.ts
-var DEFAULT_API_URL = "https://api.lizard.run";
+var DEFAULT_API_URL = "https://lizard.build";
 var DEFAULT_SANDBOX_TIMEOUT_MS = 5 * 60 * 1e3;
 var ConnectionConfig = class {
   constructor(opts) {
@@ -240,7 +241,8 @@ var SandboxClient = class {
         template,
         timeoutMs,
         metadata: opts?.metadata,
-        envs: opts?.envs
+        envs: opts?.envs,
+        volumeId: opts?.volumeId
       })
     });
     if (!res.ok) await handleApiError(res);
@@ -405,7 +407,7 @@ var Sandbox = class extends SandboxClient {
    * ```ts
    * await sandbox.process.exec('npx -y serve -p 3000 &')
    * const url = sandbox.getHost(3000)
-   * // https://{sandboxId}-3000.sandbox.lizard.run
+   * // https://{sandboxId}-3000.sandbox.{region}.onlizard.com
    * ```
    */
   async getHost(port, opts) {
@@ -608,6 +610,55 @@ async function* readLines(body) {
     reader.releaseLock();
   }
 }
+
+// src/volume/index.ts
+var Volume = class _Volume {
+  constructor(opts) {
+    this.volumeId = opts.volumeId;
+    this.config = new ConnectionConfig(opts);
+  }
+  static async create(projectId, name, opts) {
+    const config = new ConnectionConfig(opts);
+    const res = await fetch(`${config.apiUrl}/api/projects/${projectId}/volumes`, {
+      method: "POST",
+      headers: config.headers,
+      body: JSON.stringify({ name, sizeGb: opts?.sizeGb ?? 5 })
+    });
+    if (!res.ok) await handleApiError(res);
+    const vol = await res.json();
+    return new _Volume({ volumeId: vol.id, ...opts });
+  }
+  static async get(projectId, volumeId, opts) {
+    const config = new ConnectionConfig(opts);
+    const res = await fetch(`${config.apiUrl}/api/projects/${projectId}/volumes/${volumeId}`, {
+      headers: config.headers
+    });
+    if (!res.ok) await handleApiError(res);
+    return new _Volume({ volumeId, ...opts });
+  }
+  static async list(projectId, opts) {
+    const config = new ConnectionConfig(opts);
+    const res = await fetch(`${config.apiUrl}/api/projects/${projectId}/volumes`, {
+      headers: config.headers
+    });
+    if (!res.ok) await handleApiError(res);
+    return res.json();
+  }
+  async getInfo(projectId) {
+    const res = await fetch(`${this.config.apiUrl}/api/projects/${projectId}/volumes/${this.volumeId}`, {
+      headers: this.config.headers
+    });
+    if (!res.ok) await handleApiError(res);
+    return res.json();
+  }
+  async delete(projectId) {
+    const res = await fetch(`${this.config.apiUrl}/api/projects/${projectId}/volumes/${this.volumeId}`, {
+      method: "DELETE",
+      headers: this.config.headers
+    });
+    if (!res.ok) await handleApiError(res);
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AuthenticationError,
@@ -615,5 +666,6 @@ async function* readLines(body) {
   LizardError,
   NotFoundError,
   Sandbox,
-  TimeoutError
+  TimeoutError,
+  Volume
 });

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // src/config.ts
-var DEFAULT_API_URL = "https://api.lizard.run";
+var DEFAULT_API_URL = "https://lizard.build";
 var DEFAULT_SANDBOX_TIMEOUT_MS = 5 * 60 * 1e3;
 var ConnectionConfig = class {
   constructor(opts) {
@@ -209,7 +209,8 @@ var SandboxClient = class {
         template,
         timeoutMs,
         metadata: opts?.metadata,
-        envs: opts?.envs
+        envs: opts?.envs,
+        volumeId: opts?.volumeId
       })
     });
     if (!res.ok) await handleApiError(res);
@@ -374,7 +375,7 @@ var Sandbox = class extends SandboxClient {
    * ```ts
    * await sandbox.process.exec('npx -y serve -p 3000 &')
    * const url = sandbox.getHost(3000)
-   * // https://{sandboxId}-3000.sandbox.lizard.run
+   * // https://{sandboxId}-3000.sandbox.{region}.onlizard.com
    * ```
    */
   async getHost(port, opts) {
@@ -577,11 +578,61 @@ async function* readLines(body) {
     reader.releaseLock();
   }
 }
+
+// src/volume/index.ts
+var Volume = class _Volume {
+  constructor(opts) {
+    this.volumeId = opts.volumeId;
+    this.config = new ConnectionConfig(opts);
+  }
+  static async create(projectId, name, opts) {
+    const config = new ConnectionConfig(opts);
+    const res = await fetch(`${config.apiUrl}/api/projects/${projectId}/volumes`, {
+      method: "POST",
+      headers: config.headers,
+      body: JSON.stringify({ name, sizeGb: opts?.sizeGb ?? 5 })
+    });
+    if (!res.ok) await handleApiError(res);
+    const vol = await res.json();
+    return new _Volume({ volumeId: vol.id, ...opts });
+  }
+  static async get(projectId, volumeId, opts) {
+    const config = new ConnectionConfig(opts);
+    const res = await fetch(`${config.apiUrl}/api/projects/${projectId}/volumes/${volumeId}`, {
+      headers: config.headers
+    });
+    if (!res.ok) await handleApiError(res);
+    return new _Volume({ volumeId, ...opts });
+  }
+  static async list(projectId, opts) {
+    const config = new ConnectionConfig(opts);
+    const res = await fetch(`${config.apiUrl}/api/projects/${projectId}/volumes`, {
+      headers: config.headers
+    });
+    if (!res.ok) await handleApiError(res);
+    return res.json();
+  }
+  async getInfo(projectId) {
+    const res = await fetch(`${this.config.apiUrl}/api/projects/${projectId}/volumes/${this.volumeId}`, {
+      headers: this.config.headers
+    });
+    if (!res.ok) await handleApiError(res);
+    return res.json();
+  }
+  async delete(projectId) {
+    const res = await fetch(`${this.config.apiUrl}/api/projects/${projectId}/volumes/${this.volumeId}`, {
+      method: "DELETE",
+      headers: this.config.headers
+    });
+    if (!res.ok) await handleApiError(res);
+  }
+};
 export {
   AuthenticationError,
   CodeSandbox,
   LizardError,
   NotFoundError,
   Sandbox,
-  TimeoutError
+  TimeoutError,
+  Volume
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lizard-build/sdk",
-  "version": "0.1.7",
+  "version": "0.1.15",
   "description": "Lizard SDK — cloud sandboxes for AI agents",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -29,6 +29,12 @@
     "firecracker"
   ],
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lizard-build/lizard-sdk.git",
+    "directory": "packages/js"
+  },
+  "homepage": "https://lizard.build",
   "devDependencies": {
     "@types/node": "^20.0.0",
     "tsup": "^8.0.0",