Skip to content

Commit ece183a

Browse files
committed
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
1 parent 36843a8 commit ece183a

1 file changed

Lines changed: 196 additions & 100 deletions

File tree

README.md

Lines changed: 196 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,44 @@
33
</p>
44

55
<p align="center">
6-
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.
79
</p>
810

911
<p align="center">
10-
<a href="https://agentos-sdk.dev/docs">Documentation</a> | <a href="https://agentos-sdk.dev/docs/quickstart">Quickstart</a> | <a href="https://agentos-sdk.dev/registry">Registry</a> | <a href="https://rivet.dev/discord">Discord</a>
12+
<a href="#benchmarks">92x faster cold starts</a> ·
13+
<a href="#benchmarks">47x less memory</a> ·
14+
<a href="#benchmarks">254x cheaper</a> than sandboxes
1115
</p>
1216

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.
17+
<p align="center">
18+
<a href="https://agentos-sdk.dev/docs">Documentation</a> |
19+
<a href="https://agentos-sdk.dev/docs/quickstart">Quickstart</a> |
20+
<a href="https://agentos-sdk.dev/registry">Registry</a> |
21+
<a href="https://rivet.dev/discord">Discord</a>
22+
</p>
2923

3024
## Quick start
3125

26+
### 1. Install agentOS and the agents you want
27+
3228
```bash
33-
npm install @rivet-dev/agentos @agentos-software/pi
29+
npm install @rivet-dev/agentos
30+
31+
# One package per agent — install as many as you need
32+
npm install @agentos-software/pi # Pi
33+
npm install @agentos-software/claude-code # Claude Code (beta)
34+
npm install @agentos-software/codex # Codex (beta)
35+
npm install @agentos-software/opencode # OpenCode
3436
```
3537

36-
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
3742

38-
Create the server:
43+
Everything you installed gets passed to `software`:
3944

4045
```ts
4146
// server.ts
@@ -50,7 +55,9 @@ export const registry = setup({ use: { vm } });
5055
registry.start();
5156
```
5257

53-
Create the client — any public frontend or another backend:
58+
### 3. Connect to agentOS
59+
60+
The client is any public frontend or another backend:
5461

5562
```ts
5663
// client.ts
@@ -79,122 +86,211 @@ await handle.prompt({
7986
],
8087
});
8188

82-
// Read the file the agent created
89+
// Read the file the agent created.
8390
const content = await handle.readFile("/workspace/hello.js");
8491
console.log(new TextDecoder().decode(content));
8592
```
8693

87-
Run both:
88-
8994
```bash
90-
# Terminal 1: start the server
91-
npx tsx server.ts
95+
npx tsx server.ts # terminal 1
96+
npx tsx client.ts # terminal 2
97+
```
9298

93-
# Terminal 2: run the client
94-
npx tsx client.ts
99+
Each VM is a Rivet Actor, which is where persistence, sleep/wake, multiplayer, preview URLs, and
100+
orchestration come from.
101+
102+
### Alternative: `@rivet-dev/agentos-core`
103+
104+
```bash
105+
npm install @rivet-dev/agentos-core
95106
```
96107

