Skip to content

Getting Started — Standalone Desktop App

The Miragon BPMN Modeler is also available as a standalone desktop app built on Eclipse Theia. Same modeler as the VS Code extension, packaged as a native Electron app for when you don't want to run a full IDE.

The standalone app ships for macOS, Windows, and Linux x86_64.

Install

Grab the latest package for your platform from the Download page:

  • macOS: signed and notarized .dmg
  • Windows: NSIS .exe installer
  • Linux x86_64: Flatpak from the Miragon repository or a .flatpak bundle

On macOS, you can also install from the terminal with Homebrew:

bash
brew tap miragon/tap
brew install --cask miragon-bpmn-modeler

Every asset also lives on GitHub Releases.

Install on Linux with Flatpak

Install Flatpak for your Linux distribution before continuing.

Miragon publishes the app through a custom Flatpak repository instead of Flathub because the Flathub Generative AI policy does not accept applications that contain AI-generated or AI-assisted code or documentation.

Install the app for your current user. This option does not require root privileges:

bash
flatpak remote-add --user --if-not-exists miragon https://miragon.github.io/bpmn-modeler-flatpak-repo/miragon.flatpakrepo
flatpak install --user miragon io.miragon.BpmnModeler

To make the app available to every user on the system, install it system-wide:

bash
sudo flatpak remote-add --system --if-not-exists miragon https://miragon.github.io/bpmn-modeler-flatpak-repo/miragon.flatpakrepo
sudo flatpak install --system miragon io.miragon.BpmnModeler

Launch the app:

bash
flatpak run io.miragon.BpmnModeler

The Download page also provides a standalone .flatpak bundle. Use the repository installation when possible so Flatpak can discover updates automatically.

Update

macOS

If you installed the app with Homebrew, run:

bash
brew upgrade --cask miragon-bpmn-modeler

If you installed the app from a .dmg, use the in-app auto-updater.

Linux (Flatpak)

Update an installation for your current user with:

bash
flatpak update --user io.miragon.BpmnModeler

Update a system-wide Flatpak installation with:

bash
sudo flatpak update --system io.miragon.BpmnModeler

If you installed a downloaded .flatpak bundle instead of using the repository, download the newer bundle and install it again:

bash
flatpak install --user --bundle Miragon.BPMN.Modeler-<version>-x86_64.flatpak

Windows

The Windows NSIS installation uses the in-app auto-updater.

Build from source

If you would rather build it yourself, see apps/standalone/README.md. On macOS, a locally built .dmg without the release pipeline's Apple credentials is unsigned. Gatekeeper will block the first launch; right-click the app in /ApplicationsOpen → confirm. After that one-time bypass, the app launches normally.

Open a diagram

Use File → Open… to open any .bpmn or .dmn file, or drop it onto the app window. The modeler opens automatically as the default editor for those file types.

To work with a folder of diagrams, use File → Open Folder….

Opening files from the terminal

macOS already lets you open files with any installed app. To open a .bpmn or .dmn file in the standalone modeler from a shell:

bash
open -a "Miragon BPMN Modeler" path/to/diagram.bpmn

You can also open a folder of diagrams as a workspace:

bash
open -a "Miragon BPMN Modeler" path/to/diagrams/

For convenience, drop a short alias into your shell config (~/.zshrc or ~/.bashrc):

bash
alias bpmn='open -a "Miragon BPMN Modeler"'

Then:

bash
bpmn diagram.bpmn

Features

Feature behaviour matches the VS Code extension one-to-one — same modeler engine, same element templates, same diff view, same deploy flow. Explore:

A few things differ from the VS Code surface — no Extensions view and no Command Palette keybindings for VS Code-specific commands. The modeler itself behaves identically.

Auto-save

The standalone saves every change ~1 second after the last edit, so the file on disk always matches what you see in the canvas and the Source Control view reflects modifications immediately. Disable or change the delay in Settings → Files: Auto Save.

Source Control

The standalone ships with the same VS Code Git extension that powers the Source Control view in VS Code, including BPMN-aware diffs for modified diagrams. Git operations rely on the system git binary:

The Flatpak sandbox does not expose the host's git executable, so the Source Control view is currently unavailable in the Linux package. Host-side Git tools can still manage the same workspace files.

If git --version works in your terminal, the standalone app will pick it up on launch.