The waggle documentation map
July 11, 2026 · View on GitHub
Four kinds of documents live here, for four kinds of readers. Start where your question is.
Why does this exist? (the case)
| WHY.md | The cornerstone essay: how resources actually pass between agents today (the four-boundary matrix), what it costs, why provider optimizations don't transfer, the bee that inspired the design — and how the substrate works at every radius. |
| The essay | The inspiration essay: the waggle dance, stigmergy, and the distributed-systems lineage (tuple spaces, named-data networking, capabilities, leases, the log) — why the design is shaped this way. |
How do I use it? (the guides — in reading order)
Getting started
- Five minutes to a first token — install, mint, resolve, hand off
- waggle in Claude Code — the MCP wiring,
waggle init, subagent handoffs
The core moves
- Variants & media — one token, per-consumer projections; attachments
- Lifecycle & query — revoke/supersede/expire; slicing documents by path
- The full lifecycle, illustrated — orchestrator → subagents → back, the URI taking shape end to end
The sharp edges
- Surgical content access — read/search through the token: the grep travels, the artifact stays
- Embedding in Rust — the crates as a library
Running it
- waggled & federation — lifecycle verbs, two-machine setup, strict vs eventual freshness
- The edge — deploy to Cloudflare in 5 minutes;
waggle edge status|push|smoke - The edge, walked through — every command against a real account, with diagrams
- The tmux switchboard — window-per-harness workspaces, the live board, agent-driven screen swaps; Fable ↔ Opus, Claude → Codex with lineage, the delegation chain, coverage proof, sealed handoffs
What exactly does it promise? (the reference)
| The specification | Normative (RFC-2119): token, three-zone manifest, sealed matcher, log guarantees, storage contract, trust, resolution semantics |
| Conformance vectors | Generated FROM the implementation, drift-checked in CI — the portable half of the spec |
| COMMANDS.md | Every operation, every argument — generated from the catalog, drift-checked in CI |
| PERF.md | Measured numbers with their benchmarks: 7.4 ns resolves to 2 ms edge round-trips |
How was it designed? (the design docs — the contract)
The design corpus predates the code and governs it. By concern:
- The domain — 02 domain model · 03 core architecture · 04 event sourcing
- The agent experience — 06 agent coordination · 17 agent fluency · 18 content access · 05 social minting
- Storage & concurrency — 07 storage interface · 15 concurrency model · 16 deployment topologies
- The edge — 08 cloudflare foundation (incl. the E1-E13 completeness matrix)
- What's next — 19 interrogation telemetry (plan): convergence, receipt-driven routing, scaffold distillation · 20 the symbol lens (design): source-code handoffs, mint-time structure · 21 the resource projection: MCP resources + subscriptions, and why the verbs are tools