You are reading a legacy (pre v1.0) document.
You can use
--help flag for more information about commands.Auth
auth login
Log in to the CLI. It will save your access token in ~/.e2b file.
auth logout
Log out of the CLI. It will remove your access token from ~/.e2b file.
auth configure
Configure the default team for the CLI. It will be used for all commands that require a team.
auth info
Get info about your current user.
Templates
template init
Creates a basic Dockerfile (./e2b.Dockerfile) in current directory.
You can then run e2b template build to build sandbox template from this Dockerfile.
Options
template build
Builds a sandbox template defined by ./e2b.Dockerfile or ./Dockerfile from the root directory.
By default, the root directory is the current working directory.
This command also creates the e2b.toml config.
Running
e2b template build without specifying a template with the [template] argument will rebuild template defined by the e2b.toml config.If there is no e2b.toml config a new template will be created.Arguments
[template]
Specify the template you want to rebuild. You can use the template name or ID.
Options
Specify the command that should be running when a sandbox starts.
Specify the path to the config file. By default, E2B tries to find
e2b.toml in the root directory.Specify the name of the sandbox template. You can use the template name to start the sandbox in the SDK. The name must be lowercase and contain only letters, numbers, dashes, and underscores.
Change the root directory where the command is executed to the
path directory.Specify the path to Dockerfile. By default E2B tries to find
e2b.Dockerfile or Dockerfile in the root directory.Specify the team that will be used for the sandbox template. You can find team ID in the team settings in the E2B dashboard.
Specify the number of CPUs that will be used to run the sandbox. The default value is 2.
Specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512.
Specify a build argument for the Dockerfile. The format is
key=value. You can use this option multiple times.template delete
Delete the sandbox template specified by the [template] argument, e2b.toml config in the working directory, or by an interactive selection.
By default, the root directory is the current working directory.
This command also deletes the e2b.toml config.
Running
e2b template delete without specifying a template with the [template] argument will delete the template defined by the e2b.toml config.Arguments
[template]
Specify the template you want to delete. You can use the template name or ID.
Options
Change the root directory where the command is executed to the
path directory.Specify the path to the config file. By default, E2B tries to find
e2b.toml in the root directory.Specify the team that will be used for the sandbox template. You can find team ID in the team settings in the E2B dashboard.
-s, --select
Interactively select sandbox templates you want to delete.
-y, --yes
Don’t ask for confirmation before deleting the sandbox template.
template list
List your sandbox templates.
Options
Specify the team that will be used for the sandbox template. You can find team ID in the team settings in the E2B dashboard.
Sandboxes
sandbox list
List your created sandboxes that are running right now.
sandbox logs
Starts printing logs from the specified sandbox.
If the sandbox is running new logs will be streamed to the terminal.
The timestamps are in the UTC format.
This command is useful if you need to debug a running sandbox or check logs from a sandbox that was already closed.
You can use
e2b sandbox list to get a list of running sandboxes and their IDs that can be used with e2b sandbox logs <sandboxID> command.Arguments
<sandboxID>
Specify the ID of the sandbox you want to get logs from.
Options
-f, --follow
Enable streaming logs until the sandbox is closed.
sandbox connect
Connects your terminal to a running sandbox that you created via the E2B SDK.
This command is useful if you need to debug a running sandbox.
This command works similar to the docker exec -it <container> bash command in Docker.
You can use
e2b sandbox list to get a list of running sandboxes and their IDs that can be used with e2b sandbox connect <sandboxID> command.Arguments
<sandboxID>
Specify the ID of a running sandbox you want to connect to.
sandbox create
Spawns a sandbox and connects your terminal to the sandbox.
This command can be used to debug your sandbox template.
This command works similar to the docker run -it <image> bash command in Docker.
Running
e2b sandbox create without specifying a template with the [template] argument will create sandbox defined by the e2b.toml config.Arguments
[template]
Specify the template you want to create sandbox from. You can use the template name or ID.
Options
Specify the path to the config file. By default, E2B tries to find
e2b.toml in the root directory.