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
Read and edit Lark/Feishu Docx & Wiki documents via CLI — fetch, create, update, and manage media attachments.
lark-base
Manage Lark Base (multi-dimensional tables): create tables, fields, records, views, formulas, forms, dashboards, workflows, and roles.
lark-im
Lark/Feishu IM skill: send messages, manage group chats, download files, and handle interactive cards via lark-cli
lark-drive
Manage Lark/Feishu Drive files and folders: upload, download, import, organize, comment, and control permissions.
lark-shared
Manage Lark CLI auth, identity, permissions, and scopes for coding agents like Claude Code and Cursor
lark-calendar
Manage Lark calendar events and meeting rooms: view, create, update events, check availability, and book rooms.