Documentation · npm · Excalidraw+ · Excalidraw
Render Excalidraw drawings and Mermaid diagrams from your terminal, free and without an account. Log in to Excalidraw+ to manage your workspace too.
- 🖼️ 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: log in with your browser, then manage scenes, collections, share links, presentations, members and audit logs.
- 🤖 Made for scripts and AI agents: JSON output, stdin and stdout, and
EXCALIDRAW_API_KEY. - ✏️ Excalidraw+ MCP tools, no setup:
excalidraw mcpgives agents the drawing tools (diagrams, charts, slides, screenshots) through the CLI's login.
npm install -g @excalidraw/cliOr run it without installing: npx @excalidraw/cli --help. Requires Node.js 22 or newer. excalidraw update updates it.
# 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 --web # log in with your browser
excalidraw scenes list --output table
excalidraw scenes render <sceneId> --out scene.pngEvery command has --help with examples.
excalidraw login asks how to log in; pick the browser, or run excalidraw login --web. It opens Excalidraw+, where you sign in, pick a workspace and allow the CLI. The CLI then acts as you in that workspace, with your role, and stays logged in until you run excalidraw logout or disconnect it under Settings → Connected apps; either cuts it off at once.
For scripts, CI and machines without a browser, use an API key instead: excalidraw login --api-key <key>, --api-key or EXCALIDRAW_API_KEY. A key passed with --api-key or EXCALIDRAW_API_KEY takes priority over the saved login, so unset it to use your browser login. excalidraw whoami shows which one is in use. See Configuration and API keys.
📚 plus.excalidraw.com/docs/cli
- Render to PNG or SVG
- Mermaid diagrams
- Editing scene content
- MCP tools
- Scripting and agents
- Configuration and API keys
- Command reference
The same guides are in docs/.
See CONTRIBUTING.md for building the CLI and running the tests.