Skip to content
Get packs

Guide · Agent skill

How to use the Lark Whiteboard Editor agent skill

Updated · written with AI from the project's own documentation and checked against our catalogue data

The lark-whiteboard skill lets an AI agent read, export and edit whiteboards inside Feishu/Lark cloud documents. It is for teams that keep architecture or process diagrams on Lark whiteboards and developers who already write Mermaid or PlantUML. After this guide you will know what the skill does, how to install it, how to phrase requests so it triggers, and what it needs to run.

Lark Whiteboard Editorlarksuite/cli · MIT

Quick start

  1. 1Download the ZIP. Download the lark-whiteboard skill ZIP from this page.
  2. 2Unzip into a skills folder. Extract it into ~/.claude/skills/ for personal use or into a project's .claude/skills/ folder.
  3. 3Install lark-shared. Make sure the lark-shared skill is also available, since it handles authentication and permissions.
  4. 4Check lark-cli and the npm package. Confirm lark-cli is installed and authenticated, and that npx can run @larksuite/whiteboard-cli@^0.2.13 or later.
  5. 5Make a request. Ask the agent in plain language, such as exporting a board or drawing a diagram in a Lark document.
  6. 6Confirm any overwrite. If the agent asks to rebuild a non-empty board, review the target before approving.

What is an agent skill and what does lark-whiteboard do?

An agent skill is a folder of instructions and supporting files that an AI agent loads when a request matches the skill's description. The lark-whiteboard skill covers whiteboards embedded in Feishu/Lark cloud documents.

Once installed, the agent can export a board as a preview image, an SVG vector file, or its Mermaid/PlantUML source code, and it can read a board's raw node structure. It can also create or change board content from Mermaid, PlantUML, SVG or native formats, and it follows step-by-step workflows for building complex diagrams or editing existing boards.

  • Export a whiteboard as a preview image (--output-type preview)
  • Export as SVG vector graphics (--output-type svg)
  • Extract Mermaid or PlantUML source (--output-type source)
  • Create or update board content with the +update shortcut

Install the lark-whiteboard skill

Download the skill ZIP from this page and unzip it into one of two places. For a personal setup, use ~/.claude/skills/. For a single project, use the .claude/skills/ folder inside that project.

If you use the Claude apps instead, upload the ZIP under Settings → Capabilities → Skills.

  • Personal: unzip into ~/.claude/skills/
  • Project only: unzip into the project's .claude/skills/ folder
  • Claude apps: Settings → Capabilities → Skills, then upload the ZIP

Set up the required tools

The skill relies on the lark-cli command-line tool, which must be installed and authenticated. It also uses npx with the @larksuite/whiteboard-cli npm package, version 0.2.13 or later. The skill's instructions tell the agent to check both tools before starting, so you do not need to ask for confirmation.

The skill also depends on the lark-shared skill, which handles authentication and permission. The agent is instructed to read that file before doing any whiteboard work. Your Feishu/Lark account must have permission to access the target document.

  • lark-cli installed and authenticated
  • npx available, with @larksuite/whiteboard-cli@^0.2.13 or later
  • A Feishu/Lark account with access to the target document
  • The lark-shared skill installed alongside lark-whiteboard
lark-cli --version npx -y @larksuite/whiteboard-cli@^0.2.13 -v

Trigger the skill with natural requests

You do not need a special command. Describe what you want with whiteboard words, such as viewing content, exporting an image, or editing a board. The skill is meant for those requests, and it does not handle ordinary document text.

The skill works in two modes. Read-only requests (view, export) never change the board. Write requests (create or edit) do change it. For write requests that use existing Mermaid, PlantUML or SVG code, name the format if you want a specific one.

  • "Export the architecture whiteboard in this doc as a PNG preview."
  • "Export the whiteboard as SVG so I can put it in a slide."
  • "Pull the Mermaid source out of this board."
  • "Turn this Mermaid flowchart into a Lark whiteboard."
  • "Draw a 3-tier microservice architecture diagram on the board in this doc."
  • "Update the existing process board to add an approval step."

Examples of what to ask for

For a new diagram from scratch, the agent follows the creation workflow. For a simple request, it draws a simple diagram, and for a detailed one it adds more layers and nodes. Short or vague prompts get reasonable domain content added, so give specifics if you have them.

When you already have Mermaid or PlantUML code, the agent can use it directly. If the board already has content, the agent follows the editing workflow instead of rebuilding it.

  • Simple request: "Draw a simple three-layer architecture diagram."
  • Existing code: "Here is my PlantUML sequence diagram, put it on the whiteboard in this doc."
  • Editing: "Add a monitoring box connected to the API layer on the existing board."

Safety notes: scripts and network access

This skill runs scripts and uses the network. It calls lark-cli and runs npx to fetch @larksuite/whiteboard-cli, and it works against your Feishu/Lark documents through your authorised account. Review the skill files before installing if that matters for your environment.

Overwrite is the main risk. The skill says a write to a non-empty board may rebuild the whole board and asks for confirmation. Check the board before you approve, and keep a copy if the content matters.

  • It runs scripts and network calls by design
  • Writes to a non-empty board may overwrite it; the agent should ask first
  • Editing ordinary document text, spreadsheets or Base tables is out of scope and goes to lark-doc, lark-sheets or lark-base

What people use it for

  • Export an architecture whiteboard as a PNG for a product requirements doc.
  • Convert an SVG board into a vector file for a presentation slide.
  • Turn Mermaid flowcharts from a repository into a Lark whiteboard for the team.
  • Extract the source code of a board so it can be stored in version control.
  • Add new steps or boxes to an existing process diagram.

Frequently asked questions

Is the lark-whiteboard skill free?

The source material for this page does not state pricing or licence terms beyond the repository licence, which is MIT. Check the repository for details on cost. The skill also requires a Feishu/Lark account with access to the target document.

What do I need before installing lark-whiteboard?

You need the lark-cli command-line tool installed and authenticated, npx available, and the @larksuite/whiteboard-cli npm package at version 0.2.13 or later. You also need a Feishu/Lark account with permission to the document, and the lark-shared skill.

Where do I put the skill files?

Unzip the downloaded ZIP into ~/.claude/skills/ for personal use, or into a project's .claude/skills/ folder for one project. In the Claude apps, upload the ZIP under Settings → Capabilities → Skills.

Can the agent work offline?

No. The skill cannot be used offline because it needs authorised access to Feishu/Lark documents.

Will the agent overwrite my whiteboard?

It may. The skill says a write to a non-empty board can rebuild the whole board, and it asks for confirmation first. Review the board before confirming, since blind bulk edits risk losing content.

How does it compare with other diagram tools?

The source does not compare this skill with other tools. Its scope is Feishu/Lark whiteboards inside cloud documents, so it suits teams already working in Lark. If you need to edit document text, spreadsheets or Base tables, use lark-doc, lark-sheets or lark-base instead.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Use lark-whiteboard if your team keeps diagrams on Feishu/Lark whiteboards and wants an agent to export, draw or update them, or if you already write Mermaid or PlantUML and want it on a board. Skip it if you have no Feishu/Lark access, need offline work, or want bulk edits to a board that already has content without a careful review.

Download the skill