BPMN Kit

核心层级。 在 1.0 版本之前遵循 Semver：除非发布主版本，否则不会有任何破坏性变更。请参阅产品层级。

---

概览

@bpmnkit/cli 提供用于与 Camunda 8 集群交互的 casen 命令行工具。管理配置文件、部署流程、运行查询并生成连接器模板 — 所有操作都可在终端中完成。

安装

npm install -g @bpmnkit/cli
# or
pnpm add -g @bpmnkit/cli

快速开始

本地开发 — 无需集群

casen dev

在浏览器中的 BPMN Kit 编辑器内打开文件夹里的所有 .bpmn、.dmn 和 .form 文件，并支持模拟。保存的更改会写回磁盘，同时保留文件格式；在其他位置所做的更改会实时重新加载；每次更改都会重新运行 lint 和文件的 .bpmn.tests.json 场景。请参阅 casen dev。

配置配置文件

# Camunda SaaS: the credentials file Hub offers for a cluster's API client
casen profile import my-cluster ./camunda-credentials.sh
casen profile use my-cluster

部署流程

casen deploy deploy order-process.bpmn --target camunda8

列出流程实例

casen pi list --filter '{"state":"ACTIVE"}'

命令

配置文件管理

命令	说明
casen profile list	列出所有已配置的配置文件
casen profile create <name>	通过标志（--base-url、--auth-type 等）添加配置文件
casen profile import <name> <file>	从 Camunda 凭据文件添加配置文件
casen profile use <name>	切换当前配置文件
casen profile delete <name>	删除配置文件

流程与部署

命令	说明
casen deploy deploy <file> [--target camunda8]	将 BPMN、DMN 或表单文件部署到本地 Reebe 或当前配置文件
casen resource create-deployment <file...>	将多个文件作为一次部署部署到当前配置文件
casen pd list	列出已部署的流程定义
casen pi list [--filter <json>]	列出流程实例
casen pi cancel <key>	取消正在运行的实例

模板

命令	说明
casen template list [--category <c>]	列出模板库中的可运行流程模板
casen template use <id> [dir]	写入模板的 .bpmn、.bpmn.tests.json 场景以及所有 .dmn/.form 文件（--force 将覆盖现有文件）

事件与作业

命令	说明
casen incident list	列出事件
casen incident resolve <key>	解决事件
casen job list	列出作业

连接器生成

命令	说明
casen connector generate <spec>	根据 OpenAPI/Swagger 生成元素模板
casen connector show <template> [--filter <text>] [--condensed]	列出模板的属性键、类型和默认值
casen connector apply <file.bpmn> <elementId> <template>	使用 --values file.json 和 --set key=value 应用模板

类型化代码生成

命令	说明
casen gen types <files...> --out <file>	为作业 Worker 生成 TypeScript 类型（作业类型、变量、标头、消息、错误代码）
casen gen types <files...> --out <file> --check	生成的文件不是最新版本时退出并返回 1（CI）
casen gen types <files...> --check-workers <glob> --strict	报告没有 Worker 的作业类型，以及没有作业类型的 Worker

Camunda 7 迁移

命令	说明
casen migrate c7 <files...>	将 Camunda 7 模型转换为 Camunda 8（生成 <name>.c8.bpmn，或使用 --out <dir>），并报告每个构造是可转换、需手动处理还是不受支持
casen migrate c7 <files...> --check	仅报告；仍有需手动处理或不受支持的问题时退出并返回 1（CI 可使用 --format json）

有关转换内容及原因，请参阅从 Camunda 7 迁移。

全局选项

标志	说明
--profile <name>	为此命令使用指定的配置文件
--json	以 JSON 格式输出（机器可读）
--help	显示帮助

---

相关软件包

软件包	描述
@bpmnkit/core	BPMN/DMN/Form 解析器、构建器和布局引擎
@bpmnkit/canvas	零依赖 SVG BPMN 查看器
@bpmnkit/editor	功能齐全的交互式 BPMN 编辑器
@bpmnkit/engine	用于测试和演示的轻量级 BPMN 流程模拟器
@bpmnkit/feel	FEEL 表达式语言解析器和求值器
@bpmnkit/plugins	34 个可组合的画布插件
@bpmnkit/api	Camunda 8 REST API TypeScript 客户端
@bpmnkit/ascii	将 BPMN 图表渲染为 Unicode ASCII 艺术图
@bpmnkit/markdown	Markdown 中的 BPMN 图表 — 支持 remark、markdown-it 和 README 预渲染
@bpmnkit/docspack	面向 AI Agent 的 BPMN Kit 离线 docspack 软件包
@bpmnkit/camunda-docspack	面向 AI Agent 的 Camunda 8 文档离线 docspack 软件包
@bpmnkit/ui	共享设计令牌和 UI 组件
@bpmnkit/profiles	CLI 和代理共用的身份验证、配置文件存储及客户端工厂
@bpmnkit/operate	Camunda 集群的监控和运维前端
@bpmnkit/connector-gen	根据 OpenAPI 规范生成连接器模板
@bpmnkit/connectors	Camunda 8 开箱即用连接器目录和确定性模板应用
@bpmnkit/proxy	本地 AI 桥接和 Camunda API 代理服务
@bpmnkit/patterns	面向 BPMNKit AIKit 的领域流程模式
@bpmnkit/reebe-wasm	用于浏览器模拟的 WebAssembly BPMN 引擎
@bpmnkit/worker-client	面向独立工作器的轻量 Zeebe REST 客户端
@bpmnkit/flow	以代码优先的持久化流程，可派生 BPMN、作业类型和工作器
@bpmnkit/user-tasks	可嵌入的 Camunda 8 用户任务组件
@bpmnkit/cli-sdk	用于 casen CLI 的插件开发 SDK
@bpmnkit/create-casen-plugin	几秒钟内搭建新的 casen CLI 插件
@bpmnkit/casen-report	根据 Camunda 8 事件和 SLA 数据生成 HTML 报告
@bpmnkit/casen-worker-http	HTTP 工作器插件示例 — 使用实时 JSONPlaceholder API 数据完成作业
@bpmnkit/casen-worker-ai	AI 任务工作器 — 使用 Claude 进行分类、总结、提取和决策

许可证

MIT © BPMN Kit — 由 u11g 打造