Hybrid Manager CLI - edbctl v1.1

edbctl is a command line tool (CLI) to manage Hybrid Manager (HM) resources and perform database cluster operations.

Prerequisites

Hybrid Manager CLI is available for most Linux distributions. To use edbctl, you must install the package from the pgai-platform repository.

edbctl is distributed as a standalone package with its own independent versioning lifecycle. Consequently, its version numbers do not mirror those of the Host Manager (HM).

The following matrix defines the supported compatibility between specific edbctl releases and HM versions to ensure system stability and feature availability.

Compatibility matrix

edbctl version	HM version	Notes
1.2.0	v1.3.x (LTS) & 2026.2 (IR)	Supports the LTS and latest IR (2026.2) releases of HM.
1.1.1	v1.3.x (LTS)	Patch release with improvements and bug fixes.
1.1.0	v1.3.0 (LTS)	First version compatible with HM v1.3.0+. It also has support for multi-location.
1.0.0.	Up to v1.2.0 (LTS)	HM v1.3.0+ require edbctl 1.1.0+.

Obtain your EDB subscription token

The pgai-platform repository requires a token to enable downloads. To obtain your token, log in to EDB Repos 2.0. If this is your first time visiting the EDB Repos 2.0 page, you must select Request Access to generate your token. Once a generated token is available, select the Copy icon to copy it to your clipboard or the eye icon to view it.

Set the `EDB_SUBSCRIPTION_TOKEN` environment variable

Once you have the token, execute the command shown for your operating system, substituting your token for <your-token>.

export EDB_SUBSCRIPTION_TOKEN=<your-token>

Install from the pgai-platform repository

Run the appropriate commands for your operating system.

Debian or Ubuntu
RHEL, Rocky, AlmaLinux, or Oracle Linux

Debian or Ubuntu

On Debian or Ubuntu, you can install HM CLI using the apt package manager.

curl -1sSLf "https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/pgai-platform/setup.deb.sh" | sudo -E bash

If this command returns an error like curl: (22) The requested URL returned error: 404, check that you entered the correct token.

When the command is successful, you'll see output like this:

Executing the  setup script for the 'enterprisedb/pgai-platform' repository ...
...

You can now install the edbctl package using the command:

sudo apt-get install edbctl

RHEL, Rocky, AlmaLinux, or Oracle Linux

On RHEL, Rocky, AlmaLinux, or Oracle Linux, you can install HM CLI using the yum package manager. You can also use the dnf package manager, which is the default package manager for RHEL 8 and later.

curl -1sSLf "https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/pgai-platform/setup.rpm.sh" | sudo -E bash

If this command returns an error like curl: (22) The requested URL returned error: 404, check that you entered the correct token.

When the command is successful, you'll see output like this:

Executing the  setup script for the 'enterprisedb/pgai-platform' repository ...
...

You can now install the edbctl package using the command:

sudo dnf install edbctl

sudo yum install edbctl

Configuring the HM CLI

After installing the package, configure an access key using the credential command. These credentials allow you to access the supported HM resources and manage them using the CLI. The CLI supports various commands for managing projects, clusters, backups, credentials, and more.

Configuration example:

edbctl credential import-access-key --name user1 --access-key your_HM_access_key --address https://YOUR_HM_INSTANCE_URL:443
edbctl config set context_project "Your Project Name"

Options

Use the edbctl --help or -h command to return the complete list of commands:

edbctl --help

Output

Usage:
  edbctl [options]
  edbctl [command]

Management Commands:
  credential        Manage authentication credentials.
  project           Manage projects associated with the database clusters.
  cluster           Manage database cluster resources.
  backup            Manage cluster backups.

Configuration Commands:
  config            Manages configuration settings for edbctl tool
  help              Help about any command
  completion        Generate the autocompletion script for the specified shell

Setup Commands:
  image             Asset management commands
  operand           Operand image management commands
  image-pull-secret Pull Secret management commands

Options:
  -h, --help      help for edbctl
  -v, --version   version for edbctl

Use "edbctl [command] --help" for more information about a command.

More information

edbctl credential — Manage authentication credentials.
edbctl image — Asset management commands
edbctl image-pull-secret — Pull secret management commands.
edbctl operand — Operand image management commands.
edbctl project — Manage projects associated with the database clusters.
edbctl cluster — Manage database cluster resources.
edbctl backup — Manage cluster backups.
edbctl config — Manage configuration settings for edbctl tool.