8000 GitHub - excalidraw/cli: Official Excalidraw CLI for humans and agents · GitHub
[go: up one dir, main page]

Skip to content
excalidrawPublic

About

Official Excalidraw CLI for humans and agents

Resources

Contributing

Stars

270 stars

Watchers

3 watching

Forks

Repository files navigation

Excalidraw CLI: turn .excalidraw files and Mermaid diagrams into PNG, SVG, slides and Excalidraw+ scenes from your terminal

Documentation · npm · Excalidraw+ · Excalidraw

npm license

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 .excalidraw file, 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/cli

Or 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.png

Every command has --help with examples.

Documentation

📚 plus.excalidraw.com/docs/cli

The same guides are in docs/.

Contributing

See CONTRIBUTING.md for building the CLI and running the tests.

License

MIT

About

Official Excalidraw CLI for humans and agents

Resources

Contributing

Stars

270 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages

0