Website · Documentation · GitHub · Changelog

Overview

@bpmnkit/camunda-docspack packages the Camunda 8 documentation — BPMN, FEEL, engine concepts and the Orchestration Cluster API — as a docspack pack you can search offline, with no network call and no MCP server.

It is built from the docs/ tree of camunda/camunda-docs, which is the unreleased 8.10 documentation, plus the Orchestration Cluster API specification.

This is Camunda's documentation, not BPMN Kit's. The content is the work of Camunda Services GmbH and copyright in it remains with them; this package contains no documentation written by BPMN Kit and claims no rights over what it carries. All it adds is the tooling that stages, chunks and indexes that content so an AI agent can retrieve it offline. BPMN Kit is not affiliated with, endorsed by, or sponsored by Camunda. It is a convenience copy pinned to one upstream commit, so for canonical and current documentation prefer docs.camunda.io.

Features

• Diagrams as text — the best-practice pages argue through embedded BPMN diagrams. Camunda's own Markdown export drops them; this renders each one as a flow description, so a page about naming gateways still contains the gateway, its question and its conditions.
• 227 API operations — one digest per endpoint, read from the specification rather than from the generated reference pages, with required permissions decoded, the version it appeared in, and its consistency guarantee.
• Every chunk cites its page — links are rewritten to absolute docs.camunda.io URLs, and each chunk ends with the page it came from.
• Nothing dropped silently — an MDX component the build does not recognise fails the build by file and line instead of quietly thinning the corpus.
• Offline — one SQLite-free local index; no server, nothing resident.

Installation

npm i -D @bpmnkit/camunda-docspack
pnpm add -D @bpmnkit/camunda-docspack

Quick Start

Search it with the CLI that ships in @bpmnkit/docspack:

npx bpmnkit-docs ask "how should I name an exclusive gateway"
npx bpmnkit-docs ask "POST /jobs/activation"
npx bpmnkit-docs ask "what permissions does creating a process instance need"
npx bpmnkit-docs ask "FEEL string concatenation" --pack @bpmnkit/camunda-docspack

Answers cap at 3 chunks / 3,000 tokens, so prefer several narrow questions to one broad one.

API Reference

The published artefact is the .llms/ payload. These exports are the build that produces it:

| Export | Purpose | | --- | --- | | build(options) | Stage a camunda-docs checkout and write the .llms/ payload | | stage(options) | Run the staging transforms only, to a directory | | bpmnToText(xml) | Render a BPMN diagram as a compact flow description | | readOperations(entry) | Read one digest per operation from an OpenAPI document | | stripMdx(source, options) | Reduce Camunda's MDX to indexable Markdown | | absoluteLinks(markdown, slug) | Rewrite relative links to docs.camunda.io URLs | | notice(commit) | The CC BY-SA 3.0 attribution written on every build |

Rebuild the pack against a checkout:

node packages/camunda-docspack/dist/cli.js --camunda-docs ../camunda-docs

Licence

The documentation content belongs to Camunda. It is the work of Camunda Services GmbH, taken from camunda/camunda-docs, and copyright in it remains with them. BPMN Kit claims no ownership of it and asserts no rights over it; its own contribution is the build tooling in src/ and nothing else.

Camunda publishes that documentation under CC BY-SA 3.0, and this package redistributes it under those same terms, unchanged. Chunking the prose and rendering its embedded diagrams as text make this an Adaptation under §1 of that licence rather than a mere Collection, so ShareAlike applies and the package as a whole is CC BY-SA 3.0 rather than MIT like the rest of BPMN Kit.

Those terms grant you rights, and nothing here narrows them: you may share and adapt this content, provided you credit Camunda, state what you changed, and license your result alike. See NOTICE for the attribution, the upstream commit, and the list of changes made.

BPMN Kit is not affiliated with, endorsed by, or sponsored by Camunda Services GmbH. "Camunda" is a trademark of its owner, used here only to state truthfully whose documentation this is. For canonical and current documentation, prefer docs.camunda.io.

Related Packages

| Package | Description | |---------|-------------| | @bpmnkit/core | BPMN/DMN/Form parser, builder, layout engine | | @bpmnkit/canvas | Zero-dependency SVG BPMN viewer | | @bpmnkit/editor | Full-featured interactive BPMN editor | | @bpmnkit/engine | Lightweight BPMN process execution engine | | @bpmnkit/feel | FEEL expression language parser & evaluator | | @bpmnkit/plugins | 22 composable canvas plugins | | @bpmnkit/api | Camunda 8 REST API TypeScript client | | @bpmnkit/ascii | Render BPMN diagrams as Unicode ASCII art | | @bpmnkit/docspack | BPMN Kit docs as an offline docspack package for AI agents | | @bpmnkit/ui | Shared design tokens and UI components | | @bpmnkit/profiles | Shared auth, profile storage, and client factories for CLI & proxy | | @bpmnkit/operate | Monitoring & operations frontend for Camunda clusters | | @bpmnkit/connector-gen | Generate connector templates from OpenAPI specs | | @bpmnkit/connectors | Camunda 8 OOTB connector catalog and deterministic template application | | @bpmnkit/cli | Camunda 8 command-line interface (casen) | | @bpmnkit/proxy | Local AI bridge and Camunda API proxy server | | @bpmnkit/patterns | Domain process patterns for BPMNKit AIKit | | @bpmnkit/reebe-wasm | WebAssembly BPMN engine for browser simulation | | @bpmnkit/worker-client | Thin Zeebe REST client for standalone workers | | @bpmnkit/user-tasks | Embeddable user task widget for Camunda 8 | | @bpmnkit/cli-sdk | Plugin authoring SDK for the casen CLI | | @bpmnkit/create-casen-plugin | Scaffold a new casen CLI plugin in seconds | | @bpmnkit/casen-report | HTML reports from Camunda 8 incident and SLA data | | @bpmnkit/casen-worker-http | Example HTTP worker plugin — completes jobs with live JSONPlaceholder API data | | @bpmnkit/casen-worker-ai | AI task worker — classify, summarize, extract, and decide using Claude |

License

MIT © BPMN Kit — made by u11g