Getting started
Installation
Add the Syndra client to your project and connect it to a project.
Syndra ships as a single, tree-shakeable package with zero runtime dependencies. It runs in browsers, Node.js 20+, Deno, Bun and edge runtimes.
Install the client
sh pnpm add @syndra/client sh npm install @syndra/client sh yarn add @syndra/client sh bun add @syndra/client Create a project
Every app connects to a project. Create one with the CLI it opens your browser to sign in the first time.
sh pnpm dlx syndra init sh npx syndra init sh yarn dlx syndra init sh bunx syndra init The CLI writes a syndra.config.ts file and adds your public key to .env:
SYNDRA_PROJECT=acme-notes
SYNDRA_PUBLIC_KEY=pk_live_7f3a9c2e41b8Framework bindings
The core client works everywhere. For idiomatic hooks and stores, add a binding for your framework:
| Framework | Package | Status |
|---|---|---|
| React | @syndra/react |
Stable |
| Vue | @syndra/vue |
Stable |
| Svelte | @syndra/svelte |
Stable |
| Solid | @syndra/solid |
Beta |
| Swift | SyndraKit |
Preview |
Next, follow the Quickstart to sync your first document.