@lizard-build/sdk 0.1.38 → 0.1.40

package/README.md

@@ -1,8 +1,12 @@
 # Lizard SDK
 
-Firecracker microVM sandboxes for AI agents — boot a full Linux environment in milliseconds, run code, write files, and expose ports, all from your agent or CI pipeline.
+TypeScript and Python clients for Lizard apps, managed databases, storage and Linux sandboxes.
 
-Each sandbox is an isolated microVM with its own filesystem, network, and process namespace. Sandboxes can be paused — vCPUs frozen, memory and running processes kept — and resumed instantly, so a long-running agent session picks up without re-running setup.
+The current platform runs sandboxes on Kubernetes. Persistent volumes keep files across sandbox lifetimes. Pause, resume, fork and snapshot restore currently return HTTP 501; the SDK exposes those endpoints but does not promise state preservation.
+
+Requires Node.js 18+ or Python 3.10+. The optional `LizardCLI` adapter and `billing.payX402()` / `billing.pay_x402()` require Lizard CLI 4.0.8+ on PATH.
+
+See [CLI coverage and migration notes](https://github.com/lizard-build/lizard-sdk/blob/main/docs/cli-parity.md) for native methods, CLI-backed operations and test scope.
 
 ## Install
 
@@ -26,23 +30,23 @@ import { Lizard } from '@lizard-build/sdk'
 // apiKey defaults to the LIZARD_API_KEY env var.
 const lizard = new Lizard({ project: 'my-project' })
 
-// Boot a microVM from the 'base' template (Debian + Node.js 26)
+// Boot a sandbox from the 'base' template (Debian + Node.js 26)
 const sandbox = await lizard.create('base')
 
-// Write a file directly into the microVM filesystem
+// Write a file directly into the sandbox filesystem
 await sandbox.fs.write('/app/server.js', `
   const http = require('http')
   http.createServer((_, res) => res.end('hello from Lizard')).listen(3000)
 `)
 
-// Execute a process inside the microVM
+// Execute a process inside the sandbox
 await sandbox.process.exec('node /app/server.js &')
 
 // Get a public HTTPS URL for port 3000 inside the sandbox
-const url = sandbox.getHost(3000)
+const url = await sandbox.getHost(3000)
 console.log(`Live at https://${url}`)
 
-// Tear down the microVM when done
+// Tear down the sandbox when done
 await sandbox.kill()
 ```
 
@@ -55,10 +59,10 @@ from lizard import Lizard
 # project is required (its ID, slug, or name). api_key defaults to LIZARD_API_KEY.
 lizard = Lizard(project="my-project")
 
-# Boot a Python microVM from the 'code-interpreter-v1' template
+# Boot a Python sandbox from the 'code-interpreter-v1' template
 sandbox = lizard.create("code-interpreter-v1")
 
-# Write a script into the microVM filesystem
+# Write a script into the sandbox filesystem
 sandbox.fs.write("/app/main.py", """
 import http.server, socketserver
 
@@ -72,7 +76,7 @@ with socketserver.TCPServer(("", 3000), Handler) as httpd:
     httpd.serve_forever()
 """)
 
-# Execute a process inside the microVM
+# Execute a process inside the sandbox
 sandbox.process.exec_("python /app/main.py &")
 
 print(f"Live at https://{sandbox.get_host(3000)}")
@@ -170,7 +174,7 @@ const sandbox = await lizard.create('code-interpreter-v1', { timeoutMs: 10 * 60
 
 ### `Sandbox.create(template?, opts?)`
 
-Boot a new Lizard microVM. Built-in templates: `base` (Debian + Node.js 26) and `code-interpreter-v1` (Python 3.14 + Node.js 26). Custom templates can be pushed via `lizard push`. A project is required — pass `project` (ID, slug, or name) or an exact `projectId` in `opts`, or use a `Lizard` client, which pins one for you.
+Create a Lizard sandbox using a template such as `base` or `code-interpreter-v1`. Template availability depends on the platform and region. A project is required — pass `project` (ID, slug, or name) or an exact `projectId` in `opts`, or use a `Lizard` client, which pins one for you.
 
 ```ts
 const sandbox = await Sandbox.create('base', { project: 'my-project' })
@@ -221,7 +225,7 @@ A volume's **name** is its key inside a project, so an agent can reconstruct it
 
 ### `sandbox.fs`
 
-Read and write files inside the microVM filesystem.
+Read and write files inside the sandbox filesystem.
 
 | Method | Description |
 |---|---|
@@ -233,7 +237,7 @@ Read and write files inside the microVM filesystem.
 
 ### `sandbox.process`
 
-Execute commands inside the microVM.
+Execute commands inside the sandbox.
 
 | Method | Description |
 |---|---|
@@ -243,11 +247,11 @@ Execute commands inside the microVM.
 
 ### `sandbox.getHost(port)`
 
-Returns a public HTTPS URL for a port listening inside the microVM — no tunneling required.
+Returns a public HTTPS URL for a port listening inside the sandbox — no tunneling required.
 
 ```ts
 await sandbox.process.exec('npx -y serve -p 3000 &')
-const url = sandbox.getHost(3000)
+const url = await sandbox.getHost(3000)
 // https://{sandboxId}-3000.sandbox.{region}.onlizard.com
 ```
 
@@ -282,7 +286,7 @@ Once your agent has produced a working app inside a sandbox, deploy it as a pers
 lizard up
 ```
 
-Your sandbox template becomes the base, your code ships as a layer on top, and Lizard manages the Firecracker microVM fleet from there.
+Lizard manages the sandbox runtime.
 
 ## License