Documentation

E2B templates allow you to define custom sandboxes. You can define the base image, environment variables, files to copy, commands to run, and a start command that runs during the template build and is captured in a snapshot — so the process is already running when you create a sandbox from that template. This gives you fully configured sandboxes with running processes ready to use with zero wait time for your users. There are two ways how you can start creating a new template:

using the CLI
manually using the SDK

CLI

You can use the E2B CLI to create a new template.

Install the E2B CLI

Install the latest version of the E2B CLI

Initialize a new template

e2b template init

Follow the prompts

Follow the prompts to create a new template.

Done

Check the generated README.md file to see how to build and use your new template.

Manual

Install the packages

Requires the E2B SDK version at least 2.3.0

npm install e2b dotenv

pip install e2b dotenv

Create the .env file

E2B_API_KEY=e2b_***

Create a new template file

Create a template file with the following name and content

// template.ts
import { Template, waitForTimeout } from 'e2b';

export const template = Template()
  .fromBaseImage()
  .setEnvs({
    HELLO: "Hello, World!",
  })
  .setStartCmd("echo $HELLO", waitForTimeout(5_000));

# template.py
from e2b import Template, wait_for_timeout

template = (
    Template()
    .from_base_image()
    .set_envs(
        {
            "HELLO": "Hello, World!",
        }
    )
    .set_start_cmd("echo $HELLO", wait_for_timeout(5_000)))

Create a development build script

// build.dev.ts
import 'dotenv/config';
import { Template, defaultBuildLogger } from 'e2b';
import { template } from './template';

async function main() {
  await Template.build(template, 'template-tag-dev', {
    cpuCount: 1,
    memoryMB: 1024,
    onBuildLogs: defaultBuildLogger(),
  });
}

main().catch(console.error);

# build_dev.py
from dotenv import load_dotenv
from e2b import Template, default_build_logger
from template import template

load_dotenv()

if __name__ == '__main__':
    Template.build(
        template,
        'template-tag-dev',
        cpu_count=1,
        memory_mb=1024,
        on_build_logs=default_build_logger(),
    )

Create a production build script

// build.prod.ts
import 'dotenv/config';
import { Template, defaultBuildLogger } from 'e2b';
import { template } from './template';

async function main() {
  await Template.build(template, 'template-tag', {
    cpuCount: 1,
    memoryMB: 1024,
    onBuildLogs: defaultBuildLogger(),
  });
}

main().catch(console.error);

# build_prod.py
from dotenv import load_dotenv
from e2b import Template, default_build_logger
from template import template

load_dotenv()

if __name__ == '__main__':
    Template.build(
        template,
        'template-tag',
        cpu_count=1,
        memory_mb=1024,
        on_build_logs=default_build_logger(),
    )

Build the template

Build the development template

npx tsx build.dev.ts

python build_dev.py

Build the production template

npx tsx build.prod.ts

python build_prod.py

Create a new Sandbox from the Template

import 'dotenv/config';
import { Sandbox } from 'e2b';

// Create a Sandbox from development template
const sandbox = await Sandbox.create("template-tag-dev");

// Create a Sandbox from production template
const sandbox = await Sandbox.create("template-tag");

from dotenv import load_dotenv
from e2b import Sandbox

load_dotenv()

# Create a new Sandbox from the development template
sbx = Sandbox(template="template-tag-dev")

# Create a new Sandbox from the production template
sbx = Sandbox(template="template-tag")

The template name is the identifier that can be used to create a new Sandbox.

​CLI

​Manual

​Install the packages

​Create a new template file

​Create a development build script

​Create a production build script

​Build the template

​Create a new Sandbox from the Template

CLI

Manual

Install the packages

Create a new template file

Create a development build script

Create a production build script

Build the template

Create a new Sandbox from the Template