Skip to content

Quickstart

Download

Download the latest binary from GitHub Releases:

Supported platforms (release binaries)

  • Linux x86_64
  • macOS x86_64 (Intel)
  • macOS arm64 (Apple Silicon)
  • Windows x86_64

Supported databases

  • SQLite
  • PostgreSQL
  • MySQL

Initialize and run

bash
zeptoz --help
zeptoz init myproject
cd myproject
zeptoz collection create Task title:string:required done:bool:default=false --id-strategy uuidv7
zeptoz dev --project-root .

Runtime migrations

When zeptoz dev starts, Zeptoz:

  1. Connects to database.url
  2. Applies pending migrations
  3. Runs a DB health check

Migration execution is idempotent, so startup can safely re-run migration checks.

Hot reload in dev mode

In zeptoz dev, runtime watcher is enabled by default (2-second poll):

  • watches hook files under configured hooks path
  • watches SQLite DB file changes (when using SQLite)
  • recompiles changed TS/JS hook sources into .compiled.js artifacts
  • refreshes runtime snapshot and OpenAPI validation without full process restart

Verify runtime

bash
curl -s http://127.0.0.1:3000/health
curl -s http://127.0.0.1:3000/openapi.json