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
docs: rewrite README to follow the marketing landing page structure
- Lead with Execution, Filesystem, and Orchestration as top-level sections
- Restructure the quickstart into four numbered steps, with per-agent
install commands and a pointer to agentos-core
- Replace the why/vs-sandbox framing with runtime mechanism and a
"when to use a sandbox instead" section
- Collapse three benchmark tables into one, linking out for methodology
- Fold the feature list into a documentation index
- Fix dead links: /docs/benchmarks, /docs/js-runtime; drop /docs/webhooks
Give agents an operating system as a library.<br/>92x faster cold starts, 47x less memory, 254x cheaper than sandboxes.<br/>Built-in ACP agents: Pi, Claude Code, Codex, and OpenCode
6
+
Give agents an operating system as a library.<br/>
7
+
Each agent gets a POSIX filesystem, real process execution, and orchestration —<br/>
8
+
inside your existing backend process. No microVMs, no containers, no separate service.
<ahref="#benchmarks">254x cheaper</a> than sandboxes
11
15
</p>
12
16
13
-
14
-
## Why agentOS
15
-
16
-
-**Runs inside your process**: No microVMs to boot, no containers to pull, no nested virtualization. Warm VM creation takes single-digit milliseconds and each VM costs tens of megabytes.
17
-
-**Embeds in your backend**: Agents call your functions directly via [bindings](https://agentos-sdk.dev/docs/bindings) — ordinary JavaScript calls, not another network service. Credentials stay on the host; agents see only inputs and outputs.
18
-
-**Granular security**: [Permissions](https://agentos-sdk.dev/docs/permissions) gate filesystem, network, process, and environment access, with outward-facing capabilities like network egress denied by default. Guest JavaScript runs in V8 isolates and compiled tools run as WebAssembly, all inside one compact runtime.
19
-
-**Deploy anywhere**: Just an npm package. Run locally with `npx rivetkit dev`, then deploy to [Rivet Cloud](https://agentos-sdk.dev/docs/deployment) for managed infrastructure or self-host on your own.
20
-
-**Open source**: Apache 2.0 licensed.
21
-
22
-
### agentOS vs Sandbox
23
-
24
-
agentOS is a lightweight VM that runs inside your process. Sandboxes are full Linux environments. agentOS integrates agents into your backend with [bindings](https://agentos-sdk.dev/docs/bindings) and granular permissions. Sandboxes give you a full OS for browsers, native binaries, and dev servers.
25
-
26
-
You don't have to choose: agentOS works with sandboxes through [sandbox mounting](https://agentos-sdk.dev/docs/sandbox), spinning up a full sandbox on demand and mounting the sandbox's file system when the workload needs it.
27
-
28
-
See [agentOS vs Sandbox](https://agentos-sdk.dev/docs/versus-sandbox) for a full comparison.
Common POSIX utilities (coreutils, sed, grep, gawk, findutils, diffutils, tar, gzip) ship out of the box. [Claude Code](https://agentos-sdk.dev/docs/agents/claude), [Codex](https://agentos-sdk.dev/docs/agents/codex), and [OpenCode](https://agentos-sdk.dev/docs/agents/opencode) install the same way as Pi.
38
+
Common POSIX utilities ship in the box. More agents and software in the
39
+
[registry](https://agentos-sdk.dev/registry).
40
+
41
+
### 2. Set up the server
37
42
38
-
Create the server:
43
+
Everything you installed gets passed to `software`:
- Bash, Node.js, Python, and registry software, all in the same VM
120
+
- Real processes, subprocesses, shells, and in-VM servers
121
+
- JavaScript runs on native V8 with the full JIT — not JavaScript compiled to WebAssembly
98
122
99
123
```ts
100
-
// Node.js
101
124
awaithandle.writeFile("/hello.mjs", 'import fs from "fs"; fs.writeFileSync("/out.txt", "hi")');
102
125
awaithandle.exec("node /hello.mjs");
103
126
104
-
// Bash
105
127
const result =awaithandle.exec("cat /out.txt");
106
128
console.log(result.stdout); // "hi"
107
129
```
108
130
109
-
`@rivet-dev/agentos` runs each VM as a Rivet Actor with built-in persistence, sleep/wake, multiplayer, preview URLs, and orchestration. For direct in-process VM control without the actor runtime, use [`@rivet-dev/agentos-core`](https://agentos-sdk.dev/docs/core) standalone: `AgentOs.create()` boots a VM and returns a handle you call directly.
See the [Quickstart guide](https://agentos-sdk.dev/docs/quickstart) for the full walkthrough. agentOS is in preview and the API is subject to change — questions and issues welcome on [Discord](https://rivet.dev/discord).
136
+
## Filesystem
112
137
113
-
## Benchmarks
138
+
- A persistent POSIX filesystem per agent
139
+
- Mount S3-compatible storage, Google Drive, host directories, or in-memory volumes at ordinary paths
140
+
- Attach mounts at boot or dynamically at runtime
141
+
- Normal files and shell tools work against all of it
114
142
115
-
All benchmarks compare agentOS against the fastest/cheapest mainstream sandbox providers as of March 30, 2026. Methodology and reproduction steps: [Benchmarks](https://agentos-sdk.dev/docs/benchmarks).
-**Built-in agents**: Run [Pi](https://agentos-sdk.dev/docs/agents/pi), [Claude Code](https://agentos-sdk.dev/docs/agents/claude) (beta), [Codex](https://agentos-sdk.dev/docs/agents/codex) (beta), and [OpenCode](https://agentos-sdk.dev/docs/agents/opencode) with a unified API, or [bring your own agent](https://agentos-sdk.dev/docs/agents/custom)
162
-
-**[Sessions via ACP](https://agentos-sdk.dev/docs/sessions)**: Create, manage, and resume agent sessions over the [Agent Client Protocol](https://agentclientprotocol.com)
163
-
-**Universal transcript format**: One transcript format across all agents for debugging, auditing, and comparison
164
-
-**[Automatic persistence](https://agentos-sdk.dev/docs/persistence)**: Every conversation is saved and replayable without extra code
165
-
-**Framework integrations**: Use agentOS as the sandbox backend for [Vercel Eve](https://agentos-sdk.dev/docs/frameworks/vercel-eve) (beta) and [Flue](https://agentos-sdk.dev/docs/frameworks/flue) (beta)
166
-
167
-
### Infrastructure
168
-
-**[Execution](https://agentos-sdk.dev/docs/processes)**: Run Bash, Node.js, Python, and registry software inside the VM with real processes, subprocesses, shells, and in-VM servers
169
-
-**[Mount external storage as a filesystem](https://agentos-sdk.dev/docs/filesystem)**: S3-compatible storage, Google Drive, host directories, or in-memory mounts, attached at boot or dynamically at runtime
170
-
-**[Bindings](https://agentos-sdk.dev/docs/bindings)**: Define JavaScript functions that agents call as CLI commands inside the VM
171
-
-**[Cron](https://agentos-sdk.dev/docs/cron) and [webhooks](https://agentos-sdk.dev/docs/webhooks)**: Schedule tasks with built-in cron jobs, and trigger agents from external webhooks with your own HTTP server
172
-
-**[Browser](https://agentos-sdk.dev/docs/browser)** (beta): Give agents a cloud browser via Browserbase
173
-
-**[Sandbox mounting](https://agentos-sdk.dev/docs/sandbox)** (beta): Pair with full sandboxes (E2B, Daytona, etc.) for heavy workloads like browsers or native compilation
174
-
175
-
### Orchestration
176
-
-**[Multiplayer](https://agentos-sdk.dev/docs/multiplayer)**: Multiple clients observe and collaborate with the same agent in real time
177
-
-**[Agent-to-agent](https://agentos-sdk.dev/docs/agent-to-agent)**: Agents delegate work to other agents through host-defined bindings
178
-
-**[Workflows](https://agentos-sdk.dev/docs/workflows)**: Chain agent tasks into durable workflows with retries, branching, and resumable execution
179
-
-**[Authentication](https://agentos-sdk.dev/docs/authentication)**: Integrate with your existing auth model (API keys, OAuth, JWTs)
180
-
181
-
### Security
182
-
-**[Granular permissions](https://agentos-sdk.dev/docs/permissions)**: Control filesystem, network, process, and environment access, with outward-facing capabilities denied by default
183
-
-**[Programmatic network control](https://agentos-sdk.dev/docs/networking)**: Allow or deny any outbound connection with per-host rules, and proxy HTTP into VM services with preview URLs
184
-
-**[Resource limits](https://agentos-sdk.dev/docs/resource-limits)**: Set precise CPU and memory limits per agent
185
-
-**[VM isolation](https://agentos-sdk.dev/docs/security-model)**: Each agent runs in its own VM with no shared state
186
-
187
-
## Architecture
198
+
## Registry
188
199
189
-
agentOS runs each agent in a fully virtualized VM. A trusted sidecar process owns every VM's kernel — virtual filesystem, process table, pipes, PTYs, and a virtual network stack — and brokers every guest syscall; nothing the guest does touches the host directly: no real host filesystem, no real host sockets, no real host processes. Guest JavaScript runs on native V8 with its full JIT ([JavaScript runtime](https://agentos-sdk.dev/docs/js-runtime)), and compiled tools run as WebAssembly. Many VMs share one sidecar process, so each additional VM costs a V8 isolate plus kernel state, not an OS process. With `@rivet-dev/agentos`, each VM is a Rivet Actor with durable state.
200
+
- Agents, browsers, and software install from npm under `@agentos-software/*` → `software: [...]`
201
+
- Filesystem plugins need no install → `mounts: [...]`
190
202
191
-
See the [Architecture docs](https://agentos-sdk.dev/docs/architecture) for details.
203
+
[Browse the registry](https://agentos-sdk.dev/registry)
192
204
193
-
## Registry
205
+
## Benchmarks
194
206
195
-
Extend agentOS with agents, filesystems, browsers, and software from one registry. Browse the full catalog at the [agentOS Registry](https://agentos-sdk.dev/registry).
207
+
Measured against the fastest and cheapest mainstream sandbox providers as of March 30, 2026.
196
208
197
-
Common POSIX utilities ship out of the box. The registry adds agents (`@agentos-software/pi`, `@agentos-software/claude-code`, `@agentos-software/codex`, `@agentos-software/opencode`), command packages (`git`, `ripgrep`, `jq`, `sqlite3`, `duckdb`, `curl`, `vim`, and more), meta-packages (`common`, `build-essential`, `everything`), and integrations like the Browserbase cloud browser. Install any of them from npm and pass them via `software: [...]`.
209
+
|| agentOS | Sandbox ||
210
+
|---|---|---|---|
211
+
| Cold start (p50) | 4.8 ms | 440 ms (E2B) |**92x faster**|
0 commit comments