CLI

init, generate

init

npx @bettersync/cli init

Scaffolds sync into an existing project.

generate

# New database
npx @bettersync/cli generate --config lib/sync.ts

# Existing database
npx @bettersync/cli generate --config lib/sync.ts --alter --backfill

# Save to file
npx @bettersync/cli generate --output migrations/sync.sql

React

SyncProvider, useSync, useSyncQuery, SyncDevtools

Playground

Try bettersync live — two clients syncing through a virtual server

On this page