PluginBench
Skill
Fail
Audit score 45

lark-doc

larksuite/cli

Read and edit Lark/Feishu Docx & Wiki documents via CLI — fetch, create, update, and manage media attachments.

What is lark-doc?

lark-doc enables AI agents to interact with Lark (Feishu) cloud documents (Docx and Wiki format). It supports fetching document content, creating new documents, editing existing content with precise block-level operations, and managing media attachments and cover images. Routing is based on URL path patterns (/docx/ or /wiki/) and tokens, not domain names, so it also handles doubao.com document URLs. It does not handle document comments, spreadsheet data, or Base (multi-dimensional table) data operations.

  • Fetch Lark Docx/Wiki document content in XML, Markdown, or im-markdown format with configurable scope and detail levels
  • Create new Lark documents from XML or Markdown content
  • Update existing documents using str_replace, block insert/replace/delete/move, append, or overwrite commands
  • Insert local images or clipboard screenshots into documents with auto-rollback on failure
  • Download or preview document media files and whiteboard thumbnails
  • Download, update, or delete Docx cover image resources

How to install lark-doc

npx skills add null --skill lark-doc
Prerequisites
  • lark-cli must be installed and available in PATH
  • User must run `lark-cli auth login` before first use
  • lark-shared SKILL.md must be readable for auth and global parameter handling
  • Reference files (lark-doc-fetch.md, lark-doc-xml.md, lark-doc-update.md, etc.) must be accessible for the agent to read before executing operations
Claude Code
Cursor
Windsurf
Cline

How to use lark-doc

  1. 1.Run `lark-cli auth login` to authenticate if not already done
  2. 2.To read a document: `lark-cli docs +fetch --doc "<URL or token>"`
  3. 3.To create a document: `lark-cli docs +create --content '<title>Title</title><p>Body</p>'`
  4. 4.To append content: `lark-cli docs +update --doc "<URL or token>" --command append --content '<p>Text</p>'`
  5. 5.To replace specific text: use `--command str_replace` with old and new text values
  6. 6.To insert an image from clipboard: `lark-cli docs +media-insert --from-clipboard --doc "<URL or token>"`
  7. 7.To download a cover image: `lark-cli docs +resource-download --type cover --doc "<URL or token>"`
  8. 8.For embedded spreadsheets or bitables found in fetched content, extract the token and switch to lark-sheets or lark-base skill

Use cases

Good for
  • Read a Feishu or doubao.com document by URL or token and summarize its contents
  • Create a structured Lark document with rich blocks (callouts, grids, checkboxes) from scratch
  • Replace specific text or blocks in an existing document without rewriting the whole file
  • Insert a screenshot or local image file into a Lark document
  • Extract embedded spreadsheet or bitable tokens from a document and hand off to lark-sheets or lark-base
Who it's for
  • Developers automating Lark document workflows via AI agents
  • Teams using Claude Code or Cursor to draft, update, or summarize Feishu documents
  • Users who need to programmatically manage Lark Docx/Wiki content including media attachments
  • Agents routing document tasks that originate from doubao.com /docx/ or /wiki/ URLs

lark-doc FAQ

Does this skill work with doubao.com document URLs?

Yes. Routing is based on URL path pattern (/docx/ or /wiki/) and token, not domain name, so doubao.com /docx/ and /wiki/ URLs are handled by lark-doc.

Can I use Markdown instead of XML when creating or editing documents?

Yes for create and full-section append/overwrite. XML is the default and supports richer blocks (callout, grid, checkbox). Use Markdown only when the user provides a .md file or explicitly requests it. For precise block-level edits, always use XML.

What happens if I need to edit a spreadsheet or bitable embedded in a document?

Use lark-doc to fetch the document and extract the token from the embedded <sheet> or <bitable> tag, then switch to lark-sheets or lark-base skill for data operations.

Can this skill manage document comments?

No. Comment management (add, view, reply, reactions) is handled by the lark-drive skill.

How do I insert an image that is already on my clipboard?

Use `lark-cli docs +media-insert --from-clipboard --doc "<URL or token>"`. Use --file only for images already saved to disk.

Full instructions (SKILL.md)

Source of truth, from larksuite/cli.


name: lark-doc version: 2.0.0 description: "飞书云文档(Docx / Wiki 文档):读取和编辑飞书文档内容。当用户给出文档 URL 或 token,或需要查看、创建、编辑文档、插入或下载文档图片附件时使用。文档中嵌入的电子表格、多维表格、画板,先用本 skill 提取 token 再切到对应 skill。当用户给出 doubao.com 的 /docx/ 或 /wiki/ URL/token 时,也应直接使用本 skill;路由依据是 URL 路径模式和 token,而不是域名。不负责文档评论管理,也不负责表格或 Base 的数据操作。" metadata: requires: bins: ["lark-cli"] cliHelp: "lark-cli docs --help; lark-cli docs +create --help; lark-cli docs +fetch --help; lark-cli docs +update --help; lark-cli docs +resource-download --help; lark-cli docs +resource-update --help; lark-cli docs +resource-delete --help"

docs

身份:文档操作默认使用 --as user。首次使用前执行 lark-cli auth login

# 常用示例
lark-cli docs +fetch --doc "文档URL或token"
lark-cli docs +create --content '<title>标题</title><p>内容</p>'
lark-cli docs +update --doc "文档URL或token" --command append --content '<p>内容</p>'

前置条件 — 执行操作前必读

