mcpField
L
lark-whiteboard

lark-whiteboard

larksuiteAgent 工作流17.9k472.5k 次安装今天更新
代码仓库

关于 lark-whiteboard

lark-whiteboard 是用于飞书画板的 Agent Skill,供命令行工具调用。它支持导出画板内容,也支持以 Mermaid、PlantUML、SVG 等格式写入或更新画板。

主要功能

  1. 01导出预览图片、SVG 或源码
  2. 02支持 Mermaid、PlantUML、SVG 写入
  3. 03区分只读与写入操作的决策规则
  4. 04可在已有画板上追加或覆盖内容

适用场景

  1. 01导出飞书画板为图片或 SVG
  2. 02将已有 Mermaid 或 PlantUML 代码写入画板
  3. 03基于需求从零绘制架构或流程图

安装

复制下面的命令,在终端中运行。

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

安装后在 Claude Code 中输入/lark-whiteboard确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

elements/
connectors.md
content.md
image.md
layout.md
schema.md
style.md
typography.md
references/
lark-whiteboard-export.md
lark-whiteboard-update.md
lark-whiteboard-workflow.md
routes/
dsl.md
mermaid.md
svg-edit.md
svg.md
scenes/
architecture.md
bar-chart.md
comparison.md
fishbone.md
flowchart.md
flywheel.md
funnel.md
line-chart.md
mention.md
mermaid.md
milestone.md
organization.md
photo-showcase.md
pyramid.md
swimlane.md
treemap.md

详细介绍

来自项目 README

重要

  • 运行 lark-cli --version,确认可用,无需询问用户。
  • 运行 npx -y @larksuite/whiteboard-cli@^0.2.13 -v,确认可用,无需询问用户。

CRITICAL — 开始前 MUST 先用 Read 工具读取 ../lark-shared/SKILL.md,其中包含认证、权限处理


快速决策

身份:画板操作默认使用 --as user。仅当需要以应用身份上传时使用 --as bot。

先判断「只读还是写入」,再在对应表内按上到下匹配,命中即停。

A. 只读 · 查看 / 导出(不改画板)
用户需求行动
查看画板内容 / 导出图片+export --output-type preview
导出 SVG 矢量图+export --output-type svg
提取画板的 Mermaid/PlantUML 源码+export --output-type source
B. 写入 · 创作 / 编辑(会改画板,命中即停)
场景行动写入方式对原内容
用户已提供 Mermaid/PlantUML/SVG 代码,或明确指定用该格式使用该代码 → +update,--input_format 取单值 mermaid / plantuml / svg;写入非空已有画板并需要 overwrite 时,先确认会整板重建;若 SVG 用于修改已有画板,先走 routes/svg-edit.md 有损确认overwrite / append按用户要求
从零新建复杂图表(架构/流程/组织等)→ § 创作 Workflow首次写入—
修改 / 增补已有画板→ § 编辑 Workflow见该表见该表

Shortcuts

Shortcut说明
+export导出画板为预览图片、SVG 矢量图、代码或原始节点结构。
+update更新画板,支持 PlantUML、Mermaid、SVG 或 OpenAPI 原生格式

不在本 skill 范围

评论

支持 Markdown