diff --git a/docs.json b/docs.json index 34728932..a37749ae 100644 --- a/docs.json +++ b/docs.json @@ -67,62 +67,26 @@ "docs/agents/opencode" ] }, - { - "group": "Code interpreting", - "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", - "docs/code-interpreting/contexts", - { - "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" - ] - } - ] - }, { "group": "Sandbox", "pages": [ "docs/sandbox", - "docs/sandbox/lifecycle-events-api", - "docs/sandbox/lifecycle-events-webhooks", + "docs/sandbox/lifecycle", "docs/sandbox/persistence", - "docs/sandbox/snapshots", - "docs/sandbox/auto-resume", - "docs/sandbox/git-integration", - "docs/sandbox/metrics", - "docs/sandbox/metadata", + "docs/sandbox/commands", + "docs/sandbox/cli", + "docs/sandbox/filesystem", "docs/sandbox/environment-variables", - "docs/sandbox/list", - "docs/sandbox/connect", - "docs/sandbox/internet-access", - "docs/sandbox/pty", - "docs/sandbox/ssh-access", "docs/sandbox/connect-bucket", - "docs/sandbox/rate-limits", - "docs/sandbox/secured-access", - "docs/sandbox/ip-tunneling", - "docs/sandbox/custom-domain" + "docs/sandbox/security", + "docs/sandbox/observability", + "docs/sandbox/runtime-customization", + "docs/sandbox/git-integration", + "docs/sandbox/proxy-tunneling", + "docs/sandbox/custom-domain", + "docs/sandbox/volumes", + "docs/sandbox/mcp", + "docs/sandbox/mcp/available-servers" ] }, { @@ -156,57 +120,36 @@ ] }, { - "group": "Filesystem", - "pages": [ - "docs/filesystem", - "docs/filesystem/read-write", - "docs/filesystem/info", - "docs/filesystem/watch", - "docs/filesystem/upload", - "docs/filesystem/download" - ] - }, - { - "group": "Volumes", - "pages": [ - "docs/volumes", - "docs/volumes/manage", - "docs/volumes/mount", - "docs/volumes/read-write", - "docs/volumes/info", - "docs/volumes/upload", - "docs/volumes/download" - ] - }, - { - "group": "Commands", - "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", + "group": "Code interpreting", "pages": [ - "docs/cli", - "docs/cli/auth", - "docs/cli/list-sandboxes", - "docs/cli/create-sandbox", - "docs/cli/connect-to-sandbox", - "docs/cli/exec-command", - "docs/cli/shutdown-sandboxes" + { + "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", + "docs/code-interpreting/contexts", + { + "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" + ] + } ] }, { @@ -228,6 +171,14 @@ "docs/troubleshooting/templates/49999-port-not-open", "docs/troubleshooting/pip-install-error" ] + }, + { + "group": "Page Templates (Preview)", + "pages": [ + "templates/preview-code-example", + "templates/preview-use-case", + "templates/preview-guide" + ] } ] }, @@ -3712,6 +3663,156 @@ } }, "redirects": [ + { + "source": "/docs/cli", + "destination": "/docs/sandbox/cli", + "permanent": true + }, + { + "source": "/docs/cli/auth", + "destination": "/docs/sandbox/cli", + "permanent": true + }, + { + "source": "/docs/cli/list-sandboxes", + "destination": "/docs/sandbox/cli", + "permanent": true + }, + { + "source": "/docs/cli/create-sandbox", + "destination": "/docs/sandbox/cli", + "permanent": true + }, + { + "source": "/docs/cli/connect-to-sandbox", + "destination": "/docs/sandbox/cli", + "permanent": true + }, + { + "source": "/docs/cli/exec-command", + "destination": "/docs/sandbox/cli", + "permanent": true + }, + { + "source": "/docs/cli/shutdown-sandboxes", + "destination": "/docs/sandbox/cli", + "permanent": true + }, + { + "source": "/docs/sandbox/configuration", + "destination": "/docs/sandbox/environment-variables", + "permanent": true + }, + { + "source": "/docs/filesystem", + "destination": "/docs/sandbox/filesystem", + "permanent": true + }, + { + "source": "/docs/filesystem/read-write", + "destination": "/docs/sandbox/filesystem", + "permanent": true + }, + { + "source": "/docs/filesystem/info", + "destination": "/docs/sandbox/filesystem", + "permanent": true + }, + { + "source": "/docs/filesystem/watch", + "destination": "/docs/sandbox/filesystem", + "permanent": true + }, + { + "source": "/docs/filesystem/upload", + "destination": "/docs/sandbox/filesystem", + "permanent": true + }, + { + "source": "/docs/filesystem/download", + "destination": "/docs/sandbox/filesystem", + "permanent": true + }, + { + "source": "/docs/volumes", + "destination": "/docs/sandbox/volumes", + "permanent": true + }, + { + "source": "/docs/volumes/manage", + "destination": "/docs/sandbox/volumes", + "permanent": true + }, + { + "source": "/docs/volumes/mount", + "destination": "/docs/sandbox/volumes", + "permanent": true + }, + { + "source": "/docs/volumes/read-write", + "destination": "/docs/sandbox/volumes", + "permanent": true + }, + { + "source": "/docs/volumes/info", + "destination": "/docs/sandbox/volumes", + "permanent": true + }, + { + "source": "/docs/volumes/upload", + "destination": "/docs/sandbox/volumes", + "permanent": true + }, + { + "source": "/docs/volumes/download", + "destination": "/docs/sandbox/volumes", + "permanent": true + }, + { + "source": "/docs/commands", + "destination": "/docs/sandbox/commands", + "permanent": true + }, + { + "source": "/docs/commands/streaming", + "destination": "/docs/sandbox/commands", + "permanent": true + }, + { + "source": "/docs/commands/background", + "destination": "/docs/sandbox/commands", + "permanent": true + }, + { + "source": "/docs/mcp", + "destination": "/docs/sandbox/mcp", + "permanent": true + }, + { + "source": "/docs/mcp/quickstart", + "destination": "/docs/sandbox/mcp", + "permanent": true + }, + { + "source": "/docs/mcp/available-servers", + "destination": "/docs/sandbox/mcp/available-servers", + "permanent": true + }, + { + "source": "/docs/mcp/custom-templates", + "destination": "/docs/sandbox/mcp", + "permanent": true + }, + { + "source": "/docs/mcp/custom-servers", + "destination": "/docs/sandbox/mcp", + "permanent": true + }, + { + "source": "/docs/mcp/examples", + "destination": "/docs/sandbox/mcp", + "permanent": true + }, { "source": "/docs/template/aliases", "destination": "/docs/template/names", @@ -3834,17 +3935,17 @@ }, { "source": "/docs/legacy/sandbox/api/reconnect", - "destination": "/docs/sandbox/connect", + "destination": "/docs/sandbox/lifecycle", "permanent": true }, { "source": "/docs/legacy/sandbox/api/url", - "destination": "/docs/sandbox/internet-access", + "destination": "/docs/sandbox/security", "permanent": true }, { "source": "/docs/legacy/sandbox/api/metadata", - "destination": "/docs/sandbox/metadata", + "destination": "/docs/sandbox/lifecycle", "permanent": true }, { @@ -3961,6 +4062,86 @@ "source": "/docs/git", "destination": "/docs/sandbox/git-integration", "permanent": true + }, + { + "source": "/docs/sandbox/snapshots", + "destination": "/docs/sandbox/persistence", + "permanent": true + }, + { + "source": "/docs/sandbox/auto-resume", + "destination": "/docs/sandbox/persistence", + "permanent": true + }, + { + "source": "/docs/sandbox/list", + "destination": "/docs/sandbox/lifecycle", + "permanent": true + }, + { + "source": "/docs/sandbox/connect", + "destination": "/docs/sandbox/lifecycle", + "permanent": true + }, + { + "source": "/docs/sandbox/metadata", + "destination": "/docs/sandbox/lifecycle", + "permanent": true + }, + { + "source": "/docs/sandbox/lifecycle-events-api", + "destination": "/docs/sandbox/observability", + "permanent": true + }, + { + "source": "/docs/sandbox/lifecycle-events-webhooks", + "destination": "/docs/sandbox/observability", + "permanent": true + }, + { + "source": "/docs/sandbox/metrics", + "destination": "/docs/sandbox/observability", + "permanent": true + }, + { + "source": "/docs/sandbox/secured-access", + "destination": "/docs/sandbox/security", + "permanent": true + }, + { + "source": "/docs/sandbox/internet-access", + "destination": "/docs/sandbox/security", + "permanent": true + }, + { + "source": "/docs/sandbox/rate-limits", + "destination": "/docs/sandbox/security", + "permanent": true + }, + { + "source": "/docs/sandbox/pty", + "destination": "/docs/sandbox/commands", + "permanent": true + }, + { + "source": "/docs/sandbox/ssh-access", + "destination": "/docs/sandbox/commands", + "permanent": true + }, + { + "source": "/docs/sandbox/ip-tunneling", + "destination": "/docs/sandbox/proxy-tunneling", + "permanent": true + }, + { + "source": "/docs/use-cases/agent-browser", + "destination": "/docs/use-cases/computer-use", + "permanent": true + }, + { + "source": "/docs/use-cases/browser-use", + "destination": "/docs/use-cases/computer-use", + "permanent": true } ] } diff --git a/docs/agents/amp.mdx b/docs/agents/amp.mdx index 197b7081..849b61f2 100644 --- a/docs/agents/amp.mdx +++ b/docs/agents/amp.mdx @@ -8,7 +8,7 @@ icon: "/images/icons/amp.svg" ## CLI -Create a sandbox with the [E2B CLI](/docs/cli). +Create a sandbox with the [E2B CLI](/docs/sandbox/cli). ```bash e2b sbx create amp @@ -304,7 +304,7 @@ python build.py Clone repos, manage branches, and push changes - + Connect to the sandbox via SSH for interactive sessions diff --git a/docs/agents/claude-code.mdx b/docs/agents/claude-code.mdx index 68c3423a..ddf3ae52 100644 --- a/docs/agents/claude-code.mdx +++ b/docs/agents/claude-code.mdx @@ -8,7 +8,7 @@ icon: "/images/icons/claude-code.svg" ## CLI -Create a sandbox with the [E2B CLI](/docs/cli). +Create a sandbox with the [E2B CLI](/docs/sandbox/cli). ```bash e2b sbx create claude @@ -326,7 +326,7 @@ sandbox.kill() ## 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). +Claude Code has built-in support for [MCP](https://modelcontextprotocol.io/). E2B provides an [MCP gateway](/docs/sandbox/mcp) that gives Claude access to 200+ tools from the [Docker MCP Catalog](https://hub.docker.com/mcp). ```typescript JavaScript & TypeScript @@ -447,7 +447,7 @@ python build.py ## Related guides - + Connect Claude Code to 200+ MCP tools diff --git a/docs/agents/codex.mdx b/docs/agents/codex.mdx index 7b6f854f..967a36a4 100644 --- a/docs/agents/codex.mdx +++ b/docs/agents/codex.mdx @@ -8,7 +8,7 @@ icon: "/images/icons/codex.svg" ## CLI -Create a sandbox with the [E2B CLI](/docs/cli). +Create a sandbox with the [E2B CLI](/docs/sandbox/cli). ```bash e2b sbx create codex @@ -360,7 +360,7 @@ python build.py Clone repos, manage branches, and push changes - + Connect to the sandbox via SSH for interactive sessions diff --git a/docs/agents/openclaw.mdx b/docs/agents/openclaw.mdx index 20165972..f8265a97 100644 --- a/docs/agents/openclaw.mdx +++ b/docs/agents/openclaw.mdx @@ -8,7 +8,7 @@ icon: "/images/icons/openclaw-v2.svg" ## CLI -Create a sandbox with the [E2B CLI](/docs/cli). +Create a sandbox with the [E2B CLI](/docs/sandbox/cli). ```bash e2b sbx create openclaw @@ -506,7 +506,7 @@ python build.py Clone repos, manage branches, and push changes - + Connect to the sandbox via SSH for interactive sessions diff --git a/docs/agents/opencode.mdx b/docs/agents/opencode.mdx index a5cee3b1..b09127ca 100644 --- a/docs/agents/opencode.mdx +++ b/docs/agents/opencode.mdx @@ -8,7 +8,7 @@ icon: "/images/icons/opencode.svg" ## CLI -Create a sandbox with the [E2B CLI](/docs/cli). +Create a sandbox with the [E2B CLI](/docs/sandbox/cli). ```bash e2b sbx create opencode @@ -284,7 +284,7 @@ python build.py Clone repos, manage branches, and push changes - + Connect to the sandbox via SSH for interactive sessions diff --git a/docs/billing.mdx b/docs/billing.mdx index 752646e5..4b71c21e 100644 --- a/docs/billing.mdx +++ b/docs/billing.mdx @@ -21,7 +21,7 @@ E2B uses [usage-based pricing](#usage-based-pricing) - you pay only for what you 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). -Plans have different [API rate limits](/docs/sandbox/rate-limits). +Plans have different [API rate limits](/docs/sandbox/security#rate-limits). To upgrade your plan or purchase add-ons, visit the [dashboard billing tab](https://e2b.dev/dashboard?tab=billing). For Enterprise plans, [contact sales](mailto:enterprise@e2b.dev). @@ -96,8 +96,8 @@ Check your usage and costs in the [dashboard usage tab](https://e2b.dev/dashboar - **Pause sandboxes when idle** - Use `sbx.pause()` to stop billing while keeping state available for later - **Kill sandboxes you no longer need** - Use `sbx.kill()` to stop billing and release resources permanently - **Allocate only what you need** - Start with default resources (2 vCPU, 1 GB RAM) and increase only if necessary - - **Monitor actively running sandboxes** - Use the [CLI](/docs/cli/list-sandboxes) or [dashboard](https://e2b.dev/dashboard?tab=usage) to track active sandboxes - - **Use lifecycle events** - Set up [webhooks](/docs/sandbox/lifecycle-events-webhooks) to get notified when sandboxes are created + - **Monitor actively running sandboxes** - Use the [CLI](/docs/sandbox/cli#list-sandboxes) or [dashboard](https://e2b.dev/dashboard?tab=usage) to track active sandboxes + - **Use lifecycle events** - Set up [webhooks](/docs/sandbox/observability#lifecycle-webhooks) to get notified when sandboxes are created diff --git a/docs/cli.mdx b/docs/cli.mdx deleted file mode 100644 index 25b76f6b..00000000 --- a/docs/cli.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "E2B CLI" -sidebarTitle: Installation ---- - -E2B CLI is a command line tool that allows you to manage and interact with sandboxes and [templates](/docs/template/quickstart). - -## Installation - -**Using Homebrew (on macOS)** - - -```bash Terminal -brew install e2b -``` - - -**Using NPM** - -You can install E2B CLI using the following command: - - -```bash Terminal -npm i -g @e2b/cli -``` - diff --git a/docs/cli/auth.mdx b/docs/cli/auth.mdx deleted file mode 100644 index 1ef2efa3..00000000 --- a/docs/cli/auth.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Authentication in CLI" -sidebarTitle: Authentication ---- - -There are two ways to authenticate with the E2B CLI: - -## Option 1: browser authentication - - -This option requires an interactive browser environment. - - -Run the following command to sign in through your browser: - -```bash -e2b auth login -``` - -This will open your default browser and prompt you to authenticate with your E2B account. - -## Option 2: setup environment variables - -Set your environment variables: - -```bash -export E2B_API_KEY=your_api_key_here -export E2B_ACCESS_TOKEN=your_acces_token_here -``` - - -Learn more about obtaining and managing your API key and access token on the [API Key page](/docs/api-key). - - diff --git a/docs/cli/connect-to-sandbox.mdx b/docs/cli/connect-to-sandbox.mdx deleted file mode 100644 index 4315da98..00000000 --- a/docs/cli/connect-to-sandbox.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Connect to sandbox" ---- - -You can connect an interactive terminal to an already running sandbox. - - -```bash Terminal -e2b sandbox connect -``` - - -Unlike the `create` command, `connect` does not kill the sandbox when you disconnect. When you exit the terminal, only your terminal session is closed—the sandbox continues running. - -Once connected, you can inspect the sandbox filesystem and processes to debug or experiment, or use it as a dedicated environment for running agents instead of your local computer. diff --git a/docs/cli/create-sandbox.mdx b/docs/cli/create-sandbox.mdx deleted file mode 100644 index f7e90c65..00000000 --- a/docs/cli/create-sandbox.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Create sandbox" ---- - -You can create a sandbox and connect an interactive terminal to it. - - -```bash Terminal -e2b sandbox create