@bpmnkit/cli

Command-line interface for Camunda 8 — deploy, manage, and monitor processes from the terminal

Website · Documentation · GitHub · Changelog

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
# or
pnpm add -g @bpmnkit/cli

Quick Start

Develop locally — no cluster needed

casen dev

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.

Configure a profile

casen profile add my-cluster
# Interactive prompts for base URL and auth type

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

---

Related Packages

Package	Description
@bpmnkit/core	BPMN/DMN/Form parser, builder, layout engine
@bpmnkit/canvas	Zero-dependency SVG BPMN viewer
@bpmnkit/editor	Full-featured interactive BPMN editor
@bpmnkit/engine	Lightweight BPMN process simulator for tests and demos
@bpmnkit/feel	FEEL expression language parser & evaluator
@bpmnkit/plugins	34 composable canvas plugins
@bpmnkit/api	Camunda 8 REST API TypeScript client
@bpmnkit/ascii	Render BPMN diagrams as Unicode ASCII art
@bpmnkit/markdown	BPMN diagrams in Markdown — remark, markdown-it and README pre-rendering
@bpmnkit/docspack	BPMN Kit docs as an offline docspack package for AI agents
@bpmnkit/camunda-docspack	Camunda 8 docs as an offline docspack package for AI agents
@bpmnkit/ui	Shared design tokens and UI components
@bpmnkit/profiles	Shared auth, profile storage, and client factories for CLI & proxy
@bpmnkit/operate	Monitoring & operations frontend for Camunda clusters
@bpmnkit/connector-gen	Generate connector templates from OpenAPI specs
@bpmnkit/connectors	Camunda 8 OOTB connector catalog and deterministic template application
@bpmnkit/proxy	Local AI bridge and Camunda API proxy server
@bpmnkit/patterns	Domain process patterns for BPMNKit AIKit
@bpmnkit/reebe-wasm	WebAssembly BPMN engine for browser simulation
@bpmnkit/worker-client	Thin Zeebe REST client for standalone workers
@bpmnkit/flow	Code-first durable flows that derive BPMN, job types and workers
@bpmnkit/user-tasks	Embeddable user task widget for Camunda 8
@bpmnkit/cli-sdk	Plugin authoring SDK for the casen CLI
@bpmnkit/create-casen-plugin	Scaffold a new casen CLI plugin in seconds
@bpmnkit/casen-report	HTML reports from Camunda 8 incident and SLA data
@bpmnkit/casen-worker-http	Example HTTP worker plugin — completes jobs with live JSONPlaceholder API data
@bpmnkit/casen-worker-ai	AI task worker — classify, summarize, extract, and decide using Claude

License

MIT © BPMN Kit — made by u11g