CLI quickstart

This walkthrough goes from a fresh install to a running service with a backup. It takes about five minutes, most of which is waiting for the service to provision.

You need a SabaothCloud account with a plan that has room for another service. See Plans and pricing.

Install the CLI

npm install --global @sabaoth-cloud/cli
sabaoth --version

You need Node.js 22.12 or later. See Install the CLI.

Create an API key

In the dashboard, open API Keys, click Create API Key and copy the key. It starts with mpg_ and is shown only once. See API keys.

sabaoth login

Paste the key at the hidden prompt. The CLI checks it, saves it in your OS keychain and selects its organization:

Sabaoth API key:
Logged in to Acme (org_abc).

Create a service

Choose a name and the resources to give it. CPU is in millicores (500 is half a vCPU), memory in MiB and storage in GiB.

sabaoth postgres create \
  --name orders-db \
  --cpu-millicores 500 \
  --memory-mb 1024 \
  --storage-gb 10

The CLI shows exactly what it will create and asks you to confirm, because a service is billable:

Create a PostgreSQL service in Acme (org_abc):
  Name:      orders-db
  CPU:       500m
  Memory:    1024Mi
  Storage:   10Gi

Anything not listed uses the server default. This provisions billable resources.
Continue? [y/N] y
Created orders-db (clu_abc), currently provisioning.
Provisioning continues in the background; check with `sabaoth postgres get clu_abc`.

Note the service ID (clu_abc here). You’ll use it in the next steps.

Wait until it is ready

sabaoth postgres get clu_abc

Run it again until Status shows ready. Provisioning usually takes a couple of minutes. To list every service instead, run sabaoth postgres list.

Get the connection details

Once the service is ready, sabaoth postgres get shows its host, port, database and username:

Connection:
  Host:      orders-db.example.sabaothcloud.com
  Port:      5432
  Database:  app
  Username:  app_owner

The CLI never shows passwords. Create a database user and get its password in the dashboard; see Database users. To connect from outside SabaothCloud, see Networking.

Follow the logs

sabaoth postgres logs clu_abc --follow

Log events stream in as they happen. Press Ctrl-C to stop. See sabaoth postgres logs for filtering by severity and replaying history.

Take a backup

sabaoth backup create clu_abc --name first-backup

Confirm with y. The backup is queued, then runs in the background. Check on it with:

sabaoth backup list clu_abc

Clean up

If you created the service just to try things out, delete it so it stops costing money:

sabaoth postgres delete clu_abc

You’ll be asked to type the service ID back to confirm. Deletion is permanent.

Next steps

Scripting and CI

Use --json, exit codes and SABAOTH_API_KEY in pipelines.

Command reference

Every flag for every command.

Get Started

Account

Organizations

PostgreSQL

Backups

Reference

Clean up

Next steps

Scripting and CI

Command reference