CLI

You can find the full directory of CLI commands with cb --help. For a guide to getting started the first time with the CLI see the quickstart

List of commands available in the Crunchy Bridge CLI

Command Description
backup See a backup list, start a new backup, or retrieve a token to view backups in storage
create Create a new cluster, create a fork, or create a replica. Input platform, zone, and machine specifications to create a new cluster
destroy Deletes a cluster
detach Detach a cluster
firewall Manage firewall rules
help Shows the help
info Detailed cluster info including plan, region, network, and firewall
list List the active clusters for your entire account for all teams
logdest View or update the log destinations for a cluster
login Stores your api id and secret for a single session in a command line
logs View live cluster logs
psql Input the cluster id and connects to cluster with psql as postgres user
rename Change cluster names
restart Restart a cluster
resume Resume a suspended cluster
role Manage cluster roles
scope This will run a helpful set of queries to get insights into your cluster and database health
suspend This will suspend a cluster’s operations while saving the database in storage
team Manage teams
team-member Manage team members
teamcert This will show you the certificate for a team which can be used to check certificates
token Returns a token that is required for use when interacting with the API. Read more about tokens in the API docs
upgrade Manage a cluster upgrades
uri Dsiplay connection URI for a cluster
version Show the version and last updated date of the CLI tool
whoami Information on current user