Orez documentation
Orez is an easy, all-in-one way to run Zero locally. It manages zero-cache, its databases, replica storage, migrations, and process lifecycle from one configuration.
bunx orez
Get started
Start the default portable stack, connect the real Zero client, and add your application endpoints.
PGlite / WASM
Run without Docker, a separately installed database, or native compilation.
Embedded Postgres
Use a real PostgreSQL server when tests need concurrent connections and stock logical replication.
What Orez manages
Orez coordinates the services around a stock Zero application:
- zero-cache and its replica storage;
- PGlite or Embedded Postgres;
- migrations and application lifecycle hooks;
- local object storage and admin controls; and
- stable addresses for development and CI.
Your application keeps the real @rocicorp/zero client, schema, named queries,
custom mutators, and optimistic local state.
Recommended path
- Run the quick start.
- Keep PGlite/WASM for the smallest local and CI setup.
- Switch to Embedded Postgres when you need production-like concurrency and logical replication.
- Move repeatable settings into Configuration and CLI.
Lime Sync, the SQLite-native replacement sync server, now has its own documentation site.