ybm syntax and commands


ybm [-h] [ <resource> ] [ <command> ] [ <flags> ]
  • resource: resource to be changed
  • command: command to run
  • flags: one or more flags, separated by spaces.

For example:

ybm cluster create

Online help

Access command-line help for ybm by running the following command:

ybm help

For help with specific ybm resource commands, use the --help or -h flag, in the following form:

ybm [ resource ] [ command ] -h

For example, to print the command-line help for the cluster create command, run the following:

ybm cluster create -h

Print the version of ybm CLI:

ybm --version


You can manage the following resources using ybm:

Resource Commands
api-key create, list, revoke
backup create, delete, list, restore
cluster cert download, create, delete, describe,
encryption list, encryption update,
list, node list, pause, resume, update
cluster network allow-list assign, allow-list unassign,
endpoint create, endpoint delete , endpoint describe,
endpoint list, endpoint update
cluster read-replica create, delete, list, update
metrics-exporter attach, create, delete, list, pause, remove, resume, update
network-allow-list create, delete, list
permission list
region list, instance list
role create, delete, describe, list, update
user delete, invite, list, update
vpc create, delete, list
vpc peering create, delete, list

Use the following commands to configure ybm:

Resource Description
auth Write API key to a configuration file.
completion Configure autocompletion for Bash, Fish, PowerShell, and Zsh
signup Navigate to the YugabyteDB Managed signup page.

Global flags

The following flags can be passed in with any command. These flags can also be added to your configuration file (see Configure ybm).

-a, --apiKey string
YugabyteDB Managed account API Key.
--config string
Configuration file (default is $HOME/.ybm-cli.yaml).
Use debug mode, same as --logLevel debug.
-l, --logLevel string
Specify the desired level of logging. debug or info (default).
Disable colors in output. true or false (default).
-o, --output string
Specify the desired output format. table (default), json, or pretty.
--timeout duration
Wait command timeout. For example, 5m, 1h. Default is 168h0m0s.
For long-running commands such as creating or deleting a cluster, you can use the --wait flag to display progress in the shell. true or false (default). For example:
ybm cluster delete \
    --cluster-name=test-cluster \

If you are using ybm with the --wait flag in your CI system, you can set the environment variable YBM_CI to true to avoid generating unnecessary log lines.