Documentation
Start local in five minutes, then read the source of truth.
The authoritative documentation lives in the repository, versioned with the code. This page is the map: what to run first, what to read to operate Switchyard, and where the normative references are.
Start here
The five-minute quickstart
Requires Docker for PostgreSQL. bin/setup is safe to run repeatedly.
git clone git@github.com:jenksed/switchyard.git
cd switchyard
bin/setup # starts PostgreSQL, installs deps, migrates, builds assets
bin/dev # serves http://localhost:4000
Open http://localhost:4000 and click Create an endpoint to
receive your first webhook. The full walkthrough is in
docs/quickstart.md.
Operate
Run it day to day
- Relay protocol
How the authenticated relay carries delivery to your private network, so the server never dials it directly.
- CLI reference
The switchyard CLI, including the evidence commands for events, deliveries, replay, and receipts.
Evidence
Receipts, bundles, and shares
- AI-agent webhook evidence guide
Receipts, bundles, verification vocabulary, and the scoped operations an agent may follow up with.
- Evidence shares spec
How sanitized evidence is bundled and shared, and what is structurally absent from every export.
Reference
The normative documents
- PROJECT_PLAN
The product roadmap and the scope decisions behind the non-claims on the trust page.
- PATH_TO_V1
What remains between the v0.9 release candidate and the v1 stability contract.
- TESTED_LIMITS
The complete v0.9 soak record: hardware, software, topology, receipts, and classification.
- Evidence shares spec
The normative specification for sanitized, versioned evidence bundles.
Everything linked here lives in the Switchyard repository. If this page and the repository ever disagree, the repository is correct.