Skip to content

Commit 0aa3ff6

Browse files
Merge branch 'main' into feat--can-pipe-into-stdin
2 parents 8a8ff8e + d9350c9 commit 0aa3ff6

14 files changed

Lines changed: 1272 additions & 82 deletions

File tree

docs.json

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@
4242
"docs/billing"
4343
]
4444
},
45+
{
46+
"group": "Use cases",
47+
"pages": [
48+
"docs/use-cases/computer-use",
49+
"docs/use-cases/ci-cd"
50+
]
51+
},
4552
{
4653
"group": "Code Interpreting",
4754
"pages": [
@@ -82,12 +89,15 @@
8289
"docs/sandbox/lifecycle-events-api",
8390
"docs/sandbox/lifecycle-events-webhooks",
8491
"docs/sandbox/persistence",
92+
"docs/sandbox/git-integration",
8593
"docs/sandbox/metrics",
8694
"docs/sandbox/metadata",
8795
"docs/sandbox/environment-variables",
8896
"docs/sandbox/list",
8997
"docs/sandbox/connect",
9098
"docs/sandbox/internet-access",
99+
"docs/sandbox/pty",
100+
"docs/sandbox/ssh-access",
91101
"docs/sandbox/connect-bucket",
92102
"docs/sandbox/rate-limits",
93103
"docs/sandbox/secured-access",
@@ -118,7 +128,8 @@
118128
"docs/template/examples/nextjs-bun",
119129
"docs/template/examples/expo",
120130
"docs/template/examples/desktop",
121-
"docs/template/examples/claude-code"
131+
"docs/template/examples/claude-code",
132+
"docs/template/examples/docker"
122133
]
123134
},
124135
"docs/template/migration-v2",
@@ -152,12 +163,6 @@
152163
"docs/commands/background"
153164
]
154165
},
155-
{
156-
"group": "Git",
157-
"pages": [
158-
"docs/git"
159-
]
160-
},
161166
{
162167
"group": "MCP Gateway",
163168
"pages": [
@@ -196,13 +201,7 @@
196201
{
197202
"group": "Troubleshooting",
198203
"pages": [
199-
{
200-
"group": "SDKs",
201-
"pages": [
202-
"docs/troubleshooting/sdks/workers-edge-runtime"
203-
]
204-
},
205-
{
204+
{
206205
"group": "Templates",
207206
"pages": [
208207
"docs/troubleshooting/templates/build-authentication-error",
@@ -333,6 +332,11 @@
333332
"source": "/docs/getting-started/installation",
334333
"destination": "/docs/quickstart",
335334
"permanent": true
335+
},
336+
{
337+
"source": "/docs/git",
338+
"destination": "/docs/sandbox/git-integration",
339+
"permanent": true
336340
}
337341
]
338342
}

docs.mdx

Lines changed: 49 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,69 @@ sidebarTitle: Home
44
icon: house
55
---
66

7-
import { Concepts } from '/snippets/Concepts.jsx';
8-
import { CodeInterpreting } from '/snippets/CodeInterpreting.jsx';
97
import { Quickstart } from '/snippets/Quickstart.jsx';
108

11-
Here you'll find all the guides, concepts, and SDK references for developing with E2B.
9+
## What is E2B?
10+
11+
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.
12+
13+
Spin up a sandbox and run code in a few lines:
1214

1315
<CodeGroup>
1416
```bash JavaScript & TypeScript
15-
npm i @e2b/code-interpreter
17+
npm i e2b
1618
```
1719
```bash Python
18-
pip install e2b-code-interpreter
20+
pip install e2b
1921
```
2022
</CodeGroup>
2123

22-
## What is E2B?
23-
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.
24-
To start and control sandboxes, use our [Python SDK](https://pypi.org/project/e2b/) or [JavaScript SDK](https://www.npmjs.com/package/e2b).
24+
<CodeGroup>
25+
```javascript JavaScript & TypeScript
26+
import { Sandbox } from 'e2b'
27+
28+
const sandbox = await Sandbox.create() // Needs E2B_API_KEY environment variable
29+
const result = await sandbox.commands.run('echo "Hello from E2B Sandbox!"')
30+
console.log(result.stdout)
31+
```
32+
```python Python
33+
from e2b import Sandbox
34+
35+
sandbox = Sandbox.create() # Needs E2B_API_KEY environment variable
36+
result = sandbox.commands.run('echo "Hello from E2B Sandbox!"')
37+
print(result.stdout)
38+
```
39+
</CodeGroup>
40+
41+
## E2B Building Blocks
42+
43+
A quick overview of the core building blocks you'll interact with when using E2B.
44+
45+
- [**Sandbox**](/docs/sandbox) — A fast, secure Linux VM created on demand for your agent
46+
47+
- [**Template**](/docs/template/quickstart) — Defines what environment a sandbox starts with
48+
49+
## How to use the docs
50+
51+
The documentation is split into three main sections:
52+
53+
- [**Quickstart**](#quickstart) — Step-by-step tutorials that walk you through spinning up your first E2B sandboxes.
2554

26-
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).
55+
- [**Examples**](#examples) — In-depth tutorials focused on specific use cases. Pick the topics that match what you're building.
2756

28-
### Under the hood
29-
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.
30-
For example, if you were building an AI data analysis chatbot, you would start the sandbox for every user session.
57+
- [**SDK Reference**](https://e2b.dev/docs/sdk-reference) — A complete technical reference for every SDK method, parameter, and configuration option.
3158

3259
## Quickstart
33-
<Quickstart/>
3460

35-
## Code interpreting with AI
36-
<CodeInterpreting/>
61+
<Quickstart />
3762

38-
## Learn the core concepts
39-
<Concepts/>
63+
## Examples
4064

65+
<CardGroup cols={2}>
66+
<Card title="Computer Use" icon="desktop" href="/docs/use-cases/computer-use">
67+
Build AI agents that see, understand, and control virtual Linux desktops using E2B Desktop sandboxes.
68+
</Card>
69+
<Card title="GitHub Actions CI/CD" icon="gears" href="/docs/use-cases/ci-cd">
70+
Use E2B sandboxes in your GitHub Actions workflows to run testing, validation, and AI code reviews.
71+
</Card>
72+
</CardGroup>

docs/billing.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ E2B uses [usage-based pricing](#usage-based-pricing) - you pay only for what you
1818
| **Concurrent sandboxes** | 20 | 100 - 1,100 | 1,100+ |
1919

2020
<Note>
21-
Pro plan includes 100 concurrent sandboxes. Higher concurrency up to 1,100 is available as a purchasable [add-on](https://e2b.dev/dashboard/tberan/billing).
21+
Pro plan includes 100 concurrent sandboxes. Higher concurrency up to 1,100 is available as a purchasable [add-on](https://e2b.dev/dashboard?tab=billing).
2222
</Note>
2323

2424
Plans have different [API rate limits](/docs/sandbox/rate-limits).
@@ -64,6 +64,10 @@ Template.build(
6464

6565
See [template quickstart](/docs/template/quickstart) for more details on building custom templates.
6666

67+
<Note>
68+
Need higher CPU or RAM limits? Contact [support@e2b.dev](mailto:support@e2b.dev) for more information.
69+
</Note>
70+
6771
---
6872

6973
## Monitoring usage

docs/git.mdx renamed to docs/sandbox/git-integration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Git"
3-
sidebarTitle: Overview
2+
title: "Git Integration"
3+
description: "Clone repositories, manage branches, and push changes using the sandbox.git methods."
44
---
55

66
Use the `sandbox.git` methods to run common git operations inside a sandbox.

docs/sandbox/persistence.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -276,13 +276,6 @@ If you resume the sandbox, the service will be accessible again but you need to
276276

277277
## Limitations while in beta
278278

279-
### Lifecycle duration
280-
- A sandbox can exist for **up to 30 days** from the initial `create` call.
281-
- After 30 days, sandbox data **may be deleted** and the sandbox can no longer be resumed.
282-
- Attempting to resume a deleted or non-existent sandbox will result in:
283-
- `NotFoundError` in the JavaScript SDK
284-
- `NotFoundException` in the Python SDK
285-
286279
### Pause and resume performance
287280
- Pausing a sandbox takes approximately **4 seconds per 1 GiB of RAM**
288281
- Resuming a sandbox takes approximately **1 second**
@@ -292,4 +285,3 @@ If you resume the sandbox, the service will be accessible again but you need to
292285
- **24 hours** on the **Pro tier**
293286
- **1 hour** on the **Base tier**
294287
- After a sandbox is paused and resumed, the continuous runtime limit is **reset**
295-
- The **30-day total lifetime limit** still applies regardless of how many times the sandbox is paused or resumed

0 commit comments

Comments
 (0)