97-
agentOS can run Node.js and shell scripts inside the VM:
108+
- Direct in-process VM control — `AgentOs.create()` returns a handle you call directly
109+
- No actor runtime, no server, no client
110+
- Trades away the Rivet Actor features above
111+
112+
[Direct VM API](https://agentos-sdk.dev/docs/core)
113+
114+
Full walkthrough: [Quickstart](https://agentos-sdk.dev/docs/quickstart) ·
115+
[Crash Course](https://agentos-sdk.dev/docs/crash-course)
116+
117+
## Execution
118+
119+
- 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
98122

99123
```ts
100-
// Node.js
101124
await handle.writeFile("/hello.mjs", 'import fs from "fs"; fs.writeFileSync("/out.txt", "hi")');
102125
await handle.exec("node /hello.mjs");
103126

104-
// Bash
105127
const result = await handle.exec("cat /out.txt");
106128
console.log(result.stdout); // "hi"
107129
```
108130

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.
131+
[Bash](https://agentos-sdk.dev/docs/bash) ·
132+
[Node.js](https://agentos-sdk.dev/docs/javascript) ·
133+
[Python](https://agentos-sdk.dev/docs/python) ·
134+
[Processes & shells](https://agentos-sdk.dev/docs/processes)
110135

111-
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
112137

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
114142

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).
143+
[Filesystem](https://agentos-sdk.dev/docs/filesystem) ·
144+
[Software](https://agentos-sdk.dev/docs/software) ·
145+
[Persistence & sleep](https://agentos-sdk.dev/docs/persistence)
116146

117-
### Cold start
147+
## Orchestration
118148

119-
| Percentile | agentOS | Fastest Sandbox (E2B) | Speedup |
120-
|---|---|---|---|
121-
| p50 | 4.8 ms | 440 ms | **92x faster** |
122-
| p95 | 5.6 ms | 950 ms | **170x faster** |
123-
| p99 | 6.1 ms | 3,150 ms | **516x faster** |
149+
- Durable sessions — persist across restarts, sleep when idle, wake with state intact
150+
- Run recurring jobs on a cron schedule
151+
- Delegate work from one agent to another
152+
- Share one live session across many connected clients
153+
- Pause for human approval before a tool call runs
124154

125-
<sub>agentOS: measured on Intel i7-12700KF. Sandbox baseline: E2B, the fastest mainstream sandbox provider as of March 30, 2026.</sub>
155+
[Workflows & graphs](https://agentos-sdk.dev/docs/workflows) ·
156+
[Multiplayer](https://agentos-sdk.dev/docs/multiplayer) ·
157+
[Agent-to-agent](https://agentos-sdk.dev/docs/agent-to-agent) ·
158+
[Crons & loops](https://agentos-sdk.dev/docs/cron) ·
159+
[Approvals](https://agentos-sdk.dev/docs/approvals) ·
160+
[Apps](https://agentos-sdk.dev/docs/apps)
126161

127-
### Memory per instance
162+
## Agents
128163

129-
| Workload | agentOS | Cheapest Sandbox (Daytona) | Reduction |
130-
|---|---|---|---|
131-
| Full coding agent (Pi + MCP + filesystem) | ~131 MB | ~1,024 MB | **8x smaller** |
132-
| Simple shell command | ~22 MB | ~1,024 MB | **47x smaller** |
133-
134-
<sub>Sandbox baseline: Daytona minimum instance (1 vCPU + 1 GiB RAM), the cheapest mainstream sandbox provider as of March 30, 2026.</sub>
164+
[Pi](https://agentos-sdk.dev/docs/agents/pi) ·
165+
[Claude Code](https://agentos-sdk.dev/docs/agents/claude) (beta) ·
166+
[Codex](https://agentos-sdk.dev/docs/agents/codex) (beta) ·
167+
[OpenCode](https://agentos-sdk.dev/docs/agents/opencode) ·
168+
[custom agents](https://agentos-sdk.dev/docs/agents/custom) ·
169+
[Vercel Eve](https://agentos-sdk.dev/docs/frameworks/vercel-eve) (beta) ·
170+
[Flue](https://agentos-sdk.dev/docs/frameworks/flue) (beta) ·
171+
[Rivet](https://agentos-sdk.dev/docs/frameworks/rivet)
135172

136-
### Cost per execution-second (self-hosted)
173+
- One API for all of them, over the [Agent Client Protocol](https://agentclientprotocol.com)
174+
- [One transcript format](https://agentos-sdk.dev/docs/sessions) for debugging, auditing, and comparison
137175

138-
Full coding agent:
176+
## Runtime
139177

140-
| Host tier | agentOS | Cheapest Sandbox (Daytona) | Difference |
141-
|---|---|---|---|
142-
| AWS ARM | $0.00000058/s | $0.000018/s | **32x cheaper** |
143-
| AWS x86 | $0.00000072/s | $0.000018/s | **26x cheaper** |
144-
| Hetzner ARM | $0.000000066/s | $0.000018/s | **281x cheaper** |
145-
| Hetzner x86 | $0.00000011/s | $0.000018/s | **171x cheaper** |
178+
A trusted sidecar process owns every VM's kernel and brokers every guest syscall:
146179

147-
Simple shell command:
180+
- Kernel owns the virtual filesystem, process table, pipes, PTYs, and network stack
181+
- No host filesystem, host sockets, or host processes are reachable from the guest
182+
- Guest JavaScript runs in V8 isolates; compiled tools run as WebAssembly
183+
- An additional VM costs an isolate plus kernel state — not an OS process or a microVM
148184

149-
| Host tier | agentOS | Cheapest Sandbox (Daytona) | Difference |
150-
|---|---|---|---|
151-
| AWS ARM | $0.000000073/s | $0.000018/s | **254x cheaper** |
152-
| AWS x86 | $0.000000090/s | $0.000018/s | **205x cheaper** |
153-
| Hetzner ARM | $0.000000011/s | $0.000018/s | **1738x cheaper** |
154-
| Hetzner x86 | $0.000000017/s | $0.000018/s | **1061x cheaper** |
185+
That boundary is where policy is enforced:
155186

156-
<sub>Sandbox baseline: Daytona at $0.0504/vCPU-h + $0.0162/GiB-h (1 vCPU + 1 GiB minimum). Assumes one agent per sandbox and 70% host utilization.</sub>
187+
- **[Permissions](https://agentos-sdk.dev/docs/permissions)** gate filesystem, network, process,
188+
and environment access. Outward-facing capabilities like network egress are denied by default.
189+
- **[Resource limits](https://agentos-sdk.dev/docs/resource-limits)** cap CPU, memory, processes,
190+
files, and sockets per VM.
191+
- **[Bindings](https://agentos-sdk.dev/docs/bindings)** expose host functions as CLI commands, so
192+
credentials stay on the host and the agent sees only inputs and outputs.
157193

158-
## Features
194+
[Architecture](https://agentos-sdk.dev/docs/architecture) ·
195+
[Security model](https://agentos-sdk.dev/docs/security-model) ·
196+
[Networking & previews](https://agentos-sdk.dev/docs/networking)
159197

160-
### Agents
161-
- **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
188199

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: [...]`
190202

191-
See the [Architecture docs](https://agentos-sdk.dev/docs/architecture) for details.
203+
[Browse the registry](https://agentos-sdk.dev/registry)
192204

193-
## Registry
205+
## Benchmarks
194206

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.
196208

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** |
212+
| Memory per instance | ~22 MB | ~1,024 MB (Daytona) | **47x smaller** |
213+
| Cost per execution-second | $0.000000073/s | $0.000018/s (Daytona) | **254x cheaper** |
214+
215+
<sub>agentOS cold start measured on Intel i7-12700KF. Memory and cost use the shell workload; a full
216+
coding agent (Pi + MCP + filesystem) is ~131 MB. Cost is self-hosted on AWS ARM at 70% utilization
217+
against Daytona's 1 vCPU + 1 GiB minimum.</sub>
218+
219+
Percentiles, per-workload figures, host tiers, and reproduction steps:
220+
[Performance](https://agentos-sdk.dev/docs/performance)
221+
222+
## When to use a sandbox instead
223+
224+
- **agentOS** — a lightweight VM inside your process, for embedding agents in a backend with
225+
bindings and granular permissions
226+
- **Sandboxes** — full Linux environments, a better fit for native binaries, browsers, and dev servers
227+
- **Both**[sandbox mounting](https://agentos-sdk.dev/docs/sandbox) spins up a sandbox on demand
228+
and mounts its filesystem into the VM
229+
230+
[agentOS vs Sandbox](https://agentos-sdk.dev/docs/versus-sandbox) ·
231+
[Limitations](https://agentos-sdk.dev/docs/limitations)
232+
233+
## Documentation
234+
235+
**Getting Started**
236+
[Quick Start](https://agentos-sdk.dev/docs/quickstart) ·
237+
[Crash Course](https://agentos-sdk.dev/docs/crash-course)
238+
239+
**Agents**
240+
[Pi](https://agentos-sdk.dev/docs/agents/pi) ·
241+
[Claude Code](https://agentos-sdk.dev/docs/agents/claude) ·
242+
[Codex](https://agentos-sdk.dev/docs/agents/codex) ·
243+
[OpenCode](https://agentos-sdk.dev/docs/agents/opencode) ·
244+
[Flue](https://agentos-sdk.dev/docs/frameworks/flue) ·
245+
[Eve](https://agentos-sdk.dev/docs/frameworks/vercel-eve)
246+
247+
**Execution**
248+
[Bash](https://agentos-sdk.dev/docs/bash) ·
249+
[Node.js](https://agentos-sdk.dev/docs/javascript) ·
250+
[Python](https://agentos-sdk.dev/docs/python)
251+
252+
**Orchestration**
253+
[Apps](https://agentos-sdk.dev/docs/apps) ·
254+
[Multiplayer](https://agentos-sdk.dev/docs/multiplayer) ·
255+
[Workflows](https://agentos-sdk.dev/docs/workflows) ·
256+
[Crons](https://agentos-sdk.dev/docs/cron) ·
257+
[Agent-to-Agent](https://agentos-sdk.dev/docs/agent-to-agent)
258+
259+
**Operating System**
260+
[Software](https://agentos-sdk.dev/docs/software) ·
261+
[Filesystem](https://agentos-sdk.dev/docs/filesystem) ·
262+
[Networking](https://agentos-sdk.dev/docs/networking) ·
263+
[Permissions](https://agentos-sdk.dev/docs/permissions) ·
264+
[Resource Limits](https://agentos-sdk.dev/docs/resource-limits)
265+
266+
**Extension**
267+
[Custom Bindings](https://agentos-sdk.dev/docs/bindings) ·
268+
[Browser Automation](https://agentos-sdk.dev/docs/browser) ·
269+
[External Sandboxes](https://agentos-sdk.dev/docs/sandboxes)
270+
271+
**Reference**
272+
[Deploy](https://agentos-sdk.dev/docs/deployment) ·
273+
[Custom Software](https://agentos-sdk.dev/docs/custom-software/definition)
274+
275+
**Architecture**
276+
[Overview](https://agentos-sdk.dev/docs/architecture) ·
277+
[Security Model](https://agentos-sdk.dev/docs/security-model) ·
278+
[Limitations](https://agentos-sdk.dev/docs/limitations)
279+
280+
**More**
281+
[Sessions & Transcripts](https://agentos-sdk.dev/docs/sessions) ·
282+
[Approvals](https://agentos-sdk.dev/docs/approvals) ·
283+
[Models & Credentials](https://agentos-sdk.dev/docs/models-and-credentials) ·
284+
[Authentication](https://agentos-sdk.dev/docs/authentication) ·
285+
[Persistence & Sleep](https://agentos-sdk.dev/docs/persistence) ·
286+
[Direct VM API](https://agentos-sdk.dev/docs/core) ·
287+
[Debugging](https://agentos-sdk.dev/docs/debugging)
288+
289+
## Deploy
290+
291+
- **Library**`npm install` and run in your process. No servers. [Quickstart](https://agentos-sdk.dev/docs/quickstart)
292+
- **Rivet Cloud** — managed agentOS with BYOC support. [Dashboard](https://dashboard.rivet.dev)
293+
- **Self-host** — Kubernetes, VMs, or bare metal. [Deployment docs](https://agentos-sdk.dev/docs/deployment)
198294

199295
## License
200296

0 commit comments

Comments
 (0)