Electric Sync

Electric Sync is a read-path sync engine for Postgres. It syncs data out of Postgres into local clients over HTTP using a primitive called a Shape.

Use it to build fast, modern apps and multi-agent systems with Electric.

Getting started

Start with the Quickstart for the fastest way to get up-and-running.

The easiest way to use Electric in production is the Electric Cloud. Alternatively, the Deployment guide covers how to self host.

• Quickstart — get a sync running end-to-end in a few minutes.
• Stacks — recommended stacks for building local-first apps with Electric.

Guides

• Shapes — defining what gets synced.
• Auth — securing access to your shapes.
• Writes — patterns for writing data back through your API.
• Deployment — how to self-host Electric.
• Security — securing your Electric deployment.
• Client development — building your own client library.

Reference

• HTTP API — the protocol that clients consume.
• TypeScript client — the official client library.
• Configuration — server configuration options.
• Integrations — framework, platform, and database integrations.

Examples

See the Demos section and examples folder on GitHub for demos and examples, e.g.:

Burn

Agentic system built on Postgres and a real-time sync stack.

• Open demo
• Source code

Linearlite

Local-first project management app built with Electric and PGlite.

• Open demo
• Source code

The integration docs also illustrate common patterns, e.g. using Electric with frameworks like TanStack and Phoenix and platforms like Supabase and Cloudflare.

See also

• PGlite — embeddable Postgres for the browser, Node.js, and edge.

Source code

Electric is an open source project developed at github.com/electric-sql. Check out the source code, issues and development in progress there.

Support

See the Community page for information on support and events, including our community Discord where you can ask questions and get support.