Skip to main content
The sabaoth command-line interface lets you work with SabaothCloud from a terminal, a script or a CI pipeline. With it you can:
  • Sign in with an API key and switch between organizations
  • List, inspect, create and delete PostgreSQL services
  • Follow a service’s logs live
  • Take on-demand backups and list existing ones
Every command can print machine-readable JSON, so the CLI works just as well in automation as it does interactively.
A service is a managed PostgreSQL instance, the same as in the dashboard. Service IDs start with clu_, and error codes use the API’s name for a service, cluster, as in CLUSTER_NOT_FOUND.

Get started

Install the CLI

Install with npm and check that it works.

Sign in

Log in with an API key, or use an environment variable in CI.

Quickstart

Create a service, follow its logs and back it up, end to end.

Organizations

Choose which organization each command acts in.

Commands

Run sabaoth --help for the full list, or sabaoth <command> --help for any one command’s flags and examples.

Built to be safe by default

  • Your API key stays in the OS keychain. It is never written to a plain-text file, and no command prints it.
  • Billable or destructive actions ask first. Creating a service and taking a backup ask for confirmation. Deleting a service asks you to type its ID.
  • No silent retries of changes. If a create, delete or backup request gets no response, the CLI tells you to check, instead of trying again and risking a duplicate.
  • Output you can trust. Names and log lines from the server are cleaned before they are printed, so they cannot move your cursor or fake extra output.

Reference

Scripting and CI

JSON output, exit codes and pipelines.

Error codes

Every error code and what to do about it.

Troubleshooting

Fixes for common problems.