Installation

You can use SynDB in three ways:

• the hosted web app at app.syndb.xyz
• a local development stack via Docker Compose
• the syndb CLI built from this repository

Hosted Web App

If you only need to browse datasets, authenticate, or use the UI, no local installation is required. Open:

• app.syndb.xyz for the web app
• api.syndb.xyz/docs for the OpenAPI UI

Local Stack

For local development, build the project images and start the stack:

git clone --recurse-submodules https://github.com/memorycircuits/SynDB.git
cd SynDB
cp .env.example .env
syndb dev sync-versions
cargo run -p cli --features dev -- stack prepare
cargo run -p cli --features dev -- stack up

If you already cloned the repo without submodules, run:

git submodule update --init --recursive

The local entry points are:

• API docs: http://localhost:8080/docs
• UI: http://localhost:8090
• Health check: http://localhost:8080/health

CLI From Source

Build or run the current CLI directly from the repo:

cargo run -p cli --features full -- --help
cargo run -p cli --features full -- query --help
cargo run -p cli --features dev -- stack --help

If you want a standalone binary, build the crate and run ./target/debug/syndb or ./target/release/syndb afterward.

Direct API Usage

The API can be used directly through:

• api.syndb.xyz/docs
• GET https://api.syndb.xyz/openapi.json

If you want generated client bindings, use the OpenAPI schema above with your preferred generator.