Developer docs

These pages are for people who write parties and client apps.

What you will learn

• how to run synkd on your machine
• how to create a project with the CLI
• how to write a party class
• how to connect with partysocket
• how to add a Yjs collaborative pad
• which packages to import
• what works on Node versus a Durable Objects host

Start here

1. Get started — example stack or a new CLI project
2. CLI — init, doctor, up, down, deploy
3. Write a party — Server API and synkd.json
4. Connect clients — partysocket and auth tokens

Related

• Operators: Operator docs
• System shape: Architecture
• Studio: http://127.0.0.1:5173 when you run pnpm dev:studio