@@ -8,38 +8,38 @@ metadata:
88 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"
99---
1010
11- # docs
11+ # docs (v2)
1212
13- ** 身份:文档操作默认使用 ` --as user ` 。首次使用前执行 ` lark-cli auth login ` 。**
13+
14+ > ** CRITICAL — API 版本:本 skill 使用 v2 API。执行 ` docs +create ` 、` docs +fetch ` 、` docs +update ` 时必须显式传入 ` --api-version v2 ` 。**
1415
1516``` bash
1617# 常用示例
17- lark-cli docs +fetch --doc " 文档URL或token"
18- lark-cli docs +create --content ' <title>标题</title><p>内容</p>'
19- lark-cli docs +update --doc " 文档URL或token" --command append --content ' <p>内容</p>'
18+ lark-cli docs +fetch --api-version v2 --doc " 文档URL或token"
19+ lark-cli docs +create --api-version v2 -- content ' <title>标题</title><p>内容</p>'
20+ lark-cli docs +update --api-version v2 -- doc " 文档URL或token" --command append --content ' <p>内容</p>'
2021```
2122
2223## 前置条件 — 执行操作前必读
2324
2425** CRITICAL — 执行对应操作前,MUST 先用 Read 工具读取以下文件,缺一不可:**
25- 1 . [ ` ../lark-shared/SKILL.md ` ] ( ../lark-shared/SKILL.md ) — 认证、权限处理、全局参数(所有操作通用)
26- 2 . ** 读取文档(` docs +fetch ` )** → 必读 [ ` lark-doc-fetch.md ` ] ( references/lark-doc-fetch.md ) (` --scope ` / ` --detail ` 选择、局部读取策略、` <fragment> ` / ` <excerpt> ` 输出结构)
27- 3 . ** 创建或编辑文档内容** → 必读 [ ` lark-doc-xml.md ` ] ( references/lark-doc-xml.md ) (XML 语法规则,仅当用户明确要求 Markdown 时改读 [ ` lark-doc-md.md ` ] ( references/lark-doc-md.md ) )和 [ ` lark-doc-style.md ` ] ( references/style/lark-doc-style.md ) (元素选择、丰富度规则、颜色语义);从零创建时加读 [ ` lark-doc-create-workflow.md ` ] ( references/style/lark-doc-create-workflow.md ) ;编辑已有文档时加读 [ ` lark-doc-update.md ` ] ( references/lark-doc-update.md ) 和 [ ` lark-doc-update-workflow.md ` ] ( references/style/lark-doc-update-workflow.md )
26+ 1 . ** 读取文档(` docs +fetch --api-version v2 ` )** → 必读 [ ` lark-doc-fetch.md ` ] ( references/lark-doc-fetch.md ) (` --scope ` / ` --detail ` 选择、局部读取策略、` <fragment> ` / ` <excerpt> ` 输出结构)
27+ 2 . ** 创建或编辑文档内容** → 必读 [ ` lark-doc-xml.md ` ] ( references/lark-doc-xml.md ) (XML 语法规则,仅当用户明确要求 Markdown 时改读 [ ` lark-doc-md.md ` ] ( references/lark-doc-md.md ) )和必读 [ ` lark-doc-style.md ` ] ( references/style/lark-doc-style.md ) (写作原则:默认段落、按体裁、组件克制);从零创建时加读 [ ` lark-doc-create-workflow.md ` ] ( references/style/lark-doc-create-workflow.md ) ;编辑已有文档时加读 [ ` lark-doc-update.md ` ] ( references/lark-doc-update.md ) 和 [ ` lark-doc-update-workflow.md ` ] ( references/style/lark-doc-update-workflow.md )
2828
2929** 未读完以上文件就执行相应操作会导致参数选择错误或格式错误。**
3030
3131> ** 格式选择规则(全局):**
32- > - ** 创建 / 导入场景** (` docs +create ` ,或 ` docs +update --command append/overwrite ` 的整段写入):XML 和 Markdown 都可以。用户提供 ` .md ` 本地文件、或明确说"导入 Markdown"时,直接用 Markdown;否则默认 XML(可用 callout、grid、checkbox 等富 block) 。
32+ > - ** 创建 / 导入场景** (` docs +create ` ,或 ` docs +update --command append/overwrite ` 的整段写入):XML 和 Markdown 都可以。用户提供 ` .md ` 本地文件、或明确说"导入 Markdown"时,直接用 Markdown;否则默认 XML。
3333> - ** 精准编辑场景** (` docs +update ` 的 ` str_replace ` / ` block_insert_after ` / ` block_replace ` / ` block_delete ` / ` block_move_after ` 等局部精修指令):优先使用 XML(` --doc-format xml ` ,即默认值)。XML 能稳定表达 block 结构和样式,局部精修更可控;不要因为 Markdown 更简单就自行切换。
3434
3535## 快速决策
36- - 用户要** 复制文档 / 创建文档副本 / 另存为副本** 时,切到 [ ` lark-drive ` ] ( ../lark-drive/SKILL.md ) ,按其中的复制指引使用 ` lark-cli drive files copy ` ;不要用 ` docs +fetch ` + ` docs +create ` 重建正文,也不要走 ` drive +export ` / ` drive +import ` 。
3736- 先判定任务路径:找文档 / 导入导出走 [ ` lark-drive ` ] ( ../lark-drive/SKILL.md ) ;只读 / 摘要用 ` docs +fetch ` 默认 ` simple ` ;明确旧文本 → 新文本直接 ` str_replace ` ;只有 block 链接、评论锚点、插入 / 替换 / 删除 / 移动才局部 fetch ` with-ids ` ;保真改写已有内容才读 ` full `
3837- block 直达链接格式:` 文档基础 URL#block_id ` ;没有 block_id 时局部 fetch ` with-ids `
3938- 连续执行多个文档写操作时,必须按 [ ` lark-doc-update.md ` ] ( references/lark-doc-update.md ) 的「Block ID 生命周期」判断旧 block ID 是否还能复用;` overwrite ` / ` block_replace ` / ` block_delete ` 后不要复用受影响的旧 ID,插入 / 复制后要重新 fetch 才能拿到新 block ID
4039- 用户需要在文档内** 创建、复制或移动** 资源块(画板、电子表格、多维表格等)时,必须先读取 [ ` lark-doc-xml.md ` ] ( references/lark-doc-xml.md ) 的「三、资源块」章节
4140- 写文档时,由内容和用户意图决定表达形式;流程、架构、路线图、关键指标等信息可以使用画板,但不要默认把重要信息都画板化
42- - 新增画板必须隔离到 SubAgent:简单图由 SubAgent 直接插入 ` <whiteboard type="svg">完整 SVG</whiteboard> ` ,不读 ` lark-whiteboard ` ;复杂图才由主 Agent 先建 ` <whiteboard type="blank"></whiteboard> ` ,再启动 SubAgent 读取 ` lark-whiteboard ` 写入
41+ - 用户给了明确字数要求(写 N 字 / x-y 字 / x 字左右 / 上下浮动)→ 生成或改写后用 ` scripts/count_chars.py ` (lark-doc skill 根的 ` scripts/ ` 下,对齐飞书「总字数」)校验,按 create/update workflow 的「字数校验」闭环处理(最多 2 轮,不达标如实告知)
42+ - 新增画板:思维导图/时序图/类图/饼图/甘特图用 Mermaid,由** 主 Agent 直接插入** ` <whiteboard type="mermaid">…</whiteboard> ` ,无需 SubAgent;其他图表隔离到 SubAgent——简单图由 SubAgent 直接插入 ` <whiteboard type="svg">完整 SVG</whiteboard> ` (不读 ` lark-whiteboard ` ),复杂图由主 Agent 先建 ` <whiteboard type="blank"></whiteboard> ` ,再启动 SubAgent 读取 ` lark-whiteboard ` 写入
4343- 用户说"看一下文档里的图片/附件/素材""预览素材" → 用 ` lark-cli docs +media-preview `
4444- 用户明确说"下载素材" → 用 ` lark-cli docs +media-download `
4545- 用户明确说"下载/更新/删除文档封面图" → 用 ` lark-cli docs +resource-download/+resource-update/+resource-delete --type cover `
@@ -55,8 +55,7 @@ lark-cli docs +update --doc "文档URL或token" --command append --content '<p>
5555| ` <bitable token="..." table-id="..."> ` | ` token ` -> app_token, ` table-id ` | [ ` lark-base ` ] ( ../lark-base/SKILL.md ) |
5656| ` <cite type="doc" file-type="sheets" token="..." sheet-id="..."> ` | 同 ` <sheet> ` | [ ` lark-sheets ` ] ( ../lark-sheets/SKILL.md ) |
5757| ` <cite type="doc" file-type="bitable" token="..." table-id="..."> ` | 同 ` <bitable> ` | [ ` lark-base ` ] ( ../lark-base/SKILL.md ) |
58- | ` <vc-transcribe-tab vc-node-id="..."> ` | ` vc-node-id ` -> note_id | [ ` lark-note ` ] ( ../lark-note/SKILL.md ) :先 ` note +detail --note-id <vc-node-id> ` |
59- | ` <synced_reference src-token="..." src-block-id="..."> ` | ` src-token ` -> doc_token, ` src-block-id ` -> block_id | 用 ` docs +fetch ` 读取 src-token 文档,定位 block |
58+ | ` <synced_reference src-token="..." src-block-id="..."> ` | ` src-token ` -> doc_token, ` src-block-id ` -> block_id | 用 ` docs +fetch --api-version v2 ` 读取 src-token 文档,定位 block |
6059
6160## Shortcuts(推荐优先使用)
6261
0 commit comments