lark-doc
open.feishu.cn
Read, create, and edit Feishu cloud documents (Docx/Wiki) with content manipulation and media handling.
What is lark-doc?
Manages Feishu cloud document operations including reading, creating, editing, and media insertion. Use this skill when working with document URLs or tokens, viewing/creating/editing content, or handling embedded images and attachments. For embedded spreadsheets, multidimensional tables, or whiteboards, extract the token and switch to the corresponding skill.
- Fetch document content in XML, Markdown, or IM-Markdown format with configurable scope and detail levels
- Create new documents from scratch using XML or Markdown syntax
- Update existing documents with precise block-level operations (str_replace, block_insert, block_replace, block_delete, block_move)
- Insert local images or files from clipboard or disk into documents with automatic rollback on failure
- Download or preview document media files and whiteboard thumbnails
- Manage Docx cover image resources (download, update, delete)
How to install lark-doc
npx skills add null --skill lark-doc- lark-cli installed and available in PATH
- User authentication via `lark-cli auth login` (operations use `--as user` by default)
- Read lark-shared/SKILL.md for authentication and global parameters before any operation
How to use lark-doc
- 1.Authenticate with `lark-cli auth login` if not already done
- 2.For reading: use `lark-cli docs +fetch --doc "<URL or token>"` with appropriate `--scope` and `--detail` flags
- 3.For creating: use `lark-cli docs +create --content '<XML or Markdown>'` with proper formatting
- 4.For editing: use `lark-cli docs +update --doc "<URL or token>" --command <operation> --content '<content>'` for precise block-level changes
- 5.For media: use `lark-cli docs +media-insert`, `+media-download`, or `+media-preview` as needed
- 6.For embedded resources: extract tokens from sheet/bitable/whiteboard tags and switch to lark-sheets, lark-base, or lark-whiteboard skills
Use cases
- Fetch and summarize document content for analysis or reporting
- Create structured documents with rich formatting (callouts, grids, checkboxes) from templates or user input
- Update specific sections of existing documents without overwriting the entire content
- Insert screenshots or files into documents directly from clipboard
- Preview or download media assets embedded in documents
- Document automation engineers
- Content management workflows
- Knowledge base maintainers
- Users integrating Feishu documents into larger automation pipelines
lark-doc FAQ
Use XML by default for creation and precise editing—it supports rich blocks like callouts, grids, and checkboxes. Use Markdown only when the user provides a .md file or explicitly requests Markdown import. For read operations, choose based on output needs (XML for structure, Markdown for readability, IM-Markdown only for lark-im integration).
Extract the token and table-id from the <sheet> or <bitable> tags, then switch to lark-sheets or lark-base skills to perform data operations. Do not attempt to modify the embedded object directly in the document.
No, document comments are handled by lark-drive skill. This skill focuses only on document content and media.
Do not reuse old block IDs after overwrite, block_replace, or block_delete operations. Fetch the document again to obtain new block IDs if you need to reference them in subsequent operations.
Use `lark-cli docs +media-insert --from-clipboard` to insert images already on the system clipboard. Use `--file` only for on-disk sources.
Full instructions (SKILL.md)
Source of truth, from open.feishu.cn.
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 工具读取以下文件,缺一不可:
../lark-shared/SKILL.md— 认证、权限处理、全局参数(所有操作通用)- 读取文档(
docs +fetch) → 必读lark-doc-fetch.md(--scope/--detail选择、局部读取策略、<fragment>/<excerpt>输出结构) - 创建或编辑文档内容 → 必读
lark-doc-xml.md(XML 语法规则,仅当用户明确要求 Markdown 时改读lark-doc-md.md)和lark-doc-style.md(元素选择、丰富度规则、颜色语义);从零创建时加读lark-doc-create-workflow.md;编辑已有文档时加读lark-doc-update.md和lark-doc-update-workflow.md
未读完以上文件就执行相应操作会导致参数选择错误或格式错误。
格式选择规则(全局):
- 创建 / 导入场景(
docs +create,或docs +update --command append/overwrite的整段写入):XML 和 Markdown 都可以。用户提供.md本地文件、或明确说"导入 Markdown"时,直接用 Markdown;否则默认 XML(可用 callout、grid、checkbox 等富 block)。- 精准编辑场景(
docs +update的str_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 链接、评论锚点、插入 / 替换 / 删除 / 移动才局部 fetchwith-ids;保真改写已有内容才读full - block 直达链接格式:
文档基础 URL#block_id;没有 block_id 时局部 fetchwith-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-id | lark-sheets |
<bitable token="..." table-id="..."> | token -> app_token, table-id | lark-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_id | lark-note:先 note +detail --note-id <vc-node-id> |
<synced_reference src-token="..." src-block-id="..."> | src-token -> doc_token, src-block-id -> block_id | 用 docs +fetch 读取 src-token 文档,定位 block |
Shortcuts(推荐优先使用)
Shortcut 是对常用操作的高级封装(lark-cli docs +<verb> [flags])。有 Shortcut 的操作优先使用。
| Shortcut | 说明 |
|---|---|
+create | Create a Lark document (XML / Markdown) |
+fetch | Fetch Lark document content (XML / Markdown / im-markdown; im-markdown only after fetch for lark-im) |
+update | Update a Lark document (str_replace / block_insert_after / block_replace / ...) |
+media-insert | Insert 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-download | Download document media or whiteboard thumbnail (auto-detects extension) |
+media-preview | Preview document media file (auto-detects extension) |
+resource-download / +resource-update / +resource-delete | Download, update, or delete a Docx cover image resource with --type cover |
+whiteboard-update | Alias of whiteboard +update. Update an existing whiteboard with DSL, Mermaid or PlantUML. Prefer whiteboard +update; refer to lark-whiteboard skill for details. |
不在本 Skill 范围
- 文档评论管理 →
lark-drive - 电子表格或 Base 的数据操作 →
lark-sheets/lark-base - 云空间文件上传、下载、权限管理 →
lark-drive
Related skills
More from open.feishu.cn and the wider catalog.
lark-approval
Query, process, and initiate Lark approval tasks via CLI — search definitions, manage instances, and handle approvals.
lark-base
Operate Feishu Multidimensional Tables (Base): create tables, manage fields, records, views, formulas, forms, dashboards, workflows, and permissions.
lark-calendar
Manage Lark calendar events and meeting rooms: view, create, update, search events, check availability, and book rooms.
lark-drive
Manage Feishu Drive files and folders: upload, download, organize, and import local documents.
lark-contact
Resolve Lark/Feishu names & emails to open_id, or look up user details by open_id
lark-im
Lark/Feishu IM skill: send messages, manage group chats, download files, handle interactive cards, and more.