lark-whiteboard:
lark-whiteboard:

什么是 lark-whiteboard

如果你经常在飞书文档里画流程图、架构图或者各种思维导图,一定体会过手动拖拽对齐的痛苦——鼠标挪来挪去,框框拉大拉小,线条歪歪扭扭,改一个节点位置所有连线都得重新调。lark-whiteboard 正是为了解决这个问题而生的。

简单来说,这是一个基于命令行的飞书画板自动化工具。你可以用代码来描述图表,然后让工具自动在飞书画板里生成出来。它本质上是飞书官方 CLI 工具集里的一个 Skill,由 larksuite 团队开发维护。目前已经在各类 AI 编程助手和开发者工具中获得了超过 10 万次下载

听起来可能有点抽象,但它的核心价值就一句话:把画图这件事,从“鼠标拖拽”变成了“写代码生成”

核心功能

lark-whiteboard 的能力可以拆成三个层面:查询、导出和更新。

查询画板内容

你可以通过命令行直接查看飞书文档里某个画板的所有内容。不管画板里有多少节点、多复杂的连线,都能一键获取完整的结构信息

导出多种格式

这是最实用的功能之一。你可以把画板导出为:

  • 预览图片:直接把画板内容转成 PNG 图片,方便分享或嵌入到其他文档里

  • SVG 矢量图:需要高清印刷或进一步编辑时用

  • 源代码:提取画板的 Mermaid 或 PlantUML 代码,方便在其他工具里复用或二次修改

  • 原始节点结构:获取飞书 OpenAPI 原生格式的 JSON 数据

这意味着你不再需要在飞书里一点点截图保存,也不用担心画板内容无法迁移到别的工具。

更新画板内容

这是 lark-whiteboard 最强大的地方。它支持三种方式更新画板

  • Mermaid 格式:用 Mermaid 语法描述图表,工具自动渲染到画板

  • PlantUML 格式:同样用代码描述,适合更复杂的 UML 类图、时序图等

  • SVG 格式:直接传入 SVG 代码

  • OpenAPI 原生格式:如果你熟悉飞书的底层数据结构,可以直接操作 JSON

支持绘制的图表类型非常丰富——流程图、时序图、架构图、泳道图、对比图、鱼骨图、柱状图、折线图、树状图、漏斗图、金字塔图、循环图、里程碑图等等

安装方法

lark-whiteboard 的安装依赖两个命令行工具:lark-cli(飞书 CLI 主工具)和 @larksuite/whiteboard-cli(画板专用 CLI 工具)

环境准备

首先确保你的电脑上有 Node.js 16 或以上版本。可以用以下命令检查:

bash
node --version

如果没装,先去 Node.js 官网下载安装。

方式一:通过 npx 直接安装(推荐)

在项目根目录执行:

bash
npx bzskills add larksuite/cli --skill lark-whiteboard

或者使用通用安装命令

bash
npx skills add https://github.com/larksuite/cli --skill lark-whiteboard

安装过程中会提示你选择要安装到的 AI 助手环境(如 Cursor、Cline、Codex 等),按需选择即可

方式二:手动安装 CLI 工具

如果自动安装失败,可以手动安装核心依赖

bash
npm install -g @larksuite/whiteboard-cli@^0.1.0

安装完成后,运行以下命令确认环境正常

bash
lark-cli --version
npx -y @larksuite/whiteboard-cli@^0.2.13 -v

方式三:在 Cursor 中安装

如果你用 Cursor 编辑器,安装会更简单

  1. 在项目根目录执行安装命令

  2. 安装时选择 Cursor 作为目标环境

  3. 确认 .cursor/skills/lark-whiteboard 目录已生成

  4. 重启 Cursor 即可生效

之后在 Cursor 的命令面板中输入 /lark-whiteboard 就能调用了。

适用场景

技术文档撰写

写技术方案、系统设计文档的时候,架构图几乎是标配。以前你可能得在 draw.io 或者飞书画板里慢慢画,现在用 lark-whiteboard,写一段 Mermaid 代码就能自动生成

项目汇报与复盘

项目复盘需要画时间线、里程碑图、因果分析图。用 lark-whiteboard 的 PlantUML 支持,可以快速产出结构清晰的可视化内容

团队协作与知识沉淀

飞书文档本身就是团队协作的载体。lark-whiteboard 让你可以在文档里直接嵌入高质量的可视化内容,而且因为是代码生成的,后续修改也只需要改代码重新跑一遍,不需要重新手动画

批量图表生成

如果需要在多个文档里插入类似的图表(比如每个项目的架构图都遵循同一套模板),lark-whiteboard 的脚本化能力可以大幅节省重复劳动

使用案例

案例一:用 Mermaid 快速生成流程图

假设你想在飞书文档里画一个用户登录的流程图。只需要准备好 Mermaid 代码,比如:

然后通过命令行更新画板

bash
cat login-flow.mmd | lark-cli whiteboard +update <画板token> --source - --input_format mermaid

几秒钟,流程图就出现在飞书画板里了。

案例二:从已有画板提取代码复用

你在飞书里有一个现成的架构图画板,想把它迁移到另一个文档里,或者想基于它修改。先用查询命令导出代码:

bash
lark-cli whiteboard +query <画板token> --output_as code

工具会返回这个画板的 Mermaid 或 PlantUML 代码。你修改代码后,再用 update 命令写入新画板就行。

案例三:导出画板为图片

老板要你把架构图放进 PPT 里,但飞书画板没有直接的下载按钮

bash
lark-cli whiteboard +export <画板token> --output-type preview

一张高清截图就存到你电脑上了。如果是要高清印刷或做进一步编辑,可以导出 SVG 格式

bash
lark-cli whiteboard +export <画板token> --output-type svg

注意事项

lark-whiteboard 专注于画板本身的操作,不负责飞书文档的整体内容编辑(那是 lark-doc 的职责),也不处理文档里的表格和电子表格(那是 lark-sheetslark-base 的职责)

画板操作默认使用用户身份(--as user),只有在需要以应用身份上传时才用 --as bot

如果你是第一次使用,建议先花十分钟熟悉一下 Mermaid 或 PlantUML 的基本语法。这两种语法都不难学,但掌握之后画图的效率提升是肉眼可见的——从“拖拽五分钟”变成“写代码三十秒”。

工具本身是 MIT 协议开源的,代码在 GitHub 上完全可见,有能力的开发者也可以根据自己的需求进行定制和扩展。