Syncropel Documentation
Coordination protocol for hybrid human-AI teams. Build with immutable records, evidence-based trust, manifest-driven workspaces, and self-improving workflows.
Install
# Linux + macOS
curl -sSf https://get.syncropic.com/spl | sh
# Windows (PowerShell)
irm https://get.syncropic.com/spl.ps1 | iex
# Then
spl init && spl serve --daemonFollow the Quickstart for a 10-minute walkthrough — install to first task with trust evidence. Or read Get Started for the deeper, multi-page onboarding journey.
If you're integrating from code, jump to the TypeScript SDK or Python SDK.
What a Syncropel thread looks like
Every coordination event — chat, task, code change, tool call, observation, intent — becomes a record. Records group into threads. Threads produce trust:
fix-checkout-timeout 5 records · 3 actors · trust 0.92
● you INTEND "Fix checkout timeout before launch" 14m ago
○ agent DO Profiled API — connection pool saturated at 10 12m ago
○ agent DO Patch applied: pool 10 → 50, deployed to staging 9m ago
○ monitor KNOW p99 latency 4.2s → 180ms — 340 users unblocked 6m ago
○ agent LEARN "Pool sizing must scale with replicas" now
pattern crystallized (trust 0.92)● is human; ○ is an AI agent or system. Every record is immutable, content-addressed, and signed by its actor. The LEARN at the end crystallizes into a reusable pattern — next time the same shape of issue appears, the solution replays automatically.
That same thread can federate to another instance with consent-gated sync, ship as a workspace others can install, or be queried via the TypeScript SDK / Python SDK / MCP-compatible AI clients (Claude Desktop, Cursor, Cline, Zed, OpenCode, and others).
Tutorials
Step-by-step learning — follow along from start to finish.
| Tutorial | Description |
|---|---|
| Your First Task | Create, complete, and see trust grow |
| Working with Threads | Open, fork, and close coordinated workflows |
| Build your First Workspace | Scaffold, edit, test, publish, and share — the canonical workspace path |
| Multi-Namespace Setup | Two isolated environments under one ORG with the 5-level hierarchy |
| Your First Fan-Out | 5-minute version: boot a fleet, fan out a task, watch the barrier join |
| Parallel Dev Walkthrough | 20 minutes: 3-instance fleet, real fan-out, kill switch, barrier join, cleanup |
| First SDK Integration | 15 minutes: Node.js script that emits records and queries them back |
| First Iframe Extension | 30 minutes: build an iframe extension with @syncropel/extensions |
| First React Component Consumer | 30 minutes: Next.js task inbox using @syncropel/sdk + @syncropel/react |
Templates
Ready-to-scaffold workspace examples.
| Section | What's there |
|---|---|
| Templates Gallery | Seven worked workspace examples (tracker, multi-page, newsletter, course, recipe-collection, solo-tracker, catalog). Each scaffolds via spl workspace init and passes spl workspace test immediately. |
Concepts
Understand how Syncropel works under the hood.
| Concept | Description |
|---|---|
| Records | The 8-field immutable, content-addressed unit |
| Threads | Group records into coordinated workflows |
| Actors | Identity, trust profiles, and persistent memory |
| Workspaces | Manifest-driven applications you ship by publishing a record |
| Catalog | Curated discovery surface above the registry |
| Trust | Evidence-based reputation with the dial |
| Patterns | Proven workflows that replay automatically |
| Namespaces | 5-level hierarchy for tenancy and policy isolation |
| Governance | PARC, scope tokens, and how decisions get authorized |
| Federation | How two instances sync records with consent and signatures |
| Secrets | Four-layer credential handling — values never enter the record graph |
| The Engine | Four loops from ingest to learning |
Guides
Solve specific problems — task-oriented, practical.
Day-to-day operations
| Guide | Description |
|---|---|
| Task Management | Full lifecycle from creation to approval |
| Routing Rules | Control how work flows to actors |
| Scheduled Triggers | Cron-style automation against the record stream |
| CEL Expressions | Author rules for triggers, routing, fold, health, AITL, permissions |
| Query | MongoDB-style filter grammar for record retrieval |
| Search | Semantic + full-text search across threads |
| body.kind manifest | Record kind grammar and reserved scopes |
| Namespaces | Set up multi-tenant scoping |
| Consent Management | Control what crosses namespace boundaries |
Federation
| Guide | Description |
|---|---|
| Pair two stewards | One-command handshake — discovery, reciprocal tokens, persistent pair records |
| Federation discovery | Find peers by handle or directory |
| Async federation | Record sync via relay when peers are offline |
| Federation (legacy sync) | Manual sync setup for reference |
Inference
| Guide | Description |
|---|---|
| Inference Overview | Why infer.query.v1, what it solves, where it fits |
| Query Anatomy | Walking through a query body |
| Fold Functions | The five aggregators in detail |
| Orchestration Patterns | Six multi-step flows |
Integration
| Guide | Description |
|---|---|
| Actors & Adapters | Register participants and connect them |
| Agent Integration | Connect AI agents to dispatch and trust |
| Session Checkpoints | Save + resume agent sessions |
| Debugging Syncropel | doctor → status → debug replay → audit export |
| Dispatch observability | Records-as-observations for every dispatch |
| Cookbook: dispatch recovery | Resume from partial dispatch failure |
| Cookbook: Claude session correlation | Map dispatches to Claude session IDs |
SDKs + UI
| Guide | Description |
|---|---|
| TypeScript SDK | Universal JS/TS client — Node, Deno, Bun, Workers, browsers |
| Python SDK | Emit records and query threads from Python |
| Projections | Schema + validators for declarative UI documents |
| React Components | Component palette that renders projection documents natively |
| Extensions SDK | Build iframe-embedded apps for a Syncropel workspace |
Operations + Backup
| Guide | Description |
|---|---|
| Backup & Recovery | Protect your data and recover safely |
| Docker Deployment | Multi-stage image, compose topology, smoke test |
| SIEM Integration | Pipe spl audit export into Splunk, Elastic, Loki, Datadog |
Cookbook
Short, tested recipes for common operational shapes — copy, adapt, ship. See the full cookbook for all recipes.
| Recipe | Problem it solves |
|---|---|
| Route by domain | Dispatch code to one agent and ops to another without rule explosion |
| Trust-gated auto-approval | High-trust actors ship without blocking on review |
| Federate one thread | Share a single task thread with a collaborator on a different instance |
| Scheduled daily digest | Cron trigger at 09:00 that summarises the last 24 hours |
| Audit export to Elastic | Pipe security-relevant records into your SIEM |
| 3-LLM consensus summarization | Fan out to three LLMs, consensus-fold, take the most-agreed answer |
| Translate with human verification | Two LLMs translate + verify; human only when LLMs disagree |
| Cost-bounded query waterfall | Cheap LLM first, escalate stage-by-stage, hard-stop at a cost ceiling |
| Audit-critical with ensemble | Ensemble-fold three LLMs, compliance officer audits |
| Escalate on low confidence | LLM handles the common case; human pulled in when LLM isn't sure |
Integrate
Connect Syncropel to other tools.
| Page | Description |
|---|---|
| AI clients | Plug Syncropel into MCP-compatible clients (Claude Desktop, Cursor, Cline, Zed, OpenCode, and others) |
| Programmatic agents | Integrate code-execution-capable agents that emit records via the SDK in a sandbox |
Operate
Day-2 operations for production instances.
| Page | Description |
|---|---|
| Operator Runbook | Daemon lifecycle, recovery from corruption, backup discipline, in-place upgrades |
| Persist Instance | Auto-start at login + auto-restart on crash (systemd, launchd, Windows Service) |
| Authentication & Service Accounts | Bearer-token auth, service accounts, device pairing, rotation, revocation |
| Doctor | Top-down diagnostic tree — when something doesn't work, start here |
| Troubleshooting connection | Browser-can't-reach-daemon, CORS, PNA, network failure modes |
| Audit export | Stream the security-relevant record subset for compliance + SIEM |
| Actor portability | Move an actor identity between instances |
| Workspace lifecycle | Draft / published / archived, the transition matrix |
| Workspace testing | Native test runner for workspace fold functions |
| Workspace sharing | spl share for bug repro + collaboration |
| Extension publishing | Ship iframe extensions to a workspace registry |
| Fleet benchmarking | Measure your fleet's parallel speedup honestly |
| Windows service | Run spl serve as a Windows Service |
| Relay operator guide | Deploy your own async-federation relay |
Reference
Look things up — commands, endpoints, formats.
| Reference | Description |
|---|---|
| CLI | Every spl command with flags and examples |
| HTTP API | All endpoints with request examples |
| Record Format | The 8 fields, types, and canonical JSON |
| Configuration | Settings, rules, and data locations |
| infer.query.v1 schema | Full inference query schema with field tables |
| Iframe host snippet | Drop-in code for hosting an extension iframe |
| Glossary | Key terms A to Z |