@excalidraw/cli
v0.3.0
Published
Manage Excalidraw workspace resources through the public API, render scenes locally as PNG or SVG, and convert Mermaid diagrams.
Downloads
3,741
Readme
Render Excalidraw drawings and Mermaid diagrams from your terminal, free and without an account. With an Excalidraw+ API key, manage your workspace too.
Features
- 🖼️ Render to PNG or SVG: any
.excalidrawfile, light or dark, transparent, up to 16× scale. - 🎞️ Export slides: each frame to its own image, in presentation order.
- 🧜 Mermaid to Excalidraw: flowcharts, sequence, class, ER and state diagrams, Gantt charts, quadrant charts and timelines become editable shapes.
- 🔒 Runs locally: uses the browser you already have. Nothing is uploaded, no account needed.
- ☁️ Excalidraw+ workspace: scenes, collections, share links, presentations, members and audit logs.
- 🤖 Made for scripts and AI agents: JSON output, stdin and stdout, and
EXCALIDRAW_API_KEY.
Install
npm install -g @excalidraw/cliOr run it without installing: npx @excalidraw/cli --help. Requires Node.js 22 or newer. excalidraw update updates it.
Quick start
# No account needed
excalidraw render drawing.excalidraw --out drawing.png
excalidraw render deck.excalidraw --all-frames --out slides/
excalidraw mermaid flow.mmd --out flow.excalidraw
# With Excalidraw+
excalidraw login
excalidraw scenes list --output table
excalidraw scenes render <sceneId> --out scene.pngEvery command has --help with examples.
Documentation
📚 plus.excalidraw.com/docs/cli
- Render to PNG or SVG
- Mermaid diagrams
- Editing scene content
- Scripting and agents
- Configuration and API keys
- Command reference
The same guides are in docs/.
Contributing
See CONTRIBUTING.md for building the CLI and running the tests.
