Documentation
Generate, edit, simulate, and deploy BPMN 2.0 processes from TypeScript — reference guides for every BPMN Kit package and the casen CLI.
BPMN Kit is a TypeScript monorepo for working with BPMN 2.0 entirely in code: a fluent builder with auto-layout, a zero-dependency simulation engine, a typed Camunda 8 REST client, an embeddable canvas and editor, and a terminal CLI. Every package is strict-TypeScript and ESM-only, and runs in browsers, Node.js, Deno, Bun and edge runtimes.
Reading this as an AI agent? These same pages ship as an offline, version-locked npm package. Install
@bpmnkit/docspackand runnpx bpmnkit-docs ask "<question>"— it answers from the version the project actually installed, with no server and no network call.
01 Getting Started
Installation Install BPMN Kit packages in your project. Quick Start Build and run your first BPMN process in minutes. Core Concepts Understand how the builder, serializer, auto-layout, and AI-compact format work. Stability and Versioning What a version number promises — what counts as a breaking change, what is public API, and how long each release is supported. Conformance What BPMN Kit implements of BPMN 2.0, DMN 1.3, FEEL and Camunda Forms — measured where a measurement exists, and with the gaps listed.
02 Guides
Building Processes Service tasks, user tasks, events, sub-processes, boundary events, multi-process diagrams, and multi-instance patterns. Gateways & Branching Exclusive, parallel, inclusive, and event-based gateways with condition expressions. Pattern Library Domain BPMN patterns that Claude uses as context when implementing processes with /bpmnkit:implement. Process Templates 25 runnable Camunda 8 process templates — business processes and AI agent patterns — with test scenarios, from the gallery, the editor or casen template use. Simulation Run BPMN processes locally with @bpmnkit/engine — no Camunda cluster required. Camunda 8 Deployment Deploy and manage BPMN processes on a live Camunda 8 cluster using @bpmnkit/api. Standalone Workers Build, run, and deploy TypeScript workers that connect to Zeebe without any BPMNKit dependency. Using BPMN Kit with AI Give an AI agent the three things it needs to build a process — BPMN Kit's own docs, Camunda's docs, and your team's prose — all indexed offline, then generate the BPMN. AI Integration Use BPMN Kit with LLMs to generate and modify process diagrams from natural language. Building Processes with AI Go from a natural language description to a deployed, tested BPMN process — via a deterministic ProcessPlan pipeline, never hand-written XML. Connectors in AI Generation How BPMN Kit turns "post the open GitHub issues to Slack" into an executable process — connector cards, with lines, the offline API index, and a dry run that proves it runs. AI Agents Add a Camunda 8 AI Agent Sub-process to a BPMN process — an LLM-in-the-loop step that can call tools, generated deterministically like everything else in the pipeline. AI Decisions Route a Camunda 8 process on a Cloudflare Clef decision model — typed yes/no, choice and score answers with calibrated probabilities, through one element template. Claude Code Plugin Install the bpmnkit plugin for Claude Code to get AI-first BPMN development and operations — generate diagrams, wire connectors, deploy, and resolve incidents from natural language. Drop — Share & Co-edit Turn a BPMN, DMN or Camunda Form file — or a FEEL expression and the variables it reads — into a link anyone can open, watch live, comment on, and edit one writer at a time. No account, no modeler install, no Camunda cluster. VS Code Extension View, edit, compare and analyse BPMN, DMN and Camunda Form files inside VS Code — the same renderer, linter and engine the rest of BPMN Kit uses, with no bpmn.io and no round-trip rewrites of your XML. bpmnlint Compatibility Keep your .bpmnlintrc. casen lint and the VS Code extension read it, map bpmnlint's rules onto BPMN Kit's findings, and run your project's own bpmnlint for bpmnlint-plugin-* rules. Includes the rule-by-rule mapping table. BPMN Diagrams in Markdown Put real BPMN diagrams in READMEs, Astro, Docusaurus, VitePress and MDX pages — write a fenced ```bpmn or ```bpmn-compact block and @bpmnkit/markdown renders it to inline, themeable, accessible SVG at build time. Migrate from Camunda 7 Convert Camunda 7 BPMN models to Camunda 8 with casen migrate c7 or convertCamunda7() — what is converted, what needs a person and why, how JUEL becomes FEEL, and how this relates to Camunda's own migration tools. Testing Processes Unit-test BPMN processes in Vitest or Jest with @bpmnkit/engine/testing — job and connector mocks, manual job completion, a virtual clock for timers, BPMN matchers and path coverage. No Docker, no cluster. Typed Workers Generate TypeScript types from BPMN so that job types, variables, headers, message names and error codes are checked at compile time, and check that every job type has a worker. Testing AI Agents Put an AI Agent Sub-process under deterministic tests — script or replay the tools the model calls, check the arguments it passes and the path the process takes, and measure which tools your tests exercise. No LLM, no network. Process documentation Turn a BPMN diagram into a document to circulate — the diagram, every step in flow order with its performer and settings, and the linked DMN tables and forms — as print-ready HTML (PDF), Markdown or Word. Durable Agent Flows Write a workflow in TypeScript, let coding agents do the steps, and let the engine remember the run across crashes and reboots.
03 Packages
@bpmnkit/core Fluent process builder, BPMN 2.0 parser/serializer, auto-layout, and AI-compact format. @bpmnkit/engine Zero-dependency BPMN simulation engine for browsers and Node.js. @bpmnkit/api Fully-typed Camunda 8 REST API client with OAuth2, caching, and retry. @bpmnkit/canvas Zero-dependency SVG BPMN viewer with pan/zoom, dark/light theme, and plugin API. @bpmnkit/plugins Thirty-four composable plugins for the BPMN canvas and editor — minimap, linting, simulation, AI bridge, storage and more. @bpmnkit/editor Full BPMN editor — canvas, properties panel, AI bridge, and storage. @bpmnkit/feel The FEEL expression language — lexer, parser, evaluator, formatter and syntax highlighter, with no dependencies. @bpmnkit/worker-client Thin Zeebe REST client for standalone workers — no BPMNKit SDK required at runtime. @bpmnkit/ascii Render BPMN diagrams, DMN decision tables and Camunda Forms as Unicode text. @bpmnkit/connector-gen Generate Camunda REST connector element templates from OpenAPI 3.x and Swagger 2.x specs. @bpmnkit/flow Code-first durable flows — one TypeScript definition yields the BPMN, the job types, the message correlation and the worker. @bpmnkit/docspack BPMN Kit documentation as an offline, version-locked package that AI agents can install and search. @bpmnkit/camunda-docspack The Camunda 8 documentation as an offline, version-locked package an AI agent can install and search — BPMN, FEEL, engine concepts, Self-Managed, the clients and the Orchestration Cluster API. @bpmnkit/connectors The Camunda 8 connector catalog, with deterministic element-template application and validation. @bpmnkit/operate Lightweight monitoring and operations UI for Camunda 8 dev clusters, Camunda 8 Run and SaaS trials.
04 CLI
casen CLI Interactive TUI for managing Camunda 8 clusters from the terminal. casen generate Generate BPMN files from built-in templates, CompactDiagram JSON, or by patching an existing file — and TypeScript types for job workers from BPMN. casen view View BPMN, DMN, and Camunda form files in the browser via a local server. casen diff Compare two BPMN files and report what a reviewer would see change — added, removed, changed and moved elements, as text or JSON, with an exit code for CI. casen connector Browse the bundled Camunda 8 connector catalog, or generate connector element templates from OpenAPI specs, via the casen CLI. AIKit Skills Claude Code slash commands for AI-driven process implementation, review, testing, and deployment. casen Plugins Official casen CLI plugins shipped with the BPMN Kit monorepo. casen Plugin Authoring Build and publish plugins that extend the casen CLI with new command groups. casen dev One command for the local development loop — edit every process in a folder in the browser, simulate it, and re-run lint and scenario tests on every save. No Docker, no cluster, no licence key. casen migrate Convert Camunda 7 BPMN models to Camunda 8 and get a per-element report of what was converted, what needs a person, and what Camunda 8 cannot do — as text or JSON, with a CI gate.