Skip to content
Open
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
147 changes: 14 additions & 133 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,158 +36,39 @@
"docs/quickstart/install-custom-packages"
]
},
"docs/api-key",
"docs/cookbook",
"docs/support"
"docs/api-key"
]
},
{
"group": "Code Interpreting",
"group": "Use Case Examples",
"pages": [
{
"group": "Analyze data with AI",
"pages": [
"docs/code-interpreting/analyze-data-with-ai",
"docs/code-interpreting/analyze-data-with-ai/pre-installed-libraries"
]
},
{
"group": "Charts & visualizations",
"pages": [
"docs/code-interpreting/create-charts-visualizations",
"docs/code-interpreting/create-charts-visualizations/static-charts",
"docs/code-interpreting/create-charts-visualizations/interactive-charts"
]
},
"docs/code-interpreting/streaming",
{
"group": "Supported languages",
"pages": [
"docs/code-interpreting/supported-languages",
"docs/code-interpreting/supported-languages/python",
"docs/code-interpreting/supported-languages/javascript",
"docs/code-interpreting/supported-languages/r",
"docs/code-interpreting/supported-languages/java",
"docs/code-interpreting/supported-languages/bash"
]
}
"docs/use-cases/linux-desktop",
"docs/use-cases/deep-research-agents",
"docs/use-cases/ai-data-analysis-visualization",
"docs/use-cases/reinforcement-learning",
"docs/use-cases/vibe-coding"
]
},
{
"group": "Sandbox",
"pages": [
"docs/sandbox",
"docs/sandbox/lifecycle-events-api",
"docs/sandbox/lifecycle-events-webhooks",
"docs/sandbox/intro",
"docs/sandbox/executing-code",
"docs/sandbox/reading-output",
"docs/sandbox/persistence",
"docs/sandbox/metrics",
"docs/sandbox/metadata",
"docs/sandbox/environment-variables",
"docs/sandbox/list",
"docs/sandbox/connect",
"docs/sandbox/internet-access",
"docs/sandbox/connect-bucket",
"docs/sandbox/rate-limits",
"docs/sandbox/secured-access"
"docs/sandbox/security"
]
},
{
"group": "Templates",
"pages": [
"docs/template/quickstart",
"docs/template/how-it-works",
"docs/template/user-and-workdir",
"docs/template/caching",
"docs/template/base-image",
"docs/template/private-registries",
"docs/template/defining-template",
"docs/template/start-ready-command",
"docs/template/build",
"docs/template/logging",
"docs/template/error-handling",
{
"group": "Examples",
"pages": [
"docs/template/examples/nextjs",
"docs/template/examples/nextjs-bun",
"docs/template/examples/expo",
"docs/template/examples/desktop",
"docs/template/examples/claude-code"
]
},
"docs/template/migration-v2",
{
"group": "Legacy Docs",
"pages": [
"docs/sandbox-template",
"docs/sandbox-template/start-cmd",
"docs/sandbox-template/ready-cmd",
"docs/sandbox-template/customize-cpu-ram"
]
}
]
},
{
"group": "Filesystem",
"pages": [
"docs/filesystem",
"docs/filesystem/read-write",
"docs/filesystem/info",
"docs/filesystem/watch",
"docs/filesystem/upload",
"docs/filesystem/download"
"docs/templates/intro"
]
},
{
"group": "Commands",
"group": "FAQ",
"pages": [
"docs/commands",
"docs/commands/streaming",
"docs/commands/background"
]
},
{
"group": "MCP Gateway",
"pages": [
"docs/mcp",
"docs/mcp/quickstart",
"docs/mcp/available-servers",
"docs/mcp/custom-templates",
"docs/mcp/custom-servers",
"docs/mcp/examples"
]
},
{
"group": "CLI",
"pages": [
"docs/cli",
"docs/cli/auth",
"docs/cli/list-sandboxes",
"docs/cli/shutdown-sandboxes"
]
},
{
"group": "Deployment",
"pages": ["docs/byoc"]
},
{
"group": "Migration",
"pages": ["docs/migration/v2"]
},
{
"group": "Troubleshooting",
"pages": [
{
"group": "SDKs",
"pages": ["docs/troubleshooting/sdks/workers-edge-runtime"]
},
{
"group": "Templates",
"pages": [
"docs/troubleshooting/templates/build-authentication-error",
"docs/troubleshooting/templates/49999-port-not-open"
]
}
"docs/faq"
]
}
]
Expand Down
54 changes: 30 additions & 24 deletions docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,43 @@ sidebarTitle: Home
icon: house
---

