Start Command

The start command allows you to specify a command that will be already running when you spawn your custom sandbox. This way, you can for example have running servers or seeded databases inside the sandbox that are already fully ready when you spawn the sandbox using the SDK and with zero waiting time for your users during the runtime.

The idea behind the start command feature is to lower the wait times for your users and have everything ready for your users when you spawn your sandbox.

You can see how it works here.

​

How to add start command

When you are building a sandbox template you can specify the start command by using the -c option:

export E2B_DOMAIN=sandbox.novita.ai
e2b template build -c "<your-start-command>"

When you spawn the custom sandbox you built, the start command will be already running if there was no error when we tried to execute it.

​

Sandbox template config

You can specify the start command also inside the e2b.toml in the same directory where you run e2b template build.

template_id = "0r0efkbfwzfp9p7qpc1c"
dockerfile = "e2b.Dockerfile"
template_name = "my-agent-sandbox"
start_cmd = "<your-start-command>"

​

Logs

You can retrieve the start command’s logs using the SDK during runtime.

import { Sandbox } from '@e2b/code-interpreter'

// Spawn your custom sandbox
const sandbox = await Sandbox.create({
  id: 'my-agent-sandbox',
  // If you specify onStderr and onStdout handlers when spawning the sandbox
  // you will see logs from the start command.
  onStderr: output => console.log("stderr", output.line),
  onStdout: output => console.log("stdout", output.line),
})

// Close sandbox once done
await sandbox.close()

Or you can use the CLI:

export E2B_DOMAIN=sandbox.novita.ai
e2b sandbox logs <sandbox-id>