Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"icon": "book-open-cover",
"groups": [
{
"group": "Getting Started",
"group": "Getting started",
"pages": [
"docs",
{
Expand All @@ -50,7 +50,7 @@
]
},
{
"group": "Agents in Sandbox",
"group": "Agents in sandbox",
"pages": [
"docs/agents/amp",
"docs/agents/claude-code",
Expand All @@ -59,7 +59,7 @@
]
},
{
"group": "Code Interpreting",
"group": "Code interpreting",
"pages": [
{
"group": "Analyze data with AI",
Expand Down Expand Up @@ -173,7 +173,7 @@
]
},
{
"group": "MCP Gateway",
"group": "MCP gateway",
"pages": [
"docs/mcp",
"docs/mcp/quickstart",
Expand Down Expand Up @@ -218,7 +218,7 @@
]
},
{
"anchor": "SDK Reference",
"anchor": "SDK reference",
"icon": "brackets-curly",
"href": "https://e2b.dev/docs/sdk-reference"
}
Expand Down
2 changes: 1 addition & 1 deletion docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ print(result.stdout)
```
</CodeGroup>

## E2B Building Blocks
## E2B building blocks

A quick overview of the core building blocks you'll interact with when using E2B.

Expand Down
14 changes: 7 additions & 7 deletions docs/agents/amp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once inside the sandbox, start AMP.
amp
```

## Run Headless
## Run headless

Use `-x` for non-interactive mode and `--dangerously-allow-all` to auto-approve all tool calls (safe inside E2B sandboxes). AMP uses its own API key from [ampcode.com/settings](https://ampcode.com/settings).

Expand Down Expand Up @@ -170,7 +170,7 @@ sandbox.kill()
```
</CodeGroup>

## Thread Management
## Thread management

AMP persists conversations as threads that can be resumed or continued with follow-up tasks.

Expand Down Expand Up @@ -236,7 +236,7 @@ sandbox.kill()
```
</CodeGroup>

## Build a Custom Template
## Build a custom template

If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `amp` template.

Expand Down Expand Up @@ -295,16 +295,16 @@ python build.py
```
</CodeGroup>

## Related Guides
## Related guides

<CardGroup cols={3}>
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
Auto-pause, resume, and manage sandbox lifecycle
</Card>
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
Clone repos, manage branches, and push changes
</Card>
<Card title="SSH Access" icon="terminal" href="/docs/sandbox/ssh-access">
<Card title="SSH access" icon="terminal" href="/docs/sandbox/ssh-access">
Connect to the sandbox via SSH for interactive sessions
</Card>
</CardGroup>
22 changes: 11 additions & 11 deletions docs/agents/claude-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once inside the sandbox, start Claude Code.
claude
```

## Run Headless
## Run headless

Use `-p` for non-interactive mode and `--dangerously-skip-permissions` to auto-approve all tool calls (safe inside E2B sandboxes).

Expand Down Expand Up @@ -111,7 +111,7 @@ sandbox.kill()
```
</CodeGroup>

## Structured Output
## Structured output

Use `--output-format json` to get machine-readable responses — useful for building pipelines or extracting specific results.

Expand Down Expand Up @@ -152,7 +152,7 @@ sandbox.kill()
```
</CodeGroup>

## Streaming Output
## Streaming output

Use `--output-format stream-json` to get a real-time JSONL event stream — including tool calls, token usage, and result metadata.

Expand Down Expand Up @@ -210,7 +210,7 @@ sandbox.kill()
```
</CodeGroup>

## Resume a Session
## Resume a session

Claude Code persists conversations that can be resumed with follow-up tasks using `--session-id`.

Expand Down Expand Up @@ -274,7 +274,7 @@ sandbox.kill()
```
</CodeGroup>

## Custom System Prompt
## Custom system prompt

Write a `CLAUDE.md` file into the sandbox for project context or use `--system-prompt` to provide task-specific instructions.

Expand Down Expand Up @@ -324,7 +324,7 @@ sandbox.kill()
```
</CodeGroup>

## Connect MCP Tools
## Connect MCP tools

Claude Code has built-in support for [MCP](https://modelcontextprotocol.io/). E2B provides an [MCP gateway](/docs/mcp) that gives Claude access to 200+ tools from the [Docker MCP Catalog](https://hub.docker.com/mcp).

Expand Down Expand Up @@ -385,7 +385,7 @@ sandbox.kill()
```
</CodeGroup>

## Build a Custom Template
## Build a custom template

If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `claude` template.

Expand Down Expand Up @@ -444,16 +444,16 @@ python build.py
```
</CodeGroup>

## Related Guides
## Related guides

<CardGroup cols={3}>
<Card title="MCP Tools" icon="plug" href="/docs/mcp">
<Card title="MCP tools" icon="plug" href="/docs/mcp">
Connect Claude Code to 200+ MCP tools
</Card>
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
Auto-pause, resume, and manage sandbox lifecycle
</Card>
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
Clone repos, manage branches, and push changes
</Card>
</CardGroup>
18 changes: 9 additions & 9 deletions docs/agents/codex.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once inside the sandbox, start Codex.
codex
```

## Run Headless
## Run headless

Use `codex exec` for non-interactive mode and `--full-auto` to auto-approve tool calls (safe inside E2B sandboxes). Pass `--skip-git-repo-check` to bypass git directory ownership checks inside the sandbox. Pass `CODEX_API_KEY` as an environment variable.

Expand Down Expand Up @@ -113,7 +113,7 @@ sandbox.kill()
```
</CodeGroup>

## Schema-Validated Output
## Schema-validated output

Use `--output-schema` to constrain the agent's final response to a JSON Schema. This ensures the output conforms to a specific structure — useful for building reliable pipelines.

Expand Down Expand Up @@ -194,7 +194,7 @@ sandbox.kill()
```
</CodeGroup>

## Streaming Events
## Streaming events

Use `--json` to get a JSONL event stream. Each line is a JSON object representing an agent event (tool calls, file changes, messages). Progress goes to stderr; events go to stdout.

Expand Down Expand Up @@ -244,7 +244,7 @@ sandbox.kill()
```
</CodeGroup>

## Image Input
## Image input

Pass screenshots or design mockups with `--image` to give Codex visual context alongside the prompt.

Expand Down Expand Up @@ -292,7 +292,7 @@ sandbox.kill()
```
</CodeGroup>

## Build a Custom Template
## Build a custom template

If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `codex` template.

Expand Down Expand Up @@ -351,16 +351,16 @@ python build.py
```
</CodeGroup>

## Related Guides
## Related guides

<CardGroup cols={3}>
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
Auto-pause, resume, and manage sandbox lifecycle
</Card>
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
Clone repos, manage branches, and push changes
</Card>
<Card title="SSH Access" icon="terminal" href="/docs/sandbox/ssh-access">
<Card title="SSH access" icon="terminal" href="/docs/sandbox/ssh-access">
Connect to the sandbox via SSH for interactive sessions
</Card>
</CardGroup>
2 changes: 1 addition & 1 deletion docs/agents/examples.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
url: https://github.com/e2b-dev
title: All Examples
title: All examples
icon: "github"
---
18 changes: 9 additions & 9 deletions docs/agents/openclaw.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once inside the sandbox, start OpenClaw.
openclaw agent --local --message "Hello"
```

## Run Headless
## Run headless

Use `openclaw agent --message` for non-interactive mode. Pass `--local` to use API keys from environment variables and `--thinking` to control reasoning depth.

Expand Down Expand Up @@ -111,7 +111,7 @@ sandbox.kill()
```
</CodeGroup>

## Structured Output
## Structured output

Use `--json` to get machine-readable responses with structured payload and metadata.

Expand Down Expand Up @@ -270,7 +270,7 @@ sandbox.kill()
```
</CodeGroup>

## Add Skills
## Add skills

OpenClaw supports a [skills ecosystem](https://docs.openclaw.ai/tools/skills) via [ClawHub](https://clawhub.com). Skills are markdown files (`SKILL.md`) that extend the agent with additional tools. Install them with the `clawhub` CLI or write them directly into the workspace.

Expand Down Expand Up @@ -382,7 +382,7 @@ sandbox.kill()
```
</CodeGroup>

## Launch the Gateway
## Launch the gateway

OpenClaw has a built-in [web UI and chat interface](https://openclaw.ai) served by its gateway. Start it inside a sandbox and connect from your browser.

Expand Down Expand Up @@ -426,7 +426,7 @@ print(f"Sandbox ID: {sandbox.sandbox_id}")
```
</CodeGroup>

## Build a Custom Template
## Build a custom template

If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `openclaw` template.

Expand Down Expand Up @@ -495,16 +495,16 @@ python build.py
```
</CodeGroup>

## Related Guides
## Related guides

<CardGroup cols={3}>
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
Auto-pause, resume, and manage sandbox lifecycle
</Card>
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
Clone repos, manage branches, and push changes
</Card>
<Card title="SSH Access" icon="terminal" href="/docs/sandbox/ssh-access">
<Card title="SSH access" icon="terminal" href="/docs/sandbox/ssh-access">
Connect to the sandbox via SSH for interactive sessions
</Card>
</CardGroup>
14 changes: 7 additions & 7 deletions docs/agents/opencode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once inside the sandbox, start OpenCode.
opencode
```

## Run Headless
## Run headless

Use `opencode run` for non-interactive mode. Pass your LLM provider's API key as an environment variable — OpenCode supports `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, `GEMINI_API_KEY`, and [others](https://opencode.ai/docs/config/).

Expand Down Expand Up @@ -111,7 +111,7 @@ sandbox.kill()
```
</CodeGroup>

## Launch the Web UI
## Launch the web UI

OpenCode has a [built-in web interface](https://opencode.ai/docs/web/). Start it inside a sandbox and connect from your browser.

Expand Down Expand Up @@ -163,7 +163,7 @@ print(f"Sandbox ID: {sandbox.sandbox_id}")
```
</CodeGroup>

## Build a Custom Template
## Build a custom template

If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `opencode` template.

Expand Down Expand Up @@ -238,16 +238,16 @@ python build.py
```
</CodeGroup>

## Related Guides
## Related guides

<CardGroup cols={3}>
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
Auto-pause, resume, and manage sandbox lifecycle
</Card>
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
Clone repos, manage branches, and push changes
</Card>
<Card title="SSH Access" icon="terminal" href="/docs/sandbox/ssh-access">
<Card title="SSH access" icon="terminal" href="/docs/sandbox/ssh-access">
Connect to the sandbox via SSH for interactive sessions
</Card>
</CardGroup>
6 changes: 3 additions & 3 deletions docs/api-key.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "API Key"
title: "API key"
icon: "key"
---

Expand Down Expand Up @@ -27,15 +27,15 @@ You can get your API key at [dashboard](https://e2b.dev/dashboard?tab=keys).

<br/>

# Access Token
# Access token

The access token is used only in the CLI and is **not needed in the SDK**. There's no need to set it when logging into the CLI using `e2b auth login`.

<Note>
To authenticate without the browser, you can set `E2B_ACCESS_TOKEN` as an environment variable. This is useful for CI/CD pipelines.
</Note>

## Where to find Access token
## Where to find access token

You can get your **Access token key** at the [dashboard](https://e2b.dev/dashboard/account).

Loading