excalidraw-converter for Mac

Excalidraw Converter

A command line tool for porting Excalidraw diagrams to Gliffy, draw.io and Mermaid.

Excalidraw is great for sketching diagrams as part of a design process, but chances are that you have to redo those sketches for documentation. This tool is made to bridge those tasks.

Supported Commands

Getting Started

Installation MacOS with Homebrew (stable)

Latest releases

Use this tap to stay on the latest releases that have not (yet) been added to the official Homebrew Formulae:

Installation for other OSes Download a compatible binary from the Releases page.

If you're a Linux or MacOS user, move it to your local bin folder to make it available in your environment (optional).

Quick Start

Convert your Excalidraw diagram by running:

See below for details on each command, available options and examples.

Command Usage & Examples

Gliffy & Draw.io Converts to a Gliffy compatible format, which can be imported directly into services like Gliffy, Gliffy for Confluence, draw.io or draw.io for Confluence.

Usage: Mac/Linux: Windows:

Flags:

Importing in Gliffy

After converting your diagram(s), import them into Gliffy (or draw.io) using the standard Import dialog. Mermaid diagrams can be pasted or included in markdown files or compatible tools.

Mermaid Converts to a Mermaid diagram that can be used for a variety of cases, such as being included in markdown files on GitHub, GitLab, MkDocs or Docusaurus. [!NOTE] Currently only supports conversion to flowcharts. Only elements that are connected by arrows, or contained inside a connected element, are included.

Usage: Mac/Linux: Windows:

Flags:

Validate a converted diagram

You can validate and customize a converted diagram using tools like Mermaid Live Editor.

Import a converted diagram back into Excalidraw

After converting your diagram(s), you can use the Mermaid to Excalidraw playground to convert it back to the Excalidraw format.

Note that some styling attributes could be lost as part of the conversion and import process.

Example diagram embedded in markdown

Click to expand

Features

All fixed shapes and most styling and text options are supported.

Shapes

Text

Styling

Library graphics are not fully supported (experimental).

Compatibility with draw.io Converted Gliffy diagrams should also work in the online version of draw.io.

In draw.io, you can import a diagram by simply opening the file from your device. If you're using draw.io for Confluence, you should be able use the import dialog.

Note that this is only supported in the online version of draw.io, not the desktop app.

Compatibility with Excalidraw for Obsidian Diagrams created using the Excalidraw for Obsidian plugin must be exported before conversion, as described here.

Contributing See something you'd like to improve? Great! See the contributing guidelines for instructions.

Attributions Workflow icons created by Freepik - Flaticon

Development

Instructions

Prerequisites: Go (see version in go.mod)