Camunda Control (cctl)¶

Camunda Control (cctl) is a command line interface to the camunda REST API.

The majority of the direct camunda commands are generated from the openapi.json file provided by the camunda project. For more details have a look a their documentation.

The aim of this tool is to create a quick way to interact with the API while using the speed and flexibility of command line tools over guis for experienced users.

What it does¶

$ cctl [command] [resource] [args] [flags]

where command, operation/resource, args and flags are:

command: Specifies the operation you want to perform on a resource. For example: get, delete, apply or describe.
resource: Desribes the resource you want to apply the operation on. For example: processInstance, variableInstance, deployment, ...
args: Arguments to specify the exact resource. For example: processInstanceId, variableInstanceId, ...
flags: Extra arguments to be send to the REST API or specifing the output.

Install¶

Camunda Control can be installed via pip:

$ pip install camundactl [--user]

Examples¶

List all process instances:

$ cctl get processInstances
id                                    suspended
------------------------------------  -----------
0027da48-0a61-11ec-bd5f-0242ac120014  False
003248e7-0b05-11ec-990f-0242ac12000d  False
...

Load all active process isntances and use the result in a jinja2 template

$  cctl get processInstances -o template -oT '{{result|length}}'
1337

More Examples