用途:当用户要求在飞书云文档中绘制图表,或使用飞书画板绘制架构图、流程图、思维导图、时序图等可视化图表时使用。
主要能力:支持 Mermaid 与 DSL 两条渲染路径。思维导图、时序图、类图、饼图、流程图默认走 Mermaid;其他类型走 DSL,可精确控制样式与布局。场景指南覆盖架构图、组织架构图、对比图、鱼骨图、柱状图、折线图、树状图、漏斗图、金字塔图、循环/飞轮图、里程碑等。
使用方式:环境依赖 @larksuite/whiteboard-cli 与 lark-cli。安装失败可执行 npm install -g @larksuite/whiteboard-cli@^0.1.0;安装新依赖前须征得用户同意。DSL 路径按三步执行:读取对应 scene 指南与 references 核心模块,生成含颜色的完整 DSL(部分图形需先写 .js 脚本用 node 生成 JSON),再渲染 PNG 并审查,最多修复 2 轮,仍严重则考虑 Mermaid 兜底。渲染命令示例:npx -y @larksuite/whiteboard-cli@^0.1.0 -i my-diagram.json -o ./images/my-diagram.png。上传飞书画板需先获取画板 Token,再执行上传;对已存在画板写入前必须加 --overwrite --dry-run 探测,若提示将删除节点须向用户确认后才可去掉 --dry-run 执行。
限制:画板是无限画布,非网页,flex 布局为可选增强。含文字节点 height 须用 fit-content;fill-container 仅在 flex 父容器生效;connector 须放顶层 nodes 数组;flex 容器内 x/y 会被忽略。画板一经上传不可修改。认证与权限问题需参考 lark-shared 技能,文档操作参考 lark-doc 技能。