e2b sandbox
work with sandboxesUsage
e2b sandbox connect
connect terminal to already running sandboxUsage
Options
-u, --user <user>: user to start the terminal session as-c, --cwd <dir>: working directory for the terminal session-e, --env <KEY=VALUE>: set environment variable for the terminal session (repeatable) [default: [object Object]]
e2b sandbox info
show information for a sandboxUsage
Options
-f, --format <format>: output format, eg. json, pretty
e2b sandbox list
list all sandboxes, by default it list only running onesUsage
Options
-s, --state <state>: filter by state, eg. running, paused. Defaults to running-m, --metadata <metadata>: filter by metadata, eg. key1=value1-t, --template <template>: filter by template ID or alias, eg. base--started-after <date>: filter by start time, only sandboxes started at or after this time are returned, eg. 2025-01-01T00:00:00Z-o, --order <order>: sort order by start time, asc or desc (default: desc)-l, --limit <limit>: limit the number of sandboxes returned (default: 1000, 0 for no limit)-f, --format <format>: output format, eg. json, pretty
e2b sandbox kill
kill sandboxUsage
Options
-a, --all: kill all sandboxes-s, --state <state>: when used with -a/--all flag, filter by state, eg. running, paused. Defaults to running-m, --metadata <metadata>: when used with -a/--all flag, filter by metadata, eg. key1=value1
e2b sandbox pause
pause sandboxUsage
e2b sandbox resume
resume paused sandboxUsage
e2b sandbox create
create sandbox and connect terminal to itUsage
Options
-d, --detach: create sandbox without connecting terminal to it--lifecycle.ontimeout <action>: action when sandbox timeout is reached: pause or kill--lifecycle.autoresume: enable sandbox auto-resume, requires --lifecycle.ontimeout pause--timeout <seconds>: sandbox timeout in seconds-u, --user <user>: user to start the terminal session as-c, --cwd <dir>: working directory for the terminal session-e, --env <KEY=VALUE>: set environment variable for the terminal session (repeatable) [default: [object Object]]--config <e2b-toml>: [deprecated] e2b.toml is no longer read here
e2b sandbox spawn
create sandbox and connect terminal to itUsage
Options
-d, --detach: create sandbox without connecting terminal to it--lifecycle.ontimeout <action>: action when sandbox timeout is reached: pause or kill--lifecycle.autoresume: enable sandbox auto-resume, requires --lifecycle.ontimeout pause--timeout <seconds>: sandbox timeout in seconds-u, --user <user>: user to start the terminal session as-c, --cwd <dir>: working directory for the terminal session-e, --env <KEY=VALUE>: set environment variable for the terminal session (repeatable) [default: [object Object]]--config <e2b-toml>: [deprecated] e2b.toml is no longer read here
e2b sandbox logs
show logs for sandboxUsage
Options
--level <level>: filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]-f, --follow: keep streaming logs until the sandbox is closed--format <format>: specify format for printing logs (json, pretty) [default: pretty]--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma.
e2b sandbox metrics
show metrics for sandboxUsage
Options
-f, --follow: keep streaming metrics until the sandbox is closed--format <format>: specify format for printing metrics (json, pretty) [default: pretty]
e2b sandbox exec
execute a command in a running sandboxUsage
Options
-b, --background: run in background and return immediately-c, --cwd <dir>: working directory-u, --user <user>: run as specified user-e, --env <KEY=VALUE>: set environment variable (repeatable) [default: [object Object]]
e2b sandbox snapshot
work with sandbox snapshotsUsage
e2b sandbox snapshot create
create a snapshot from a sandboxUsage
Options
-n, --name <name>: name for the snapshot template, reuses the existing template if it already exists
e2b sandbox snapshot list
list snapshotsUsage
Options
-n, --name <name>: filter by snapshot name or ID, optionally tag-qualified, eg. my-snapshot:v1-l, --limit <limit>: limit the number of snapshots returned (default: 1000, 0 for no limit)-f, --format <format>: output format, eg. json, pretty
e2b sandbox snapshot delete
delete snapshotsUsage
e2b sandbox fork
fork running sandbox into new sandboxes and print their IDs, one per lineUsage
Options
-n, --count <count>: number of forks to create, at most 20 (default: 1)--timeout <seconds>: timeout of the forked sandboxes in seconds