ZeroDB Local · v0.3.0
Run the full ZeroDB stack on your machine
Vectors, tables, files, memory, and events — offline, mirroring the cloud API onlocalhost. Build with no network, then sync to the cloud when you're ready. Same code, no lock-in.
Offline-first
Build and test with no network and no cloud spend. Everything runs locally.
Cloud API parity
The same API on localhost as in the cloud — write once, run either place unchanged.
Sync when ready
Link a cloud project and push local work up (or pull it down) with one command.
Install & run
Option A — Docker Compose
cd zerodb-local cp .env.local.example .env.local docker-compose up -d # API: http://localhost:8000 (docs at /docs) # Dashboard: http://localhost:3000
Option B — pip
pip install zerodb-local==0.3.0 # Python 3.9–3.13 zerodb serve --host 0.0.0.0 --port 8765 # Or run the guided setup wizard: zerodb init
zerodb init checks Docker, scans ports, downloads the embedding model, and starts every service — in about a minute. Runzerodb doctor --fix if anything needs attention.
What's inside
The real engines behind ZeroDB, running as local services:
| Component | Tech | Port | Purpose |
|---|---|---|---|
| API Server | FastAPI | 8000 | REST API mirroring the cloud (docs at /docs) |
| Database | PostgreSQL 16 + pgvector | 5432 | Tables + vectors |
| Vector search | Qdrant | 6333 | Semantic search |
| Object storage | MinIO | 9000/9001 | S3-compatible files |
| Event streaming | RedPanda | 9092/9644 | Kafka-compatible events |
| Embeddings | bge-small-en-v1.5 (384d) | 8001 | Local embedding generation |
| Dashboard | React 18 + Next.js 14 | 3000 | Web UI |
Sync to the cloud
zerodb cloud login # authenticate zerodb cloud link <project_id> # link local <-> a cloud project zerodb sync plan # preview the diff zerodb sync apply # push local -> cloud zerodb cloud pull # pull cloud -> local
Sync uses ZeroDB's bundle sync. Set a conflict policy in .env.local:newest-wins /local-wins /cloud-wins / manual.
Looking for a one-click app? ZeroDB Desktop bundles all of this into a native installer (coming soon).
Get the ZeroDB Local Step-by-Step Guide
A free PDF workbook: install, run the wizard, hit API parity, and sync to the cloud — step by step.
Frequently asked questions
What is ZeroDB Local?
ZeroDB Local (v0.3.0) runs the full ZeroDB stack — vectors, tables, files, memory, and events — on your own machine. It exposes the same API surface as ZeroDB Cloud on localhost, so code written against Local runs unchanged against the cloud.
How do I install ZeroDB Local?
Two ways: (1) Docker Compose — clone the repo, copy .env.local.example to .env.local, and run docker-compose up -d. (2) pip — run pip install zerodb-local, then zerodb serve. The zerodb init wizard checks Docker, scans ports, downloads the embedding model, and starts every service in about a minute.
Does ZeroDB Local work offline?
Yes. ZeroDB Local is offline-first — you can build and test with no network and no cloud spend. When you are ready, link a cloud project and sync your data up (or pull it down) with the zerodb sync commands.
Is the local API the same as the cloud API?
Yes — Local mirrors the cloud API. Projects, vectors, tables/NoSQL, files, memory, and events all behave the same. The only difference between environments is the base URL: http://localhost:8000 locally versus https://api.ainative.studio in the cloud.
What runs inside ZeroDB Local?
A FastAPI server (port 8000) mirroring the cloud API, PostgreSQL 16 + pgvector (5432), Qdrant for vector search (6333), MinIO for S3-compatible storage (9000), RedPanda for event streaming (9092), a local embeddings service (8001, BAAI/bge-small-en-v1.5), and a web dashboard (3000).
