Skip to content

Commit 471f69b

Browse files
Add Crabbox with E2B use case docs (#275)
* Add Crabbox E2B use case docs * Add Crabbox logo icon * Refine Crabbox docs label and icon * Move Crabbox under Agents group and shorten sidebar label --------- Co-authored-by: Ondrej Drapalik <ondrej.drapalik@gmail.com> Co-authored-by: Ondrej Drapalik <43215019+OndrejDrapalik@users.noreply.github.com>
1 parent 4e0a878 commit 471f69b

3 files changed

Lines changed: 90 additions & 1 deletion

File tree

docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,13 @@
5555
]
5656
},
5757
{
58-
"group": "Agents in sandbox",
58+
"group": "Agents",
5959
"pages": [
6060
"docs/agents/amp",
6161
"docs/agents/claude-code",
6262
"docs/agents/claude-managed-agents",
6363
"docs/agents/codex",
64+
"docs/agents/crabbox",
6465
"docs/agents/devin",
6566
"docs/agents/openai-agents-sdk",
6667
{

docs/agents/crabbox.mdx

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: "Crabbox with E2B"
3+
sidebarTitle: "Crabbox"
4+
description: "Run Crabbox test and execution workflows on E2B sandboxes."
5+
icon: "/images/icons/crabbox.svg"
6+
---
7+
8+
[Crabbox](https://github.com/openclaw/crabbox) is a remote software testing and execution control plane for maintainers and AI agents. Use its E2B provider when you want Crabbox to create an E2B Linux sandbox, sync your working tree, run a command, stream output, and clean up from one CLI command.
9+
10+
## Install
11+
12+
Install Crabbox locally.
13+
14+
```bash
15+
brew install openclaw/tap/crabbox
16+
crabbox --version
17+
```
18+
19+
## Configure E2B
20+
21+
Export your E2B API key before running Crabbox.
22+
23+
```bash
24+
export E2B_API_KEY=e2b_...
25+
```
26+
27+
You can select E2B per command with `--provider e2b`, or set it in a repo-level Crabbox config.
28+
29+
```yaml .crabbox.yaml
30+
provider: e2b
31+
target: linux
32+
e2b:
33+
template: base
34+
workdir: crabbox
35+
```
36+
37+
`template` is the E2B template to create. `workdir` is the directory where Crabbox syncs and runs your project inside the sandbox.
38+
39+
## Run tests
40+
41+
Run a command in a fresh E2B sandbox.
42+
43+
```bash
44+
crabbox run --provider e2b -- echo crabbox-e2b-ok
45+
```
46+
47+
Use an existing warm sandbox for repeated runs.
48+
49+
```bash
50+
crabbox warmup --provider e2b --e2b-template base
51+
lease="<lease-or-slug>"
52+
crabbox run --provider e2b --id "$lease" -- echo crabbox-e2b-ok
53+
crabbox status --provider e2b --id "$lease" --wait
54+
crabbox stop --provider e2b "$lease"
55+
```
56+
57+
Run in a custom E2B workdir.
58+
59+
```bash
60+
crabbox run --provider e2b --e2b-workdir repo -- echo crabbox-e2b-ok
61+
```
62+
63+
## How it works
64+
65+
With `provider: e2b`, Crabbox uses E2B sandbox lifecycle, file upload, and process APIs instead of SSH. Crabbox owns local config, sync manifests, command orchestration, output streaming, and normalized `list` / `status` behavior. E2B owns the sandbox runtime and command transport.
66+
67+
## Limitations
68+
69+
- E2B is a Linux delegated-run provider for Crabbox.
70+
- Crabbox SSH commands such as `ssh`, `vnc`, `code`, and SSH-based Actions hydration are not available with `provider: e2b`.
71+
- `--class` and `--type` are rejected because sandbox resources come from the selected E2B template.
72+
- `--e2b-template`, `--e2b-workdir`, `--e2b-user`, `--e2b-api-url`, and `--e2b-domain` override matching config values.
73+
74+
For the full Crabbox command and provider reference, see the [Crabbox repository](https://github.com/openclaw/crabbox).

images/icons/crabbox.svg

Lines changed: 14 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)