agentleFS
AFK-surfAFK-surf/OpenBridge/sandbox-vm/AGENTS.md

OpenBridge / sandbox-vm

AGENTS.md430 starsChanged 6 months agoMITView on GitHub

This file provides guidance to coding agents working in sandbox-vm/, OpenBridge's pure sandbox VM control library. Read repo-wide rules first: /AGENTS.md sandbox-vm owns VM and sandbox control only. Swift owns the agent SDK, model loop, tool definitions, product features, and environment routing. Current product-facing responsibilities:

The file

We split this AGENTS.md into the rules it gives an agent

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep source-of-truth in current Go code.

    line 73
  2. Very specific:

    Do not reintroduce agent-cli, slack-agentd, meetd, gcal-auth, meeting joiner, prompt/history agent types, or old framework client/server …

    line 74
  3. Very specific:

    Prefer product-facing runtime ownership in localconnector, envhost, runtimebridge, and platform/vm

    line 75
  4. Very specific:

    Avoid adding new tool/loop/LLM logic to sandbox-vm.

    line 76

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Sandbox VM

This file provides guidance to coding agents working in sandbox-vm/, OpenBridge's pure sandbox VM control library.

Read repo-wide rules first: /AGENTS.md

What This Component Is

sandbox-vm owns VM and sandbox control only. Swift owns the agent SDK, model loop, tool definitions, product features, and environment routing.

Current product-facing responsibilities:

  • local-vm runtime framework export for the macOS app
  • local VM runtime ownership (internal/localconnector)
  • sandbox execution host (internal/envhost/sandbox)
  • execution-scoped runtime bridge (internal/framework/runtimebridge)
  • VM lifecycle / vsock / guest daemon (internal/platform/vm)

Current Architecture

macos (SwiftUI)
  └─ local-vm runtime framework (sdk/apple/)
       ├─ internal/localconnector   local VM session runtime
       ├─ internal/envhost/         sandbox host + runtime bridge server
       ├─ internal/framework/
       │   └─ runtimebridge/        host callback + local runtime bridge
       └─ internal/platform/vm/     VM + vsock + guest daemon

Directory Map

sandbox-vm/
├── cmd/
│   └── vmd/
├── sdk/apple/               gomobile-facing runtime API
├── internal/envhost/        sandbox execution host + runtime bridge server
├── internal/framework/      runtime bridge
├── internal/localconnector/ local VM runtime ownership
├── internal/platform/vm/    VM lifecycle + guest daemon
└── internal/integrations/   local integration helpers

Build and Test

  • make framework build the local-vm runtime artifact (current filename: dist/SandboxVM.xcframework)
  • make vm build VM kernel/rootfs assets
  • make proto regenerate internal/platform/vm/vmrpc/*.pb.go
  • make go-test run Go tests

Runtime Concepts

Session and Local VM State

  • runtime root defaults to ~/.openbridge/sandbox-vm
  • per-session local VM state lives under ~/.openbridge/sandbox-vm/sessions/<session-id>/
  • localconnector owns overlay restore / apply / discard

Environment Model

  • concrete execution host ownership now lives in internal/envhost/sandbox
  • VM lifecycle ownership lives in envhost/platform layers, not in higher adapters

Runtime Bridge

  • capability URL generation and local callbacks live in internal/framework/runtimebridge
  • host HTTP entrypoint lives in internal/envhost/runtime_bridge_server.go
  • sandbox reuses the shared host-side runtime bridge server

Guardrails

  • Keep source-of-truth in current Go code; docs here must track implementation
  • Do not reintroduce agent-cli, slack-agentd, meetd, gcal-auth, meeting joiner, prompt/history agent types, or old framework client/server paths
  • Prefer product-facing runtime ownership in localconnector, envhost, runtimebridge, and platform/vm
  • Avoid adding new tool/loop/LLM logic to sandbox-vm; the product agent now lives in the macOS app through vendored kwwk

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.