Labsco
larksuite logo

lark-doc

15,100

by larksuite · part of larksuite/cli

飞书云文档 / Docx / 知识库 Wiki 文档(v2):创建、打开、读取、获取、查看、总结、整理、改写、翻译、审阅和编辑飞书文档内容。当用户给出飞书文档 URL/token,或说查看/读取/打开某个文档、提取文档内容、总结文档、生成/创建文档、追加/替换/删除/移动内容、调整排版、插入或下载文档图片/附件/素材/画板缩略图时使用。文档内容中出现嵌入电子表格、多维表格、需要将重要信息可视化为画板(含 SVG 画板)、引用或同步块时,也先用本 skill 读取和提取 token,再切到对应 skill 下钻。使用本 skill 时,docs +create、docs +fetch、docs +update 必须携带 --api-version v2;默认使用 DocxXML,也支持 Markdown。

🔥🔥🔥✓ VerifiedFreeQuick setup
🧰 Not standalone. This skill ships with larksuite/cli and only works together with that tool — install the tool first, then add this skill.

飞书云文档 / Docx / 知识库 Wiki 文档(v2):创建、打开、读取、获取、查看、总结、整理、改写、翻译、审阅和编辑飞书文档内容。当用户给出飞书文档 URL/token,或说查看/读取/打开某个文档、提取文档内容、总结文档、生成/创建文档、追加/替换/删除/移动内容、调整排版、插入或下载文档图片/附件/素材/画板缩略图时使用。文档内容中出现嵌入电子表格、多维表格、需要将重要信息可视化为画板(含 SVG 画板)、引用或同步块时,也先用本 skill 读取和提取 token,再切到对应 skill 下钻。使用本 skill 时,docs +create、docs +fetch、docs +update 必须携带 --api-version v2;默认使用 DocxXML,也支持 Markdown。

Inspect the full instructions your agent will receiveExpand

This is the exact playbook injected into your agent when the skill activates — shown here so you can audit it before installing. You don't need to read it to use the skill.

by larksuite

飞书云文档 / Docx / 知识库 Wiki 文档(v2):创建、打开、读取、获取、查看、总结、整理、改写、翻译、审阅和编辑飞书文档内容。当用户给出飞书文档 URL/token,或说查看/读取/打开某个文档、提取文档内容、总结文档、生成/创建文档、追加/替换/删除/移动内容、调整排版、插入或下载文档图片/附件/素材/画板缩略图时使用。文档内容中出现嵌入电子表格、多维表格、需要将重要信息可视化为画板(含 SVG 画板)、引用或同步块时,也先用本 skill 读取和提取 token,再切到对应 skill 下钻。使用本 skill 时,docs +create、docs +fetch、docs +update 必须携带 --api-version v2;默认使用 DocxXML,也支持 Markdown。 npx skills add https://github.com/larksuite/cli --skill lark-doc Download ZIPGitHub15.1k

docs

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

Copy & paste — that's it
# 常用示例
lark-cli docs +fetch --doc "文档URL或token"
lark-cli docs +create --content ' 标题 内容
'
lark-cli docs +update --doc "文档URL或token" --command append --content ' 内容
'

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

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

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

格式选择规则(全局):

  • 创建 / 导入场景docs +create,或 docs +update --command append/overwrite 的整段写入):XML 和 Markdown 都可以。用户提供 .md 本地文件、或明确说"导入 Markdown"时,直接用 Markdown;否则默认 XML。

  • 精准编辑场景docs +updatestr_replace / block_insert_after / block_replace / block_delete / block_move_after 等局部精修指令):优先使用 XML(--doc-format xml,即默认值)。XML 能稳定表达 block 结构和样式,局部精修更可控;不要因为 Markdown 更简单就自行切换。

快速决策

  • 用户要复制文档 / 创建文档副本 / 另存为副本时,切到 lark-drive,按其中的复制指引使用 lark-cli drive files copy;不要用 docs +fetch + docs +create 重建正文,也不要走 drive +export / drive +import

  • 先判定任务路径:找文档 / 导入导出走 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 的「三、资源块」章节

  • 写文档时,由内容和用户意图决定表达形式;流程、架构、路线图、关键指标等信息可以使用画板,但不要默认把重要信息都画板化

  • 新增或更新画板时,按 lark-doc-whiteboard.md 选型;Mermaid 可由主 Agent 直接插入,SVG / 复杂图 / 已有画板更新按其中流程隔离到 SubAgent

  • 用户说"看一下文档里的图片/附件/素材""预览素材" → 用 lark-cli docs +media-preview

  • 用户明确说"下载素材" → 用 lark-cli docs +media-download

  • 用户想把文档回滚到某个 revision_id 或某一时刻 → 先读 lark-doc-history.md,按其中流程操作

  • 用户明确说"下载/更新/删除文档封面图" → 用 lark-cli docs +resource-download/+resource-update/+resource-delete --type cover

  • resource-* 目前仅支持 Docx 封面资源;其他图片、附件或素材请走 +media-*

  • 如果目标是画板/whiteboard/画板缩略图 → 只能用 lark-cli docs +media-download --type whiteboard(不要用 +media-preview

  • 用户明确要操作思维笔记时;已有思维笔记,走 思维笔记链路;新建思维笔记,走 lark-doc-whiteboard

  • 拿到 spreadsheet URL/token 后 → 切到 lark-sheets 做对象内部操作

  • 用户需要统计文档的总字数 / 总字符数(word count / character count)时,先读取 lark-doc-word-stat.md,并按其中流程调用 scripts/doc_word_stat.py;统计口径以该脚本为准,不要改用其他方式自行计算。

  • 用户说"给文档加评论""查看评论""回复评论""给评论加/删除表情 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 / ...) +history-list / +history-revert / +history-revert-status List document history, revert to a history_version_id, and query revert task status +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 范围