Repository files navigation

sandbox

MicroVM sandboxes for AI agents, built on cocoon: a fast-boot guest stack, an in-guest product daemon, a per-node control plane with warm pools, and a Go SDK. Warm claims are sub-millisecond; a pool miss clones from a golden snapshot in tens of milliseconds; cold boot is ~200ms on bare metal.

SDK (Go) sandboxd (per node) guest microVM
sandbox.New() ── HTTP ─► claim: warm pool / golden clone Cloud Hypervisor
sb.Exec/Files/… ─ HTTP upgrade ─► byte relay ── vsock ──► silkd :2048
memberlist mesh: warm-count gossip,
MOVED-style redirect to the owning node

Cloud Hypervisor serves both network lanes. net=none has no NIC and uses vsock-only I/O (hardened default); net=egress attaches a bridge/CNI NIC.

Documentation: cocoonstack.github.io/sandbox (deployment, clusters, HTTP API, Go + Python SDK references, the MCP server, the OpenAI Agents SDK and LangChain adapters, silkd protocol, performance) — source in docs/.

Layout

  • silkd/ — in-guest product daemon (Rust, tokio): exec with context, persistent shell sessions, streaming fs, tar-stream tree push/pull, find/replace, watch (ready-acked), pty, structured git, guest port relay (port_forward), and an LSP broker for flavor-shipped language servers — newline-JSON frames over vsock 2048, one connection per RPC; baked into the base image
  • sandboxd/ — per-node control plane (Go): warm pools refilled from golden snapshot exports (online-retunable), claim/release/hibernate/fork/promote/ checkpoint HTTP API, operator-catalog dataset volumes (read-only or writable), signed preview URLs, the HTTP-upgrade byte relay to silkd, usage + audit journals, /metrics, reap + restart reconcile, memberlist mesh with redirect placement
  • sdk/go/ — Go SDK: Connect/New/Lookup, Exec/Run, files, Push/Pull, sessions, Find/Replace, Watch, git verbs, OpenPty, Fork/Hibernate/Promote/Checkpoint, DialPort/ProxyPort/PreviewURL, StartLsp, Spawn/Ps/Kill/Logs/Attach; protocol/wire carries the frame vocabulary, sdk/go/silkd the conn layer, silkdtest a test fake
  • sdk/python/ — Python SDK (stdlib-only, sync), matching the Go guest and data-plane surface for the Python-first agent ecosystem; node pool retuning remains Go-only; round-trips the shared fixture corpus
  • mcp/sandbox-mcp, an MCP stdio server exposing the surface as tools for Claude Code / Cursor / agent frameworks
  • sdk/openai/cocoonstack-sandbox-openai, a custom sandbox provider for the OpenAI Agents SDK (Python, over the Python SDK)
  • sdk/langchain/cocoonstack-sandbox-langchain, a LangChain toolkit (StructuredTools over the Python SDK, checkpoint branching)
  • protocol/wire/fixtures/ — golden frame corpus; the Rust, Go, and Python protocol tests all round-trip it, so wire drift fails CI
  • e2e/ — in-process full-stack tests (real pool/engine/relay/SDK, fake cocoon+guest) plus bare-metal acceptance drivers under cmd/: demo, smoke, meshsmoke, crossnode, coldproof, egresssmoke, interceptsmoke, volumesmoke, lifecycle (idle→hibernate→archive), androidsmoke, browsersmoke, and the pullbench/pushbench/rpcbench perf drivers
  • boot/kernel/ — kernel version pin (VERSION + matching tarball SHA256, bump both together) + config fragment (amd64: over x86_64_defconfig + kvm_guest.config; arm64: over defconfig, then sandbox-arm64.config)
  • boot/init/sandbox-init, the entire initramfs userland (Rust, static musl build)
  • boot/Dockerfile — multi-stage: kernel → init → cpio → scratch image with /boot/vmlinuz-sandbox + /boot/initrd.img-sandbox
  • os-image/ — VM images consuming the boot artifact: base (layered, for builds), rt (base squashed to one layer — the default template in examples), python, python-rt, browser, and android
  • scripts/boot-bench.sh (boot phase timing), bench.sh (the published benchmark procedure), sandboxd-e2e.sh (bare-metal e2e, below), plus the archive/egress/intercept e2e drivers

Build & test

make help# this list
make lint test# Rust: boot/init + silkd (fmt --check, clippy -D warnings, tests)
make go-lint # Go: sandboxd + sdk/go + e2e + mcp, GOOS linux AND darwin
make go-test # Go: go test -race across the Go modules
make sandboxd # build dist/sandboxd
make boot # kernel + initramfs artifact image (docker)# KERNEL_MIRROR=… if kernel.org tarball paths 404 locally
make silkd-image # silkd release binary in a scratch carrier image
make images # base + python images against the local boot + silkd images

The parent workspace's go.work includes these modules, which is why the Makefile forces GOWORK=off: CI has no workspace, and a workspace build resolves sibling checkouts instead of the pinned versions. silkd's integration tests spawn real processes — run them in a Linux container too (docker run rust:1 … cargo test) before touching platform-sensitive paths; macOS green alone has hidden Linux-only breakage before.

Bare-metal e2e

scripts/sandboxd-e2e.sh drives the real stack on a node with cocoon and a silkd-baked template image: golden build → warm pool → claim tiers → the full v2-verb smoke (files/session/find/replace/watch/git/pty) → reap → restart reconcile.

TEMPLATE=rt:24.04 scripts/sandboxd-e2e.sh
# BRIDGE=br0 adds an egress pool and the egress lane-detect check; a plain# `ip link add br0 type bridge` with no uplink is enough (NIC, not network).# SANDBOXD_BIN/DEMO_BIN/SMOKE_BIN point at prebuilt binaries for nodes# without a Go toolchain.# VOLUME_IMAGE=/absolute/dataset.img enables the volumes proof (ro sharing;# the image contains volume-e2e.txt); VOLUME_RW_IMAGE=/absolute/scratch.img# adds the rw claim/release leg. Prebuilt runs also set VOLUME_SMOKE_BIN.

