@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
package/dist/text.js ADDED
@@ -0,0 +1,204 @@
1
+ /** Tokenising, stemming and token counting — shared by the builder and the index. */
2
+ const CONSONANT = "[^aeiou][^aeiouy]*";
3
+ const VOWEL = "[aeiouy][aeiou]*";
4
+ const M_GT_0 = new RegExp(`^(${CONSONANT})?${VOWEL}${CONSONANT}`);
5
+ const M_EQ_1 = new RegExp(`^(${CONSONANT})?${VOWEL}${CONSONANT}(${VOWEL})?$`);
6
+ const M_GT_1 = new RegExp(`^(${CONSONANT})?(${VOWEL}${CONSONANT}){2,}`);
7
+ const HAS_VOWEL = new RegExp(`^(${CONSONANT})?[aeiouy]`);
8
+ const STEP2 = {
9
+ ational: "ate",
10
+ tional: "tion",
11
+ enci: "ence",
12
+ anci: "ance",
13
+ izer: "ize",
14
+ bli: "ble",
15
+ alli: "al",
16
+ entli: "ent",
17
+ eli: "e",
18
+ ousli: "ous",
19
+ ization: "ize",
20
+ ation: "ate",
21
+ ator: "ate",
22
+ alism: "al",
23
+ iveness: "ive",
24
+ fulness: "ful",
25
+ ousness: "ous",
26
+ aliti: "al",
27
+ iviti: "ive",
28
+ biliti: "ble",
29
+ logi: "log",
30
+ };
31
+ const STEP3 = {
32
+ icate: "ic",
33
+ ative: "",
34
+ alize: "al",
35
+ iciti: "ic",
36
+ ical: "ic",
37
+ ful: "",
38
+ ness: "",
39
+ };
40
+ const DOUBLE_END = /([^aeiouylsz])\1$/;
41
+ const CVC = new RegExp(`^${CONSONANT}${VOWEL}[^aeiouwxy]$`);
42
+ /**
43
+ * The Porter (1980) stemmer, so a query for `authenticate` reaches a chunk that
44
+ * only ever says `authentication`. Both reduce to `authent`.
45
+ */
46
+ export function stem(input) {
47
+ let w = input;
48
+ if (w.length < 3)
49
+ return w;
50
+ // Step 1a — plurals.
51
+ if (/sses$|ies$/.test(w))
52
+ w = w.slice(0, -2);
53
+ else if (/[^s]s$/.test(w))
54
+ w = w.slice(0, -1);
55
+ // Step 1b — past participles and gerunds.
56
+ let restore = false;
57
+ if (/eed$/.test(w)) {
58
+ if (M_GT_0.test(w.slice(0, -3)))
59
+ w = w.slice(0, -1);
60
+ }
61
+ else {
62
+ const stripped = /(ed|ing)$/.exec(w);
63
+ if (stripped) {
64
+ const base = w.slice(0, w.length - stripped[0].length);
65
+ if (HAS_VOWEL.test(base)) {
66
+ w = base;
67
+ restore = true;
68
+ }
69
+ }
70
+ }
71
+ if (restore) {
72
+ if (/(at|bl|iz)$/.test(w))
73
+ w += "e";
74
+ else if (DOUBLE_END.test(w))
75
+ w = w.slice(0, -1);
76
+ else if (M_EQ_1.test(w) && CVC.test(w))
77
+ w += "e";
78
+ }
79
+ // Step 1c — terminal y.
80
+ if (/y$/.test(w) && HAS_VOWEL.test(w.slice(0, -1)))
81
+ w = `${w.slice(0, -1)}i`;
82
+ // Steps 2 and 3 — derivational suffixes, longest match first.
83
+ w = replaceSuffix(w, STEP2, M_GT_0);
84
+ w = replaceSuffix(w, STEP3, M_GT_0);
85
+ // Step 4 — strip the suffix outright when the stem is long enough.
86
+ const tail = /(?:ion|ement|ance|ence|able|ible|ment|ant|ent|ism|ate|iti|ous|ive|ize|al|er|ic|ou)$/.exec(w);
87
+ if (tail) {
88
+ const base = w.slice(0, w.length - tail[0].length);
89
+ // `-ion` only comes off a stem that kept the `s` or `t` in front of it.
90
+ const removable = tail[0] === "ion" ? /[st]$/.test(base) : true;
91
+ if (removable && M_GT_1.test(base))
92
+ w = base;
93
+ }
94
+ // Step 5 — terminal e and doubled l.
95
+ if (/e$/.test(w)) {
96
+ const base = w.slice(0, -1);
97
+ if (M_GT_1.test(base) || (M_EQ_1.test(base) && !CVC.test(base)))
98
+ w = base;
99
+ }
100
+ if (/ll$/.test(w) && M_GT_1.test(w.slice(0, -1)))
101
+ w = w.slice(0, -1);
102
+ return w;
103
+ }
104
+ function replaceSuffix(w, table, measure) {
105
+ for (const [suffix, replacement] of Object.entries(table)) {
106
+ if (!w.endsWith(suffix))
107
+ continue;
108
+ const base = w.slice(0, w.length - suffix.length);
109
+ if (!measure.test(base))
110
+ continue;
111
+ return base + replacement;
112
+ }
113
+ return w;
114
+ }
115
+ /**
116
+ * Words a query and a chunk share no meaning through: indexing them costs space
117
+ * and matching on them ranks every chunk equally.
118
+ */
119
+ export const STOP_WORDS = new Set([
120
+ "a",
121
+ "about",
122
+ "an",
123
+ "and",
124
+ "are",
125
+ "as",
126
+ "at",
127
+ "be",
128
+ "but",
129
+ "by",
130
+ "can",
131
+ "do",
132
+ "does",
133
+ "for",
134
+ "from",
135
+ "how",
136
+ "i",
137
+ "if",
138
+ "in",
139
+ "into",
140
+ "is",
141
+ "it",
142
+ "its",
143
+ "of",
144
+ "on",
145
+ "or",
146
+ "our",
147
+ "that",
148
+ "the",
149
+ "their",
150
+ "then",
151
+ "there",
152
+ "these",
153
+ "this",
154
+ "to",
155
+ "use",
156
+ "using",
157
+ "was",
158
+ "what",
159
+ "when",
160
+ "where",
161
+ "which",
162
+ "who",
163
+ "why",
164
+ "will",
165
+ "with",
166
+ "you",
167
+ "your",
168
+ ]);
169
+ /** Split text into lowercase word tokens, keeping the dots inside `a.b` identifiers. */
170
+ export function tokenize(text) {
171
+ return text.toLowerCase().match(/[a-z0-9][a-z0-9._-]*/g) ?? [];
172
+ }
173
+ /** Tokenize, drop stop words, stem — the form both the index and a query use. */
174
+ export function terms(text) {
175
+ const out = [];
176
+ for (const token of tokenize(text)) {
177
+ if (STOP_WORDS.has(token))
178
+ continue;
179
+ // `Bpmn.createProcess` is worth matching whole and by its parts.
180
+ if (/[._-]/.test(token)) {
181
+ out.push(token);
182
+ for (const part of token.split(/[._-]+/)) {
183
+ if (part.length > 1 && !STOP_WORDS.has(part))
184
+ out.push(stem(part));
185
+ }
186
+ continue;
187
+ }
188
+ out.push(stem(token));
189
+ }
190
+ return out;
191
+ }
192
+ /**
193
+ * Approximate the token count of a string. Deterministic and close enough to
194
+ * budget an answer against — docspack counts from the manifest before it reads
195
+ * any content, so this must not need the content to be tokenised twice.
196
+ */
197
+ export function estimateTokens(text) {
198
+ if (text.trim() === "")
199
+ return 0;
200
+ const words = text.trim().split(/\s+/).length;
201
+ const punctuation = (text.match(/[^\w\s]/g) ?? []).length;
202
+ return Math.max(1, Math.round(words * 1.3 + punctuation * 0.3));
203
+ }
204
+ //# sourceMappingURL=text.js.map
@@ -0,0 +1,48 @@
1
+ /** The docspack package format, version 1: https://docspack.dev/spec */
2
+ /** One retrievable unit of documentation, as described in `.llms/manifest.json`. */
3
+ export interface ManifestChunk {
4
+ /** Unique within the package. Matches `^[A-Za-z0-9][A-Za-z0-9._-]*$`. */
5
+ id: string;
6
+ /** Path relative to `.llms/`. Must not escape that directory. */
7
+ file: string;
8
+ /** Approximate token count, used to budget an answer. Never 0. */
9
+ tokens?: number;
10
+ /** Search terms indexed alongside the content, weighted above it. */
11
+ tags?: string[];
12
+ /** Identifiers the chunk documents, e.g. `Bpmn.createProcess`. */
13
+ entities?: string[];
14
+ }
15
+ /** Contents of `.llms/manifest.json`. */
16
+ export interface Manifest {
17
+ $schema?: string;
18
+ name: string;
19
+ version: string;
20
+ /** Libraries this package documents, each `name` or `name@version`. */
21
+ documents?: string[];
22
+ chunks: ManifestChunk[];
23
+ }
24
+ /** A documentation package found on disk, with its manifest already validated. */
25
+ export interface Pack {
26
+ name: string;
27
+ /** The installed `package.json` version, which supersedes the manifest's. */
28
+ version: string;
29
+ /** Absolute path to the package root (the directory holding `.llms/`). */
30
+ dir: string;
31
+ /** False for `@docspack-community/*`, whose content is unreviewed. */
32
+ trusted: boolean;
33
+ manifest: Manifest;
34
+ /** Set when the manifest version disagrees with the installed package.json. */
35
+ versionMismatch?: string;
36
+ }
37
+ /** A chunk that matched a query, scored against the whole corpus. */
38
+ export interface SearchHit {
39
+ /** `<name>@<version>/<id>` — the identifier an answer header shows. */
40
+ chunkId: string;
41
+ pack: Pack;
42
+ chunk: ManifestChunk;
43
+ /** The chunk's own Markdown, already read from disk. */
44
+ content: string;
45
+ tokens: number;
46
+ score: number;
47
+ }
48
+ //# sourceMappingURL=types.d.ts.map
package/dist/types.js ADDED
@@ -0,0 +1,3 @@
1
+ /** The docspack package format, version 1: https://docspack.dev/spec */
2
+ export {};
3
+ //# sourceMappingURL=types.js.map
package/llms.txt ADDED
@@ -0,0 +1,174 @@
1
+ # @bpmnkit/docspack
2
+
3
+ > BPMN Kit documentation as an offline, version-locked docspack package with a built-in search CLI for AI agents
4
+
5
+ Version 0.0.1. 152 chunks documenting @bpmnkit/core, @bpmnkit/canvas, @bpmnkit/editor, @bpmnkit/engine, @bpmnkit/feel, @bpmnkit/plugins, @bpmnkit/api, @bpmnkit/ascii, @bpmnkit/connector-gen, @bpmnkit/connectors, @bpmnkit/patterns, @bpmnkit/worker-client, @bpmnkit/cli.
6
+
7
+ ```sh
8
+ npm i -D @bpmnkit/docspack
9
+ npx bpmnkit-docs ask "how do I deploy a process"
10
+ ```
11
+
12
+ ## cli
13
+
14
+ - [casen CLI](.llms/chunks/cli.casen.md) — 677 tokens
15
+ - [casen CLI — Generate BPMN files](.llms/chunks/cli.casen.generate-bpmn-files.md) — 205 tokens
16
+ - [casen CLI — Connection Profiles](.llms/chunks/cli.casen.connection-profiles.md) — 279 tokens
17
+ - [casen CLI — Plugins](.llms/chunks/cli.casen.plugins.md) — 271 tokens
18
+ - [casen CLI — BPMN generation pipeline](.llms/chunks/cli.casen.bpmn-generation-pipeline.md) — 281 tokens
19
+ - [casen CLI — AIKit Skills](.llms/chunks/cli.casen.aikit-skills.md) — 197 tokens
20
+ - [casen CLI — Worker commands](.llms/chunks/cli.casen.worker-commands.md) — 192 tokens
21
+ - [casen connector](.llms/chunks/cli.connector.md) — 167 tokens
22
+ - [casen connector — Browse the bundled OOTB catalog](.llms/chunks/cli.connector.browse-the-bundled-ootb-catalog.md) — 213 tokens
23
+ - [casen connector — Generate from the OpenAPI catalog](.llms/chunks/cli.connector.generate-from-the-openapi-catalog.md) — 174 tokens
24
+ - [casen connector — All flags](.llms/chunks/cli.connector.all-flags.md) — 329 tokens
25
+ - [casen connector — Common workflows](.llms/chunks/cli.connector.common-workflows.md) — 288 tokens
26
+ - [casen connector — What gets generated](.llms/chunks/cli.connector.what-gets-generated.md) — 225 tokens
27
+ - [casen connector — Built-in catalog](.llms/chunks/cli.connector.built-in-catalog.md) — 426 tokens
28
+ - [casen connector — Programmatic usage](.llms/chunks/cli.connector.programmatic-usage.md) — 45 tokens
29
+ - [casen generate](.llms/chunks/cli.generate.md) — 508 tokens
30
+ - [casen generate — Definition mode (AI / scripting path)](.llms/chunks/cli.generate.definition-mode-ai-scripting-path.md) — 672 tokens
31
+ - [casen generate — Modify-existing mode (`--input`)](.llms/chunks/cli.generate.modify-existing-mode-input.md) — 449 tokens
32
+ - [casen generate — Typical AI workflow](.llms/chunks/cli.generate.typical-ai-workflow.md) — 106 tokens
33
+ - [casen Plugin Authoring](.llms/chunks/cli.plugin-authoring.md) — 326 tokens
34
+ - [casen Plugin Authoring — What gets generated](.llms/chunks/cli.plugin-authoring.what-gets-generated.md) — 310 tokens
35
+ - [casen Plugin Authoring — The `@bpmnkit/cli-sdk` SDK](.llms/chunks/cli.plugin-authoring.the-bpmnkit-cli-sdk-sdk.md) — 423 tokens
36
+ - [casen Plugin Authoring — Writing commands](.llms/chunks/cli.plugin-authoring.writing-commands.md) — 425 tokens
37
+ - [casen Plugin Authoring — Test locally](.llms/chunks/cli.plugin-authoring.test-locally.md) — 161 tokens
38
+ - [casen Plugin Authoring — Plugin naming conventions](.llms/chunks/cli.plugin-authoring.plugin-naming-conventions.md) — 116 tokens
39
+ - [casen Plugins](.llms/chunks/cli.plugins.md) — 167 tokens
40
+ - [casen Plugins — `@bpmnkit/casen-report`](.llms/chunks/cli.plugins.bpmnkit-casen-report.md) — 244 tokens
41
+ - [casen Plugins — `@bpmnkit/casen-worker-http`](.llms/chunks/cli.plugins.bpmnkit-casen-worker-http.md) — 116 tokens
42
+ - [AIKit Skills](.llms/chunks/cli.skills.md) — 166 tokens
43
+ - [AIKit Skills — `/implement`](.llms/chunks/cli.skills.implement.md) — 221 tokens
44
+ - [AIKit Skills — `/review`](.llms/chunks/cli.skills.review.md) — 184 tokens
45
+ - [AIKit Skills — `/test`](.llms/chunks/cli.skills.test.md) — 193 tokens
46
+ - [AIKit Skills — `/deploy`](.llms/chunks/cli.skills.deploy.md) — 184 tokens
47
+ - [AIKit Skills — No MCP server required](.llms/chunks/cli.skills.no-mcp-server-required.md) — 83 tokens
48
+ - [casen view](.llms/chunks/cli.view.md) — 358 tokens
49
+ - [casen view — Folder support](.llms/chunks/cli.view.folder-support.md) — 202 tokens
50
+ - [casen view — Tabbed navigation](.llms/chunks/cli.view.tabbed-navigation.md) — 181 tokens
51
+
52
+ ## getting-started
53
+
54
+ - [Core Concepts — The Fluent Builder](.llms/chunks/getting-started.concepts.the-fluent-builder.md) — 252 tokens
55
+ - [Core Concepts — Auto-Layout](.llms/chunks/getting-started.concepts.auto-layout.md) — 150 tokens
56
+ - [Core Concepts — Parsing and Serializing](.llms/chunks/getting-started.concepts.parsing-and-serializing.md) — 149 tokens
57
+ - [Core Concepts — AI-Compact Format](.llms/chunks/getting-started.concepts.ai-compact-format.md) — 182 tokens
58
+ - [Core Concepts — Zeebe Extensions](.llms/chunks/getting-started.concepts.zeebe-extensions.md) — 135 tokens
59
+ - [Installation](.llms/chunks/getting-started.installation.md) — 141 tokens
60
+ - [Installation — SVG Canvas Viewer](.llms/chunks/getting-started.installation.svg-canvas-viewer.md) — 189 tokens
61
+ - [Installation — Worker client](.llms/chunks/getting-started.installation.worker-client.md) — 145 tokens
62
+ - [Installation — Runtime Requirements](.llms/chunks/getting-started.installation.runtime-requirements.md) — 87 tokens
63
+ - [Quick Start](.llms/chunks/getting-started.quick-start.md) — 149 tokens
64
+ - [Quick Start — Step 2: Simulate locally](.llms/chunks/getting-started.quick-start.step-2-simulate-locally.md) — 158 tokens
65
+ - [Quick Start — Step 3: Deploy to Camunda 8](.llms/chunks/getting-started.quick-start.step-3-deploy-to-camunda-8.md) — 152 tokens
66
+ - [Quick Start — What's next?](.llms/chunks/getting-started.quick-start.what-s-next.md) — 137 tokens
67
+
68
+ ## guides
69
+
70
+ - [AI Agents](.llms/chunks/guides.ai-agents.md) — 146 tokens
71
+ - [AI Agents — How it's modeled](.llms/chunks/guides.ai-agents.how-it-s-modeled.md) — 183 tokens
72
+ - [AI Agents — The `aiAgent` plan step](.llms/chunks/guides.ai-agents.the-aiagent-plan-step.md) — 501 tokens
73
+ - [AI Agents — Deploy-grade validation](.llms/chunks/guides.ai-agents.deploy-grade-validation.md) — 205 tokens
74
+ - [AI Agents — Testing without a real LLM call](.llms/chunks/guides.ai-agents.testing-without-a-real-llm-call.md) — 201 tokens
75
+ - [AI Agents — See also](.llms/chunks/guides.ai-agents.see-also.md) — 49 tokens
76
+ - [Building Processes with AI](.llms/chunks/guides.ai-implement.md) — 403 tokens
77
+ - [Building Processes with AI — The Claude Code plugin](.llms/chunks/guides.ai-implement.the-claude-code-plugin.md) — 231 tokens
78
+ - [Building Processes with AI — Lightweight alternative: `casen skills install`](.llms/chunks/guides.ai-implement.lightweight-alternative-casen-skills-install.md) — 172 tokens
79
+ - [Building Processes with AI — Deploying](.llms/chunks/guides.ai-implement.deploying.md) — 256 tokens
80
+ - [Building Processes with AI — Extending an existing process](.llms/chunks/guides.ai-implement.extending-an-existing-process.md) — 100 tokens
81
+ - [AI Integration](.llms/chunks/guides.ai.md) — 227 tokens
82
+ - [AI Integration — Minimal Empty Diagram](.llms/chunks/guides.ai.minimal-empty-diagram.md) — 229 tokens
83
+ - [AI Integration — Claude API Example](.llms/chunks/guides.ai.claude-api-example.md) — 227 tokens
84
+ - [AI Integration — OpenAI Function Calling](.llms/chunks/guides.ai.openai-function-calling.md) — 192 tokens
85
+ - [AI Integration — MCP Server](.llms/chunks/guides.ai.mcp-server.md) — 151 tokens
86
+ - [Building Processes — Service Tasks](.llms/chunks/guides.building-processes.service-tasks.md) — 203 tokens
87
+ - [Building Processes — Events](.llms/chunks/guides.building-processes.events.md) — 245 tokens
88
+ - [Building Processes — Sub-Processes](.llms/chunks/guides.building-processes.sub-processes.md) — 181 tokens
89
+ - [Building Processes — Boundary Events](.llms/chunks/guides.building-processes.boundary-events.md) — 294 tokens
90
+ - [Building Processes — Call Activities](.llms/chunks/guides.building-processes.call-activities.md) — 217 tokens
91
+ - [Building Processes — Task Defaults](.llms/chunks/guides.building-processes.task-defaults.md) — 141 tokens
92
+ - [Building Processes — Multi-Instance](.llms/chunks/guides.building-processes.multi-instance.md) — 93 tokens
93
+ - [Claude Code Plugin](.llms/chunks/guides.claude-code-plugin.md) — 205 tokens
94
+ - [Claude Code Plugin — Configuration](.llms/chunks/guides.claude-code-plugin.configuration.md) — 591 tokens
95
+ - [Claude Code Plugin — Reference docs](.llms/chunks/guides.claude-code-plugin.reference-docs.md) — 412 tokens
96
+ - [Claude Code Plugin — Ambient Hooks](.llms/chunks/guides.claude-code-plugin.ambient-hooks.md) — 191 tokens
97
+ - [Camunda 8 Deployment](.llms/chunks/guides.deployment.md) — 192 tokens
98
+ - [Camunda 8 Deployment — Deploying a Process](.llms/chunks/guides.deployment.deploying-a-process.md) — 196 tokens
99
+ - [Camunda 8 Deployment — Handling Jobs](.llms/chunks/guides.deployment.handling-jobs.md) — 195 tokens
100
+ - [Camunda 8 Deployment — Managing Incidents](.llms/chunks/guides.deployment.managing-incidents.md) — 143 tokens
101
+ - [Camunda 8 Deployment — CI/CD: Deploy on Push](.llms/chunks/guides.deployment.ci-cd-deploy-on-push.md) — 222 tokens
102
+ - [Gateways & Branching — Exclusive Gateway (XOR)](.llms/chunks/guides.gateways.exclusive-gateway-xor.md) — 218 tokens
103
+ - [Gateways & Branching — Parallel Gateway (AND)](.llms/chunks/guides.gateways.parallel-gateway-and.md) — 143 tokens
104
+ - [Gateways & Branching — Inclusive Gateway (OR)](.llms/chunks/guides.gateways.inclusive-gateway-or.md) — 208 tokens
105
+ - [Gateways & Branching — Branching Inside Sub-Processes](.llms/chunks/guides.gateways.branching-inside-sub-processes.md) — 142 tokens
106
+ - [Gateways & Branching — Nested Branching](.llms/chunks/guides.gateways.nested-branching.md) — 122 tokens
107
+ - [Pattern Library](.llms/chunks/guides.patterns.md) — 304 tokens
108
+ - [Pattern Library — How matching works](.llms/chunks/guides.patterns.how-matching-works.md) — 138 tokens
109
+ - [Pattern Library — What a pattern contains](.llms/chunks/guides.patterns.what-a-pattern-contains.md) — 154 tokens
110
+ - [Pattern Library — Using patterns from the CLI](.llms/chunks/guides.patterns.using-patterns-from-the-cli.md) — 139 tokens
111
+ - [Pattern Library — Pattern schema](.llms/chunks/guides.patterns.pattern-schema.md) — 212 tokens
112
+ - [Pattern Library — See also](.llms/chunks/guides.patterns.see-also.md) — 45 tokens
113
+ - [Simulation](.llms/chunks/guides.simulation.md) — 261 tokens
114
+ - [Simulation — Instance State](.llms/chunks/guides.simulation.instance-state.md) — 136 tokens
115
+ - [Simulation — Message Correlation](.llms/chunks/guides.simulation.message-correlation.md) — 144 tokens
116
+ - [Simulation — DMN Decision Evaluation](.llms/chunks/guides.simulation.dmn-decision-evaluation.md) — 251 tokens
117
+ - [Simulation — Multiple Deployments](.llms/chunks/guides.simulation.multiple-deployments.md) — 86 tokens
118
+ - [Standalone Workers](.llms/chunks/guides.workers-standalone.md) — 184 tokens
119
+ - [Standalone Workers — Anatomy of a worker](.llms/chunks/guides.workers-standalone.anatomy-of-a-worker.md) — 212 tokens
120
+ - [Standalone Workers — Environment variables](.llms/chunks/guides.workers-standalone.environment-variables.md) — 141 tokens
121
+ - [Standalone Workers — Running workers](.llms/chunks/guides.workers-standalone.running-workers.md) — 222 tokens
122
+ - [Standalone Workers — Camunda SaaS](.llms/chunks/guides.workers-standalone.camunda-saas.md) — 274 tokens
123
+ - [Standalone Workers — See also](.llms/chunks/guides.workers-standalone.see-also.md) — 46 tokens
124
+
125
+ ## packages
126
+
127
+ - [@bpmnkit/api — Overview](.llms/chunks/packages.api.overview.md) — 218 tokens
128
+ - [@bpmnkit/api — Resource Namespaces](.llms/chunks/packages.api.resource-namespaces.md) — 172 tokens
129
+ - [@bpmnkit/api — Process Operations](.llms/chunks/packages.api.process-operations.md) — 239 tokens
130
+ - [@bpmnkit/api — Incident Resolution](.llms/chunks/packages.api.incident-resolution.md) — 138 tokens
131
+ - [@bpmnkit/api — Observability Events](.llms/chunks/packages.api.observability-events.md) — 95 tokens
132
+ - [@bpmnkit/canvas — Overview](.llms/chunks/packages.canvas.overview.md) — 162 tokens
133
+ - [@bpmnkit/canvas — Options](.llms/chunks/packages.canvas.options.md) — 147 tokens
134
+ - [@bpmnkit/canvas — Events](.llms/chunks/packages.canvas.events.md) — 269 tokens
135
+ - [@bpmnkit/connector-gen — Overview](.llms/chunks/packages.connector-gen.overview.md) — 182 tokens
136
+ - [@bpmnkit/connector-gen — Installation](.llms/chunks/packages.connector-gen.installation.md) — 159 tokens
137
+ - [@bpmnkit/connector-gen — Generating from the catalog](.llms/chunks/packages.connector-gen.generating-from-the-catalog.md) — 268 tokens
138
+ - [@bpmnkit/connector-gen — `WriteOptions`](.llms/chunks/packages.connector-gen.writeoptions.md) — 236 tokens
139
+ - [@bpmnkit/connector-gen — Body expansion](.llms/chunks/packages.connector-gen.body-expansion.md) — 137 tokens
140
+ - [@bpmnkit/connector-gen — Lower-level API](.llms/chunks/packages.connector-gen.lower-level-api.md) — 185 tokens
141
+ - [@bpmnkit/connector-gen — Catalog reference](.llms/chunks/packages.connector-gen.catalog-reference.md) — 518 tokens
142
+ - [@bpmnkit/connector-gen — `CatalogEntry` type](.llms/chunks/packages.connector-gen.catalogentry-type.md) — 86 tokens
143
+ - [@bpmnkit/core — Overview](.llms/chunks/packages.core.overview.md) — 136 tokens
144
+ - [@bpmnkit/core — Installation](.llms/chunks/packages.core.installation.md) — 27 tokens
145
+ - [@bpmnkit/core — Installation — `Bpmn.createProcess(id, name?)`](.llms/chunks/packages.core.installation-bpmn.createprocess-id-name.md) — 51 tokens
146
+ - [@bpmnkit/core — Installation — `Bpmn.createDiagram(id?)`](.llms/chunks/packages.core.installation-bpmn.creatediagram-id.md) — 107 tokens
147
+ - [@bpmnkit/core — Installation — `Bpmn.export(definitions)`](.llms/chunks/packages.core.installation-bpmn.export-definitions.md) — 44 tokens
148
+ - [@bpmnkit/core — Installation — `Bpmn.parse(xml)`](.llms/chunks/packages.core.installation-bpmn.parse-xml.md) — 45 tokens
149
+ - [@bpmnkit/core — Installation — `Bpmn.makeEmpty(processId?, processName?)`](.llms/chunks/packages.core.installation-bpmn.makeempty-processid-processname.md) — 65 tokens
150
+ - [@bpmnkit/core — Installation — `Bpmn.SAMPLE_XML`](.llms/chunks/packages.core.installation-bpmn.sample_xml.md) — 43 tokens
151
+ - [@bpmnkit/core — Installation — `compactify(definitions)`](.llms/chunks/packages.core.installation-compactify-definitions.md) — 62 tokens
152
+ - [@bpmnkit/core — Installation — `expand(compact)`](.llms/chunks/packages.core.installation-expand-compact.md) — 57 tokens
153
+ - [@bpmnkit/core — Installation — `layoutProcess(process)`](.llms/chunks/packages.core.installation-layoutprocess-process.md) — 85 tokens
154
+ - [@bpmnkit/core — Installation — ProcessBuilder methods](.llms/chunks/packages.core.installation-processbuilder-methods.md) — 415 tokens
155
+ - [@bpmnkit/core — DMN Support](.llms/chunks/packages.core.dmn-support.md) — 113 tokens
156
+ - [@bpmnkit/docspack — Overview](.llms/chunks/packages.docspack.overview.md) — 253 tokens
157
+ - [@bpmnkit/docspack — Installation](.llms/chunks/packages.docspack.installation.md) — 252 tokens
158
+ - [@bpmnkit/docspack — Reading it yourself](.llms/chunks/packages.docspack.reading-it-yourself.md) — 252 tokens
159
+ - [@bpmnkit/docspack — Using the index directly](.llms/chunks/packages.docspack.using-the-index-directly.md) — 320 tokens
160
+ - [@bpmnkit/docspack — Trust](.llms/chunks/packages.docspack.trust.md) — 118 tokens
161
+ - [@bpmnkit/editor — Overview](.llms/chunks/packages.editor.overview.md) — 135 tokens
162
+ - [@bpmnkit/editor — Basic Setup](.llms/chunks/packages.editor.basic-setup.md) — 166 tokens
163
+ - [@bpmnkit/editor — HUD Options](.llms/chunks/packages.editor.hud-options.md) — 164 tokens
164
+ - [@bpmnkit/editor — Full Editor with All Plugins](.llms/chunks/packages.editor.full-editor-with-all-plugins.md) — 157 tokens
165
+ - [@bpmnkit/engine — Overview](.llms/chunks/packages.engine.overview.md) — 141 tokens
166
+ - [@bpmnkit/engine — Installation](.llms/chunks/packages.engine.installation.md) — 346 tokens
167
+ - [@bpmnkit/engine — ProcessInstance](.llms/chunks/packages.engine.processinstance.md) — 161 tokens
168
+ - [@bpmnkit/engine — Variable Scoping](.llms/chunks/packages.engine.variable-scoping.md) — 148 tokens
169
+ - [@bpmnkit/worker-client](.llms/chunks/packages.worker-client.md) — 141 tokens
170
+ - [@bpmnkit/worker-client — `createWorkerClient(options?)`](.llms/chunks/packages.worker-client.createworkerclient-options.md) — 267 tokens
171
+ - [@bpmnkit/worker-client — `client.poll(jobType, options?)`](.llms/chunks/packages.worker-client.client.poll-jobtype-options.md) — 265 tokens
172
+ - [@bpmnkit/worker-client — `job.complete(variables?)`](.llms/chunks/packages.worker-client.job.complete-variables.md) — 172 tokens
173
+ - [@bpmnkit/worker-client — OAuth2 (Camunda SaaS)](.llms/chunks/packages.worker-client.oauth2-camunda-saas.md) — 150 tokens
174
+ - [@bpmnkit/worker-client — See also](.llms/chunks/packages.worker-client.see-also.md) — 47 tokens
package/package.json ADDED
@@ -0,0 +1,76 @@
1
+ {
2
+ "name": "@bpmnkit/docspack",
3
+ "version": "0.0.1",
4
+ "type": "module",
5
+ "main": "./dist/index.js",
6
+ "types": "./dist/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "types": "./dist/index.d.ts",
10
+ "import": "./dist/index.js"
11
+ }
12
+ },
13
+ "bin": {
14
+ "bpmnkit-docs": "./dist/cli.js"
15
+ },
16
+ "files": [
17
+ "LICENSE",
18
+ "README.md",
19
+ "llms.txt",
20
+ ".llms",
21
+ "dist/**/*.js",
22
+ "dist/**/*.d.ts"
23
+ ],
24
+ "engines": {
25
+ "node": ">=20"
26
+ },
27
+ "docspack": {
28
+ "source": "../../apps/docs/src/content/docs",
29
+ "siteUrl": "https://docs.bpmnkit.com",
30
+ "maxTokens": 800,
31
+ "minTokens": 120,
32
+ "documents": [
33
+ "@bpmnkit/core",
34
+ "@bpmnkit/canvas",
35
+ "@bpmnkit/editor",
36
+ "@bpmnkit/engine",
37
+ "@bpmnkit/feel",
38
+ "@bpmnkit/plugins",
39
+ "@bpmnkit/api",
40
+ "@bpmnkit/ascii",
41
+ "@bpmnkit/connector-gen",
42
+ "@bpmnkit/connectors",
43
+ "@bpmnkit/patterns",
44
+ "@bpmnkit/worker-client",
45
+ "@bpmnkit/cli"
46
+ ]
47
+ },
48
+ "description": "BPMN Kit documentation as an offline, version-locked docspack package with a built-in search CLI for AI agents",
49
+ "keywords": [
50
+ "docspack",
51
+ "llms-txt",
52
+ "ai-agents",
53
+ "documentation",
54
+ "search",
55
+ "bpmn",
56
+ "mcp"
57
+ ],
58
+ "license": "MIT",
59
+ "repository": {
60
+ "type": "git",
61
+ "url": "https://github.com/bpmnkit/monorepo"
62
+ },
63
+ "homepage": "https://bpmnkit.com",
64
+ "bugs": {
65
+ "url": "https://github.com/bpmnkit/monorepo/issues"
66
+ },
67
+ "publishConfig": {
68
+ "access": "public"
69
+ },
70
+ "scripts": {
71
+ "build": "tsc && node ./dist/cli.js build",
72
+ "typecheck": "tsc --noEmit",
73
+ "check": "biome check .",
74
+ "test": "vitest run"
75
+ }
76
+ }