BPMN Kit

コアティア。 1.0 以降の Semver に準拠しており、メジャーリリースなしに互換性が損なわれることはありません。製品ティアをご覧ください。

---

概要

@bpmnkit/cli は、Camunda 8 クラスターとやり取りするための casen コマンドラインツールを提供します。プロファイルの管理、プロセスのデプロイ、クエリの実行、コネクターテンプレートの生成を、すべてターミナルから行えます。

インストール

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

クイックスタート

ローカルで開発する — クラスターは不要です

casen dev

フォルダー内のすべての .bpmn、.dmn、.form ファイルを、シミュレーション機能とともにブラウザーで BPMN Kit エディターに開きます。保存内容はファイルの書式を保持したままディスクに反映され、別の場所で行った変更はリアルタイムで再読み込みされます。また、変更のたびに 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...>	複数のファイルを1つのデプロイメントとしてアクティブなプロファイルにデプロイします
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>	ジョブワーカー用の TypeScript 型（ジョブ型、変数、ヘッダー、メッセージ、エラーコード）を生成します
casen gen types <files...> --out <file> --check	生成されたファイルが最新でない場合に終了コード 1 を返します（CI）
casen gen types <files...> --check-workers <glob> --strict	ワーカーのないジョブ型と、ジョブ型のないワーカーを報告します

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／フォームのパーサー、ビルダー、レイアウトエンジン
@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 エージェント向けのオフライン docspack パッケージとして提供される BPMN Kit ドキュメント
@bpmnkit/camunda-docspack	AI エージェント向けのオフライン docspack パッケージとして提供される Camunda 8 ドキュメント
@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 が制作