CI

  • silkd.yml / sandboxd.yml — Rust and Go test+lint suites
  • python.yml — ruff + pytest for the three Python packages
  • images.yml — the single image entry point: on a push touching boot/**, silkd/**, protocol/**, or os-image/** it builds the changed carriers (via build-boot.yml / build-silkd.yml, workflow_call) then os-images, in order, so the chain is deterministic
  • build-os-images.yml — bakes base + flavors FROM the sha-pinned carriers
  • release.yml — on a version tag, builds the release binaries and archives
  • publish-pypi.yml — on an sdk-*-v* tag, builds and publishes the matching package via PyPI Trusted Publishing (OIDC, per-package environment)

On a fresh repo run build-boot first — images build FROM the boot artifact.

Boot chain

cloud-hypervisor
→ vmlinux (PVH ELF, everything =y, no decompress stage)
→ uncompressed ~1.5MB cpio: /init = sandbox-init (static Rust)
→ resolve virtio-blk serials via sysfs (2ms poll, no udev)
→ mount EROFS layers → overlayfs + ext4 COW → switch_root
→ exec /sbin/init (systemd, trimmed; cocoon-agent + silkd start at sysinit)

Boot contract (cmdline keys consumed by sandbox-init):

cmdline keymeaning
cocoon.layers=a,b,…EROFS layer disks resolved from virtio-blk serials, lowerdir order
cocoon.cow=xwritable ext4 COW disk (same resolution rules)
cocoon.timeout=10per-disk wait budget, seconds
cocoon.hostname=hset via sethostname(2) before handoff
ip=addr::gw:mask:host:ethN:off[:dns0[:dns1]]cocoon CNI static config: persisted as a MAC-matched networkd unit in the new root (not applied in the initramfs); absent → the image's DHCP fallback covers the NIC
sandbox.init=/pathhandoff target, default /sbin/init
sandbox.debug=1fatal errors drop to /bin/sh (debug initramfs) instead of poweroff
sandbox.trace=1emit one pre-handoff line with per-phase µs timings

boot=cocoon-overlay is ignored. Everything cocoon passes today keeps working — images built here boot with an unmodified cocoon.

License

The server stack — sandboxd, silkd, the boot chain, the OS images, and the MCP server — is licensed under AGPL-3.0. The client SDKs (sdk/go, sdk/python, sdk/openai, sdk/langchain) are licensed under Apache-2.0 (see the LICENSE file in each directory), so embedding a client in a proprietary agent stack carries no copyleft obligation.

About

Fast cold-boot MicroVM sandboxes for AI agents on cocoon

Topics

Resources

Security policy

Stars

50 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

sandbox

MicroVM sandboxes for AI agents, built on cocoon: a fast-boot guest stack, an in-guest product daemon, a per-node control plane with warm pools, and a Go SDK. Warm claims are sub-millisecond; a pool miss clones from a golden snapshot in tens of milliseconds; cold boot is ~200ms on bare metal.

SDK (Go) sandboxd (per node) guest microVM
sandbox.New() ── HTTP ─► claim: warm pool / golden clone Cloud Hypervisor
sb.Exec/Files/… ─ HTTP upgrade ─► byte relay ── vsock ──► silkd :2048
memberlist mesh: warm-count gossip,
MOVED-style redirect to the owning node

Cloud Hypervisor serves both network lanes. net=none has no NIC and uses vsock-only I/O (hardened default); net=egress attaches a bridge/CNI NIC.

Documentation: cocoonstack.github.io/sandbox (deployment, clusters, HTTP API, Go + Python SDK references, the MCP server, the OpenAI Agents SDK and LangChain adapters, silkd protocol, performance) — source in docs/.

Layout

  • silkd/ — in-guest product daemon (Rust, tokio): exec with context, persistent shell sessions, streaming fs, tar-stream tree push/pull, find/replace, watch (ready-acked), pty, structured git, guest port relay (port_forward), and an LSP broker for flavor-shipped language servers — newline-JSON frames over vsock 2048, one connection per RPC; baked into the base image
  • sandboxd/ — per-node control plane (Go): warm pools refilled from golden snapshot exports (online-retunable), claim/release/hibernate/fork/promote/ checkpoint HTTP API, operator-catalog dataset volumes (read-only or writable), signed preview URLs, the HTTP-upgrade byte relay to silkd, usage + audit journals, /metrics, reap + restart reconcile, memberlist mesh with redirect placement
  • sdk/go/ — Go SDK: Connect/New/Lookup, Exec/Run, files, Push/Pull, sessions, Find/Replace, Watch, git verbs, OpenPty, Fork/Hibernate/Promote/Checkpoint, DialPort/ProxyPort/PreviewURL, StartLsp, Spawn/Ps/Kill/Logs/Attach; protocol/wire carries the frame vocabulary, sdk/go/silkd the conn layer, silkdtest a test fake
  • sdk/python/ — Python SDK (stdlib-only, sync), matching the Go guest and data-plane surface for the Python-first agent ecosystem; node pool retuning remains Go-only; round-trips the shared fixture corpus
  • mcp/sandbox-mcp, an MCP stdio server exposing the surface as tools for Claude Code / Cursor / agent frameworks
  • sdk/openai/cocoonstack-sandbox-openai, a custom sandbox provider for the OpenAI Agents SDK (Python, over the Python SDK)
  • sdk/langchain/cocoonstack-sandbox-langchain, a LangChain toolkit (StructuredTools over the Python SDK, checkpoint branching)
  • protocol/wire/fixtures/ — golden frame corpus; the Rust, Go, and Python protocol tests all round-trip it, so wire drift fails CI
  • e2e/ — in-process full-stack tests (real pool/engine/relay/SDK, fake cocoon+guest) plus bare-metal acceptance drivers under cmd/: demo, smoke, meshsmoke, crossnode, coldproof, egresssmoke, interceptsmoke, volumesmoke, lifecycle (idle→hibernate→archive), androidsmoke, browsersmoke, and the pullbench/pushbench/rpcbench perf drivers
  • boot/kernel/ — kernel version pin (VERSION + matching tarball SHA256, bump both together) + config fragment (amd64: over x86_64_defconfig + kvm_guest.config; arm64: over defconfig, then sandbox-arm64.config)
  • boot/init/sandbox-init, the entire initramfs userland (Rust, static musl build)
  • boot/Dockerfile — multi-stage: kernel → init → cpio → scratch image with /boot/vmlinuz-sandbox + /boot/initrd.img-sandbox
  • os-image/ — VM images consuming the boot artifact: base (layered, for builds), rt (base squashed to one layer — the default template in examples), python, python-rt, browser, and android
  • scripts/boot-bench.sh (boot phase timing), bench.sh (the published benchmark procedure), sandboxd-e2e.sh (bare-metal e2e, below), plus the archive/egress/intercept e2e drivers

Build & test

make help# this list
make lint test# Rust: boot/init + silkd (fmt --check, clippy -D warnings, tests)
make go-lint # Go: sandboxd + sdk/go + e2e + mcp, GOOS linux AND darwin
make go-test # Go: go test -race across the Go modules
make sandboxd # build dist/sandboxd
make boot # kernel + initramfs artifact image (docker)# KERNEL_MIRROR=… if kernel.org tarball paths 404 locally
make silkd-image # silkd release binary in a scratch carrier image
make images # base + python images against the local boot + silkd images

The parent workspace's go.work includes these modules, which is why the Makefile forces GOWORK=off: CI has no workspace, and a workspace build resolves sibling checkouts instead of the pinned versions. silkd's integration tests spawn real processes — run them in a Linux container too (docker run rust:1 … cargo test) before touching platform-sensitive paths; macOS green alone has hidden Linux-only breakage before.

Bare-metal e2e

scripts/sandboxd-e2e.sh drives the real stack on a node with cocoon and a silkd-baked template image: golden build → warm pool → claim tiers → the full v2-verb smoke (files/session/find/replace/watch/git/pty) → reap → restart reconcile.

TEMPLATE=rt:24.04 scripts/sandboxd-e2e.sh
# BRIDGE=br0 adds an egress pool and the egress lane-detect check; a plain# `ip link add br0 type bridge` with no uplink is enough (NIC, not network).# SANDBOXD_BIN/DEMO_BIN/SMOKE_BIN point at prebuilt binaries for nodes# without a Go toolchain.# VOLUME_IMAGE=/absolute/dataset.img enables the volumes proof (ro sharing;# the image contains volume-e2e.txt); VOLUME_RW_IMAGE=/absolute/scratch.img# adds the rw claim/release leg. Prebuilt runs also set VOLUME_SMOKE_BIN.

CI

  • silkd.yml / sandboxd.yml — Rust and Go test+lint suites
  • python.yml — ruff + pytest for the three Python packages
  • images.yml — the single image entry point: on a push touching boot/**, silkd/**, protocol/**, or os-image/** it builds the changed carriers (via build-boot.yml / build-silkd.yml, workflow_call) then os-images, in order, so the chain is deterministic
  • build-os-images.yml — bakes base + flavors FROM the sha-pinned carriers
  • release.yml — on a version tag, builds the release binaries and archives
  • publish-pypi.yml — on an sdk-*-v* tag, builds and publishes the matching package via PyPI Trusted Publishing (OIDC, per-package environment)

On a fresh repo run build-boot first — images build FROM the boot artifact.

Boot chain

cloud-hypervisor
→ vmlinux (PVH ELF, everything =y, no decompress stage)
→ uncompressed ~1.5MB cpio: /init = sandbox-init (static Rust)
→ resolve virtio-blk serials via sysfs (2ms poll, no udev)
→ mount EROFS layers → overlayfs + ext4 COW → switch_root
→ exec /sbin/init (systemd, trimmed; cocoon-agent + silkd start at sysinit)

Boot contract (cmdline keys consumed by sandbox-init):

cmdline keymeaning
cocoon.layers=a,b,…EROFS layer disks resolved from virtio-blk serials, lowerdir order
cocoon.cow=xwritable ext4 COW disk (same resolution rules)
cocoon.timeout=10per-disk wait budget, seconds
cocoon.hostname=hset via sethostname(2) before handoff
ip=addr::gw:mask:host:ethN:off[:dns0[:dns1]]cocoon CNI static config: persisted as a MAC-matched networkd unit in the new root (not applied in the initramfs); absent → the image's DHCP fallback covers the NIC
sandbox.init=/pathhandoff target, default /sbin/init
sandbox.debug=1fatal errors drop to /bin/sh (debug initramfs) instead of poweroff
sandbox.trace=1emit one pre-handoff line with per-phase µs timings

boot=cocoon-overlay is ignored. Everything cocoon passes today keeps working — images built here boot with an unmodified cocoon.

License

The server stack — sandboxd, silkd, the boot chain, the OS images, and the MCP server — is licensed under AGPL-3.0. The client SDKs (sdk/go, sdk/python, sdk/openai, sdk/langchain) are licensed under Apache-2.0 (see the LICENSE file in each directory), so embedding a client in a proprietary agent stack carries no copyleft obligation.

About

Fast cold-boot MicroVM sandboxes for AI agents on cocoon

Topics

Resources

Security policy

Stars

50 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

sandbox

MicroVM sandboxes for AI agents, built on cocoon: a fast-boot guest stack, an in-guest product daemon, a per-node control plane with warm pools, and a Go SDK. Warm claims are sub-millisecond; a pool miss clones from a golden snapshot in tens of milliseconds; cold boot is ~200ms on bare metal.

SDK (Go) sandboxd (per node) guest microVM
sandbox.New() ── HTTP ─► claim: warm pool / golden clone Cloud Hypervisor
sb.Exec/Files/… ─ HTTP upgrade ─► byte relay ── vsock ──► silkd :2048
memberlist mesh: warm-count gossip,
MOVED-style redirect to the owning node

Cloud Hypervisor serves both network lanes. net=none has no NIC and uses vsock-only I/O (hardened default); net=egress attaches a bridge/CNI NIC.

Documentation: cocoonstack.github.io/sandbox (deployment, clusters, HTTP API, Go + Python SDK references, the MCP server, the OpenAI Agents SDK and LangChain adapters, silkd protocol, performance) — source in docs/.

Layout

  • silkd/ — in-guest product daemon (Rust, tokio): exec with context, persistent shell sessions, streaming fs, tar-stream tree push/pull, find/replace, watch (ready-acked), pty, structured git, guest port relay (port_forward), and an LSP broker for flavor-shipped language servers — newline-JSON frames over vsock 2048, one connection per RPC; baked into the base image
  • sandboxd/ — per-node control plane (Go): warm pools refilled from golden snapshot exports (online-retunable), claim/release/hibernate/fork/promote/ checkpoint HTTP API, operator-catalog dataset volumes (read-only or writable), signed preview URLs, the HTTP-upgrade byte relay to silkd, usage + audit journals, /metrics, reap + restart reconcile, memberlist mesh with redirect placement
  • sdk/go/ — Go SDK: Connect/New/Lookup, Exec/Run, files, Push/Pull, sessions, Find/Replace, Watch, git verbs, OpenPty, Fork/Hibernate/Promote/Checkpoint, DialPort/ProxyPort/PreviewURL, StartLsp, Spawn/Ps/Kill/Logs/Attach; protocol/wire carries the frame vocabulary, sdk/go/silkd the conn layer, silkdtest a test fake
  • sdk/python/ — Python SDK (stdlib-only, sync), matching the Go guest and data-plane surface for the Python-first agent ecosystem; node pool retuning remains Go-only; round-trips the shared fixture corpus
  • mcp/sandbox-mcp, an MCP stdio server exposing the surface as tools for Claude Code / Cursor / agent frameworks
  • sdk/openai/cocoonstack-sandbox-openai, a custom sandbox provider for the OpenAI Agents SDK (Python, over the Python SDK)
  • sdk/langchain/cocoonstack-sandbox-langchain, a LangChain toolkit (StructuredTools over the Python SDK, checkpoint branching)
  • protocol/wire/fixtures/ — golden frame corpus; the Rust, Go, and Python protocol tests all round-trip it, so wire drift fails CI
  • e2e/ — in-process full-stack tests (real pool/engine/relay/SDK, fake cocoon+guest) plus bare-metal acceptance drivers under cmd/: demo, smoke, meshsmoke, crossnode, coldproof, egresssmoke, interceptsmoke, volumesmoke, lifecycle (idle→hibernate→archive), androidsmoke, browsersmoke, and the pullbench/pushbench/rpcbench perf drivers
  • boot/kernel/ — kernel version pin (VERSION + matching tarball SHA256, bump both together) + config fragment (amd64: over x86_64_defconfig + kvm_guest.config; arm64: over defconfig, then sandbox-arm64.config)
  • boot/init/sandbox-init, the entire initramfs userland (Rust, static musl build)
  • boot/Dockerfile — multi-stage: kernel → init → cpio → scratch image with /boot/vmlinuz-sandbox + /boot/initrd.img-sandbox
  • os-image/ — VM images consuming the boot artifact: base (layered, for builds), rt (base squashed to one layer — the default template in examples), python, python-rt, browser, and android
  • scripts/boot-bench.sh (boot phase timing), bench.sh (the published benchmark procedure), sandboxd-e2e.sh (bare-metal e2e, below), plus the archive/egress/intercept e2e drivers

Build & test

make help# this list
make lint test# Rust: boot/init + silkd (fmt --check, clippy -D warnings, tests)
make go-lint # Go: sandboxd + sdk/go + e2e + mcp, GOOS linux AND darwin
make go-test # Go: go test -race across the Go modules
make sandboxd # build dist/sandboxd
make boot # kernel + initramfs artifact image (docker)# KERNEL_MIRROR=… if kernel.org tarball paths 404 locally
make silkd-image # silkd release binary in a scratch carrier image
make images # base + python images against the local boot + silkd images

The parent workspace's go.work includes these modules, which is why the Makefile forces GOWORK=off: CI has no workspace, and a workspace build resolves sibling checkouts instead of the pinned versions. silkd's integration tests spawn real processes — run them in a Linux container too (docker run rust:1 … cargo test) before touching platform-sensitive paths; macOS green alone has hidden Linux-only breakage before.

Bare-metal e2e

scripts/sandboxd-e2e.sh drives the real stack on a node with cocoon and a silkd-baked template image: golden build → warm pool → claim tiers → the full v2-verb smoke (files/session/find/replace/watch/git/pty) → reap → restart reconcile.

TEMPLATE=rt:24.04 scripts/sandboxd-e2e.sh
# BRIDGE=br0 adds an egress pool and the egress lane-detect check; a plain# `ip link add br0 type bridge` with no uplink is enough (NIC, not network).# SANDBOXD_BIN/DEMO_BIN/SMOKE_BIN point at prebuilt binaries for nodes# without a Go toolchain.# VOLUME_IMAGE=/absolute/dataset.img enables the volumes proof (ro sharing;# the image contains volume-e2e.txt); VOLUME_RW_IMAGE=/absolute/scratch.img# adds the rw claim/release leg. Prebuilt runs also set VOLUME_SMOKE_BIN.

CI

  • silkd.yml / sandboxd.yml — Rust and Go test+lint suites
  • python.yml — ruff + pytest for the three Python packages
  • images.yml — the single image entry point: on a push touching boot/**, silkd/**, protocol/**, or os-image/** it builds the changed carriers (via build-boot.yml / build-silkd.yml, workflow_call) then os-images, in order, so the chain is deterministic
  • build-os-images.yml — bakes base + flavors FROM the sha-pinned carriers
  • release.yml — on a version tag, builds the release binaries and archives
  • publish-pypi.yml — on an sdk-*-v* tag, builds and publishes the matching package via PyPI Trusted Publishing (OIDC, per-package environment)

On a fresh repo run build-boot first — images build FROM the boot artifact.

Boot chain

cloud-hypervisor
→ vmlinux (PVH ELF, everything =y, no decompress stage)
→ uncompressed ~1.5MB cpio: /init = sandbox-init (static Rust)
→ resolve virtio-blk serials via sysfs (2ms poll, no udev)
→ mount EROFS layers → overlayfs + ext4 COW → switch_root
→ exec /sbin/init (systemd, trimmed; cocoon-agent + silkd start at sysinit)

Boot contract (cmdline keys consumed by sandbox-init):

cmdline keymeaning
cocoon.layers=a,b,…EROFS layer disks resolved from virtio-blk serials, lowerdir order
cocoon.cow=xwritable ext4 COW disk (same resolution rules)
cocoon.timeout=10per-disk wait budget, seconds
cocoon.hostname=hset via sethostname(2) before handoff
ip=addr::gw:mask:host:ethN:off[:dns0[:dns1]]cocoon CNI static config: persisted as a MAC-matched networkd unit in the new root (not applied in the initramfs); absent → the image's DHCP fallback covers the NIC
sandbox.init=/pathhandoff target, default /sbin/init
sandbox.debug=1fatal errors drop to /bin/sh (debug initramfs) instead of poweroff
sandbox.trace=1emit one pre-handoff line with per-phase µs timings

boot=cocoon-overlay is ignored. Everything cocoon passes today keeps working — images built here boot with an unmodified cocoon.

License

The server stack — sandboxd, silkd, the boot chain, the OS images, and the MCP server — is licensed under AGPL-3.0. The client SDKs (sdk/go, sdk/python, sdk/openai, sdk/langchain) are licensed under Apache-2.0 (see the LICENSE file in each directory), so embedding a client in a proprietary agent stack carries no copyleft obligation.

About

Fast cold-boot MicroVM sandboxes for AI agents on cocoon

Topics

Resources

Security policy

Stars

50 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

sandbox

MicroVM sandboxes for AI agents, built on cocoon: a fast-boot guest stack, an in-guest product daemon, a per-node control plane with warm pools, and a Go SDK. Warm claims are sub-millisecond; a pool miss clones from a golden snapshot in tens of milliseconds; cold boot is ~200ms on bare metal.

SDK (Go) sandboxd (per node) guest microVM
sandbox.New() ── HTTP ─► claim: warm pool / golden clone Cloud Hypervisor
sb.Exec/Files/… ─ HTTP upgrade ─► byte relay ── vsock ──► silkd :2048
memberlist mesh: warm-count gossip,
MOVED-style redirect to the owning node

Cloud Hypervisor serves both network lanes. net=none has no NIC and uses vsock-only I/O (hardened default); net=egress attaches a bridge/CNI NIC.

Documentation: cocoonstack.github.io/sandbox (deployment, clusters, HTTP API, Go + Python SDK references, the MCP server, the OpenAI Agents SDK and LangChain adapters, silkd protocol, performance) — source in docs/.

Layout

  • silkd/ — in-guest product daemon (Rust, tokio): exec with context, persistent shell sessions, streaming fs, tar-stream tree push/pull, find/replace, watch (ready-acked), pty, structured git, guest port relay (port_forward), and an LSP broker for flavor-shipped language servers — newline-JSON frames over vsock 2048, one connection per RPC; baked into the base image
  • sandboxd/ — per-node control plane (Go): warm pools refilled from golden snapshot exports (online-retunable), claim/release/hibernate/fork/promote/ checkpoint HTTP API, operator-catalog dataset volumes (read-only or writable), signed preview URLs, the HTTP-upgrade byte relay to silkd, usage + audit journals, /metrics, reap + restart reconcile, memberlist mesh with redirect placement
  • sdk/go/ — Go SDK: Connect/New/Lookup, Exec/Run, files, Push/Pull, sessions, Find/Replace, Watch, git verbs, OpenPty, Fork/Hibernate/Promote/Checkpoint, DialPort/ProxyPort/PreviewURL, StartLsp, Spawn/Ps/Kill/Logs/Attach; protocol/wire carries the frame vocabulary, sdk/go/silkd the conn layer, silkdtest a test fake
  • sdk/python/ — Python SDK (stdlib-only, sync), matching the Go guest and data-plane surface for the Python-first agent ecosystem; node pool retuning remains Go-only; round-trips the shared fixture corpus
  • mcp/sandbox-mcp, an MCP stdio server exposing the surface as tools for Claude Code / Cursor / agent frameworks
  • sdk/openai/cocoonstack-sandbox-openai, a custom sandbox provider for the OpenAI Agents SDK (Python, over the Python SDK)
  • sdk/langchain/cocoonstack-sandbox-langchain, a LangChain toolkit (StructuredTools over the Python SDK, checkpoint branching)
  • protocol/wire/fixtures/ — golden frame corpus; the Rust, Go, and Python protocol tests all round-trip it, so wire drift fails CI
  • e2e/ — in-process full-stack tests (real pool/engine/relay/SDK, fake cocoon+guest) plus bare-metal acceptance drivers under cmd/: demo, smoke, meshsmoke, crossnode, coldproof, egresssmoke, interceptsmoke, volumesmoke, lifecycle (idle→hibernate→archive), androidsmoke, browsersmoke, and the pullbench/pushbench/rpcbench perf drivers
  • boot/kernel/ — kernel version pin (VERSION + matching tarball SHA256, bump both together) + config fragment (amd64: over x86_64_defconfig + kvm_guest.config; arm64: over defconfig, then sandbox-arm64.config)
  • boot/init/sandbox-init, the entire initramfs userland (Rust, static musl build)
  • boot/Dockerfile — multi-stage: kernel → init → cpio → scratch image with /boot/vmlinuz-sandbox + /boot/initrd.img-sandbox
  • os-image/ — VM images consuming the boot artifact: base (layered, for builds), rt (base squashed to one layer — the default template in examples), python, python-rt, browser, and android
  • scripts/boot-bench.sh (boot phase timing), bench.sh (the published benchmark procedure), sandboxd-e2e.sh (bare-metal e2e, below), plus the archive/egress/intercept e2e drivers

Build & test

make help# this list
make lint test# Rust: boot/init + silkd (fmt --check, clippy -D warnings, tests)
make go-lint # Go: sandboxd + sdk/go + e2e + mcp, GOOS linux AND darwin
make go-test # Go: go test -race across the Go modules
make sandboxd # build dist/sandboxd
make boot # kernel + initramfs artifact image (docker)# KERNEL_MIRROR=… if kernel.org tarball paths 404 locally
make silkd-image # silkd release binary in a scratch carrier image
make images # base + python images against the local boot + silkd images

The parent workspace's go.work includes these modules, which is why the Makefile forces GOWORK=off: CI has no workspace, and a workspace build resolves sibling checkouts instead of the pinned versions. silkd's integration tests spawn real processes — run them in a Linux container too (docker run rust:1 … cargo test) before touching platform-sensitive paths; macOS green alone has hidden Linux-only breakage before.

Bare-metal e2e

scripts/sandboxd-e2e.sh drives the real stack on a node with cocoon and a silkd-baked template image: golden build → warm pool → claim tiers → the full v2-verb smoke (files/session/find/replace/watch/git/pty) → reap → restart reconcile.

TEMPLATE=rt:24.04 scripts/sandboxd-e2e.sh
# BRIDGE=br0 adds an egress pool and the egress lane-detect check; a plain# `ip link add br0 type bridge` with no uplink is enough (NIC, not network).# SANDBOXD_BIN/DEMO_BIN/SMOKE_BIN point at prebuilt binaries for nodes# without a Go toolchain.# VOLUME_IMAGE=/absolute/dataset.img enables the volumes proof (ro sharing;# the image contains volume-e2e.txt); VOLUME_RW_IMAGE=/absolute/scratch.img# adds the rw claim/release leg. Prebuilt runs also set VOLUME_SMOKE_BIN.

CI

  • silkd.yml / sandboxd.yml — Rust and Go test+lint suites
  • python.yml — ruff + pytest for the three Python packages
  • images.yml — the single image entry point: on a push touching boot/**, silkd/**, protocol/**, or os-image/** it builds the changed carriers (via build-boot.yml / build-silkd.yml, workflow_call) then os-images, in order, so the chain is deterministic
  • build-os-images.yml — bakes base + flavors FROM the sha-pinned carriers
  • release.yml — on a version tag, builds the release binaries and archives
  • publish-pypi.yml — on an sdk-*-v* tag, builds and publishes the matching package via PyPI Trusted Publishing (OIDC, per-package environment)

On a fresh repo run build-boot first — images build FROM the boot artifact.

Boot chain

cloud-hypervisor
→ vmlinux (PVH ELF, everything =y, no decompress stage)
→ uncompressed ~1.5MB cpio: /init = sandbox-init (static Rust)
→ resolve virtio-blk serials via sysfs (2ms poll, no udev)
→ mount EROFS layers → overlayfs + ext4 COW → switch_root
→ exec /sbin/init (systemd, trimmed; cocoon-agent + silkd start at sysinit)

Boot contract (cmdline keys consumed by sandbox-init):

cmdline keymeaning
cocoon.layers=a,b,…EROFS layer disks resolved from virtio-blk serials, lowerdir order
cocoon.cow=xwritable ext4 COW disk (same resolution rules)
cocoon.timeout=10per-disk wait budget, seconds
cocoon.hostname=hset via sethostname(2) before handoff
ip=addr::gw:mask:host:ethN:off[:dns0[:dns1]]cocoon CNI static config: persisted as a MAC-matched networkd unit in the new root (not applied in the initramfs); absent → the image's DHCP fallback covers the NIC
sandbox.init=/pathhandoff target, default /sbin/init
sandbox.debug=1fatal errors drop to /bin/sh (debug initramfs) instead of poweroff
sandbox.trace=1emit one pre-handoff line with per-phase µs timings

boot=cocoon-overlay is ignored. Everything cocoon passes today keeps working — images built here boot with an unmodified cocoon.

License

The server stack — sandboxd, silkd, the boot chain, the OS images, and the MCP server — is licensed under AGPL-3.0. The client SDKs (sdk/go, sdk/python, sdk/openai, sdk/langchain) are licensed under Apache-2.0 (see the LICENSE file in each directory), so embedding a client in a proprietary agent stack carries no copyleft obligation.

About

Fast cold-boot MicroVM sandboxes for AI agents on cocoon

Topics

Resources

Security policy

Stars

50 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

sandbox

MicroVM sandboxes for AI agents, built on cocoon: a fast-boot guest stack, an in-guest product daemon, a per-node control plane with warm pools, and a Go SDK. Warm claims are sub-millisecond; a pool miss clones from a golden snapshot in tens of milliseconds; cold boot is ~200ms on bare metal.

SDK (Go) sandboxd (per node) guest microVM
sandbox.New() ── HTTP ─► claim: warm pool / golden clone Cloud Hypervisor
sb.Exec/Files/… ─ HTTP upgrade ─► byte relay ── vsock ──► silkd :2048
memberlist mesh: warm-count gossip,
MOVED-style redirect to the owning node

Cloud Hypervisor serves both network lanes. net=none has no NIC and uses vsock-only I/O (hardened default); net=egress attaches a bridge/CNI NIC.

Documentation: cocoonstack.github.io/sandbox (deployment, clusters, HTTP API, Go + Python SDK references, the MCP server, the OpenAI Agents SDK and LangChain adapters, silkd protocol, performance) — source in docs/.

Layout

  • silkd/ — in-guest product daemon (Rust, tokio): exec with context, persistent shell sessions, streaming fs, tar-stream tree push/pull, find/replace, watch (ready-acked), pty, structured git, guest port relay (port_forward), and an LSP broker for flavor-shipped language servers — newline-JSON frames over vsock 2048, one connection per RPC; baked into the base image
  • sandboxd/ — per-node control plane (Go): warm pools refilled from golden snapshot exports (online-retunable), claim/release/hibernate/fork/promote/ checkpoint HTTP API, operator-catalog dataset volumes (read-only or writable), signed preview URLs, the HTTP-upgrade byte relay to silkd, usage + audit journals, /metrics, reap + restart reconcile, memberlist mesh with redirect placement
  • sdk/go/ — Go SDK: Connect/New/Lookup, Exec/Run, files, Push/Pull, sessions, Find/Replace, Watch, git verbs, OpenPty, Fork/Hibernate/Promote/Checkpoint, DialPort/ProxyPort/PreviewURL, StartLsp, Spawn/Ps/Kill/Logs/Attach; protocol/wire carries the frame vocabulary, sdk/go/silkd the conn layer, silkdtest a test fake
  • sdk/python/ — Python SDK (stdlib-only, sync), matching the Go guest and data-plane surface for the Python-first agent ecosystem; node pool retuning remains Go-only; round-trips the shared fixture corpus
  • mcp/sandbox-mcp, an MCP stdio server exposing the surface as tools for Claude Code / Cursor / agent frameworks
  • sdk/openai/cocoonstack-sandbox-openai, a custom sandbox provider for the OpenAI Agents SDK (Python, over the Python SDK)
  • sdk/langchain/cocoonstack-sandbox-langchain, a LangChain toolkit (StructuredTools over the Python SDK, checkpoint branching)
  • protocol/wire/fixtures/ — golden frame corpus; the Rust, Go, and Python protocol tests all round-trip it, so wire drift fails CI
  • e2e/ — in-process full-stack tests (real pool/engine/relay/SDK, fake cocoon+guest) plus bare-metal acceptance drivers under cmd/: demo, smoke, meshsmoke, crossnode, coldproof, egresssmoke, interceptsmoke, volumesmoke, lifecycle (idle→hibernate→archive), androidsmoke, browsersmoke, and the pullbench/pushbench/rpcbench perf drivers
  • boot/kernel/ — kernel version pin (VERSION + matching tarball SHA256, bump both together) + config fragment (amd64: over x86_64_defconfig + kvm_guest.config; arm64: over defconfig, then sandbox-arm64.config)
  • boot/init/sandbox-init, the entire initramfs userland (Rust, static musl build)
  • boot/Dockerfile — multi-stage: kernel → init → cpio → scratch image with /boot/vmlinuz-sandbox + /boot/initrd.img-sandbox
  • os-image/ — VM images consuming the boot artifact: base (layered, for builds), rt (base squashed to one layer — the default template in examples), python, python-rt, browser, and android
  • scripts/boot-bench.sh (boot phase timing), bench.sh (the published benchmark procedure), sandboxd-e2e.sh (bare-metal e2e, below), plus the archive/egress/intercept e2e drivers

Build & test

make help# this list
make lint test# Rust: boot/init + silkd (fmt --check, clippy -D warnings, tests)
make go-lint # Go: sandboxd + sdk/go + e2e + mcp, GOOS linux AND darwin
make go-test # Go: go test -race across the Go modules
make sandboxd # build dist/sandboxd
make boot # kernel + initramfs artifact image (docker)# KERNEL_MIRROR=… if kernel.org tarball paths 404 locally
make silkd-image # silkd release binary in a scratch carrier image
make images # base + python images against the local boot + silkd images

The parent workspace's go.work includes these modules, which is why the Makefile forces GOWORK=off: CI has no workspace, and a workspace build resolves sibling checkouts instead of the pinned versions. silkd's integration tests spawn real processes — run them in a Linux container too (docker run rust:1 … cargo test) before touching platform-sensitive paths; macOS green alone has hidden Linux-only breakage before.

Bare-metal e2e

scripts/sandboxd-e2e.sh drives the real stack on a node with cocoon and a silkd-baked template image: golden build → warm pool → claim tiers → the full v2-verb smoke (files/session/find/replace/watch/git/pty) → reap → restart reconcile.

TEMPLATE=rt:24.04 scripts/sandboxd-e2e.sh
# BRIDGE=br0 adds an egress pool and the egress lane-detect check; a plain# `ip link add br0 type bridge` with no uplink is enough (NIC, not network).# SANDBOXD_BIN/DEMO_BIN/SMOKE_BIN point at prebuilt binaries for nodes# without a Go toolchain.# VOLUME_IMAGE=/absolute/dataset.img enables the volumes proof (ro sharing;# the image contains volume-e2e.txt); VOLUME_RW_IMAGE=/absolute/scratch.img# adds the rw claim/release leg. Prebuilt runs also set VOLUME_SMOKE_BIN.

CI

  • silkd.yml / sandboxd.yml — Rust and Go test+lint suites
  • python.yml — ruff + pytest for the three Python packages
  • images.yml — the single image entry point: on a push touching boot/**, silkd/**, protocol/**, or os-image/** it builds the changed carriers (via build-boot.yml / build-silkd.yml, workflow_call) then os-images, in order, so the chain is deterministic
  • build-os-images.yml — bakes base + flavors FROM the sha-pinned carriers
  • release.yml — on a version tag, builds the release binaries and archives
  • publish-pypi.yml — on an sdk-*-v* tag, builds and publishes the matching package via PyPI Trusted Publishing (OIDC, per-package environment)

On a fresh repo run build-boot first — images build FROM the boot artifact.

Boot chain

cloud-hypervisor
→ vmlinux (PVH ELF, everything =y, no decompress stage)
→ uncompressed ~1.5MB cpio: /init = sandbox-init (static Rust)
→ resolve virtio-blk serials via sysfs (2ms poll, no udev)
→ mount EROFS layers → overlayfs + ext4 COW → switch_root
→ exec /sbin/init (systemd, trimmed; cocoon-agent + silkd start at sysinit)

Boot contract (cmdline keys consumed by sandbox-init):

cmdline keymeaning
cocoon.layers=a,b,…EROFS layer disks resolved from virtio-blk serials, lowerdir order
cocoon.cow=xwritable ext4 COW disk (same resolution rules)
cocoon.timeout=10per-disk wait budget, seconds
cocoon.hostname=hset via sethostname(2) before handoff
ip=addr::gw:mask:host:ethN:off[:dns0[:dns1]]cocoon CNI static config: persisted as a MAC-matched networkd unit in the new root (not applied in the initramfs); absent → the image's DHCP fallback covers the NIC
sandbox.init=/pathhandoff target, default /sbin/init
sandbox.debug=1fatal errors drop to /bin/sh (debug initramfs) instead of poweroff
sandbox.trace=1emit one pre-handoff line with per-phase µs timings

boot=cocoon-overlay is ignored. Everything cocoon passes today keeps working — images built here boot with an unmodified cocoon.

License

The server stack — sandboxd, silkd, the boot chain, the OS images, and the MCP server — is licensed under AGPL-3.0. The client SDKs (sdk/go, sdk/python, sdk/openai, sdk/langchain) are licensed under Apache-2.0 (see the LICENSE file in each directory), so embedding a client in a proprietary agent stack carries no copyleft obligation.

About

Fast cold-boot MicroVM sandboxes for AI agents on cocoon

Topics

Resources

Security policy

Stars

50 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

sandbox

MicroVM sandboxes for AI agents, built on cocoon: a fast-boot guest stack, an in-guest product daemon, a per-node control plane with warm pools, and a Go SDK. Warm claims are sub-millisecond; a pool miss clones from a golden snapshot in tens of milliseconds; cold boot is ~200ms on bare metal.

SDK (Go) sandboxd (per node) guest microVM
sandbox.New() ── HTTP ─► claim: warm pool / golden clone Cloud Hypervisor
sb.Exec/Files/… ─ HTTP upgrade ─► byte relay ── vsock ──► silkd :2048
memberlist mesh: warm-count gossip,
MOVED-style redirect to the owning node

Cloud Hypervisor serves both network lanes. net=none has no NIC and uses vsock-only I/O (hardened default); net=egress attaches a bridge/CNI NIC.

Documentation: cocoonstack.github.io/sandbox (deployment, clusters, HTTP API, Go + Python SDK references, the MCP server, the OpenAI Agents SDK and LangChain adapters, silkd protocol, performance) — source in docs/.

Layout

  • silkd/ — in-guest product daemon (Rust, tokio): exec with context, persistent shell sessions, streaming fs, tar-stream tree push/pull, find/replace, watch (ready-acked), pty, structured git, guest port relay (port_forward), and an LSP broker for flavor-shipped language servers — newline-JSON frames over vsock 2048, one connection per RPC; baked into the base image
  • sandboxd/ — per-node control plane (Go): warm pools refilled from golden snapshot exports (online-retunable), claim/release/hibernate/fork/promote/ checkpoint HTTP API, operator-catalog dataset volumes (read-only or writable), signed preview URLs, the HTTP-upgrade byte relay to silkd, usage + audit journals, /metrics, reap + restart reconcile, memberlist mesh with redirect placement
  • sdk/go/ — Go SDK: Connect/New/Lookup, Exec/Run, files, Push/Pull, sessions, Find/Replace, Watch, git verbs, OpenPty, Fork/Hibernate/Promote/Checkpoint, DialPort/ProxyPort/PreviewURL, StartLsp, Spawn/Ps/Kill/Logs/Attach; protocol/wire carries the frame vocabulary, sdk/go/silkd the conn layer, silkdtest a test fake
  • sdk/python/ — Python SDK (stdlib-only, sync), matching the Go guest and data-plane surface for the Python-first agent ecosystem; node pool retuning remains Go-only; round-trips the shared fixture corpus
  • mcp/sandbox-mcp, an MCP stdio server exposing the surface as tools for Claude Code / Cursor / agent frameworks
  • sdk/openai/cocoonstack-sandbox-openai, a custom sandbox provider for the OpenAI Agents SDK (Python, over the Python SDK)
  • sdk/langchain/cocoonstack-sandbox-langchain, a LangChain toolkit (StructuredTools over the Python SDK, checkpoint branching)
  • protocol/wire/fixtures/ — golden frame corpus; the Rust, Go, and Python protocol tests all round-trip it, so wire drift fails CI
  • e2e/ — in-process full-stack tests (real pool/engine/relay/SDK, fake cocoon+guest) plus bare-metal acceptance drivers under cmd/: demo, smoke, meshsmoke, crossnode, coldproof, egresssmoke, interceptsmoke, volumesmoke, lifecycle (idle→hibernate→archive), androidsmoke, browsersmoke, and the pullbench/pushbench/rpcbench perf drivers
  • boot/kernel/ — kernel version pin (VERSION + matching tarball SHA256, bump both together) + config fragment (amd64: over x86_64_defconfig + kvm_guest.config; arm64: over defconfig, then sandbox-arm64.config)
  • boot/init/sandbox-init, the entire initramfs userland (Rust, static musl build)
  • boot/Dockerfile — multi-stage: kernel → init → cpio → scratch image with /boot/vmlinuz-sandbox + /boot/initrd.img-sandbox
  • os-image/ — VM images consuming the boot artifact: base (layered, for builds), rt (base squashed to one layer — the default template in examples), python, python-rt, browser, and android
  • scripts/boot-bench.sh (boot phase timing), bench.sh (the published benchmark procedure), sandboxd-e2e.sh (bare-metal e2e, below), plus the archive/egress/intercept e2e drivers

Build & test

make help# this list
make lint test# Rust: boot/init + silkd (fmt --check, clippy -D warnings, tests)
make go-lint # Go: sandboxd + sdk/go + e2e + mcp, GOOS linux AND darwin
make go-test # Go: go test -race across the Go modules
make sandboxd # build dist/sandboxd
make boot # kernel + initramfs artifact image (docker)# KERNEL_MIRROR=… if kernel.org tarball paths 404 locally
make silkd-image # silkd release binary in a scratch carrier image
make images # base + python images against the local boot + silkd images

The parent workspace's go.work includes these modules, which is why the Makefile forces GOWORK=off: CI has no workspace, and a workspace build resolves sibling checkouts instead of the pinned versions. silkd's integration tests spawn real processes — run them in a Linux container too (docker run rust:1 … cargo test) before touching platform-sensitive paths; macOS green alone has hidden Linux-only breakage before.

Bare-metal e2e

scripts/sandboxd-e2e.sh drives the real stack on a node with cocoon and a silkd-baked template image: golden build → warm pool → claim tiers → the full v2-verb smoke (files/session/find/replace/watch/git/pty) → reap → restart reconcile.

TEMPLATE=rt:24.04 scripts/sandboxd-e2e.sh
# BRIDGE=br0 adds an egress pool and the egress lane-detect check; a plain# `ip link add br0 type bridge` with no uplink is enough (NIC, not network).# SANDBOXD_BIN/DEMO_BIN/SMOKE_BIN point at prebuilt binaries for nodes# without a Go toolchain.# VOLUME_IMAGE=/absolute/dataset.img enables the volumes proof (ro sharing;# the image contains volume-e2e.txt); VOLUME_RW_IMAGE=/absolute/scratch.img# adds the rw claim/release leg. Prebuilt runs also set VOLUME_SMOKE_BIN.

CI

  • silkd.yml / sandboxd.yml — Rust and Go test+lint suites
  • python.yml — ruff + pytest for the three Python packages
  • images.yml — the single image entry point: on a push touching boot/**, silkd/**, protocol/**, or os-image/** it builds the changed carriers (via build-boot.yml / build-silkd.yml, workflow_call) then os-images, in order, so the chain is deterministic
  • build-os-images.yml — bakes base + flavors FROM the sha-pinned carriers
  • release.yml — on a version tag, builds the release binaries and archives
  • publish-pypi.yml — on an sdk-*-v* tag, builds and publishes the matching package via PyPI Trusted Publishing (OIDC, per-package environment)

On a fresh repo run build-boot first — images build FROM the boot artifact.

Boot chain

cloud-hypervisor
→ vmlinux (PVH ELF, everything =y, no decompress stage)
→ uncompressed ~1.5MB cpio: /init = sandbox-init (static Rust)
→ resolve virtio-blk serials via sysfs (2ms poll, no udev)
→ mount EROFS layers → overlayfs + ext4 COW → switch_root
→ exec /sbin/init (systemd, trimmed; cocoon-agent + silkd start at sysinit)

Boot contract (cmdline keys consumed by sandbox-init):

cmdline keymeaning
cocoon.layers=a,b,…EROFS layer disks resolved from virtio-blk serials, lowerdir order
cocoon.cow=xwritable ext4 COW disk (same resolution rules)
cocoon.timeout=10per-disk wait budget, seconds
cocoon.hostname=hset via sethostname(2) before handoff
ip=addr::gw:mask:host:ethN:off[:dns0[:dns1]]cocoon CNI static config: persisted as a MAC-matched networkd unit in the new root (not applied in the initramfs); absent → the image's DHCP fallback covers the NIC
sandbox.init=/pathhandoff target, default /sbin/init
sandbox.debug=1fatal errors drop to /bin/sh (debug initramfs) instead of poweroff
sandbox.trace=1emit one pre-handoff line with per-phase µs timings

boot=cocoon-overlay is ignored. Everything cocoon passes today keeps working — images built here boot with an unmodified cocoon.

License

The server stack — sandboxd, silkd, the boot chain, the OS images, and the MCP server — is licensed under AGPL-3.0. The client SDKs (sdk/go, sdk/python, sdk/openai, sdk/langchain) are licensed under Apache-2.0 (see the LICENSE file in each directory), so embedding a client in a proprietary agent stack carries no copyleft obligation.

About

Fast cold-boot MicroVM sandboxes for AI agents on cocoon

Topics

Resources

Security policy

Stars

50 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

sandbox

MicroVM sandboxes for AI agents, built on cocoon: a fast-boot guest stack, an in-guest product daemon, a per-node control plane with warm pools, and a Go SDK. Warm claims are sub-millisecond; a pool miss clones from a golden snapshot in tens of milliseconds; cold boot is ~200ms on bare metal.

SDK (Go) sandboxd (per node) guest microVM
sandbox.New() ── HTTP ─► claim: warm pool / golden clone Cloud Hypervisor
sb.Exec/Files/… ─ HTTP upgrade ─► byte relay ── vsock ──► silkd :2048
memberlist mesh: warm-count gossip,
MOVED-style redirect to the owning node

Cloud Hypervisor serves both network lanes. net=none has no NIC and uses vsock-only I/O (hardened default); net=egress attaches a bridge/CNI NIC.

Documentation: cocoonstack.github.io/sandbox (deployment, clusters, HTTP API, Go + Python SDK references, the MCP server, the OpenAI Agents SDK and LangChain adapters, silkd protocol, performance) — source in docs/.

Layout

  • silkd/ — in-guest product daemon (Rust, tokio): exec with context, persistent shell sessions, streaming fs, tar-stream tree push/pull, find/replace, watch (ready-acked), pty, structured git, guest port relay (port_forward), and an LSP broker for flavor-shipped language servers — newline-JSON frames over vsock 2048, one connection per RPC; baked into the base image
  • sandboxd/ — per-node control plane (Go): warm pools refilled from golden snapshot exports (online-retunable), claim/release/hibernate/fork/promote/ checkpoint HTTP API, operator-catalog dataset volumes (read-only or writable), signed preview URLs, the HTTP-upgrade byte relay to silkd, usage + audit journals, /metrics, reap + restart reconcile, memberlist mesh with redirect placement
  • sdk/go/ — Go SDK: Connect/New/Lookup, Exec/Run, files, Push/Pull, sessions, Find/Replace, Watch, git verbs, OpenPty, Fork/Hibernate/Promote/Checkpoint, DialPort/ProxyPort/PreviewURL, StartLsp, Spawn/Ps/Kill/Logs/Attach; protocol/wire carries the frame vocabulary, sdk/go/silkd the conn layer, silkdtest a test fake
  • sdk/python/ — Python SDK (stdlib-only, sync), matching the Go guest and data-plane surface for the Python-first agent ecosystem; node pool retuning remains Go-only; round-trips the shared fixture corpus
  • mcp/sandbox-mcp, an MCP stdio server exposing the surface as tools for Claude Code / Cursor / agent frameworks
  • sdk/openai/cocoonstack-sandbox-openai, a custom sandbox provider for the OpenAI Agents SDK (Python, over the Python SDK)
  • sdk/langchain/cocoonstack-sandbox-langchain, a LangChain toolkit (StructuredTools over the Python SDK, checkpoint branching)
  • protocol/wire/fixtures/ — golden frame corpus; the Rust, Go, and Python protocol tests all round-trip it, so wire drift fails CI
  • e2e/ — in-process full-stack tests (real pool/engine/relay/SDK, fake cocoon+guest) plus bare-metal acceptance drivers under cmd/: demo, smoke, meshsmoke, crossnode, coldproof, egresssmoke, interceptsmoke, volumesmoke, lifecycle (idle→hibernate→archive), androidsmoke, browsersmoke, and the pullbench/pushbench/rpcbench perf drivers
  • boot/kernel/ — kernel version pin (VERSION + matching tarball SHA256, bump both together) + config fragment (amd64: over x86_64_defconfig + kvm_guest.config; arm64: over defconfig, then sandbox-arm64.config)
  • boot/init/sandbox-init, the entire initramfs userland (Rust, static musl build)
  • boot/Dockerfile — multi-stage: kernel → init → cpio → scratch image with /boot/vmlinuz-sandbox + /boot/initrd.img-sandbox
  • os-image/ — VM images consuming the boot artifact: base (layered, for builds), rt (base squashed to one layer — the default template in examples), python, python-rt, browser, and android
  • scripts/boot-bench.sh (boot phase timing), bench.sh (the published benchmark procedure), sandboxd-e2e.sh (bare-metal e2e, below), plus the archive/egress/intercept e2e drivers

Build & test

make help# this list
make lint test# Rust: boot/init + silkd (fmt --check, clippy -D warnings, tests)
make go-lint # Go: sandboxd + sdk/go + e2e + mcp, GOOS linux AND darwin
make go-test # Go: go test -race across the Go modules
make sandboxd # build dist/sandboxd
make boot # kernel + initramfs artifact image (docker)# KERNEL_MIRROR=… if kernel.org tarball paths 404 locally
make silkd-image # silkd release binary in a scratch carrier image
make images # base + python images against the local boot + silkd images

The parent workspace's go.work includes these modules, which is why the Makefile forces GOWORK=off: CI has no workspace, and a workspace build resolves sibling checkouts instead of the pinned versions. silkd's integration tests spawn real processes — run them in a Linux container too (docker run rust:1 … cargo test) before touching platform-sensitive paths; macOS green alone has hidden Linux-only breakage before.

Bare-metal e2e

scripts/sandboxd-e2e.sh drives the real stack on a node with cocoon and a silkd-baked template image: golden build → warm pool → claim tiers → the full v2-verb smoke (files/session/find/replace/watch/git/pty) → reap → restart reconcile.

TEMPLATE=rt:24.04 scripts/sandboxd-e2e.sh
# BRIDGE=br0 adds an egress pool and the egress lane-detect check; a plain# `ip link add br0 type bridge` with no uplink is enough (NIC, not network).# SANDBOXD_BIN/DEMO_BIN/SMOKE_BIN point at prebuilt binaries for nodes# without a Go toolchain.# VOLUME_IMAGE=/absolute/dataset.img enables the volumes proof (ro sharing;# the image contains volume-e2e.txt); VOLUME_RW_IMAGE=/absolute/scratch.img# adds the rw claim/release leg. Prebuilt runs also set VOLUME_SMOKE_BIN.

CI

  • silkd.yml / sandboxd.yml — Rust and Go test+lint suites
  • python.yml — ruff + pytest for the three Python packages
  • images.yml — the single image entry point: on a push touching boot/**, silkd/**, protocol/**, or os-image/** it builds the changed carriers (via build-boot.yml / build-silkd.yml, workflow_call) then os-images, in order, so the chain is deterministic
  • build-os-images.yml — bakes base + flavors FROM the sha-pinned carriers
  • release.yml — on a version tag, builds the release binaries and archives
  • publish-pypi.yml — on an sdk-*-v* tag, builds and publishes the matching package via PyPI Trusted Publishing (OIDC, per-package environment)

On a fresh repo run build-boot first — images build FROM the boot artifact.

Boot chain

cloud-hypervisor
→ vmlinux (PVH ELF, everything =y, no decompress stage)
→ uncompressed ~1.5MB cpio: /init = sandbox-init (static Rust)
→ resolve virtio-blk serials via sysfs (2ms poll, no udev)
→ mount EROFS layers → overlayfs + ext4 COW → switch_root
→ exec /sbin/init (systemd, trimmed; cocoon-agent + silkd start at sysinit)

Boot contract (cmdline keys consumed by sandbox-init):

cmdline keymeaning
cocoon.layers=a,b,…EROFS layer disks resolved from virtio-blk serials, lowerdir order
cocoon.cow=xwritable ext4 COW disk (same resolution rules)
cocoon.timeout=10per-disk wait budget, seconds
cocoon.hostname=hset via sethostname(2) before handoff
ip=addr::gw:mask:host:ethN:off[:dns0[:dns1]]cocoon CNI static config: persisted as a MAC-matched networkd unit in the new root (not applied in the initramfs); absent → the image's DHCP fallback covers the NIC
sandbox.init=/pathhandoff target, default /sbin/init
sandbox.debug=1fatal errors drop to /bin/sh (debug initramfs) instead of poweroff
sandbox.trace=1emit one pre-handoff line with per-phase µs timings

boot=cocoon-overlay is ignored. Everything cocoon passes today keeps working — images built here boot with an unmodified cocoon.

License

The server stack — sandboxd, silkd, the boot chain, the OS images, and the MCP server — is licensed under AGPL-3.0. The client SDKs (sdk/go, sdk/python, sdk/openai, sdk/langchain) are licensed under Apache-2.0 (see the LICENSE file in each directory), so embedding a client in a proprietary agent stack carries no copyleft obligation.

About

Fast cold-boot MicroVM sandboxes for AI agents on cocoon

Topics

Resources

Security policy

Stars

50 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

sandbox

MicroVM sandboxes for AI agents, built on cocoon: a fast-boot guest stack, an in-guest product daemon, a per-node control plane with warm pools, and a Go SDK. Warm claims are sub-millisecond; a pool miss clones from a golden snapshot in tens of milliseconds; cold boot is ~200ms on bare metal.

SDK (Go) sandboxd (per node) guest microVM
sandbox.New() ── HTTP ─► claim: warm pool / golden clone Cloud Hypervisor
sb.Exec/Files/… ─ HTTP upgrade ─► byte relay ── vsock ──► silkd :2048
memberlist mesh: warm-count gossip,
MOVED-style redirect to the owning node

Cloud Hypervisor serves both network lanes. net=none has no NIC and uses vsock-only I/O (hardened default); net=egress attaches a bridge/CNI NIC.

Documentation: cocoonstack.github.io/sandbox (deployment, clusters, HTTP API, Go + Python SDK references, the MCP server, the OpenAI Agents SDK and LangChain adapters, silkd protocol, performance) — source in docs/.

Layout

  • silkd/ — in-guest product daemon (Rust, tokio): exec with context, persistent shell sessions, streaming fs, tar-stream tree push/pull, find/replace, watch (ready-acked), pty, structured git, guest port relay (port_forward), and an LSP broker for flavor-shipped language servers — newline-JSON frames over vsock 2048, one connection per RPC; baked into the base image
  • sandboxd/ — per-node control plane (Go): warm pools refilled from golden snapshot exports (online-retunable), claim/release/hibernate/fork/promote/ checkpoint HTTP API, operator-catalog dataset volumes (read-only or writable), signed preview URLs, the HTTP-upgrade byte relay to silkd, usage + audit journals, /metrics, reap + restart reconcile, memberlist mesh with redirect placement
  • sdk/go/ — Go SDK: Connect/New/Lookup, Exec/Run, files, Push/Pull, sessions, Find/Replace, Watch, git verbs, OpenPty, Fork/Hibernate/Promote/Checkpoint, DialPort/ProxyPort/PreviewURL, StartLsp, Spawn/Ps/Kill/Logs/Attach; protocol/wire carries the frame vocabulary, sdk/go/silkd the conn layer, silkdtest a test fake
  • sdk/python/ — Python SDK (stdlib-only, sync), matching the Go guest and data-plane surface for the Python-first agent ecosystem; node pool retuning remains Go-only; round-trips the shared fixture corpus
  • mcp/sandbox-mcp, an MCP stdio server exposing the surface as tools for Claude Code / Cursor / agent frameworks
  • sdk/openai/cocoonstack-sandbox-openai, a custom sandbox provider for the OpenAI Agents SDK (Python, over the Python SDK)
  • sdk/langchain/cocoonstack-sandbox-langchain, a LangChain toolkit (StructuredTools over the Python SDK, checkpoint branching)
  • protocol/wire/fixtures/ — golden frame corpus; the Rust, Go, and Python protocol tests all round-trip it, so wire drift fails CI
  • e2e/ — in-process full-stack tests (real pool/engine/relay/SDK, fake cocoon+guest) plus bare-metal acceptance drivers under cmd/: demo, smoke, meshsmoke, crossnode, coldproof, egresssmoke, interceptsmoke, volumesmoke, lifecycle (idle→hibernate→archive), androidsmoke, browsersmoke, and the pullbench/pushbench/rpcbench perf drivers
  • boot/kernel/ — kernel version pin (VERSION + matching tarball SHA256, bump both together) + config fragment (amd64: over x86_64_defconfig + kvm_guest.config; arm64: over defconfig, then sandbox-arm64.config)
  • boot/init/sandbox-init, the entire initramfs userland (Rust, static musl build)
  • boot/Dockerfile — multi-stage: kernel → init → cpio → scratch image with /boot/vmlinuz-sandbox + /boot/initrd.img-sandbox
  • os-image/ — VM images consuming the boot artifact: base (layered, for builds), rt (base squashed to one layer — the default template in examples), python, python-rt, browser, and android
  • scripts/boot-bench.sh (boot phase timing), bench.sh (the published benchmark procedure), sandboxd-e2e.sh (bare-metal e2e, below), plus the archive/egress/intercept e2e drivers

Build & test

make help# this list
make lint test# Rust: boot/init + silkd (fmt --check, clippy -D warnings, tests)
make go-lint # Go: sandboxd + sdk/go + e2e + mcp, GOOS linux AND darwin
make go-test # Go: go test -race across the Go modules
make sandboxd # build dist/sandboxd
make boot # kernel + initramfs artifact image (docker)# KERNEL_MIRROR=… if kernel.org tarball paths 404 locally
make silkd-image # silkd release binary in a scratch carrier image
make images # base + python images against the local boot + silkd images

The parent workspace's go.work includes these modules, which is why the Makefile forces GOWORK=off: CI has no workspace, and a workspace build resolves sibling checkouts instead of the pinned versions. silkd's integration tests spawn real processes — run them in a Linux container too (docker run rust:1 … cargo test) before touching platform-sensitive paths; macOS green alone has hidden Linux-only breakage before.

Bare-metal e2e

scripts/sandboxd-e2e.sh drives the real stack on a node with cocoon and a silkd-baked template image: golden build → warm pool → claim tiers → the full v2-verb smoke (files/session/find/replace/watch/git/pty) → reap → restart reconcile.

TEMPLATE=rt:24.04 scripts/sandboxd-e2e.sh
# BRIDGE=br0 adds an egress pool and the egress lane-detect check; a plain# `ip link add br0 type bridge` with no uplink is enough (NIC, not network).# SANDBOXD_BIN/DEMO_BIN/SMOKE_BIN point at prebuilt binaries for nodes# without a Go toolchain.# VOLUME_IMAGE=/absolute/dataset.img enables the volumes proof (ro sharing;# the image contains volume-e2e.txt); VOLUME_RW_IMAGE=/absolute/scratch.img# adds the rw claim/release leg. Prebuilt runs also set VOLUME_SMOKE_BIN.

CI

  • silkd.yml / sandboxd.yml — Rust and Go test+lint suites
  • python.yml — ruff + pytest for the three Python packages
  • images.yml — the single image entry point: on a push touching boot/**, silkd/**, protocol/**, or os-image/** it builds the changed carriers (via build-boot.yml / build-silkd.yml, workflow_call) then os-images, in order, so the chain is deterministic
  • build-os-images.yml — bakes base + flavors FROM the sha-pinned carriers
  • release.yml — on a version tag, builds the release binaries and archives
  • publish-pypi.yml — on an sdk-*-v* tag, builds and publishes the matching package via PyPI Trusted Publishing (OIDC, per-package environment)

On a fresh repo run build-boot first — images build FROM the boot artifact.

Boot chain

cloud-hypervisor
→ vmlinux (PVH ELF, everything =y, no decompress stage)
→ uncompressed ~1.5MB cpio: /init = sandbox-init (static Rust)
→ resolve virtio-blk serials via sysfs (2ms poll, no udev)
→ mount EROFS layers → overlayfs + ext4 COW → switch_root
→ exec /sbin/init (systemd, trimmed; cocoon-agent + silkd start at sysinit)

Boot contract (cmdline keys consumed by sandbox-init):

cmdline keymeaning
cocoon.layers=a,b,…EROFS layer disks resolved from virtio-blk serials, lowerdir order
cocoon.cow=xwritable ext4 COW disk (same resolution rules)
cocoon.timeout=10per-disk wait budget, seconds
cocoon.hostname=hset via sethostname(2) before handoff
ip=addr::gw:mask:host:ethN:off[:dns0[:dns1]]cocoon CNI static config: persisted as a MAC-matched networkd unit in the new root (not applied in the initramfs); absent → the image's DHCP fallback covers the NIC
sandbox.init=/pathhandoff target, default /sbin/init
sandbox.debug=1fatal errors drop to /bin/sh (debug initramfs) instead of poweroff
sandbox.trace=1emit one pre-handoff line with per-phase µs timings

boot=cocoon-overlay is ignored. Everything cocoon passes today keeps working — images built here boot with an unmodified cocoon.

License

The server stack — sandboxd, silkd, the boot chain, the OS images, and the MCP server — is licensed under AGPL-3.0. The client SDKs (sdk/go, sdk/python, sdk/openai, sdk/langchain) are licensed under Apache-2.0 (see the LICENSE file in each directory), so embedding a client in a proprietary agent stack carries no copyleft obligation.

About

Fast cold-boot MicroVM sandboxes for AI agents on cocoon

Topics

Resources

Security policy

Stars

50 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages