{"id":15657515,"url":"https://github.com/nikku/bpmn-js-cli-modeling-dsl","last_synced_at":"2025-08-27T03:12:49.286Z","repository":{"id":19355719,"uuid":"22595305","full_name":"nikku/bpmn-js-cli-modeling-dsl","owner":"nikku","description":"A modeling DSL for bpmn-js","archived":false,"fork":false,"pushed_at":"2021-09-15T12:22:25.000Z","size":97,"stargazers_count":23,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-11T11:15:00.260Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nikku.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-04T07:14:19.000Z","updated_at":"2024-04-19T10:35:10.000Z","dependencies_parsed_at":"2022-09-10T20:31:19.989Z","dependency_job_id":null,"html_url":"https://github.com/nikku/bpmn-js-cli-modeling-dsl","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Fbpmn-js-cli-modeling-dsl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Fbpmn-js-cli-modeling-dsl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Fbpmn-js-cli-modeling-dsl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Fbpmn-js-cli-modeling-dsl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nikku","download_url":"https://codeload.github.com/nikku/bpmn-js-cli-modeling-dsl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252436206,"owners_count":21747466,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T13:07:37.927Z","updated_at":"2025-05-05T03:41:26.480Z","avatar_url":"https://github.com/nikku.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e As of version `1.0.0` this library exposes [ES modules](http://exploringjs.com/es6/ch_modules.html#sec_basics-of-es6-modules). Use an ES module aware bundler such as [Webpack](https://webpack.js.org) or [Rollup](https://rollupjs.org) to bundle it for the browser.\n\n\n# bpmn-js-cli-modeling-dsl\n\n[![CI](https://github.com/nikku/bpmn-js-cli-modeling-dsl/actions/workflows/CI.yml/badge.svg)](https://github.com/nikku/bpmn-js-cli-modeling-dsl/actions/workflows/CI.yml)\n\nA modeling DSL (domain specific language) for [bpmn-js](https://github.com/bpmn-io/bpmn-js), built on top of [bpmn-js-cli](https://github.com/bpmn-io/bpmn-js-cli).\n\n\n## Usage\n\nUse the extension for [bpmn-js-cli](https://github.com/bpmn-io/bpmn-js-cli) to quickly model simple processes.\n\nTo model this process:\n\n![example BPMN diagram](./resources/model.png)\n\nsimply execute the following command\n\n```javascript\ncli.model('StartEvent_1 -\u003e and -\u003e service -\u003e user -\u003e icatch -\u003e xor -\u003e or -\u003e ithrow -\u003e end');\n```\n\nYou may use the full classified name of any BPMN element such as `bpmn:ServiceTask`, too to model it.\n\n\n### Shortcuts\n\nA number of aliases are registered for most commonly modeled BPMN elements:\n\n```javascript\nvar aliases = {\n  service:     'bpmn:ServiceTask',\n  user:        'bpmn:UserTask',\n  manual:      'bpmn:ManualTask',\n  task:        'bpmn:Task',\n  end:         'bpmn:EndEvent',\n  transaction: 'bpmn:Transaction',\n  sub:         'bpmn:SubProcess',\n  call:        'bpmn:CallActivity',\n  icatch:      'bpmn:IntermediateCatchEvent',\n  ithrow:      'bpmn:IntermediateThrowEvent',\n  xor:         'bpmn:ExclusiveGateway',\n  or:          'bpmn:InclusiveGateway',\n  and:         'bpmn:ParallelGateway'\n};\n```\n\nUse any of the aliases instead of the full qualified BPMN name.\n\n\n\n## Setup\n\nDeploy the cli-extension with [bpmn-js](https://github.com/bpmn-io/bpmn-js):\n\n```javascript\nimport BpmnModeler from 'bpmn-js/lib/Modeler';\nimport ModelingDslModule from 'bpmn-js-cli-modeling-dsl';\n\nvar modeler = new BpmnModeler({\n  additionalModules: [\n    ModelingDslModule\n  ],\n  cli: {\n    bindTo: 'cli'\n  }\n});\n\nmodeler.importXML('some-bpmn-xml');\n```\n\n\nAccess the cli as `cli` in your developer console (open via `F12` in most browsers).\n\nCreate a simple process from `\u003cstart\u003e` via\n\n```javascript\ncli.model('\u003cstart\u003e -\u003e and -\u003e service -\u003e user -\u003e icatch -\u003e xor -\u003e or -\u003e ithrow -\u003e end');\n```\n\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikku%2Fbpmn-js-cli-modeling-dsl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnikku%2Fbpmn-js-cli-modeling-dsl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikku%2Fbpmn-js-cli-modeling-dsl/lists"}