| title | CLI Reference |
|---|---|
| nav_order | 2 |
| nav_exclude | false |
| has_children | true |
| has_toc | true |
This section is the command reference for c8volt. Individual command pages are generated from the Cobra command tree and are the source for exact flags, examples, output modes, and mutation behavior.
Raw generated reference: c8volt root command.
For tool-selection context, see Camunda CLI options and
AI and search context. Those pages help search
engines, AI assistants, and operators classify c8volt alongside c8ctl,
zbctl, REST APIs, and SDKs without treating c8volt as an official Camunda
product.
For runtime BPMN element inspection, listener jobs, and process-instance timeline context, start with the Runtime Elements guide. For the generated command hierarchy, use the CLI Command Tree.
c8volt supports Camunda 8.7, 8.8, and 8.9, but not every command is
available on every upstream version.
| Area | 8.9 | 8.8 | 8.7 |
|---|---|---|---|
| Cluster, config, tenant, process-definition, process-instance reads | supported | supported | supported |
| Deploy and run process instances | supported | supported | supported |
| Cancel and delete process instances | supported | supported | limited |
| Process-instance variable update | supported | supported | unsupported |
get job and update job |
supported | supported | unsupported |
| Incident resolution and repair workflows | supported | supported | unsupported |
delete process-definition |
supported | unsupported | unsupported |
ops purge all-process-definitions |
supported | unsupported | unsupported |
Process-definition deletion requires Camunda 8.9 or newer because c8volt
depends on the endpoint shape that supports full process-definition history
deletion.
Use --dry-run before broad destructive or repair selectors. Use --json, --keys-only, and --automation for script and agent output. Use c8volt capabilities --json when a tool needs the machine-readable command contract.
| Command | Purpose | Reference |
|---|---|---|
c8volt |
Root command, global flags, and top-level examples | c8volt |
capabilities |
Machine-readable command contract | capabilities |
config |
Show, validate, template, and test configuration | config |
get cluster |
Cluster topology, version, and license | get cluster |
get process-definition |
List definitions, fetch latest versions, retrieve XML, and show statistics | get process-definition |
get process-instance |
Search or fetch process instances, variables, incidents, runtime elements, and task context | get process-instance |
get element |
Search or fetch runtime element instances and optional listener jobs | get element |
get incident |
Search incidents, fetch incident keys, and emit process-instance keys | get incident |
get job |
Inspect or search jobs, including runtime listener jobs | get job |
get tenant |
List visible tenants | get tenant |
get resource |
Fetch a resource by ID | get resource |
deploy process-definition |
Deploy BPMN process definitions from files or stdin | deploy process-definition |
embed |
List, deploy, or export bundled BPMN fixtures | embed |
run process-instance |
Start process instances and confirm activation by default | run process-instance |
update process-instance |
Update process-instance-scope variables | update process-instance |
update job |
Update job retries or timeout | update job |
expect process-instance |
Wait for process-instance state or incident conditions | expect process-instance |
walk process-instance |
Inspect ancestry, descendants, full family trees, variables, incidents, runtime elements, and listener jobs | walk process-instance |
cancel process-instance |
Cancel process instances by key or filters | cancel process-instance |
delete process-instance |
Delete process-instance history, with optional cancel-before-delete handling | delete process-instance |
delete process-definition |
Delete process definitions on Camunda 8.9+ |
delete process-definition |
resolve incident |
Resolve incident keys | resolve incident |
resolve process-instance |
Resolve active incidents for selected process instances | resolve process-instance |
ops analyse slow-process-instances |
Analyse slow process-instance timings with runtime element and listener context | ops analyse slow-process-instances |
ops execute retention-policy |
Delete finished process instances selected by age and state | ops execute retention-policy |
ops purge process-instances-with-incidents |
Purge process instances selected through incident filters | ops purge process-instances-with-incidents |
ops repair incident |
Repair variables/jobs and resolve selected incidents | ops repair incident |
ops repair process-instance |
Discover and repair incidents for selected process instances | ops repair process-instance |
ops purge orphan-process-instances |
Find and purge orphan child process instances | ops purge orphan-process-instances |
ops purge all-process-definitions |
Purge selected process definitions on Camunda 8.9+ |
ops purge all-process-definitions |
ops execute smoke-test |
Deploy, run, walk, and clean up a smoke-test fixture | ops execute smoke-test |
version |
Print build and compatibility information | version |
The ops command family composes lower-level commands into audited workflows.
Use the playbooks for workflow behavior and audit reports; use this generated reference for exact flags: