Clients overview

Pylon’s wire format is plain HTTP, WebSocket, and JSON. You can call it with fetch and a WebSocket from any language. Pylon also ships official SDKs that handle the bookkeeping (auth tokens, optimistic mutations, reconnection, CRDT decoding, typed entities), so you don’t reinvent them.

Available SDKs

Package	Use it for
`@pylonsync/sdk`	Schema DSL + manifest builder. Required for codegen.
`@pylonsync/react`	React hooks: `useQuery`, `useMutation`, `useShard`, `useSession`, `useSearch`, `useAggregate`, `useInfiniteQuery`
`@pylonsync/react-native`	React Native + Expo: SQLite-backed offline replica, AsyncStorage adapter
`@pylonsync/next`	Next.js App Router: Server Actions, RSC data fetching, middleware-friendly auth
Swift SDK	iOS / macOS / tvOS / watchOS / Linux native — `PylonClient`, `PylonSync`, `PylonRealtime`, `PylonSwiftUI`
`@pylonsync/sync`	The sync engine: local store, mutation queue, and WebSocket/SSE/poll transports. Every JS SDK uses it. You can also use it standalone in non-React apps.
`@pylonsync/loro`	Loro CRDT integration: collaborative text/lists/maps/trees that converge across clients

Picking the right combination

App type	Use
Web SPA (React)	`@pylonsync/react` (pulls sdk + sync transitively)
Server-rendered web (Next.js)	`@pylonsync/next` (pulls sdk + react transitively)
iOS / macOS native	Swift SDK
iOS + Android (cross-platform)	`@pylonsync/react-native` (pulls sdk + react + sync transitively)
Vite SPA, Vue, Svelte, Solid	`@pylonsync/sdk` + `@pylonsync/sync` (call directly, no React)
CLI / server-to-server	`@pylonsync/sdk` (HTTP only)
Real-time multiplayer	Same as above + `@pylonsync/react`’s `useShard` (or `PylonRealtime` on Swift)
Collaborative editor	Add `@pylonsync/loro` (or `PylonSync` Loro bridge on Swift)

The SDKs share the same wire formats. You can use @pylonsync/react on the web, the Swift SDK on iOS, and @pylonsync/react-native on Android. They all agree about what a ChangeEvent looks like. CRDT bytes are identical across platforms, because they wrap the same Loro Rust core.

Common quickstart

Every SDK shares the same shape. The TypeScript flow:

import { init, db, fetchList } from "@pylonsync/react";
import { sendMagicLink, verifyMagicLink } from "@pylonsync/client";

init({ baseUrl: "https://your-app.com" });

// Sign in
await sendMagicLink("[email protected]");
const session = await verifyMagicLink("[email protected]", code);

// Read entities (one-shot)
const todos = await fetchList("Todo");

// Live updates + optimistic writes go through the global sync engine
await db.insert("Todo", { title: "ship it", done: false });

The Swift flow does the same:

import PylonClient
import PylonSync

let client = PylonClient(baseURL: URL(string: "https://your-app.com")!)
try await client.startMagicCode(email: "[email protected]")
_ = try await client.verifyMagicCode(email: "[email protected]", code: code)

let cfg = SyncEngineConfig(baseURL: URL(string: "https://your-app.com")!)
let engine = await SyncEngine(config: cfg, client: client)
await engine.start()
_ = await engine.insert("Todo", ["title": "ship it", "done": false])

Codegen

Every SDK supports typed access via pylon codegen:

# TypeScript (default)
pylon codegen client pylon.manifest.json --out client.ts

# Swift
pylon codegen client pylon.manifest.json --target swift --out PylonGenerated.swift

Generated files emit:

Entity types: Codable structs (Swift), interface declarations (TS) per entity
Function signatures: typed args and results
Typed client extensions: client.listTodos(), client.createTodo(NewTodo(...)) instead of stringly-typed APIs

Run codegen on every manifest change. Add it to your build script.

Wire compatibility guarantees

Pylon treats wire format as a stability contract. It never breaks without a major version bump. The SDKs evolve independently of the binary; a v0.2.x client works against a v0.3.x server within the same minor.

Where to next

Pick your platform: TypeScript, React, React Native, Next.js, Swift, sync engine, or Loro CRDTs.

Get started

Core concepts

SSR

Auth

Plugins

Clients

Operations

Compare

Migrate

Clients overview

Available SDKs

Picking the right combination

Common quickstart

Codegen

Wire compatibility guarantees

Where to next

​Available SDKs

​Picking the right combination

​Common quickstart

​Codegen

​Wire compatibility guarantees

​Where to next

Available SDKs

Picking the right combination

Common quickstart

Codegen

Wire compatibility guarantees

Where to next