CRITICAL — 执行对应操作前,MUST 先用 Read 工具读取以下文件,缺一不可:

  1. ../lark-shared/SKILL.md — 认证、权限处理、全局参数(所有操作通用)
  2. 读取文档(docs +fetch → 必读 lark-doc-fetch.md--scope / --detail 选择、局部读取策略、<fragment> / <excerpt> 输出结构)
  3. 创建或编辑文档内容 → 必读 lark-doc-xml.md(XML 语法规则,仅当用户明确要求 Markdown 时改读 lark-doc-md.md)和 lark-doc-style.md(元素选择、丰富度规则、颜色语义);从零创建时加读 lark-doc-create-workflow.md;编辑已有文档时加读 lark-doc-update.mdlark-doc-update-workflow.md

未读完以上文件就执行相应操作会导致参数选择错误或格式错误。

格式选择规则(全局):

  • 创建 / 导入场景docs +create,或 docs +update --command append/overwrite 的整段写入):XML 和 Markdown 都可以。用户提供 .md 本地文件、或明确说"导入 Markdown"时,直接用 Markdown;否则默认 XML(可用 callout、grid、checkbox 等富 block)。
  • 精准编辑场景docs +updatestr_replace / block_insert_after / block_replace / block_delete / block_move_after 等局部精修指令):优先使用 XML(--doc-format xml,即默认值)。XML 能稳定表达 block 结构和样式,局部精修更可控;不要因为 Markdown 更简单就自行切换。

快速决策

  • 先判定任务路径:找文档 / 导入导出走 lark-drive;只读 / 摘要用 docs +fetch 默认 simple;明确旧文本 → 新文本直接 str_replace;只有 block 链接、评论锚点、插入 / 替换 / 删除 / 移动才局部 fetch with-ids;保真改写已有内容才读 full
  • block 直达链接格式:文档基础 URL#block_id;没有 block_id 时局部 fetch with-ids
  • 连续执行多个文档写操作时,必须按 lark-doc-update.md 的「Block ID 生命周期」判断旧 block ID 是否还能复用;overwrite / block_replace / block_delete 后不要复用受影响的旧 ID,插入 / 复制后要重新 fetch 才能拿到新 block ID
  • 用户需要在文档内创建、复制或移动资源块(画板、电子表格、多维表格等)时,必须先读取 lark-doc-xml.md 的「三、资源块」章节
  • 写文档时,由内容和用户意图决定表达形式;流程、架构、路线图、关键指标等信息可以使用画板,但不要默认把重要信息都画板化
  • 新增画板必须隔离到 SubAgent:简单图由 SubAgent 直接插入 <whiteboard type="svg">完整 SVG</whiteboard>,不读 lark-whiteboard;复杂图才由主 Agent 先建 <whiteboard type="blank"></whiteboard>,再启动 SubAgent 读取 lark-whiteboard 写入
  • 用户说"看一下文档里的图片/附件/素材""预览素材" → 用 lark-cli docs +media-preview
  • 用户明确说"下载素材" → 用 lark-cli docs +media-download
  • 用户明确说"下载/更新/删除文档封面图" → 用 lark-cli docs +resource-download/+resource-update/+resource-delete --type cover
  • resource-* 目前仅支持 Docx 封面资源;其他图片、附件或素材请走 +media-*
  • 如果目标是画板/whiteboard/画板缩略图 → 只能用 lark-cli docs +media-download --type whiteboard(不要用 +media-preview
  • 拿到 spreadsheet URL/token 后 → 切到 lark-sheets 做对象内部操作
  • 用户说"给文档加评论""查看评论""回复评论""给评论加/删除表情 reaction" → 切到 lark-drive 处理
  • 文档内容中出现嵌入的 <sheet><bitable><cite file-type="sheets|bitable"> 标签时 → 必须主动提取 token 并切到对应技能下钻读取内部数据,不能只呈现标签本身
标签 / 属性提取字段切到技能
<sheet token="..." sheet-id="...">token -> spreadsheet_token, sheet-idlark-sheets
<bitable token="..." table-id="...">token -> app_token, table-idlark-base
<cite type="doc" file-type="sheets" token="..." sheet-id="..."><sheet>lark-sheets
<cite type="doc" file-type="bitable" token="..." table-id="..."><bitable>lark-base
<vc-transcribe-tab vc-node-id="...">vc-node-id -> note_idlark-note:先 note +detail --note-id <vc-node-id>
<synced_reference src-token="..." src-block-id="...">src-token -> doc_token, src-block-id -> block_iddocs +fetch 读取 src-token 文档,定位 block

Shortcuts(推荐优先使用)

Shortcut 是对常用操作的高级封装(lark-cli docs +<verb> [flags])。有 Shortcut 的操作优先使用。

Shortcut说明
+createCreate a Lark document (XML / Markdown)
+fetchFetch Lark document content (XML / Markdown / im-markdown; im-markdown only after fetch for lark-im)
+updateUpdate a Lark document (str_replace / block_insert_after / block_replace / ...)
+media-insertInsert a local image or file at the end of a Lark document (4-step orchestration + auto-rollback). Prefer --from-clipboard when the image is already on the system clipboard (screenshots, copy from Feishu/browser); use --file only for on-disk sources.
+media-downloadDownload document media or whiteboard thumbnail (auto-detects extension)
+media-previewPreview document media file (auto-detects extension)
+resource-download / +resource-update / +resource-deleteDownload, update, or delete a Docx cover image resource with --type cover
+whiteboard-updateAlias of whiteboard +update. Update an existing whiteboard with DSL, Mermaid or PlantUML. Prefer whiteboard +update; refer to lark-whiteboard skill for details.

不在本 Skill 范围

lark-doc — AI Skill | PluginBench