Skip to content

Commit 14aea2b

Browse files
committed
docs: add architecture diagram to README
Replaces the ASCII art block with a 1536×1024 architecture overview covering all 10 design dimensions: 1. Four orthogonal ports (WHAT/HOW/WHERE/REMEMBER/AUDIT) 2. Harness Protocol — HTTP + SSE wire diagram 3. Git URL as canonical agent identity 4. Substrate runtime matrix (Local/Bwrap/E2B/VZ) 5. Permission / governance flow 6. Audit & telemetry pipeline 7. Library mode vs server mode 8. SessionStore architecture 9. End-to-end topology (one session) 10. Design principles
1 parent 606bab5 commit 14aea2b

2 files changed

Lines changed: 5 additions & 38 deletions

File tree

README.md

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -188,44 +188,11 @@ See [`PLAN.md`](./PLAN.md) for the full architecture history.
188188

189189
## Architecture in three minutes
190190

191-
```
192-
User code
193-
194-
│ new ComputerAgent({ source, harness, runtime, sessionStore, envs }).chat(msgs)
195-
196-
┌─────────────────────────────────────────────┐
197-
│ @computeragent/sdk │
198-
│ (HTTP+SSE client, ChatHandle, permissions) │
199-
└─────────────────────────────────────────────┘
200-
201-
│ Harness Protocol (SSE + POST over HTTP)
202-
│ /v1/sessions, /chat, /events, /messages, /permission, /cancel, /fs/*
203-
204-
┌─────────────────────────────────────────────┐
205-
│ @computeragent/harness-server │
206-
│ - Routes (Hono on Bun or Node) │
207-
│ - Session lifecycle + permission map │
208-
│ - Path-jailed workspace FS over HTTP │
209-
│ - Pluggable AuditSink + AuthHandler │
210-
│ - SessionStore registry (memory/file/...) │
211-
└─────────────────────────────────────────────┘
212-
│ │ │
213-
│ EngineDriver │ IdentityLoader │ SessionStore
214-
▼ ▼ ▼
215-
┌──────────────────┐ ┌────────────────────────┐ ┌──────────────────────┐
216-
│ engine-claude-… │ │ identity-gitagent… │ │ MemorySessionStore │
217-
│ engine-gitagent │ │ (your-loader here) │ │ FileSessionStore │
218-
│ (your-engine) │ └────────────────────────┘ │ MongoSessionStore │
219-
└──────────────────┘ │ SqliteSessionStore │
220-
│ │ (your-store here) │
221-
│ Substrate: bootHarness({envs}) → {url} └──────────────────────┘
222-
223-
┌──────────────────────────────────────────────────────┐
224-
│ runtime-local runtime-e2b runtime-vzvm │
225-
│ (subprocess) (cloud) (Apple VZ) │
226-
│ (your-substrate here) │
227-
└──────────────────────────────────────────────────────┘
228-
```
191+
<p align="center">
192+
<img src="./assets/architecture-diagram.png" alt="ComputerAgent — Architecture Overview" width="900">
193+
</p>
194+
195+
Ten diagrams in one: four orthogonal ports (WHAT/HOW/WHERE/REMEMBER/AUDIT), the HTTP+SSE harness protocol, git-URL-as-identity, the substrate runtime matrix, permission/governance flow, telemetry pipeline, library vs server mode, SessionStore architecture, end-to-end topology, and design principles. Every box is swappable through the same SDK call.
229196

230197
The protocol is the artifact. Engines, identity loaders, substrates, and session stores are plug-ins.
231198

assets/architecture-diagram.png

1.62 MB
Loading

0 commit comments

Comments
 (0)