Website · Documentation · GitHub · Changelog

Overview

create-casen-plugin is the official scaffolding tool for casen CLI plugins. Run it with any package manager's create shorthand — no prior install required.

pnpm create @bpmnkit/casen-plugin
# or: npx @bpmnkit/create-casen-plugin
# or: bunx @bpmnkit/create-casen-plugin

Interactive Flow

  create-casen-plugin — casen plugin scaffolding

  Plugin name (npm package name): casen-deploy
  Display name             (Deploy):
  Description              (): Git-tag-aware deploys for casen
  Author                   (): acme

  Initialize git repo? (Y/n): Y

  ✔ Created casen-deploy/
  ✔ package.json
  ✔ tsconfig.json
  ✔ src/index.ts
  ✔ git init

  Next steps:
    cd casen-deploy
    pnpm install
    pnpm build
    casen plugin install ./casen-deploy

Non-Interactive Mode

pnpm create @bpmnkit/casen-plugin \
  --name casen-deploy \
  --display-name Deploy \
  --description "Git-tag-aware deploys for casen" \
  --author acme \
  --no-git

Generated Files

package.json

{
  "name": "casen-deploy",
  "version": "0.1.0",
  "type": "module",
  "main": "dist/index.js",
  "keywords": ["casen-plugin"],
  "scripts": { "build": "tsc" },
  "devDependencies": {
    "@bpmnkit/cli-sdk": "latest",
    "typescript": "latest"
  }
}

src/index.ts

import type { CasenPlugin } from "@bpmnkit/cli-sdk"

const plugin: CasenPlugin = {
  id: "com.example.casen-deploy",
  name: "Deploy",
  version: "0.1.0",
  groups: [
    {
      name: "deploy",
      description: "Git-tag-aware deploys",
      commands: [
        {
          name: "release",
          description: "Tag and deploy the current process version",
          async run(ctx) {
            ctx.output.ok("TODO: implement release")
          },
        },
      ],
    },
  ],
}

export default plugin

Plugin Discovery

All plugins with "casen-plugin" in their keywords appear in casen plugin search. The scaffold injects this keyword automatically.

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/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/cli | Camunda 8 command-line interface (casen) | | @bpmnkit/proxy | Local AI bridge and Camunda API proxy server | | @bpmnkit/cli-sdk | Plugin authoring SDK for the casen CLI | | @bpmnkit/casen-report | HTML reports from Camunda 8 incident and SLA data |

License

MIT © BPMN Kit — made by u11g