lark-whiteboard
larksuite/cli
Query and edit Lark (Feishu) whiteboards: export images/SVG, read node structure, and update with Mermaid/PlantUML/SVG.
What is lark-whiteboard?
lark-whiteboard is a skill for coding agents that enables querying and editing whiteboards in Lark (Feishu) cloud documents. It supports exporting whiteboards as preview images or SVG vectors, reading raw node JSON structure, and updating whiteboard content using Mermaid, PlantUML, SVG, or the native OpenAPI format. It does not handle general Lark doc editing, embedded spreadsheets, or Base tables.
- Export whiteboard content as a preview image or SVG vector graphic
- Retrieve whiteboard content as Mermaid or PlantUML code
- Read raw JSON node structure of a whiteboard
- Update whiteboard content using Mermaid, PlantUML, SVG, or native OpenAPI format
- Support user-identity and bot-identity operations via --as user/bot flags
- Provide guided workflows for creating new diagrams or modifying existing ones
How to install lark-whiteboard
npx skills add null --skill lark-whiteboard- lark-cli must be installed and accessible in PATH
- npx -y @larksuite/whiteboard-cli@^0.2.12 must be available
- Authentication and permissions must be configured per the lark-shared SKILL.md
- A valid Lark whiteboard document URL or ID is required for operations
How to use lark-whiteboard
- 1.Install the skill: npx skills add null --skill lark-whiteboard
- 2.Confirm lark-cli is available by running: lark-cli --version
- 3.Confirm whiteboard-cli is available by running: npx -y @larksuite/whiteboard-cli@^0.2.12 -v
- 4.Read lark-shared/SKILL.md to configure authentication before any operation
- 5.To view or export a whiteboard, use the +query shortcut with --output_as image, svg, code, or raw
- 6.To update a whiteboard, use the +update shortcut with --input_format set to mermaid, plantuml, svg, or raw
- 7.For creating complex new diagrams, follow the creation workflow in lark-whiteboard-workflow.md
- 8.For modifying existing whiteboards, follow the modification workflow in lark-whiteboard-workflow.md
Use cases
- Exporting a Lark whiteboard as an image or SVG for use in documentation
- Checking whether a whiteboard was originally drawn from Mermaid or PlantUML code
- Making minor text or color edits to whiteboard nodes via raw JSON
- Generating and uploading a new architecture or flowchart diagram to a whiteboard
- Redrawing or updating an existing whiteboard from structured diagram code
- Developers working with Lark (Feishu) whiteboards programmatically
- Teams that maintain architecture or flow diagrams in Lark cloud documents
- Coding agents (Claude Code, Cursor) automating whiteboard content updates
- Engineers who need to export whiteboard visuals for reports or wikis
lark-whiteboard FAQ
No. Document content editing is handled by the lark-doc skill. This skill only covers whiteboard operations.
You can update whiteboards using Mermaid, PlantUML, SVG, or the native OpenAPI raw JSON format.
Operations default to --as user (user identity). Use --as bot only when uploading as the application identity.
Yes. Use +query --output_as svg to export the whiteboard as an SVG vector graphic.
No. Creating whiteboards inside documents is handled by lark-doc via lark-doc-whiteboard.md, not this skill.
Full instructions (SKILL.md)
Source of truth, from larksuite/cli.
name: lark-whiteboard version: 1.0.0 description: > 飞书画板：查询和编辑飞书云文档中的画板。支持导出画板为预览图片、导出原始节点结构、使用多种格式更新画板内容。 当用户需要查看画板内容、导出画板图片、编辑画板时使用此 skill。不负责：飞书云文档内容编辑（lark-doc）、文档内嵌电子表格/Base（lark-sheets / lark-base）。 metadata: requires: bins: ["lark-cli"] cliHelp: "lark-cli whiteboard --help"
[!IMPORTANT]
- 运行
lark-cli --version，确认可用，无需询问用户。- 运行
npx -y @larksuite/whiteboard-cli@^0.2.12 -v，确认可用，无需询问用户。
CRITICAL — 开始前 MUST 先用 Read 工具读取 ../lark-shared/SKILL.md，其中包含认证、权限处理
快速决策
身份：画板操作默认使用 --as user。仅当需要以应用身份上传时使用 --as bot。
| 用户需求 | 行动 |
|---|---|
| 查看画板内容 / 导出图片 / 导出 SVG 矢量图 | +query --output_as image/svg |
| 获取画板的 Mermaid/PlantUML 代码 | +query --output_as code |
| 检查画板是否由代码绘制 | +query --output_as code |
| 仅微调节点文字/颜色 | +query --output_as raw → 手动改 JSON → +update --input_format raw |
| 用户已提供 Mermaid/PlantUML/SVG 代码，或明确指定用该格式 | 自己生成/使用代码 → +update --input_format mermaid/plantuml/svg |
| 新建/创作复杂图表（架构/流程/组织等） | → § 创作 Workflow |
| 修改/重绘已有画板 | → § 修改 Workflow |
Shortcuts
| Shortcut | 说明 |
|---|---|
+query | 查询画板，导出为预览图片、SVG 矢量图、代码或原始节点结构。 |
+update | 更新画板，支持 PlantUML、Mermaid、SVG 或 OpenAPI 原生格式 |
不在本 skill 范围
- 文档内容编辑 → lark-doc lark-doc
- 在文档中创建画板 → lark-doc-whiteboard.md
- 表格 / Base 操作 → lark-sheets / lark-base
Related skills
More from larksuite/cli and the wider catalog.
lark-doc
飞书云文档（Docx / Wiki 文档）：读取和编辑飞书文档内容。当用户给出文档 URL 或 token，或需要查看、创建、编辑文档、插入或下载文档图片附件时使用。文档中嵌入的电子表格、多维表格、画板，先用本 skill 提取 token 再切到对应 skill。当用户给出 doubao.com 的 /docx/ 或 /wiki/ URL/token 时，也应直接使用本 skill；路由依据是 URL 路径模式和 token，而不是域名。不负责文档评论管理，也不负责表格或 Base 的数据操作。
lark-base
飞书多维表格（Base）操作：建表、字段、记录、视图、统计、公式/lookup、表单、仪表盘、workflow、角色权限；遇到 Base/多维表格/bitable 或 /base/ 链接时使用。文件导入转 lark-drive，认证/授权转 lark-shared。
lark-im
飞书即时通讯：收发消息和管理群聊。发送和回复消息、搜索聊天记录、管理群聊成员、上传下载图片和文件（支持大文件分片下载）、管理表情回复、发送应用内/短信/电话加急、发送和处理交互卡片（Interactive Card）、监听卡片按钮回调（card.action.trigger）。当用户需要发消息、查看或搜索聊天记录、下载聊天中的文件、查看群成员、搜索群、创建群聊或话题群、管理标记数据、管理 Feed 置顶（添加/移除/查询置顶会话）、管理标签数据、处理卡片回调时使用。
lark-drive
飞书云空间（云盘/云存储）：管理 Drive 文件和文件夹，包含上传/下载、创建文件夹、复制/移动/删除、查看元数据、评论/权限/订阅、标题、版本和本地文件导入。用户需要整理云盘目录、处理云空间资源 URL/token，或导入 Word/Markdown/Excel/CSV/PPTX/.base 为 docx/sheet/bitable/slides 时使用；doubao.com 云空间 URL/token 也按资源路径和 token 路由，不回退 WebFetch。不负责：文档内容编辑（走 lark-doc）、表格/Base 表内数据操作（走 lark-sheets/lark-base）、知识空间节点/成员管理（走 lark-wiki）、原生 Markdown 文件读写/patch/diff（走 lark-markdown）。
lark-shared
Use for lark-cli setup/auth tasks: auth login/status/logout, user vs bot identity, business-domain permissions (--domain, including all/docs/drive), missing scopes, revoking authorization, or handling _notice JSON.
lark-calendar
飞书日历：管理日历日程和会议室。查看/搜索日程、创建/更新日程、管理参会人、查询忙闲和推荐时段、预定会议室。当用户需要查看日程安排、创建/修改会议、查询/预定会议室时使用。不负责：查询过去的视频会议记录（走 lark-vc）、待办任务（走 lark-task）。