Getting started

Installation

This guide walks you through installing the Rillence CLI, authenticating with your license key, and verifying that both bundled tools (pgpg and psql+) are ready to use.

Prerequisites

  • Docker must be installed and running. Scenarios spin up a real PostgreSQL instance inside a Docker container on your machine, so the Docker daemon needs to be active.
  • A recent terminal with a standard shell.
  • Supported on macOS, Linux, and Windows.

To confirm Docker is up:

docker info

If that command errors, start Docker Desktop (or your Docker service) before continuing.

Install the CLI

Install with the shell installer:

curl -fsSL https://get.rillence.com/install.sh | sh

Or, on macOS and Linux, use Homebrew:

brew install rillence/tap/rillence

The installer places a single rillence binary on your PATH. The pgpg and psql+ tools are bundled with it.

Authenticate

The CLI is authenticated with your Rillence license key. Start an interactive login:

rillence login

Or activate a key directly:

rillence activate <KEY>

Your key is stored locally and used to authenticate every CLI invocation. One key covers both pgpg and psql+.

Verify

Check the installed versions:

rillence --version
pgpg --version

Both commands should print a version string. If pgpg --version succeeds and Docker is running, you are ready to start your first scenario — head to the Quick start page.