Repository navigation
Getting Started
This page explains how to install FlowMotion in your Obsidian vault and confirm that it works.
- Obsidian, version 1.4.0 or later. Download it from obsidian.md.
- Node.js, a current Node 22 or 24 release. Download it from nodejs.org. You need it only for the source-build steps below.
- A vault, which is the folder that holds your notes.
Warning: Keep a backup of your vault before you test a new plugin.
-
Download FlowMotion. On the GitHub page, select Code, then select Download ZIP. Unzip the file.
-
Open a terminal in the FlowMotion folder.
- On macOS, open Terminal. Type
cdfollowed by a space. Drag the FlowMotion folder into the window, and press Enter. - On Windows, open the FlowMotion folder in File Explorer. Click the address bar, type
cmd, and press Enter.
- On macOS, open Terminal. Type
-
Build FlowMotion. Type
npm installand press Enter. When it finishes, typenpm run buildand press Enter. -
Install FlowMotion in your vault. Type the following command, replacing the path with the path to your vault, and press Enter:
npm run install-plugin -- "/path/to/your/vault"FlowMotion is copied to the
.obsidian/plugins/flowmotionfolder inside your vault. -
Turn on FlowMotion in Obsidian.
- Open Settings, then Community plugins.
- Turn off Restricted mode, if it is on.
- Turn on FlowMotion.
-
Create a new note.
-
Paste the following text into the note:
```flowmotion flowchart TB user((User)) -->|request| gw{Gateway} subgraph platform [Platform] gw -->|ok| api[API Service] api --> db[(Orders DB)] end %% @duration db 700 ```
-
Switch the note to reading view.
-
Select the diagram to start it.
If the diagram moves, FlowMotion is working. If it does not, see Troubleshooting and FAQ.
CodeMirror is the default diagram editor. Both draw.io editor and Rich Code Editor (Monaco) are optional desktop downloads. See Settings.
- Open Settings, then FlowMotion.
- Turn on draw.io editor.
- Wait for the notice that the add-on is installed. FlowMotion downloads it from the draw.io GitHub releases, so you need a network connection once.
- Reopen the drawing.
Turn the toggle off to delete the files. See Settings for status messages.
Note: FlowMotion is a desktop-only plugin. See draw.io drawings for drawing workflows.
- Download the newest FlowMotion ZIP file, and unzip it into the FlowMotion folder.
- Type
npm installand press Enter, thennpm run buildand press Enter. - Type
npm run install-plugin -- "/path/to/your/vault"and press Enter. The new files replace the old ones.
Your diagrams are not changed by an update.
- Open Settings, then Community plugins, and turn off FlowMotion.
- In your vault, delete the folder
.obsidian/plugins/flowmotion.
Removing the plugin does not delete your diagrams. Inline diagrams stay in your notes. Diagram files (.flow, .yaml, .json, and draw.io files) stay in your vault, and they are not shown until you install FlowMotion again.
- Your first diagram shows how to create a diagram from the menu.
- Writing diagrams explains the text format.
© 2026 @vrsarin. FlowMotion documentation.