lark-whiteboard

Query, export, and update Lark whiteboards using CLI tools and diagram DSL.

Updated Jun 29, 2026
One-click install
npx skills add https://github.com/trungpr1990-coder/AMI-MAKEUP --skill lark-whiteboard-trungpr1990-coder
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: lark-whiteboard
Source: https://github.com/trungpr1990-coder/AMI-MAKEUP/tree/main/.agents/skills/lark-whiteboard
Command: npx skills add https://github.com/trungpr1990-coder/AMI-MAKEUP --skill lark-whiteboard-trungpr1990-coder

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @larksuite/whiteboard-cli, and includes references (resource) components.

What problem does it solve? Viewing and editing Lark (Feishu) whiteboards programmatically is difficult because the native OpenAPI node format is verbose and hard to author by hand. This Skill lets you export whiteboards as images, SVG, or Mermaid/PlantUML code, and create or update complex diagrams (architecture, flowchart, fishbone, funnel, bar chart, flywheel, and more) through structured workflows. ## Core Features & Use Cases - Whiteboard Query & Export: Export a whiteboard as a preview image, SVG vector graphic, Mermaid/PlantUML source code, or raw OpenAPI node JSON via lark-cli whiteboard +query. - Multi-Format Updates: Write content back to a whiteboard using Mermaid, PlantUML, SVG, or raw OpenAPI formats with idempotent, optionally overwriting updates via lark-cli whiteboard +update. - Guided Diagram Authoring: Scene-specific guides and layout rules (architecture, flowchart, comparison, fishbone, funnel, flywheel, bar chart) with a custom whiteboard DSL, Dagre auto-layout, and script-based coordinate generation, rendered and verified locally before writing. - Use Case: A user asks to draw a microservices architecture diagram in a Feishu doc. The Skill extracts the whiteboard token, generates DSL JSON following the architecture scene guide, renders a PNG for review, converts it to OpenAPI format with whiteboard-cli, and writes it into the whiteboard. ## Quick Start Use the lark-whiteboard skill to export the whiteboard in this Feishu document as a preview image, then redraw it as a layered architecture diagram.

Frequently Asked Questions about lark-whiteboard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I export a Lark whiteboard as an image or SVG?▼

Run lark-cli whiteboard +query with the whiteboard token and set --output_as to image, svg, code, or raw. Image export requires an --output path, while svg, code, and raw can print directly to the terminal.

How do I update a Feishu whiteboard with Mermaid or PlantUML?▼

Pipe your Mermaid or PlantUML source into lark-cli whiteboard +update with --input_format mermaid or plantuml and --source -. Add --overwrite to replace existing content and an --idempotent-token of at least 10 characters to make retries safe.

What diagram types can the whiteboard DSL create?▼

The DSL route covers architecture diagrams, flowcharts with Dagre auto-layout, organization charts, swimlanes, comparison tables, fishbone diagrams, bar and line charts, treemaps, funnels, pyramids, flywheels, and milestones. Mind maps, sequence diagrams, class diagrams, and pie charts use the Mermaid route instead.

Can I use images from a URL in a Lark whiteboard?▼

Not directly. Download the image first, then upload it with lark-cli docs +media-upload using --parent-type whiteboard and the target board token to get a whiteboard-domain media token. Using tokens from other domains causes API error 2891001.

Why does my whiteboard diagram have truncated text or overlapping nodes?▼

Text nodes must use height fit-content because fixed heights clip text, and frames need explicit layout, gap, and padding values. Connectors must sit in the top-level nodes array, and nodes with connectors need at least 40px spacing for arrows.

When should I use Mermaid versus the DSL route for whiteboards?▼

Use Mermaid for mind maps, sequence diagrams, class diagrams, pie charts, and Gantt charts. Use the DSL route for complex layouts like architecture, fishbone, funnel, or flywheel diagrams that need precise layout control, with SVG as an alternative route depending on model capability.