@bpmnkit/docspack 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (173) hide show
  1. package/.llms/chunks/cli.casen.aikit-skills.md +19 -0
  2. package/.llms/chunks/cli.casen.bpmn-generation-pipeline.md +32 -0
  3. package/.llms/chunks/cli.casen.connection-profiles.md +62 -0
  4. package/.llms/chunks/cli.casen.generate-bpmn-files.md +28 -0
  5. package/.llms/chunks/cli.casen.md +80 -0
  6. package/.llms/chunks/cli.casen.plugins.md +56 -0
  7. package/.llms/chunks/cli.casen.worker-commands.md +45 -0
  8. package/.llms/chunks/cli.connector.all-flags.md +29 -0
  9. package/.llms/chunks/cli.connector.browse-the-bundled-ootb-catalog.md +32 -0
  10. package/.llms/chunks/cli.connector.built-in-catalog.md +41 -0
  11. package/.llms/chunks/cli.connector.common-workflows.md +50 -0
  12. package/.llms/chunks/cli.connector.generate-from-the-openapi-catalog.md +30 -0
  13. package/.llms/chunks/cli.connector.md +20 -0
  14. package/.llms/chunks/cli.connector.programmatic-usage.md +7 -0
  15. package/.llms/chunks/cli.connector.what-gets-generated.md +20 -0
  16. package/.llms/chunks/cli.generate.definition-mode-ai-scripting-path.md +89 -0
  17. package/.llms/chunks/cli.generate.md +52 -0
  18. package/.llms/chunks/cli.generate.modify-existing-mode-input.md +59 -0
  19. package/.llms/chunks/cli.generate.typical-ai-workflow.md +18 -0
  20. package/.llms/chunks/cli.plugin-authoring.md +59 -0
  21. package/.llms/chunks/cli.plugin-authoring.plugin-naming-conventions.md +11 -0
  22. package/.llms/chunks/cli.plugin-authoring.test-locally.md +41 -0
  23. package/.llms/chunks/cli.plugin-authoring.the-bpmnkit-cli-sdk-sdk.md +82 -0
  24. package/.llms/chunks/cli.plugin-authoring.what-gets-generated.md +69 -0
  25. package/.llms/chunks/cli.plugin-authoring.writing-commands.md +84 -0
  26. package/.llms/chunks/cli.plugins.bpmnkit-casen-report.md +39 -0
  27. package/.llms/chunks/cli.plugins.bpmnkit-casen-worker-http.md +23 -0
  28. package/.llms/chunks/cli.plugins.md +25 -0
  29. package/.llms/chunks/cli.skills.deploy.md +24 -0
  30. package/.llms/chunks/cli.skills.implement.md +36 -0
  31. package/.llms/chunks/cli.skills.md +29 -0
  32. package/.llms/chunks/cli.skills.no-mcp-server-required.md +6 -0
  33. package/.llms/chunks/cli.skills.review.md +33 -0
  34. package/.llms/chunks/cli.skills.test.md +33 -0
  35. package/.llms/chunks/cli.view.folder-support.md +31 -0
  36. package/.llms/chunks/cli.view.md +70 -0
  37. package/.llms/chunks/cli.view.tabbed-navigation.md +28 -0
  38. package/.llms/chunks/getting-started.concepts.ai-compact-format.md +23 -0
  39. package/.llms/chunks/getting-started.concepts.auto-layout.md +24 -0
  40. package/.llms/chunks/getting-started.concepts.parsing-and-serializing.md +26 -0
  41. package/.llms/chunks/getting-started.concepts.the-fluent-builder.md +41 -0
  42. package/.llms/chunks/getting-started.concepts.zeebe-extensions.md +25 -0
  43. package/.llms/chunks/getting-started.installation.md +38 -0
  44. package/.llms/chunks/getting-started.installation.runtime-requirements.md +13 -0
  45. package/.llms/chunks/getting-started.installation.svg-canvas-viewer.md +41 -0
  46. package/.llms/chunks/getting-started.installation.worker-client.md +40 -0
  47. package/.llms/chunks/getting-started.quick-start.md +31 -0
  48. package/.llms/chunks/getting-started.quick-start.step-2-simulate-locally.md +28 -0
  49. package/.llms/chunks/getting-started.quick-start.step-3-deploy-to-camunda-8.md +33 -0
  50. package/.llms/chunks/getting-started.quick-start.what-s-next.md +14 -0
  51. package/.llms/chunks/guides.ai-agents.deploy-grade-validation.md +19 -0
  52. package/.llms/chunks/guides.ai-agents.how-it-s-modeled.md +11 -0
  53. package/.llms/chunks/guides.ai-agents.md +18 -0
  54. package/.llms/chunks/guides.ai-agents.see-also.md +7 -0
  55. package/.llms/chunks/guides.ai-agents.testing-without-a-real-llm-call.md +26 -0
  56. package/.llms/chunks/guides.ai-agents.the-aiagent-plan-step.md +62 -0
  57. package/.llms/chunks/guides.ai-implement.deploying.md +49 -0
  58. package/.llms/chunks/guides.ai-implement.extending-an-existing-process.md +10 -0
  59. package/.llms/chunks/guides.ai-implement.lightweight-alternative-casen-skills-install.md +28 -0
  60. package/.llms/chunks/guides.ai-implement.md +32 -0
  61. package/.llms/chunks/guides.ai-implement.the-claude-code-plugin.md +21 -0
  62. package/.llms/chunks/guides.ai.claude-api-example.md +41 -0
  63. package/.llms/chunks/guides.ai.mcp-server.md +20 -0
  64. package/.llms/chunks/guides.ai.md +32 -0
  65. package/.llms/chunks/guides.ai.minimal-empty-diagram.md +32 -0
  66. package/.llms/chunks/guides.ai.openai-function-calling.md +40 -0
  67. package/.llms/chunks/guides.building-processes.boundary-events.md +47 -0
  68. package/.llms/chunks/guides.building-processes.call-activities.md +47 -0
  69. package/.llms/chunks/guides.building-processes.events.md +57 -0
  70. package/.llms/chunks/guides.building-processes.multi-instance.md +20 -0
  71. package/.llms/chunks/guides.building-processes.service-tasks.md +39 -0
  72. package/.llms/chunks/guides.building-processes.sub-processes.md +40 -0
  73. package/.llms/chunks/guides.building-processes.task-defaults.md +18 -0
  74. package/.llms/chunks/guides.claude-code-plugin.ambient-hooks.md +24 -0
  75. package/.llms/chunks/guides.claude-code-plugin.configuration.md +126 -0
  76. package/.llms/chunks/guides.claude-code-plugin.md +47 -0
  77. package/.llms/chunks/guides.claude-code-plugin.reference-docs.md +61 -0
  78. package/.llms/chunks/guides.deployment.ci-cd-deploy-on-push.md +47 -0
  79. package/.llms/chunks/guides.deployment.deploying-a-process.md +52 -0
  80. package/.llms/chunks/guides.deployment.handling-jobs.md +50 -0
  81. package/.llms/chunks/guides.deployment.managing-incidents.md +33 -0
  82. package/.llms/chunks/guides.deployment.md +49 -0
  83. package/.llms/chunks/guides.gateways.branching-inside-sub-processes.md +27 -0
  84. package/.llms/chunks/guides.gateways.exclusive-gateway-xor.md +41 -0
  85. package/.llms/chunks/guides.gateways.inclusive-gateway-or.md +43 -0
  86. package/.llms/chunks/guides.gateways.nested-branching.md +27 -0
  87. package/.llms/chunks/guides.gateways.parallel-gateway-and.md +26 -0
  88. package/.llms/chunks/guides.patterns.how-matching-works.md +17 -0
  89. package/.llms/chunks/guides.patterns.md +26 -0
  90. package/.llms/chunks/guides.patterns.pattern-schema.md +38 -0
  91. package/.llms/chunks/guides.patterns.see-also.md +7 -0
  92. package/.llms/chunks/guides.patterns.using-patterns-from-the-cli.md +30 -0
  93. package/.llms/chunks/guides.patterns.what-a-pattern-contains.md +18 -0
  94. package/.llms/chunks/guides.simulation.dmn-decision-evaluation.md +51 -0
  95. package/.llms/chunks/guides.simulation.instance-state.md +29 -0
  96. package/.llms/chunks/guides.simulation.md +51 -0
  97. package/.llms/chunks/guides.simulation.message-correlation.md +30 -0
  98. package/.llms/chunks/guides.simulation.multiple-deployments.md +14 -0
  99. package/.llms/chunks/guides.workers-standalone.anatomy-of-a-worker.md +42 -0
  100. package/.llms/chunks/guides.workers-standalone.camunda-saas.md +43 -0
  101. package/.llms/chunks/guides.workers-standalone.environment-variables.md +14 -0
  102. package/.llms/chunks/guides.workers-standalone.md +35 -0
  103. package/.llms/chunks/guides.workers-standalone.running-workers.md +61 -0
  104. package/.llms/chunks/guides.workers-standalone.see-also.md +7 -0
  105. package/.llms/chunks/packages.api.incident-resolution.md +31 -0
  106. package/.llms/chunks/packages.api.observability-events.md +13 -0
  107. package/.llms/chunks/packages.api.overview.md +49 -0
  108. package/.llms/chunks/packages.api.process-operations.md +60 -0
  109. package/.llms/chunks/packages.api.resource-namespaces.md +20 -0
  110. package/.llms/chunks/packages.canvas.events.md +56 -0
  111. package/.llms/chunks/packages.canvas.options.md +24 -0
  112. package/.llms/chunks/packages.canvas.overview.md +35 -0
  113. package/.llms/chunks/packages.connector-gen.body-expansion.md +18 -0
  114. package/.llms/chunks/packages.connector-gen.catalog-reference.md +54 -0
  115. package/.llms/chunks/packages.connector-gen.catalogentry-type.md +21 -0
  116. package/.llms/chunks/packages.connector-gen.generating-from-the-catalog.md +44 -0
  117. package/.llms/chunks/packages.connector-gen.installation.md +42 -0
  118. package/.llms/chunks/packages.connector-gen.lower-level-api.md +31 -0
  119. package/.llms/chunks/packages.connector-gen.overview.md +16 -0
  120. package/.llms/chunks/packages.connector-gen.writeoptions.md +26 -0
  121. package/.llms/chunks/packages.core.dmn-support.md +36 -0
  122. package/.llms/chunks/packages.core.installation-bpmn.creatediagram-id.md +18 -0
  123. package/.llms/chunks/packages.core.installation-bpmn.createprocess-id-name.md +10 -0
  124. package/.llms/chunks/packages.core.installation-bpmn.export-definitions.md +10 -0
  125. package/.llms/chunks/packages.core.installation-bpmn.makeempty-processid-processname.md +11 -0
  126. package/.llms/chunks/packages.core.installation-bpmn.parse-xml.md +10 -0
  127. package/.llms/chunks/packages.core.installation-bpmn.sample_xml.md +7 -0
  128. package/.llms/chunks/packages.core.installation-compactify-definitions.md +13 -0
  129. package/.llms/chunks/packages.core.installation-expand-compact.md +13 -0
  130. package/.llms/chunks/packages.core.installation-layoutprocess-process.md +15 -0
  131. package/.llms/chunks/packages.core.installation-processbuilder-methods.md +29 -0
  132. package/.llms/chunks/packages.core.installation.md +11 -0
  133. package/.llms/chunks/packages.core.overview.md +15 -0
  134. package/.llms/chunks/packages.docspack.installation.md +45 -0
  135. package/.llms/chunks/packages.docspack.overview.md +23 -0
  136. package/.llms/chunks/packages.docspack.reading-it-yourself.md +34 -0
  137. package/.llms/chunks/packages.docspack.trust.md +13 -0
  138. package/.llms/chunks/packages.docspack.using-the-index-directly.md +52 -0
  139. package/.llms/chunks/packages.editor.basic-setup.md +41 -0
  140. package/.llms/chunks/packages.editor.full-editor-with-all-plugins.md +30 -0
  141. package/.llms/chunks/packages.editor.hud-options.md +41 -0
  142. package/.llms/chunks/packages.editor.overview.md +21 -0
  143. package/.llms/chunks/packages.engine.installation.md +77 -0
  144. package/.llms/chunks/packages.engine.overview.md +19 -0
  145. package/.llms/chunks/packages.engine.processinstance.md +17 -0
  146. package/.llms/chunks/packages.engine.variable-scoping.md +27 -0
  147. package/.llms/chunks/packages.worker-client.client.poll-jobtype-options.md +40 -0
  148. package/.llms/chunks/packages.worker-client.createworkerclient-options.md +32 -0
  149. package/.llms/chunks/packages.worker-client.job.complete-variables.md +29 -0
  150. package/.llms/chunks/packages.worker-client.md +33 -0
  151. package/.llms/chunks/packages.worker-client.oauth2-camunda-saas.md +26 -0
  152. package/.llms/chunks/packages.worker-client.see-also.md +7 -0
  153. package/.llms/manifest.json +2083 -0
  154. package/LICENSE +21 -0
  155. package/README.md +150 -0
  156. package/dist/build.d.ts +29 -0
  157. package/dist/build.js +89 -0
  158. package/dist/chunk.d.ts +41 -0
  159. package/dist/chunk.js +242 -0
  160. package/dist/cli.d.ts +9 -0
  161. package/dist/cli.js +160 -0
  162. package/dist/index.d.ts +13 -0
  163. package/dist/index.js +12 -0
  164. package/dist/load.d.ts +27 -0
  165. package/dist/load.js +144 -0
  166. package/dist/search.d.ts +53 -0
  167. package/dist/search.js +104 -0
  168. package/dist/text.d.ts +22 -0
  169. package/dist/text.js +204 -0
  170. package/dist/types.d.ts +48 -0
  171. package/dist/types.js +3 -0
  172. package/llms.txt +174 -0
  173. package/package.json +76 -0
