Getting Started
Choose how you run Synap, then open the app, connect agents, or call the API
Pick how you run a pod, then Quickstart points you to the app, AI agents, or SDK.
New here?
Read What is Synap? first if you want the product picture in one pass.
How you run Synap
Synap Cloud
Sign in at synap.live — hosted provisioning; app download in the signup flow.
- Fastest path to a workspace
- Same flow documented under Installation → Hosted
Docker / your infra
Compose, images, and production checklists.
- Official backend repo + deploy/
- Deep guides → Architecture → Deployment
CLI: pod + agents
Repo synap script for install/update; npm CLI for OpenClaw & agents.
- Server lifecycle vs npx @synap/cli
- Unifying toward one story (in progress)
From source
Clone the monorepo and run pnpm + Docker for full development.
Docs mirror: Installation → Hosted.
Then do this
Quickstart
Route to app, agents, SDK, or deeper docs.
AI agents & tools
OpenClaw, Hub Protocol, npx @synap/cli init.
First SDK queries
React, TypeScript, or cURL to your pod.
Install details & checklist
- Installation — full narrative for Cloud, Docker, CLI, and source.
- Next steps — architecture, integrate, deploy, community.
- Why events — mental model (Architecture space).
Help
- Discord
- GitHub issues
- Testing guide — local debugging