文档生成
- 作者仓库星标 13,378
- 作者更新于 实时读取
- 作者仓库 cli
- 领域
- 文档
- 兼容 Agent
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- 信任分
- 88 / 100 · 社区维护
- 作者 / 版本 / 许可
- @larksuite · 未声明 license
- Token 消耗评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部 API Key
- 不需要
- 兼容的系统
- 未声明（默认跨平台）
- 底层运行要求
- 无特殊要求
- 文件与系统权限
-
- 只读
- 允许写入 / 修改
- 网络行为
- 允许外网请求
- 安装命令数
- 26 条
档案由构建时根据 SKILL.md 与安装命令自动衍生，可能与作者实际意图存在差异。
需要注意： 未限定 allowed-tools，默认拥有全部工具权限。
---
name: lark-doc
description: 飞书云文档 / Docx / 知识库 Wiki 文档（v2）：创建、打开、读取、获取、查看、总结、整理、改写、翻译、审阅和编辑飞书文档内容。当用户给出飞书文档 URL/token，或说查看/读…
category: 文档
runtime: 无特殊运行时
---
# lark-doc 输出预览
## PART A: 任务判断
- 适用问题：PRD、RFC、README、项目说明或知识库整理。
- 输入要求：目标材料、限制条件、期望输出和验收方式。
- 证据边界：围绕“前置条件 — 执行操作前必读 / 快速决策 / Shortcuts（推荐优先使用）”读取原文规则，不把推断写成作者承诺。
## PART B: 执行结果
- **01** 任务判断：确认你的需求是否属于PRD、RFC、README、项目说明或知识库整理，并标出输入、限制和预期结果。
- **02** 执行计划：优先按“前置条件 — 执行操作前必读 / 快速决策 / Shortcuts（推荐优先使用）”拆成步骤，说明每一步会读取什么、修改什么、产出什么。
- **03** 交付结果：给出可复制的命令、文件改动、检查清单或内容草稿，并说明如何继续迭代。
- **04** 风险边界：结合 读取文件、写入/修改文件、会按任务需要访问外部网络、通常不需要额外 API Key 给出执行前确认项。
## Running Rules
- 读取文件、写入/修改文件；会按任务需要访问外部网络；通常不需要额外 API Key。
- 先小样例验证，再放大到真实任务。
- 交付时同时给结果、检查口径和下一步迭代建议。 先确认触发方式
原文没有稳定的斜杠命令要求。安装验证后通常全局生效，直接在对话里点名这个 Skill 并描述任务即可。
给清楚输入和边界
告诉 Agent 目标文件或材料、期望结果、不可改范围、是否允许联网或执行命令。本 Skill 的权限画像是：读取文件、写入/修改文件。
小样例验证后再放大
先用一个小任务确认它会围绕“前置条件 — 执行操作前必读 / 快速决策 / Shortcuts（推荐优先使用）”工作；涉及文件或命令时，先看 diff、日志、预览或测试结果。
复核后再交付
检查最终产物是否包含明确结果、必要证据和下一步动作；如果输出泛泛而谈，就补充输入、边界和验收标准后重跑。
---
name: lark-doc
description: 飞书云文档 / Docx / 知识库 Wiki 文档（v2）：创建、打开、读取、获取、查看、总结、整理、改写、翻译、审阅和编辑飞书文档内容。当用户给出飞书文档 URL/token，或说查看/读…
category: 文档
source: larksuite/cli
---
# lark-doc
## 什么时候使用
- 把项目文档方向的常用动作沉淀成 Agent 可调用的技能 适合处理README、PRD、RFC、教程和知识库文档，核心价值是把输入、判断、执行、验证和交付边界固定下来，避免 Agent 泛泛回答。 把任务拆成可执行、可检查、可继续迭代的…
- 面向PRD、RFC、README、项目说明或知识库整理，优先处理能明确输入、步骤和验收标准的工作。
## 需要提供什么
- 目标材料、目录范围、期望结果和不可改动内容。
- 是否允许联网、执行命令、读写文件或调用外部服务。
## 执行规则
- 围绕「前置条件 — 执行操作前必读 / 快速决策 / Shortcuts（推荐优先使用）」组织步骤，不把推断写成作者事实。
- 读取文件、写入/修改文件；会按任务需要访问外部网络；通常不需要额外 API Key。
- 先跑小样例，确认结果可检查后再扩大任务范围。
## 输出要求
- 给出最终产物、关键证据、验证方式和下一步动作。
- 信息不足时标记 unknown，不编造命令、平台或依赖。 证据边界与执行链路
作者原文负责流程事实；仓库文件负责来源和命令；流狐只补充适用场景、限制和质量判断。
skill "lark-doc" {
输入层 -> 用户目标 + 目标文件 + 禁止范围 + 验收标准
上下文层 -> 前置条件 — 执行操作前必读 / 快速决策 / Shortcuts（推荐优先使用）
规则层 -> SKILL.md 触发条件 / 执行顺序 / 输出格式
运行层 -> 无特殊运行时 | 读取文件、写入/修改文件 | 会按任务需要访问外部网络
安全层 -> 通常不需要额外 API Key + 小任务验证 + diff / 日志复核
输出层 -> 可复制结果 + 检查清单 + 下一步迭代
}docs (v2)
⚠️ API 版本：本 skill 使用 v2 API。所有
docs +create --api-version v2、docs +fetch --api-version v2、docs +update --api-version v2命令必须携带--api-version v2。
# 常用示例
lark-cli docs +fetch --api-version v2 --doc "文档URL或token"
lark-cli docs +create --api-version v2 --content '<title>标题</title><p>内容</p>'
lark-cli docs +update --api-version v2 --doc "文档URL或token" --command append --content '<p>内容</p>'前置条件 — 执行操作前必读
CRITICAL — 执行对应操作前，MUST 先用 Read 工具读取以下文件，缺一不可：
../lark-shared/SKILL.md— 认证、权限处理、全局参数（所有操作通用）- 读取文档（
docs +fetch --api-version v2） → 必读lark-doc-fetch.md（--scope/--detail选择、局部读取策略、<fragment>/<excerpt>输出结构） - 创建或编辑文档内容 → 必读
lark-doc-xml.md（XML 语法规则，仅当用户明确要求 Markdown 时改读lark-doc-md.md）；从零创建时加读lark-doc-create-workflow.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 更简单就自行切换。
快速决策
- 用户需要“某个 block 的直达链接 / 锚点链接”时：返回
文档基础 URL#block_id。如果当前只有文档 URL 没有 block_id，先用docs +fetch --detail with-ids拿到目标 block 的 id - 例：
- 已知文档 URL =
https://xxx.feishu.cn/docx/doxcn123 - 已知 block_id =
blkcn456 - 应返回
https://xxx.feishu.cn/docx/doxcn123#blkcn456
- 已知文档 URL =
- 用户需要在文档内创建、复制或移动资源块（画板、电子表格、多维表格等）时，必须先读取
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 - 如果目标是画板/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 |
<synced_reference src-token="..." src-block-id="..."> |
src-token -> doc_token, src-block-id -> block_id |
用 docs +fetch --api-version v2 读取 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) |
+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) |
+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. |
先判断是否适合
作者设计意图
作者的方法与取舍
边界和复核