import { Concepts } from '/snippets/Concepts.jsx';
import { CodeInterpreting } from '/snippets/CodeInterpreting.jsx';
import { Quickstart } from '/snippets/Quickstart.jsx';
import { CodeInterpreting } from '/snippets/CodeInterpreting.jsx';
import { Examples } from '/snippets/Examples.jsx';
import { Reference } from '/snippets/Reference.jsx';

Here you'll find all the guides, concepts, and SDK references for developing with E2B.
## What is E2B?

<CodeGroup>
```bash JavaScript & TypeScript
npm i @e2b/code-interpreter
```
```bash Python
pip install e2b-code-interpreter
```
</CodeGroup>
E2B provides isolated sandboxes that let agents safely execute code, process data, and run tools. Our [SDKs]() make it easy to start and manage these environments.

## What is E2B?
E2B is an [open-source](https://github.com/e2b-dev) infrastructure that allows you to run AI-generated code in secure isolated sandboxes in the cloud.
To start and control sandboxes, use our [Python SDK](https://pypi.org/project/e2b/) or [JavaScript SDK](https://www.npmjs.com/package/e2b).
## E2B Building Blocks

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

- [**Sandbox**]() — A fast, secure Linux VM created on demand for your agent

- [**Template**]() — Defines what environment a sandbox starts with

## How to use the docs

The documentation is split into three main sections:

- [**Quickstart**](#quickstart) — Step-by-step tutorials that walk you through spinning up your first E2B sandboxes.

- [**Examples**](#examples) — In-depth tutorials focused on specific use cases. Pick the topics that match what you're building.

- [**API/SDK Reference**](https://e2b.dev/docs/sdk-reference) — A complete technical reference for every feature, component, and configuration option.

<div id="quickstart"></div>

Some of the typical use cases for E2B are AI data analysis or visualization, running AI-generated code of various languages, playground for coding agents, environment for codegen evals, or running full AI-generated apps like in [Fragments](https://github.com/e2b-dev/fragments).
## 🚀 Quickstart.

### Under the hood
The E2B Sandbox is a small isolated VM the can be started very quickly (~150ms). You can think of it as a small computer for the AI model. You can run many sandboxes at once. Typically, you run separate sandbox for each LLM, user, or AI agent session in your app.
For example, if you were building an AI data analysis chatbot, you would start the sandbox for every user session.
<Quickstart />

## Quickstart
<Quickstart/>
<div id="examples"></div>

## Code interpreting with AI
<CodeInterpreting/>
## 🧠 Examples

## Learn the core concepts
<Concepts/>
<Examples />

<div id="reference"></div>
9 changes: 9 additions & 0 deletions docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "FAQ"
description: "Frequently asked questions about E2B sandboxes, templates, pricing, security, performance, and common troubleshooting scenarios."
icon: "circle-question"
---

# FAQ

Content coming soon.
9 changes: 9 additions & 0 deletions docs/sandbox/executing-code.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Executing Code"
description: "Run code and shell commands in E2B sandboxes with support for multiple languages, streaming output, background processes, and real-time execution control."
icon: "terminal"
---

# Executing Code

Content coming soon.
9 changes: 9 additions & 0 deletions docs/sandbox/intro.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Sandbox Intro"
description: "E2B sandboxes provide secure, isolated cloud environments for running untrusted code with full control over execution, filesystem, and networking."

Check warning on line 3 in docs/sandbox/intro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (e2b) - vale-spellcheck

docs/sandbox/intro.mdx#L3

Did you really mean 'untrusted'?
icon: "cube"
---

# Sandbox Intro

Content coming soon.
Loading