Skip to content

Getting Started

Vivek Sarin edited this page Nov 18, 2026 · 4 revisions

Getting started

This page explains how to install FlowMotion in your Obsidian vault and confirm that it works.

What you need

  • 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.

Install FlowMotion

Warning: Keep a backup of your vault before you test a new plugin.

  1. Download FlowMotion. On the GitHub page, select Code, then select Download ZIP. Unzip the file.

  2. Open a terminal in the FlowMotion folder.

    • On macOS, open Terminal. Type cd followed 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.
  3. Build FlowMotion. Type npm install and press Enter. When it finishes, type npm run build and press Enter.

  4. 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/flowmotion folder inside your vault.

  5. Turn on FlowMotion in Obsidian.

    1. Open Settings, then Community plugins.
    2. Turn off Restricted mode, if it is on.
    3. Turn on FlowMotion.

Check that it works

  1. Create a new note.

  2. 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
    ```
  3. Switch the note to reading view.

  4. Select the diagram to start it.

If the diagram moves, FlowMotion is working. If it does not, see Troubleshooting and FAQ.

Add the draw.io editor

CodeMirror is the default diagram editor. Both draw.io editor and Rich Code Editor (Monaco) are optional desktop downloads. See Settings.

  1. Open Settings, then FlowMotion.
  2. Turn on draw.io editor.
  3. 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.
  4. 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.

Update FlowMotion

  1. Download the newest FlowMotion ZIP file, and unzip it into the FlowMotion folder.
  2. Type npm install and press Enter, then npm run build and press Enter.
  3. 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.

Remove FlowMotion

  1. Open Settings, then Community plugins, and turn off FlowMotion.
  2. 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.

Next steps

Clone this wiki locally