Skip to main content
Version: latest

CLI client

zbctl is the command line interface to interact with Camunda Cloud. After installation, a connection can be tested immediately.

Installation#

An installation can be done quickly via the package manager npm. The corresponding package is here.

npm i -g zbctl

You can also download a binary for your operating system from the Zeebe GitHub releases page.

Connection settings#

To use zbctl, it is recommended to define environment variables for the connection settings:

export ZEEBE_ADDRESS='[Zeebe API]'export ZEEBE_CLIENT_ID='[Client ID]'export ZEEBE_CLIENT_SECRET='[Client Secret]'export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]'

When you create client credentials in Camunda Cloud, you have the option to download a file with the lines above filled out for you.

Alternatively, use the described flags (--address, --clientId, and --clientSecret) with the zbctl commands.

Usage#

zbctl [options] [command]
zbctl is a command line interface designed to create and read resources inside the Zeebe broker.It is designed for regular maintenance jobs, such as:        * Deploying processes        * Creating jobs and process instances        * Activating, completing, or failing jobs        * Updating variables and retries        * Viewing cluster status
Usage:  zbctl [command]
Available Commands:  activate    Activate a resource  cancel      Cancel resource  complete    Complete a resource  create      Create resources  deploy      Creates new process defined by provided BPMN file as processPath  fail        Fail a resource  generate    Generate documentation  help        Help about any command  publish     Publish a message  resolve     Resolve a resource  set         Set a resource  status      Checks the current status of the cluster  update      Update a resource  version     Print the version of zbctl
Flags:      --address string        Specify a contact point address. If omitted, will read from the environment variable 'ZEEBE_ADDRESS' (default '127.0.0.1:26500')      --audience string       Specify the resource that the access token should be valid for. If omitted, will read from the environment variable 'ZEEBE_TOKEN_AUDIENCE'      --authzUrl string       Specify an authorization server URL from which to request an access token. If omitted, will read from the environment variable 'ZEEBE_AUTHORIZATION_SERVER_URL' (default "https://login.cloud.camunda.io/oauth/token/")      --certPath string       Specify a path to a certificate with which to validate gateway requests. If omitted, will read from the environment variable 'ZEEBE_CA_CERTIFICATE_PATH'      --clientCache string    Specify the path to use for the OAuth credentials cache. If omitted, will read from the environment variable 'ZEEBE_CLIENT_CONFIG_PATH' (default "/Users/sitapati/.camunda/credentials")      --clientId string       Specify a client identifier to request an access token. If omitted, will read from the environment variable 'ZEEBE_CLIENT_ID'      --clientSecret string   Specify a client secret to request an access token. If omitted, will read from the environment variable 'ZEEBE_CLIENT_SECRET'  -h, --help                  help for zbctl      --insecure              Specify if zbctl should use an unsecured connection. If omitted, will read from the environment variable 'ZEEBE_INSECURE_CONNECTION'
Use "zbctl [command] --help" for more information about a command.