Get started in VS Code
Install the Miragon BPMN Modeler and edit BPMN, DMN and Camunda Form files in a visual editor inside VS Code. It supports Camunda 7 and Camunda 8, and the Camunda 7 compatible engines Operaton and CIB seven.
Install
Install the extension from the VS Code Marketplace or from Open VSX (VSCodium, Cursor, Windsurf and other editors that use Open VSX). From the command line:
code --install-extension miragon-gmbh.vs-code-bpmn-modelerOpen a file
Open any .bpmn, .dmn or .form file. The matching visual editor opens automatically.
To start from scratch, run New BPMN Model, New DMN Model or New Form from the Command Palette; for BPMN pick Camunda 7, Camunda 8 or Engine-neutral. New Element Template starts a template in the element template editor.
First steps
- Pick a mode. The chip on the canvas switches between View, Design and Implement. See Editor modes.
- Model. Use the append menu to add the next element, or move along the flow with the keyboard (flow navigation).
- Add element templates. Put template JSON files into
.camunda/element-templates/next to your diagrams (or in any folder up to the workspace root). They show up in the element template chooser and the append menu. - Try the flow. Switch on token simulation and start a token.
- Deploy. Open the Deploy view from the rocket in the activity bar to deploy to Camunda 7 or Camunda 8. See Deployment.
Change the language
Run Change Modeler Language to switch the UI (12 languages). See Language support.
Commands
Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and search for "Miragon BPMN Modeler".
| Command | Keybinding | What it does |
|---|---|---|
| Toggle Standard Text Editor | Ctrl+Shift+E | Switch between the visual editor and the XML |
| Format Diagram | Shift+Alt+F | Lay out the open diagram |
| Clean Up Diagram | List leftovers in the diagram and remove them after you confirm | |
| Generate IDs from Names | Review the IDs the element names give in the Element IDs tab of the Panel, and rename the ones you keep ticked in one undo step (IDs from names) | |
| Copy Diagram as SVG | Copy the diagram to the clipboard as SVG | |
| Save Diagram as SVG | Save an SVG file next to the BPMN file | |
| Change Modeler Language | Switch the modeler UI language | |
| Change Engine Version | Change the engine version of the open diagram | |
| Migrate All BPMN Diagrams | Change the engine version of every BPMN diagram in the workspace, except copies in node_modules, build output or folders whose name starts with a dot | |
| Deploy Diagram | Deploy the open diagram to the active deployment target | |
| Toggle Linting | Turn linting on or off | |
| Toggle Automatic Form Preview | Turn automatic linked form previews on or off | |
| Reload Modeler | Re-read element templates and re-render open diagrams | |
| Review Add-ons | Open the Add-ons view on the add-ons that need your review | |
| Refresh Add-ons | Read the Add-ons view again, installed packages included | |
| Display Logging Information | Open the modeler log |
Next steps
- Configuration: every setting in one table.
- Features: what the modeler can do, step by step.
- IntelliJ or the desktop app: the same modeler outside VS Code.