Agents: run casen agent-card <bpmn|dmn|form> (~1k tokens) instead of reading this README.
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 import my-cluster ./camunda-credentials.sh
casen profile use my-cluster
Deploy a process
casen deploy deploy order-process.bpmn --target camunda8
List process instances
casen pi list --filter '{"state":"ACTIVE"}'
Commands
Profile management
| Command | Description |
|---|
casen profile list | List all configured profiles |
casen profile create <name> | Add a profile from flags (--base-url, --auth-type, …) |
casen profile import <name> <file> | Add a profile from a Camunda credentials file |
casen profile use <name> | Switch the active profile |
casen profile delete <name> | Delete a profile |
Process & deployment
| Command | Description |
|---|
casen deploy deploy <file> [--target camunda8] | Deploy a BPMN, DMN, or form file to local Reebe or the active profile |
casen resource create-deployment <file...> | Deploy several files as one deployment to the active profile |
casen pd list | List deployed process definitions |
casen pi list [--filter <json>] | List process instances |
casen pi 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 incident list | List incidents |
casen incident resolve <key> | Resolve an incident |
casen job list | List jobs |
Connector generation
| Command | Description |
|---|
casen connector generate <spec> | Generate element templates from OpenAPI/Swagger |
casen connector show <template> [--filter <text>] [--condensed] | List a template's property keys, types and defaults |
casen connector apply <file.bpmn> <elementId> <template> | Apply a template from --values file.json and --set key=value |
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