[!IMPORTANT]
- Run
lark-cli --version, confirm availability, no need to ask the user.- Run
npx -y @larksuite/whiteboard-cli@^0.2.13 -v, confirm availability, no need to ask the user.
CRITICAL — Before starting, MUST first use the Read tool to read ../lark-shared/SKILL.md, which contains authentication and permission handling
Quick Decision
Identity: Whiteboard operations use --as userwhen uploads need to be performed as the app. --as bot。
First determine "read-only or write", then match top-to-bottom within the corresponding table,stop on hit。
A. Read-only · View / Export (does not modify the whiteboard)
| User Need | Action |
|---|---|
| View whiteboard content / export image | +export --output-type preview |
| Export SVG vector graphic | +export --output-type svg |
| Extract the whiteboard's Mermaid/PlantUML source code | +export --output-type source |
B. Write · Create / Edit (modifies the whiteboard, stop on hit)
| Scenario | Action | Write Method | For Original Content |
|---|---|---|---|
| Userhas provided Mermaid/PlantUML/SVG code, or explicitly specifies using that format | Use that code → +update，--input_format take single value mermaid / plantuml / svg; when writing to a non-empty existing whiteboard and overwrite is needed, first confirm it will rebuild the entire whiteboard; if SVG is used to modify an existing whiteboard, first go through routes/svg-edit.md lossy confirmation |
overwrite / append | As requested by user |
| Create a complex diagram from scratch (architecture/flow/org, etc.) | → § Creation Workflow | First write | — |
| Modify / augment an existing whiteboard | → § Editing Workflow | See that table | See that table |
Shortcuts
| Shortcut | Description |
|---|---|
+export |
Export the whiteboard as a preview image, SVG vector graphic, code, or original node structure. |
+update |
Update the whiteboard, supporting PlantUML, Mermaid, SVG, or the OpenAPI native format |
Not within the scope of this skill
- Document content editing → lark-doc lark-doc
- Create a whiteboard in a document → lark-doc-whiteboard.md
- Spreadsheet / Base operations → lark-sheets / lark-base