excalidraw/cli

选用指南

AI 根据 README 整理 · 2026/10/14 16:51:15

使用方式

通过命令行使用，支持管道和 JSON 输出，适合脚本和 AI 代理集成。

查看 README 依据

Qm7Tz1XcV5bN9kLp3HsA Sprint board f9Hs2KdLm4NqP8rTvX1a no 2026-09-20T09:41:52.000Z w2Ej6YhRu8IoP4aSd0Fg Onboarding flow Lr5Tg7YhUj3IkO9pWe2q no 2026-09-18T16:27:05.000Z ``` Output is JSON by default, so it works with `jq`, shell scripts and AI agents. ## Install ```bash npm install -g @excalidraw/cli ``` Or try it without installing: `npx @excalidraw/cli --help`. Requires Node.js 22 or newer.

`scenes create --file` creates a scene and fills it in one step, from a full export or a partial payload like the one above. An invalid file is rejected before the scene is created. If writing the content fails afterwards, the error names the new scene so you can retry. ## Scripting and agents - Commands print JSON, except `login` and `logout`, which print a confirmation. `-o table` prints list commands, `whoami` and `update` as a table.

部署要求

需要 Node.js 22 或更高版本。工作区命令需要 Excalidraw+ API 密钥。渲染本地文件不需要 API 密钥，但需要已安装的 Chrome、Edge、Chromium 或 Firefox 浏览器。

查看 README 依据

Qm7Tz1XcV5bN9kLp3HsA Sprint board f9Hs2KdLm4NqP8rTvX1a no 2026-09-20T09:41:52.000Z w2Ej6YhRu8IoP4aSd0Fg Onboarding flow Lr5Tg7YhUj3IkO9pWe2q no 2026-09-18T16:27:05.000Z ``` Output is JSON by default, so it works with `jq`, shell scripts and AI agents. ## Install ```bash npm install -g @excalidraw/cli ``` Or try it without installing: `npx @excalidraw/cli --help`. Requires Node.js 22 or newer.

To update, run `excalidraw update`. It installs the latest version with the package manager you installed the CLI with: npm, pnpm, yarn, bun or Volta. `excalidraw update --check` only reports whether a newer version is out. Commands you run in a terminal check for a newer version at most once a day, while the command runs, and mention it after the output. Set `EXCALIDRAW_NO_UPDATE_NOTIFIER=1` to turn this off. ## Quick start Workspace commands need an Excalidraw+ API key. The [authentication docs](https://plus.excalidraw.com/docs/api/authentication) explain how to create one. ```bash

With a file path, the command prints the PNG's path and dimensions as JSON. Pass `--out -` to write the PNG to stdout instead, for example to pipe it into another program: ```bash node generate-scene.js | excalidraw render - --out - > drawing.png excalidraw scenes render <sceneId> --out - | magick png:- -resize 50% preview.png ``` Rendering uses a browser that's already installed: Chrome, Edge or Chromium, or Firefox (slower) if none of those is. The CLI doesn't download one. If it can't find yours, pass `--browser-path` or set `EXCALIDRAW_BROWSER_PATH`. | Option | Default | Notes |

已知限制

渲染时图片必须嵌入文件，不加载图片 URL 和网站嵌入。中、日、韩文手写字体首次使用需下载，无网络时使用系统字体。

查看 README 依据

| --- | --- | --- | | `--out <file>` | required | File path, or `-` for stdout. | | `--frame-id <id>` | | Render just this frame. | | `--scale <n>` | `1` | Resolution multiplier, up to 16. | | `--max-width`, `--max-height` | `2048` | Size limits in pixels, up to 16384. Raise them along with `--scale`. | | `--padding <px>` | `20` | Ignored for frames. | | `--theme <light\|dark>` | scene setting | | | `--transparent` | off | Transparent background. | | `--timeout <ms>` | `30000` | How long a render may take. | - Images must be embedded in the file. Image URLs and website embeds aren't loaded.

- The output keeps the scene's aspect ratio and stays under 64 megapixels. - Chinese, Japanese and Korean text in the hand-drawn font needs a font that's downloaded the first time a scene uses it, then cached. Without network access, that text uses a system font. `--fonts-url` sets other download locations, or `none` to turn downloads off. - Emoji come from your system's fonts. ## Commands | Command | What it does | | --- | --- | | `login` | Check an API key and save it for later commands | | `logout` | Remove the saved API key |