@lizard-build/sdk 0.1.69 → 0.1.70
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/index.d.mts +4 -1
- package/dist/index.d.ts +4 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Lizard SDK for TypeScript
|
|
2
2
|
|
|
3
|
-
Run commands, work with files and execute code in Linux sandboxes
|
|
3
|
+
Run commands, work with files and execute code in Linux sandboxes with Firecracker support. The SDK also manages Lizard apps, databases, storage and projects.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -40,7 +40,7 @@ The package includes TypeScript declarations and ESM and CommonJS builds. For Co
|
|
|
40
40
|
|
|
41
41
|
## Machine size
|
|
42
42
|
|
|
43
|
-
Sandboxes come in three sizes: `small` (2 vCPU / 4 GB, $0.0162/h), `medium` (4 vCPU / 8 GB, $0.0324/h, the default) and `large` (8 vCPU / 16 GB, $0.0648/h). Billing is flat by size, per second while the sandbox runs
|
|
43
|
+
Sandboxes come in three sizes: `small` (2 vCPU / 4 GB, $0.0162/h), `medium` (4 vCPU / 8 GB, $0.0324/h, the default) and `large` (8 vCPU / 16 GB, $0.0648/h). Billing is flat by size, per second while the sandbox runs, including idle time. CPU and RAM are included. The sandbox egress allowance is [2 TB per account over a rolling 30 days](https://lizard.build/docs/platform/limits/#sandbox-egress), with no separate per-GB charge. A successful pause stops compute charges; storage in Persistent Volumes is billed separately, including while paused.
|
|
44
44
|
|
|
45
45
|
```ts
|
|
46
46
|
const sandbox = await lizard.create('base', { size: 'large' })
|
|
@@ -125,7 +125,7 @@ Pass `timeoutMs` to `create()` to set the sandbox lifetime. The default is five
|
|
|
125
125
|
|
|
126
126
|
## Runtime limits
|
|
127
127
|
|
|
128
|
-
|
|
128
|
+
Lizard Sandboxes support Firecracker microVMs with their own kernel. Older pod volumes or snapshots, account or region settings, and some Firecracker startup failures can select a container that shares the host kernel. Check `getInfo().runtime` in TypeScript or `get_info().runtime` in Python before running code that requires a separate kernel. Use volumes mounted at `/workspace` to keep files after a sandbox ends. `pause()`/`resume()` keep memory and running processes; `snapshot()` is ready in about 2 s and `Sandbox.restore()` starts a copy in about 0.4 s; `fork()` clones a running sandbox. File watching and sandbox log streaming are not available on Firecracker sandboxes yet. Volumes can grow but not shrink, and a sandbox with a volume attached cannot be forked. See the [snapshot guide](../../docs/sandboxes.md#pause-resume-snapshots-and-fork).
|
|
129
129
|
|
|
130
130
|
`getHost()` returns a hostname without `https://`; the port is private, so send `sandbox.accessToken` as the `X-Lizard-Access-Token` header (or use `exposePort()`, which also returns a browser `url` carrying the token). File writes accept text or bytes (binary is sent exactly); `readBytes()` supports binary downloads.
|
|
131
131
|
|
package/dist/index.d.mts
CHANGED
|
@@ -911,7 +911,10 @@ interface SandboxOpts extends ConnectionOpts {
|
|
|
911
911
|
* - `'medium'` — 4 vCPU / 8 GB, $0.0324/h (default)
|
|
912
912
|
* - `'large'` — 8 vCPU / 16 GB, $0.0648/h
|
|
913
913
|
*
|
|
914
|
-
*
|
|
914
|
+
* CPU/RAM are included; running time includes idle time. Sandbox egress includes 2 TB per
|
|
915
|
+
* account over a rolling 30 days: https://lizard.build/docs/platform/limits/#sandbox-egress
|
|
916
|
+
* A successful pause stops compute charges; Persistent Volumes storage bills separately.
|
|
917
|
+
* Ignored with {@link SandboxOpts.snapshotId}.
|
|
915
918
|
*/
|
|
916
919
|
size?: 'small' | 'medium' | 'large';
|
|
917
920
|
/** Your own key/value labels for the sandbox, returned by `getInfo()` and `list()`. */
|
package/dist/index.d.ts
CHANGED
|
@@ -911,7 +911,10 @@ interface SandboxOpts extends ConnectionOpts {
|
|
|
911
911
|
* - `'medium'` — 4 vCPU / 8 GB, $0.0324/h (default)
|
|
912
912
|
* - `'large'` — 8 vCPU / 16 GB, $0.0648/h
|
|
913
913
|
*
|
|
914
|
-
*
|
|
914
|
+
* CPU/RAM are included; running time includes idle time. Sandbox egress includes 2 TB per
|
|
915
|
+
* account over a rolling 30 days: https://lizard.build/docs/platform/limits/#sandbox-egress
|
|
916
|
+
* A successful pause stops compute charges; Persistent Volumes storage bills separately.
|
|
917
|
+
* Ignored with {@link SandboxOpts.snapshotId}.
|
|
915
918
|
*/
|
|
916
919
|
size?: 'small' | 'medium' | 'large';
|
|
917
920
|
/** Your own key/value labels for the sandbox, returned by `getInfo()` and `list()`. */
|
package/package.json
CHANGED