Core tier. Semver at 1.0: nothing breaks without a major release. See product tiers.
Overview
@bpmnkit/cli provides the casen command-line tool for interacting with Camunda 8 clusters. Manage profiles, deploy processes, run queries, and generate connector templates — all from your terminal.
Installation
npm install -g @bpmnkit/cli
pnpm add -g @bpmnkit/cli
Quick Start
Develop locally — no cluster needed
Opens every .bpmn, .dmn and .form file in the folder in the BPMN Kit editor in your
browser, with simulation. Saves go back to disk with the file's formatting kept, changes made
elsewhere reload live, and each change re-runs lint and the file's .bpmn.tests.json
scenarios. See casen dev.
casen profile add my-cluster
Deploy a process
casen deploy order-process.bpmn
List process instances
casen instances list --state active
Commands
Profile management
| Command | Description |
|---|
casen profile list | List all configured profiles |
casen profile add <name> | Add a new profile (interactive) |
casen profile use <name> | Switch the active profile |
casen profile remove <name> | Delete a profile |
Process & deployment
| Command | Description |
|---|
casen deploy <file> | Deploy a BPMN, DMN, or form file |
casen processes list | List deployed process definitions |
casen instances list | List process instances (--state filter) |
casen instances cancel <key> | Cancel a running instance |
Templates
| Command | Description |
|---|
casen template list [--category <c>] | List the runnable process templates from the gallery |
casen template use <id> [dir] | Write a template's .bpmn, .bpmn.tests.json scenarios and any .dmn/.form files (--force overwrites) |
Incidents & jobs
| Command | Description |
|---|
casen incidents list | List open incidents |
casen incidents resolve <key> | Resolve an incident |
casen jobs list | List active jobs |
Connector generation
| Command | Description |
|---|
casen connector generate <spec> | Generate element templates from OpenAPI/Swagger |
Typed code generation
| Command | Description |
|---|
casen gen types <files...> --out <file> | TypeScript types for job workers (job types, variables, headers, messages, error codes) |
casen gen types <files...> --out <file> --check | Exit 1 when the generated file is out of date (CI) |
casen gen types <files...> --check-workers <glob> --strict | Report job types without a worker and workers without a job type |
Camunda 7 migration
| Command | Description |
|---|
casen migrate c7 <files...> | Convert Camunda 7 models to Camunda 8 (<name>.c8.bpmn, or --out <dir>) and report each construct as convertible, manual or unsupported |
casen migrate c7 <files...> --check | Report only; exit 1 while manual or unsupported findings remain (--format json for CI) |
See Migrate from Camunda 7 for what is converted and why.
Global options
| Flag | Description |
|---|
--profile <name> | Use a specific profile for this command |
--json | Output as JSON (machine-readable) |
--help | Show help |
License
MIT © BPMN Kit — made by u11g