Cli lark-drive
飞书云空间:管理云空间中的文件和文件夹。上传和下载文件、创建文件夹、复制/移动/删除文件、查看文件元数据、管理文档评论、管理文档权限、订阅用户评论变更事件、修改文件标题(docx、sheet、bitable、file、folder、wiki);也负责把本地 Word/Markdown/Excel/CSV 导入为飞书在线云文档(docx、sheet、bitable)。当用户需要上传或下载文件、整理云空间目录、查看文件详情、管理评论、管理文档权限、修改文件标题、订阅用户评论变更事件,或要把本地文件导入成新版文档、电子表格、多维表格/Base 时使用。
install
source · Clone the upstream repo
git clone https://github.com/larksuite/cli
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/larksuite/cli "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/lark-drive" ~/.claude/skills/larksuite-cli-lark-drive && rm -rf "$T"
manifest:
skills/lark-drive/SKILL.mdsource content
drive (v1)
CRITICAL — 开始前 MUST 先用 Read 工具读取
,其中包含认证、权限处理../lark-shared/SKILL.md
导入分流规则: 如果用户要把本地 Excel / CSV 导入成 Base / 多维表格 / bitable,必须优先使用
。不要先切到lark-cli drive +import --type bitable;lark-base只负责导入完成后的表内操作。lark-base
快速决策
- 用户要把本地
/.xlsx
导入成 Base / 多维表格 / bitable,第一步必须使用.csv
。lark-cli drive +import --type bitable - 用户要把本地
/.md
/.docx
/.doc
/.txt
导入成在线文档,使用.html
。lark-cli drive +import --type docx - 用户要把本地
/.xlsx
/.xls
导入成电子表格,使用.csv
。lark-cli drive +import --type sheet - 用户要在云空间里新建文件夹,优先使用
。lark-cli drive +create-folder
只负责导入完成后的 Base 内部操作(表、字段、记录、视图),不要在“本地文件 -> Base”这一步提前切到lark-base
。lark-base
修改标题
- 使用
命令,通过new_title字段可以修改标题,支持 docx、sheet、bitable、file、wiki、folder 类型drive files patch
核心概念
文档类型与 Token
飞书开放平台中,不同类型的文档有不同的 URL 格式和 Token 处理方式。在进行文档操作(如添加评论、下载文件等)时,必须先获取正确的
file_token。
文档 URL 格式与 Token 处理
| URL 格式 | 示例 | Token 类型 | 处理方式 |
|---|---|---|---|
| | | URL 路径中的 token 直接作为 使用 |
| | | URL 路径中的 token 直接作为 使用 |
| | | ⚠️ 不能直接使用,需要先查询获取真实的 |
| | | URL 路径中的 token 直接作为 使用 |
| | | URL 路径中的 token 作为文件夹 token 使用 |
Wiki 链接特殊处理(关键!)
知识库链接(
/wiki/TOKEN)背后可能是云文档、电子表格、多维表格等不同类型的文档。不能直接假设 URL 中的 token 就是 file_token,必须先查询实际类型和真实 token。
处理流程
-
使用
查询节点信息wiki.spaces.get_nodelark-cli wiki spaces get_node --params '{"token":"wiki_token"}' -
从返回结果中提取关键信息
:文档类型(docx/doc/sheet/bitable/slides/file/mindnote)node.obj_type
:真实的文档 token(用于后续操作)node.obj_token
:文档标题node.title
-
根据
使用对应的 APIobj_typeobj_type 说明 使用的 API docx新版云文档
、drive file.comments.*docx.*doc旧版云文档 drive file.comments.*sheet电子表格 sheets.*bitable多维表格 bitable.*slides幻灯片 drive.*file文件 drive.*mindnote思维导图 drive.*
查询示例
# 查询 wiki 节点 lark-cli wiki spaces get_node --params '{"token":"wiki_token"}'
返回结果示例:
{ "node": { "obj_type": "docx", "obj_token": "xxxx", "title": "标题", "node_type": "origin", "space_id": "12345678910" } }
资源关系
Wiki Space (知识空间) └── Wiki Node (知识库节点) ├── obj_type: docx (新版文档) │ └── obj_token (真实文档 token) ├── obj_type: doc (旧版文档) │ └── obj_token (真实文档 token) ├── obj_type: sheet (电子表格) │ └── obj_token (真实文档 token) ├── obj_type: bitable (多维表格) │ └── obj_token (真实文档 token) └── obj_type: file/slides/mindnote └── obj_token (真实文档 token) Drive Folder (云空间文件夹) └── File (文件/文档) └── file_token (直接使用)
常见操作 Token 需求
| 操作 | 需要的 Token | 说明 |
|---|---|---|
| 读取文档内容 | / 通过 自动处理 | 支持直接传入 URL |
| 添加局部评论(划词评论) | | 传 或 时, 会创建局部评论;仅支持 ,以及最终解析为 的 wiki URL |
| 添加全文评论 | | 不传 / 时, 默认创建全文评论;支持 、旧版 URL,以及最终解析为 / 的 wiki URL |
| 下载文件 | | 从文件 URL 中直接提取 |
| 上传文件 | / | 目标位置的 token |
| 列出文档评论 | | 同添加评论 |
评论能力边界(关键!)
支持两种模式。drive +add-comment- 全文评论:未传
/--selection-with-ellipsis
时默认启用,也可显式传--block-id
;支持--full-comment
、旧版docx
URL,以及最终解析为doc
/doc
的 wiki URL。docx - 局部评论:传
或--selection-with-ellipsis
时启用;仅支持--block-id
,以及最终解析为docx
的 wiki URL。docx
的drive +add-comment
需要传--content
JSON 数组字符串,例如reply_elements
。--content '[{"type":"text","text":"正文"}]'- 如果 wiki 解析后不是
/doc
,不要用docx
。+add-comment - 如果需要更底层地直接调用评论 V2 协议,再走原生 API:先执行
,再执行lark-cli schema drive.file.comments.create_v2
。全文评论省略lark-cli drive file.comments create_v2 ...
,局部评论传anchor
。anchor.block_id
评论查询与统计口径(关键!)
- 查询文档评论时,使用
。drive file.comments list
返回的drive file.comments list
应理解为"评论卡片"列表,每个items
对应用户界面里看到的一张评论卡片,而不是平铺的互动消息列表。item- 服务端语义上,创建第一条评论时会同时创建该卡片里的第一条 reply;因此真正承载正文的是每个
,其中第一条 reply 在用户视角下就是这张卡片里的"评论本身"。item.reply_list.replies - 当用户要统计"评论数"或"评论卡片数"时,统计
的长度即可;如果是全量统计,则对所有评论分页返回的items
长度累加。items - 当用户要统计"回复数"时,按用户视角应排除每张评论卡片里的首条评论,统计口径是所有
的长度之和减去item.reply_list.replies
的长度。items - 当用户要统计"总互动数"时,统计所有
的长度之和即可;这个口径包含每张评论卡片里的首条评论。item.reply_list.replies - 如果某个
,说明该评论卡片下还有更多回复未包含在当前返回中;此时需要继续调用item.has_more=true
拉全后,再做全量回复数 / 总互动数统计。drive file.comment.replys list
评论业务特性与引导(关键!)
评论排序引导
- 一个文档通常有多个评论,评论按
(创建时间)排序。create_time - 重要:只有当用户明确提到"最新评论"、"最后评论"、"最早评论"时,才需要根据
进行排序:create_time- 必须先获取所有评论(处理分页拉完所有数据),不能只获取一页就排序
- "最新评论" / "最后评论":按
降序排列,取第一条create_time - "最早评论":按
升序排列,取第一条create_time
- 如果用户只说"第一条评论",直接使用
返回的第一条即可,不需要额外排序。drive file.comments list
评论回复限制
- 添加评论回复前先检查是否存在以下限制
- 全文评论不支持回复:
的评论(全文评论)无法添加回复,遇到此类评论应提示用户"全文评论不支持回复"。is_whole=true - 已解决评论不支持回复:
的评论无法添加回复,遇到此类评论应提示用户"该评论已被解决,无法回复"。is_solved=true - 注意:当用户要回复某条评论但该评论因上述限制不能回复时,只提示不能回复即可,不要自动帮用户找其他可以回复的评论,避免不符合用户预期。
批量查询与列表查询的选择
- 使用
是已知评论 ID 后的批量查询,需要传入具体的评论 ID 列表。drive file.comments batch_query - 使用
用于分页获取评论列表,适合统计评论总数、遍历所有评论,或获取"最新/最后 N 条评论"等场景。drive file.comments list
Reaction / 表情场景
- 遇到评论 / 回复上的 reaction(表情、各表情数量、谁点了什么、添加/删除表情)相关问题时,先阅读 lark-drive-reactions.md 了解如何使用。
典型错误与解决方案
| 错误信息 | 原因 | 解决方案 |
|---|---|---|
| 使用了错误的 token | 检查 token 类型,wiki 链接必须先查询获取 |
| 没有相关操作权限 | 引导用户检查当前身份对文档/文件是否有相应操作权限;如果需要,可以授予相应权限 |
| file_type 参数错误 | 根据 传入正确的 file_type(docx/doc/sheet) |
授权当前应用访问文档
当需要将文档权限授予当前应用(bot)自身时,先通过 bot info 接口获取应用的 open_id,再调用权限接口授权:
# 1. 获取当前应用的 open_id lark-cli api GET /open-apis/bot/v3/info --as bot # 从返回值中取 bot.open_id # 2. 授权当前应用访问文档 lark-cli drive permission.members create \ --params '{"token":"<doc_token>","type":"<resource_type>"}' \ --data '{"member_type":"openid","member_id":"<bot_open_id>","perm":"view","type":"user"}'
注意:此方式仅适用于需要授权给当前应用的场景。授权给其他用户时,直接使用对方的 open_id 即可,无需调用 bot info 接口。
<resource_type> 可选值:doc、docx、sheet、bitable、file、folder、wiki。
Shortcuts(推荐优先使用)
Shortcut 是对常用操作的高级封装(
lark-cli drive +<verb> [flags])。有 Shortcut 的操作优先使用。
| Shortcut | 说明 |
|---|---|
| Upload a local file to Drive |
| Create a Drive folder, optionally under a parent folder, with bot auto-grant support |
| Download a file from Drive to local |
| Create a shortcut to an existing Drive file in another folder |
| Add a full-document comment, or a local comment to selected docx text (also supports wiki URL resolving to doc/docx) |
| Export a doc/docx/sheet/bitable to a local file with limited polling |
| Download an exported file by file_token |
| Import a local file to Drive as a cloud document (docx, sheet, bitable) |
| Move a file or folder to another location in Drive |
| Delete a Drive file or folder with limited polling for folder deletes |
| Poll async task result for import, export, move, or delete operations |
API Resources
lark-cli schema drive.<resource>.<method> # 调用 API 前必须先查看参数结构 lark-cli drive <resource> <method> [flags] # 调用 API
重要:使用原生 API 时,必须先运行
查看schema/--data参数结构,不要猜测字段格式。--params
files
— 复制文件copy
— 新建文件夹create_folder
— 获取文件夹下的清单list
— 修改文件标题patch
file.comments
— 批量获取评论batch_query
— 添加全文/局部(划词)评论create_v2
— 分页获取文档评论list
— 解决/恢复 评论patch
file.comment.replys
— 添加回复create
— 删除回复delete
— 获取回复list
— 更新回复update
permission.members
—auth
— 增加协作者权限create
—transfer_owner
metas
— 获取文档元数据batch_query
user
— 取消订阅用户、应用维度事件remove_subscription
— 订阅用户、应用维度事件(本次开放评论添加事件)subscription
— 查询用户、应用对指定事件的订阅状态subscription_status
file.statistics
— 获取文件统计信息get
file.view_records
— 获取文档的访问者记录list
file.comment.reply.reactions
— 添加/删除 reactionupdate_reaction
权限表
| 方法 | 所需 scope |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |