From 9277f84e76c7f2444d10f1839d662e81f7dc94c0 Mon Sep 17 00:00:00 2001 From: Sree Narayanan Date: Mon, 12 Oct 2026 17:45:14 +0000 Subject: [PATCH] docs(agents): sync from rivet-dev/agents@eca7e0d Amp-Thread-ID: https://ampcode.com/threads/T-c7d08b58-92c1-4fc0-abb9-7a15f4504a4f Co-authored-by: Amp --- .../agents/docs/content/docs/quickstart.mdx | 5 +- vendor/agents/docs/content/docs/sandboxes.mdx | 51 ++++++++++--------- 2 files changed, 30 insertions(+), 26 deletions(-) diff --git a/vendor/agents/docs/content/docs/quickstart.mdx b/vendor/agents/docs/content/docs/quickstart.mdx index 83c77d13..300eadd7 100644 --- a/vendor/agents/docs/content/docs/quickstart.mdx +++ b/vendor/agents/docs/content/docs/quickstart.mdx @@ -87,15 +87,16 @@ The `prompt` action waits for the run to finish and returns `{ status, text }`. To let the agent run commands, give it a sandbox and Pi's `CodingTools`, which add `bash`: ```sh -npm add @rivet-dev/sandbox-adapter e2b +npm add @rivet-dev/sandbox-adapter ``` + -Set `E2B_API_KEY` for E2B, or install `@daytonaio/sdk` and set `DAYTONA_API_KEY` for Daytona. See [Sandboxes](/agents/docs/sandboxes). +[agentOS](/agentos/docs) needs no provider account. For E2B, install `e2b` and set `E2B_API_KEY`. For Daytona, install `@daytonaio/sdk` and set `DAYTONA_API_KEY`. See [Sandboxes](/agents/docs/sandboxes). diff --git a/vendor/agents/docs/content/docs/sandboxes.mdx b/vendor/agents/docs/content/docs/sandboxes.mdx index e6ca7415..4528d3b8 100644 --- a/vendor/agents/docs/content/docs/sandboxes.mdx +++ b/vendor/agents/docs/content/docs/sandboxes.mdx @@ -1,6 +1,6 @@ --- title: "Sandboxes" -description: "Run an agent without a sandbox, or give it a shell in E2B, Daytona, agentOS, or a sandbox provider you write." +description: "Run an agent without a sandbox, or give it a shell in agentOS, E2B, Daytona, or a sandbox provider you write." --- An agent doesn't need a sandbox. Without one, its file tools work on files in the Actor's own database. Add a sandbox only when the agent needs a shell. @@ -8,7 +8,7 @@ An agent doesn't need a sandbox. Without one, its file tools work on files in th | | Files | Shell | Setup | | --- | --- | --- | --- | | **No sandbox** | In the Actor's SQLite database | None. `bash` returns an error. | None | -| **Sandbox** | In the sandbox | `bash` runs in the sandbox | A provider account or agentOS | +| **Sandbox** | In the sandbox | `bash` runs in the sandbox | agentOS, or a provider account | ## Without a sandbox @@ -27,7 +27,7 @@ See [Built-in Tools](/agents/docs/built-in-tools) for what each tool does. When the agent needs to run commands, such as tests or a build, pass a sandbox provider. `@rivet-dev/sandbox-adapter` gives each Actor its own sandbox, and `CodingTools` run there.
- + @@ -45,9 +45,9 @@ When the agent needs to run commands, such as tests or a build, pass a sandbox p Agent Actor Sandbox adapter SandboxProvider - E2B - Daytona - agentOS + agentOS + E2B + Daytona tool calls
@@ -57,14 +57,17 @@ When the agent needs to run commands, such as tests or a build, pass a sandbox p ```sh -npm add @rivet-dev/sandbox-adapter e2b +npm add @rivet-dev/sandbox-adapter ``` - + + +agentOS needs no provider account. To use E2B or Daytona instead, see +[Providers](#providers). @@ -74,12 +77,27 @@ npm add @rivet-dev/sandbox-adapter e2b | Provider | SDK | While the Actor sleeps | When the Actor is destroyed | | --- | --- | --- | --- | +| [agentOS](/agentos/docs) | None | Sleeps when idle, and keeps its files | Left in place | | E2B | `e2b` | Paused | Deleted | | Daytona | `@daytonaio/sdk` | Stopped | Deleted | -| agentOS | None | Sleeps when idle, and keeps its files | Left in place | Provider credentials stay on your worker and never enter the sandbox. +### agentOS + +```sh +npm add @rivet-dev/sandbox-adapter +``` + + + +| Option | Description | +| --- | --- | +| `cwd` | Working directory inside the VM. Defaults to `/workspace`. | +| `software` | Packages installed when the VM is created, such as coreutils for `sh`. | + +The VM is an agentOS Actor in the `services` pool, with the key `["sandbox", ]`. It keeps its files in its own SQLite database, so they persist while the agent sleeps. The VM sleeps on its own when idle. Destroying the agent leaves the VM and its files in place. + ### E2B ```sh @@ -111,21 +129,6 @@ npm add @rivet-dev/sandbox-adapter @daytonaio/sdk The working directory is the sandbox's own working directory. A stopped sandbox is started again the next time the Actor uses it. -### agentOS - -```sh -npm add @rivet-dev/sandbox-adapter -``` - - - -| Option | Description | -| --- | --- | -| `cwd` | Working directory inside the VM. Defaults to `/workspace`. | -| `software` | Packages installed when the VM is created, such as coreutils for `sh`. | - -The VM is an agentOS Actor in the `services` pool, with the key `["sandbox", ]`. It keeps its files in its own SQLite database, so they persist while the agent sleeps. The VM sleeps on its own when idle. Destroying the agent leaves the VM and its files in place. - ## How the sandbox is managed - The sandbox is created the first time the agent needs it.