@@ -0,0 +1,19 @@
1
+ # casen CLI — AIKit Skills
2
+
3
+ `casen` ships four lightweight, CLI-only Claude Code slash commands (no MCP server, no proxy):
4
+
5
+ ```sh
6
+ casen skills install
7
+ ```
8
+
9
+ | Command | Description |
10
+ |---|---|
11
+ | `/implement <description>` | Write a plan, compile it, test it, scaffold workers, deploy |
12
+ | `/review <path>` | Run the full lint report and report a deploy-ready verdict |
13
+ | `/test <path>` | Run scenario tests and report path/branch coverage |
14
+ | `/deploy <path>` | Deploy-readiness gate, then deploy to local Reebe or Camunda 8 |
15
+
16
+ For the richer skill set (`/bpmnkit:implement`, `:extend`, `:agent`, `:connect`, plus generated reference docs), install the Claude Code plugin instead: `/plugin marketplace add github:bpmnkit/monorepo` then `/plugin install bpmnkit`. See [AIKit Skills](/cli/skills/) for full documentation.
17
+
18
+ ---
19
+ Source: https://docs.bpmnkit.com/cli/casen/
@@ -0,0 +1,32 @@
1
+ # casen CLI — BPMN generation pipeline
2
+
3
+ Every BPMN process is authored as a `ProcessPlan` JSON file — never hand-written XML — and
4
+ compiled deterministically:
5
+
6
+ ```sh
7
+ # Print the ProcessPlan JSON format reference (schema + field notes)
8
+ casen plan schema
9
+
10
+ # Compile a plan to laid-out, deployable BPMN
11
+ casen synth synth order-process.plan.json --output order-process.bpmn
12
+
13
+ # Extend an existing process: lift it back to plan form, then merge a delta plan into it
14
+ casen plan extract order-process.bpmn
15
+ casen synth synth delta.plan.json --merge order-process.bpmn --output order-process.bpmn
16
+
17
+ # Find and inspect a Camunda connector template
18
+ casen connector search slack
19
+ casen connector show io.camunda.connectors.Slack.v1
20
+
21
+ # Deploy-readiness gate, then deploy
22
+ casen lint lint order-process.bpmn --profile deploy
23
+ casen deploy deploy order-process.bpmn # local Reebe
24
+ casen deploy deploy order-process.bpmn --target camunda8 # active Camunda 8 profile
25
+ ```
26
+
27
+ `casen synth` reports any problems keyed by JSON path in the plan (e.g. `steps[2].connector.values.token`) — fix the plan, never the XML, and re-run. If the plan has a `tests` array, `casen synth` also writes a `<file>.bpmn.tests.json` sidecar, runnable with `casen test <file>.bpmn`.
28
+
29
+ See [Building Processes with AI](/guides/ai-implement/) and [AI Agents](/guides/ai-agents/) for full walkthroughs.
30
+
31
+ ---
32
+ Source: https://docs.bpmnkit.com/cli/casen/
@@ -0,0 +1,62 @@
1
+ # casen CLI — Connection Profiles
2
+
3
+ A profile stores the connection details for a Camunda cluster:
4
+
5
+ ```sh
6
+ # Add a new profile
7
+ casen profile add
8
+
9
+ # You'll be prompted for:
10
+ # Name: my-saas-cluster
11
+ # Base URL: https://api.cloud.camunda.io
12
+ # Auth type: oauth2 | bearer | none
13
+ # Client ID, Client Secret, Audience, Token URL (for oauth2)
14
+ ```
15
+
16
+ Profiles are saved to `~/.casen/profiles.json`.
17
+
18
+
19
+ ## Common Workflows
20
+
21
+ ### List process definitions
22
+
23
+ ```
24
+ Navigate to: process → list → Enter
25
+
26
+ Result:
27
+ bpmnProcessId name ver
28
+ ──────────────────────────────────────────────────────────
29
+ ▶ invoice-approval Invoice Approval 2
30
+ order-fulfillment Order Fulfillment 1
31
+ customer-onboarding Customer Onboarding 3
32
+ ```
33
+
34
+ ### Start a process instance
35
+
36
+ ```
37
+ Navigate to: process → start → Enter
38
+
39
+ Select process: invoice-approval
40
+ Variables (JSON): {"invoiceId": "inv-001", "amount": 5000}
41
+ ```
42
+
43
+ ### Resolve an incident
44
+
45
+ ```
46
+ Navigate to: incident → list → Enter
47
+ ```
48
+
49
+ Select the incident with Enter, choose "Resolve" from the action menu.
50
+
51
+ ### Publish a message
52
+
53
+ ```
54
+ Navigate to: message → publish → Enter
55
+
56
+ Message name: payment-confirmed
57
+ Correlation key: ord-456
58
+ Variables (JSON): {"method": "card"}
59
+ ```
60
+
61
+ ---
62
+ Source: https://docs.bpmnkit.com/cli/casen/
@@ -0,0 +1,28 @@
1
+ # casen CLI — Generate BPMN files
2
+
3
+ `casen generate bpmn` creates BPMN files from the command line — no interactive menu required.
4
+ Choose a built-in template, supply a full CompactDiagram JSON definition, or patch an existing file.
5
+
6
+ ```sh
7
+ casen generate bpmn --template approval --process-id leave-request
8
+ casen generate bpmn --input order.bpmn --dump-compact # inspect as JSON for AI
9
+ casen generate bpmn --input order.bpmn --patch '{"elements":[...],"flows":[...]}'
10
+ ```
11
+
12
+ See [casen generate](/cli/generate/) for full documentation.
13
+
14
+
15
+ ## View BPMN, DMN, and Form files
16
+
17
+ `casen view` opens a local browser-based viewer. Accepts individual files, folders, or a mix.
18
+
19
+ ```sh
20
+ casen view bpmn ./processes/ # all .bpmn files in a folder
21
+ casen view dmn routing.dmn # DMN decision table
22
+ casen view open ./project/ # any mix of .bpmn/.dmn/.form
23
+ ```
24
+
25
+ See [casen view](/cli/view/) for full documentation.
26
+
27
+ ---
28
+ Source: https://docs.bpmnkit.com/cli/casen/
@@ -0,0 +1,80 @@
1
+ # casen CLI
2
+
3
+ `casen` is an interactive terminal UI (TUI) for managing Camunda 8. Navigate with arrow keys,
4
+ no flags to memorize.
5
+
6
+
7
+ ## Installation
8
+
9
+ ```sh
10
+ pnpm add -g @bpmnkit/cli
11
+ ```
12
+
13
+
14
+ ## Quick Start
15
+
16
+ ```sh
17
+ casen
18
+ ```
19
+
20
+ The main menu appears. Use ↑ ↓ to navigate, Enter to select, Escape to go back.
21
+
22
+
23
+ ## Navigation Structure
24
+
25
+ ```
26
+ casen
27
+ ├── generate — generate or modify BPMN files without the TUI
28
+ │ └── bpmn — templates, CompactDiagram JSON, or patch existing files
29
+ ├── view — view BPMN, DMN, and form files in the browser
30
+ │ ├── open — any mix of .bpmn/.dmn/.form files or folders (auto-detect)
31
+ │ ├── bpmn — BPMN diagrams rendered as SVG
32
+ │ ├── dmn — DMN decision tables
33
+ │ └── form — Camunda form layouts
34
+ ├── lint — static analysis and auto-fix for BPMN files
35
+ │ ├── lint — run all checks, report findings
36
+ │ └── improve — AI-assisted improvement suggestions
37
+ ├── story — render a BPMN process as a narrative HTML page
38
+ ├── ask — ask an AI assistant about your process or cluster
39
+ ├── connector — generate element templates from OpenAPI specs
40
+ │ ├── generate — generate templates from a spec file or catalog entry
41
+ │ └── catalog — list built-in catalog entries
42
+ ├── profile — manage connection profiles
43
+ │ ├── list — show all profiles
44
+ │ ├── add — create a new profile
45
+ │ └── switch — set the active profile
46
+ ├── process
47
+ │ ├── list — list deployed process definitions
48
+ │ ├── start — start a new instance
49
+ │ ├── instances — list running instances
50
+ │ └── cancel — cancel an instance
51
+ ├── job
52
+ │ ├── list — list active jobs
53
+ │ ├── complete — complete a job
54
+ │ └── fail — fail a job with a message
55
+ ├── incident
56
+ │ ├── list — list open incidents
57
+ │ └── resolve — resolve an incident
58
+ ├── decision
59
+ │ ├── list — list deployed DMN decision tables
60
+ │ └── evaluate — evaluate a decision with test inputs
61
+ ├── variable
62
+ │ ├── list — list variables for an instance
63
+ │ └── update — set a variable value
64
+ ├── message
65
+ │ └── publish — publish a message for correlation
66
+ ├── worker — run job workers
67
+ │ ├── <job-type> — auto-complete worker for a job type
68
+ │ └── start — start scaffolded workers from ./workers/
69
+ ├── proxy — start the local AI bridge server
70
+ └── plugin — manage CLI plugins
71
+ ├── search — discover plugins on npm
72
+ ├── install — install a plugin from npm or a local path
73
+ ├── list — list installed plugins
74
+ ├── update — update one or all plugins
75
+ ├── remove — uninstall a plugin
76
+ └── info — show details for an installed plugin
77
+ ```
78
+
79
+ ---
80
+ Source: https://docs.bpmnkit.com/cli/casen/
@@ -0,0 +1,56 @@
1
+ # casen CLI — Plugins
2
+
3
+ casen's plugin system lets you extend the CLI with new command groups — your own organisation's
4
+ workflows, third-party integrations, or community-built tools.
5
+
6
+ ### Discover plugins
7
+
8
+ ```sh
9
+ # Browse all published casen plugins
10
+ casen plugin search
11
+
12
+ # Search by keyword
13
+ casen plugin search deploy
14
+ casen plugin search slack
15
+ ```
16
+
17
+ Results are fetched live from the npm registry. Any package tagged with the `casen-plugin` keyword
18
+ appears here.
19
+
20
+ ### Install a plugin
21
+
22
+ ```sh
23
+ # Install from npm
24
+ casen plugin install casen-deploy
25
+
26
+ # Install a local plugin during development
27
+ casen plugin install ./my-plugin
28
+ ```
29
+
30
+ Plugins are installed into `~/.casen/plugins/` and loaded automatically the next time casen starts.
31
+
32
+ ### Manage installed plugins
33
+
34
+ ```sh
35
+ # List installed plugins
36
+ casen plugin list
37
+
38
+ # Show full details for one plugin
39
+ casen plugin info casen-deploy
40
+
41
+ # Update a single plugin to the latest version
42
+ casen plugin update casen-deploy
43
+
44
+ # Update all installed plugins
45
+ casen plugin update
46
+
47
+ # Remove a plugin
48
+ casen plugin remove casen-deploy
49
+ ```
50
+
51
+ Once installed, plugin commands appear in the main TUI and in tab-completion alongside built-in commands.
52
+
53
+ To build your own plugin, see [Plugin Authoring](/cli/plugin-authoring/).
54
+
55
+ ---
56
+ Source: https://docs.bpmnkit.com/cli/casen/
@@ -0,0 +1,45 @@
1
+ # casen CLI — Worker commands
2
+
3
+ ```sh
4
+ # Run a simple auto-complete worker (for testing)
5
+ casen worker payment-service
6
+
7
+ # Start scaffolded workers from ./workers/
8
+ casen worker start
9
+
10
+ # Start a specific scaffolded worker
11
+ casen worker start send-invoice
12
+ ```
13
+
14
+
15
+ ## MCP Server Mode
16
+
17
+ `casen` can act as an MCP (Model Context Protocol) server, exposing all cluster operations
18
+ as tools to Claude Desktop, Cursor, or any MCP client:
19
+
20
+ ```sh
21
+ casen mcp
22
+ ```
23
+
24
+ Configure in Claude Desktop (`claude_desktop_config.json`):
25
+
26
+ ```json
27
+ {
28
+ "mcpServers": {
29
+ "camunda": {
30
+ "command": "casen",
31
+ "args": ["mcp"],
32
+ "env": {
33
+ "CAMUNDA_CLIENT_ID": "...",
34
+ "CAMUNDA_CLIENT_SECRET": "..."
35
+ }
36
+ }
37
+ }
38
+ }
39
+ ```
40
+
41
+ Now you can ask Claude: _"Show me the open incidents on the invoice-approval process"_ or
42
+ _"Resolve all incidents on process instance 2251799813685249"_.
43
+
44
+ ---
45
+ Source: https://docs.bpmnkit.com/cli/casen/
@@ -0,0 +1,29 @@
1
+ # casen connector — All flags
2
+
3
+ | Flag | Description |
4
+ |---|---|
5
+ | `--swagger <file>` | Path to a local OpenAPI/Swagger YAML or JSON file |
6
+ | `--api <id>` | Catalog entry ID — downloads the spec automatically |
7
+ | `--output <dir>` | Directory to write `.json` template files into |
8
+ | `--base-url <url>` | Override the base URL from the spec |
9
+ | `--id-prefix <prefix>` | Reverse-DNS prefix for template IDs (e.g. `com.myorg`) |
10
+ | `--filter <regex>` | Filter operations by `operationId` or summary |
11
+ | `--expand-body` | Decompose top-level request body properties into individual input fields |
12
+ | `--auth <type>` | Pre-select auth type (see below) |
13
+ | `--format <fmt>` | `one-per-op` (default) or `array` — all templates in one file |
14
+ | `--dry-run` | Print generated templates to stdout instead of writing files |
15
+
16
+ ### Auth types
17
+
18
+ | Value | Description |
19
+ |---|---|
20
+ | `noAuth` | No authentication fields |
21
+ | `apiKey` | Single API key field sent as a header |
22
+ | `basic` | Username + password (HTTP Basic) |
23
+ | `bearer` | Bearer token |
24
+ | `oauth-client-credentials-flow` | Client ID, secret, token URL, and scopes |
25
+
26
+ Auth is auto-detected from `components.securitySchemes` in the spec. Use `--auth` to override.
27
+
28
+ ---
29
+ Source: https://docs.bpmnkit.com/cli/connector/
@@ -0,0 +1,32 @@
1
+ # casen connector — Browse the bundled OOTB catalog
2
+
3
+ ```sh
4
+ casen connector search slack
5
+ casen connector show io.camunda.connectors.Slack.v1
6
+ ```
7
+
8
+ `search` scores the 116 bundled templates by keyword match and prints a table (template id,
9
+ direction, task type, description). `show` prints a template's task type, direction, and its
10
+ required/optional input keys — these are the keys a `ProcessPlan` `connector` step's `values`
11
+ object uses (see [Building Processes with AI](/guides/ai-implement/)):
12
+
13
+ ```
14
+ $ casen connector show io.camunda.connectors.Slack.v1
15
+ Slack connector (io.camunda.connectors.Slack.v1)
16
+ Task type: io.camunda:slack:1
17
+ Direction: outbound
18
+ Create a channel or send a message to a channel or user
19
+
20
+ Required inputs:
21
+ token (secret) — OAuth token
22
+ data.channel — Channel/user name/email
23
+ data.text — Message
24
+ ...
25
+ ```
26
+
27
+ A field marked `(secret)` should be supplied as a `{{secrets.NAME}}` placeholder, never a literal
28
+ credential. This is the same catalog `@bpmnkit/connectors`' `listConnectors()`/`searchConnectors()`
29
+ expose programmatically.
30
+
31
+ ---
32
+ Source: https://docs.bpmnkit.com/cli/connector/
@@ -0,0 +1,41 @@
1
+ # casen connector — Built-in catalog
2
+
3
+ ```sh
4
+ casen connector catalog
5
+ ```
6
+
7
+ | ID | Name | Default auth |
8
+ |---|---|---|
9
+ | `github` | GitHub REST API | bearer |
10
+ | `cloudflare` | Cloudflare API | bearer |
11
+ | `stripe` | Stripe API | basic |
12
+ | `notion` | Notion API | bearer |
13
+ | `resend` | Resend Email API | bearer |
14
+ | `openai` | OpenAI API | bearer |
15
+ | `figma` | Figma API | bearer |
16
+ | `twilio` | Twilio Messaging API | basic |
17
+ | `slack` | Slack Web API | bearer |
18
+ | `jira` | Atlassian Jira API | bearer |
19
+ | `hubspot` | HubSpot CRM API | oauth-client-credentials-flow |
20
+ | `discord` | Discord API | bearer |
21
+ | `pagerduty` | PagerDuty API | apiKey |
22
+ | `zoom` | Zoom API | oauth-client-credentials-flow |
23
+ | `mailchimp` | Mailchimp API | apiKey |
24
+ | `asana` | Asana API | bearer |
25
+ | `sendgrid` | SendGrid Mail API | bearer |
26
+ | `paypal` | PayPal Payments API | oauth-client-credentials-flow |
27
+ | `plaid` | Plaid API | apiKey |
28
+ | `vercel` | Vercel API | bearer |
29
+ | `anthropic` | Anthropic API | apiKey |
30
+ | `shopify` | Shopify Admin API | bearer |
31
+ | `datadog` | Datadog API | apiKey |
32
+ | `sentry` | Sentry API | bearer |
33
+ | `intercom` | Intercom API | bearer |
34
+ | `contentful` | Contentful Management API | bearer |
35
+ | `airtable` | Airtable API | bearer |
36
+ | `twitch` | Twitch Helix API | oauth-client-credentials-flow |
37
+ | `klaviyo` | Klaviyo API | apiKey |
38
+ | `brex` | Brex API | oauth-client-credentials-flow |
39
+
40
+ ---
41
+ Source: https://docs.bpmnkit.com/cli/connector/
@@ -0,0 +1,50 @@
1
+ # casen connector — Common workflows
2
+
3
+ ### Preview before writing
4
+
5
+ Use `--dry-run` to inspect the generated JSON before committing to files:
6
+
7
+ ```sh
8
+ casen connector generate --api resend --dry-run
9
+ ```
10
+
11
+ ### Filter to a subset of operations
12
+
13
+ Large APIs (GitHub, Stripe) produce hundreds of templates. Use `--filter` to narrow it down:
14
+
15
+ ```sh
16
+ # Only generate templates for issue-related operations
17
+ casen connector generate --api github --filter "issues" --output ./templates/
18
+
19
+ # Only POST and PUT operations (filter on summary/operationId)
20
+ casen connector generate --api stripe --filter "create|update" --output ./templates/
21
+ ```
22
+
23
+ ### Expand request body fields
24
+
25
+ By default the request body is a single FEEL `Text` field. Use `--expand-body` to decompose
26
+ top-level properties into individual typed input fields — useful for simple, well-documented APIs:
27
+
28
+ ```sh
29
+ casen connector generate --api resend --expand-body --output ./templates/
30
+ ```
31
+
32
+ ### All templates in one file
33
+
34
+ ```sh
35
+ casen connector generate --api slack --format array --output ./templates/
36
+ # Writes: ./templates/slack.json (array of all templates)
37
+ ```
38
+
39
+ ### Override the base URL
40
+
41
+ Useful when targeting a self-hosted or staging instance:
42
+
43
+ ```sh
44
+ casen connector generate --swagger ./openapi.yaml \
45
+ --base-url https://staging-api.mycompany.com \
46
+ --output ./templates/
47
+ ```
48
+
49
+ ---
50
+ Source: https://docs.bpmnkit.com/cli/connector/
@@ -0,0 +1,30 @@
1
+ # casen connector — Generate from the OpenAPI catalog
2
+
3
+ The fastest way to get started. The catalog contains 30 popular APIs with pre-configured spec URLs
4
+ and auth defaults:
5
+
6
+ ```sh
7
+ # List all available catalog entries
8
+ casen connector catalog
9
+
10
+ # Generate templates for the Stripe API
11
+ casen connector generate --api stripe --output ./templates/
12
+
13
+ # Generate templates for GitHub with a custom ID prefix
14
+ casen connector generate --api github --id-prefix com.myorg --output ./templates/
15
+ ```
16
+
17
+
18
+ ## Generate from a local file
19
+
20
+ Pass any local OpenAPI 3.x or Swagger 2.x file in YAML or JSON format:
21
+
22
+ ```sh
23
+ casen connector generate --swagger ./openapi.yaml --output ./templates/
24
+
25
+ # JSON format works too
26
+ casen connector generate --swagger ./api-spec.json --output ./templates/
27
+ ```
28
+
29
+ ---
30
+ Source: https://docs.bpmnkit.com/cli/connector/
@@ -0,0 +1,20 @@
1
+ # casen connector
2
+
3
+ `casen connector` has two independent jobs: **browse** the 116 bundled Camunda 8 out-of-the-box
4
+ connector templates (`search`/`show` — used by the AI generation pipeline to wire a plan step to
5
+ a real service), and **generate** brand-new connector element templates from OpenAPI 3.x/Swagger
6
+ 2.x specs (`generate`/`catalog` — for APIs Camunda doesn't ship a template for).
7
+
8
+
9
+ ## Commands
10
+
11
+ ```
12
+ casen connector
13
+ ├── search — find a bundled OOTB connector template by name/keyword
14
+ ├── show — show a bundled template's required/optional inputs
15
+ ├── generate — generate new templates from an OpenAPI spec file or catalog entry
16
+ └── catalog — list all built-in OpenAPI-catalog entries (for `generate`)
17
+ ```
18
+
19
+ ---
20
+ Source: https://docs.bpmnkit.com/cli/connector/
@@ -0,0 +1,7 @@
1
+ # casen connector — Programmatic usage
2
+
3
+ The underlying generator is available as a standalone package for use in Node.js scripts and build
4
+ pipelines. See [`@bpmnkit/connector-gen`](/packages/connector-gen/).
5
+
6
+ ---
7
+ Source: https://docs.bpmnkit.com/cli/connector/
@@ -0,0 +1,20 @@
1
+ # casen connector — What gets generated
2
+
3
+ Each operation in the spec becomes one Camunda element template JSON file. The template
4
+ pre-configures a `bpmn:ServiceTask` with job type `io.camunda:http-json:1` and wires up:
5
+
6
+ - **Method** and **URL** — hidden fixed fields; path parameters become FEEL expressions
7
+ (e.g. `="https://api.example.com/users/"+userId`)
8
+ - **Path parameters** — individual `String` input fields
9
+ - **Query parameters** — mapped to a FEEL context object
10
+ - **Headers** — mapped to a FEEL context object
11
+ - **Request body** — single FEEL `Text` field, or individual typed fields with `--expand-body`
12
+ - **Authentication** — full 5-type auth block with visibility conditions; pre-selected to the
13
+ detected or specified auth type
14
+ - **Output mapping**, **error expression**, **retries**, and **timeout** — standard connector fields
15
+
16
+ Import the generated `.json` files into Camunda Modeler via
17
+ **File → Import Element Templates** or by placing them in your `.camunda/element-templates/` directory.
18
+
19
+ ---
20
+ Source: https://docs.bpmnkit.com/cli/connector/
@@ -0,0 +1,89 @@
1
+ # casen generate — Definition mode (AI / scripting path)
2
+
3
+ Pass a full **CompactDiagram** JSON object directly. This covers all 23 BPMN element types, all event
4
+ definition types, boundary events, sub-processes, and Zeebe extensions.
5
+
6
+ ```sh
7
+ # Inline JSON
8
+ casen generate bpmn --definition '{"id":"Definitions_order","processes":[...]}'
9
+
10
+ # Pipe from a file or AI output
11
+ cat definition.json | casen generate bpmn --output order.bpmn
12
+
13
+ # Write to stdout
14
+ echo '{"id":"Defs","processes":[...]}' | casen generate bpmn --output -
15
+ ```
16
+
17
+ ### Print the JSON schema
18
+
19
+ Run `--help-schema` to print the full CompactDiagram reference — element types, event types,
20
+ field descriptions, and a worked example — formatted for quick AI consumption:
21
+
22
+ ```sh
23
+ casen generate bpmn --help-schema
24
+ ```
25
+
26
+ ### CompactDiagram structure
27
+
28
+ ```json
29
+ {
30
+ "id": "Definitions_my-process",
31
+ "processes": [{
32
+ "id": "my-process",
33
+ "name": "My Process",
34
+ "elements": [
35
+ { "id": "start", "type": "startEvent", "name": "Start" },
36
+ { "id": "task1", "type": "serviceTask", "name": "Do Work", "jobType": "my-worker" },
37
+ { "id": "gw", "type": "exclusiveGateway", "name": "OK?" },
38
+ { "id": "end-ok", "type": "endEvent", "name": "Done" },
39
+ { "id": "end-err","type": "endEvent", "name": "Failed", "eventType": "error" }
40
+ ],
41
+ "flows": [
42
+ { "id": "f1", "from": "start", "to": "task1" },
43
+ { "id": "f2", "from": "task1", "to": "gw" },
44
+ { "id": "f3", "from": "gw", "to": "end-ok", "condition": "= ok", "name": "Yes" },
45
+ { "id": "f4", "from": "gw", "to": "end-err", "condition": "= not ok", "name": "No" }
46
+ ]
47
+ }]
48
+ }
49
+ ```
50
+
51
+ **Element types** — all 23 BPMN types supported:
52
+
53
+ - Tasks: `serviceTask` `userTask` `scriptTask` `businessRuleTask` `callActivity` `sendTask` `receiveTask` `manualTask` `task`
54
+ - Events: `startEvent` `endEvent` `intermediateCatchEvent` `intermediateThrowEvent` `boundaryEvent`
55
+ - Gateways: `exclusiveGateway` `parallelGateway` `inclusiveGateway` `eventBasedGateway` `complexGateway`
56
+ - Containers: `subProcess` `adHocSubProcess` `eventSubProcess` `transaction`
57
+
58
+ **Event types** (`eventType` field on event elements):
59
+ `timer` `message` `signal` `error` `escalation` `terminate` `cancel` `conditional` `link` `compensate`
60
+
61
+ **Zeebe extensions:**
62
+
63
+ | Field | Applies to | Effect |
64
+ |---|---|---|
65
+ | `jobType` | `serviceTask`, `sendTask` | Sets `zeebe:taskDefinition.type` |
66
+ | `taskHeaders` | `serviceTask`, `sendTask` | Sets `zeebe:taskHeaders` key/value pairs |
67
+ | `resultVariable` | `serviceTask`, `businessRuleTask` | Maps connector response to a variable |
68
+ | `calledProcess` | `callActivity` | Sets `zeebe:calledElement.processId` |
69
+ | `formId` | `userTask` | Sets `zeebe:formDefinition.formId` |
70
+ | `decisionId` | `businessRuleTask` | Sets `zeebe:calledDecision.decisionId` |
71
+
72
+ **HTTP connector shorthand:**
73
+
74
+ ```json
75
+ {
76
+ "id": "http1",
77
+ "type": "serviceTask",
78
+ "name": "Call API",
79
+ "jobType": "io.camunda:http-json:1",
80
+ "taskHeaders": {
81
+ "url": "https://api.example.com/orders",
82
+ "method": "POST"
83
+ },
84
+ "resultVariable": "apiResponse"
85
+ }
86
+ ```
87
+
88
+ ---
89
+ Source: https://docs.bpmnkit.com/cli/generate/