Skip to content

Quickstart

Tested with: zb CLI 0.1 · PostgreSQL 17 · macOS 15, Ubuntu 24.04, Windows 11

  1. Install zb and sign in. The browser opens for the login; the token is stored in your OS keychain.

    shell
    brew install zerobase/tap/zb # macOS / Linux (Homebrew)
    scoop install zerobase/zb # Windows (Scoop)
    zb login
  2. Create an instance. Sizes, regions and engines are validated against the catalogue before anything is provisioned; the command prints the hourly price and monthly estimate and waits for the instance to be ready.

    shell
    zb instances create --engine postgres --engine-version 17 --size s1 --region us-east --name pg-demo
  3. Reveal the credentials once and add your IP to the allow-list.

    shell
    zb instances credentials reveal pg-demo # shown once; store it in your secret manager
    zb api PUT /v1/orgs/{org}/instances/pg-demo/network -d "{\"allow_cidrs\": [\"$(curl -s https://api.ipify.org)/32\"]}"
    zb api GET /v1/orgs/{org}/ca.pem > databasezy-ca.pem
  4. Connect. zb connect spawns the engine’s own client (psql, mysql, valkey-cli, mongosh) with TLS verification and a short-lived credential, so nothing is pasted into a shell history.

    shell
    zb connect pg-demo
  • A TLS 1.3 endpoint on <engine>-<id>.<region>.databasezy.com, re-encrypted to the pod inside the cell.
  • Per-instance credentials generated inside the cell; the control plane stores only a reference.
  • An IP allow-list on every plan, including Free.
  • Engine-native backups streamed to object storage from inside your namespace (policy depends on plan).
  • Metering for compute, storage, egress and backups, visible live under Usage.
  • An audit log of every control-plane action.