@excalidraw/cli

中文文档
0.3.0发布于 2026/11/06MITES Module近 30 天下载 3399

通过公共 API 管理 Excalidraw 工作空间资源,将场景本地化为 PNG 或 SVG,并转换出人鱼图.

中文使用文档
文档目录6 节
  1. 特征
  2. 安装
  3. 快开始
  4. 文档
  5. 捐款
  6. 许可证

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

文档 • 妇女 无 • 妇女 Excalidraw+ 缩写 • 妇女 缩略图

npm license

Render Excalidraw 绘图和美人鱼图 从您的终端,免费和没有账户。 与一个 Excalidraw+ 缩写 API 密钥, 管理您的工作空间 .

特征

  • 🖼️ 向 PNG 或 SVG 渲染: 任意 .excalidraw 文件, 浅或暗, 透明, 最多 16x 尺度 .
  • 🎞️ 导出幻灯片:每个相框到自己的相片,按呈现顺序排列.
  • 🧜 人造人造人造人造人机:流程图,序列,类,ER和状态图,甘特图,象限图和时间表成为可编辑的形状.
  • 🔒 本地运行: 使用已有的浏览器。 没有上传,不需要账户.
  • ☁️ Excalidraw+ 工作空间:场景,藏品,共享链接,演示,成员和审计日志.
  • 🤖 为剧本和AI代理制作: JSON 输出, stdin和 stdout,以及 EXCALIDRAW_API_KEY。 。 。 .

安装

npm install -g @excalidraw/cli

或运行它而不安装: npx @excalidraw/cli --help。需要22号节点或更新. excalidraw update 更新它.

快开始

# 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

每个命令都有 --help 举出例子.

文档

📚 +.excalidraw.com/docs/cli (中文(简体) )

同样的指南在 文档/。 。 。 .

捐款

见 捐款额 用来建立CLI和运行测试.

许可证

麻省理工学院

版本与发布记录

@excalidraw/cli 共发布 4 个版本,首次发布于 2026/10/08;过去 12 个月发布了 4 个版本。

版本发布日期距今
0.3.0latest2026/11/067 天前
0.2.02026/10/091 个月前
0.1.02026/10/081 个月前
0.0.0-stage2026/10/081 个月前

关于 @excalidraw/cli 的常见问题

@excalidraw/cli 是什么?

通过公共 API 管理 Excalidraw 工作空间资源,将场景本地化为 PNG 或 SVG,并转换出人鱼图.

如何安装 @excalidraw/cli?

在项目目录运行 npm install @excalidraw/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 excalidraw,可以用 npx excalidraw 直接运行。

@excalidraw/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/excalidraw__cli 是否存在。

@excalidraw/cli 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@excalidraw/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@excalidraw/cli 可以商用吗?

@excalidraw/cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@excalidraw/cli 的下载量有多少?

根据 npm 官方下载统计,@excalidraw/cli 在 2026/10/14 – 2026/11/12 这 30 天内被下载 3,399 次,日均约 113 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@excalidraw/cli 还在维护吗?

最新版本 0.3.0 发布于 2026/11/06(7 天前);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/10/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。