You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- local-sandboxes.mdx: drop bare 'ephemeral' framing in the opening
paragraph; clarify that closing the pane ends the session but the
stopped container persists on disk. Tighten the rollout note. Reword
the 'unfamiliar repo' bullet so it doesn't imply Warp mounts the
user's checkout. Collapse the two prerequisites into a single Docker
prerequisite plus an actionable PATH troubleshooting note (no
internals leak). Switch the '+' UI label from backticks to bold per
the docs style guide. Consolidate the 'Bash shell' bullets and
rewrite the 'Cloned repositories, when you add them' bullet to read
cleaner. Reword the cleanup limitation to warn that 'docker
container prune' removes *all* stopped containers, and recommend
'docker ps -a' + 'docker rm <container>' for surgical removal.
- security-overview.mdx: replace 'Sandboxes are ephemeral' with copy
that distinguishes fresh-launch behavior from stopped-container
on-disk persistence so the security overview no longer overstates
the data-retention guarantee.
Addresses bot review on PR #89:
- 3255792999 (security-overview 'ephemeral' overstatement)
- 3255793000 ('docker container prune' scope warning)
- 3255793001 (non-actionable helper PATH prerequisite)
Co-Authored-By: Oz <oz-agent@warp.dev>
Copy file name to clipboardExpand all lines: src/content/docs/agent-platform/local-agents/local-sandboxes.mdx
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,18 +9,18 @@ sidebar:
9
9
10
10
A **Local Sandbox** is an isolated shell session that runs in a container on your local machine, so the agent (and any commands you run alongside it) can't see or write to your home directory or current repository by default. Use it to try unfamiliar tooling, run risky setup steps, or hand a long-running task to an agent without giving it access to your personal files.
11
11
12
-
Local Sandboxes are powered by Docker. Each sandbox is a fresh, ephemeral container; closing the pane ends the session.
12
+
Local Sandboxes are powered by Docker. Each launch starts in a freshcontainer with an empty workspace. Closing the pane ends the sandbox session, but the stopped container remains on disk until you remove it — see [Limitations](#limitations).
13
13
14
14
:::note
15
-
Local Sandboxes are rolling out gradually. The entry points below may not be visible in every build yet.
15
+
The entry points below may not be visible to every user yet.
16
16
:::
17
17
18
18
## When to use a local sandbox
19
19
20
20
Reach for a Local Sandbox when you want isolation without leaving your machine:
21
21
22
22
***Try risky commands** - Run setup scripts, package installs, or experimental tooling without polluting your host environment.
23
-
***Hand a task to an agent against an unfamiliar repo** - Give the agent room to clone, build, and run code without exposing your existing checkout.
23
+
***Give an agent a clean container** - Let the agent clone, build, and run code in a fresh workspace, instead of touching your existing checkout.
24
24
***Test a clean toolchain** - Reproduce a "fresh box" so you can see what your project actually needs to bootstrap.
25
25
***Isolate experiments from your local working tree** - Keep half-finished work and uncommitted changes from leaking into the next thing you try.
26
26
@@ -38,7 +38,8 @@ Each Local Sandbox is a fresh Docker container with a bash shell:
38
38
## Prerequisites
39
39
40
40
***Docker installed and running locally** - Warp uses Docker to create the sandbox container. Install Docker Desktop (or your distribution's Docker engine) and confirm `docker info` succeeds before launching a sandbox.
41
-
***Warp's local sandbox helper available on `PATH`** - Warp invokes a bundled helper to drive the container lifecycle. The helper must be on the `PATH` that your interactive shell sees, not just the `PATH` your GUI launcher provides. If launching the sandbox fails with a "binary not found" error, open a regular Warp terminal and confirm the helper resolves there before retrying.
41
+
42
+
Warp resolves the container tooling it needs from your interactive shell `PATH`. If launching a sandbox fails with a "binary not found" error, confirm Docker is running and relaunch Warp from a terminal so it inherits your full `PATH`.
42
43
43
44
## Starting a local sandbox
44
45
@@ -50,7 +51,7 @@ In any local terminal session, type `/docker-sandbox` and submit. Warp opens a n
50
51
51
52
### New-session menu
52
53
53
-
Open the new-session dropdown (the `+` button next to the tab bar) and choose **Local Docker Sandbox**. Warp opens a new tab running the sandbox.
54
+
Open the new-session dropdown (the **+** button next to the tab bar) and choose **Local Docker Sandbox**. Warp opens a new tab running the sandbox.
54
55
55
56
### Default for new sessions
56
57
@@ -65,9 +66,9 @@ The same setting is also available in the Warp app under **Settings** > **Featur
65
66
66
67
## What's available inside the sandbox
67
68
68
-
***Bash shell** - A standard bash environment is the starting point. Install whatever tooling you need for the task at hand; changes stay inside the container.
69
69
***Agent conversations** - Start an agent conversation inside the sandbox the same way you would in any other terminal session. The agent's actions are scoped to the container.
70
-
***Cloned repositories, when you add them** - The sandbox doesn't mount your local checkout. Clone any code you want to work with (for example, `git clone <repo-url>`) from inside the sandbox.
70
+
***Whatever you install** - Run `apt-get`, `npm install`, `pip install`, or any other tooling from the bash shell. Changes stay inside the container.
71
+
***Code you clone in** - The sandbox doesn't mount your local checkout. Use `git clone <repo-url>` (or copy files in via `docker cp`) to bring code into the sandbox.
71
72
72
73
## Limitations
73
74
@@ -76,7 +77,7 @@ Local Sandboxes have a few constraints to be aware of today:
76
77
***Local sessions only** - Local Sandboxes aren't available inside remote SSH sessions or in Warp's web client.
77
78
***Empty workspace by default** - The sandbox starts in an empty directory. Your local repo isn't mounted in; clone it (or any other code) from inside the sandbox if you need it there.
78
79
***CLI agent plugin install uses the manual flow** - Third-party CLI agent plugin installers run against the host shell, not the container. Inside a sandbox session, Warp shows the manual install instructions so you can run them inside the container yourself.
79
-
***No automatic cleanup on close** - Closing a sandbox pane stops the session but doesn't remove the underlying container. Stopped sandbox containers stay on disk until you remove them; run`docker containerprune`if you want to free up the space.
80
+
***No automatic cleanup on close** - Closing a sandbox pane stops the session but doesn't remove the underlying container. Stopped sandbox containers stay on disk until you remove them. Use`docker ps -a` to list stopped containers and `docker rm <container>` to remove specific ones. `docker container prune`also works, but it removes **all** stopped containers on your machine, not only sandbox containers — use it only if you're comfortable with that scope.
Copy file name to clipboardExpand all lines: src/content/docs/enterprise/security-and-compliance/security-overview.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -175,7 +175,7 @@ See [Bring Your Own LLM](/enterprise/enterprise-features/bring-your-own-llm/) fo
175
175
176
176
### Local Sandboxes
177
177
178
-
Run agent conversations and terminal commands in an isolated Docker container on the developer's machine, so the agent can't see or write to the host home directory or current repository by default. Sandboxes are ephemeral — each new sandbox starts in a fresh container with an empty workspace.
178
+
Run agent conversations and terminal commands in an isolated Docker container on the developer's machine, so the agent can't see or write to the host home directory or current repository by default. Each sandbox launches in a fresh container with an empty workspace; stopped containers persist on disk until they're removed via Docker.
179
179
180
180
See [Local Sandboxes](/agent-platform/local-agents/local-sandboxes/) for details and setup.
0 commit comments