飞书 / Lark CLI

先读对资源,再预览和核对更新

官方命令行工具配合任务技能,读取文档、提取多维表格记录,并对指定数据执行可检查的更新。

作者 larksuite

飞书 / Lark CLI:先读对资源,再预览和核对更新 项目图片
GitHub Star
17,887
版本
1.0.98
资料核对

第一次读取一份文档的目录

先明确平台与 user 身份,只申请文档读取所需范围,取得真实标题和 block ID。能定位到指定章节后,再让助手整理内容;需要改变线上数据时另选更新任务。

选一个任务,开始使用

先在个人终端完成安装与账号配置,再把文档链接交给助手。首次路径使用只读文档范围;后续 Base 任务按实际命令补充权限。

从资源与目标选择任务

先看目录,再读取相关章节;适合会议记录、方案和长文档。

  1. 分步安装 CLI 与配套技能

    本页将安装拆成两步:CLI 固定为已核对的发布版 1.0.98,配套技能按仓库当前版本全局安装。作者一键入口 npx @larksuite/cli@latest install 还会在交互终端继续配置应用和授权;它不只是下载 CLI。配置前先选对 Feishu/Lark,安装后以 --help 核对实际命令。

    npm install -g @larksuite/[email protected]
    npx skills add larksuite/cli -y -g
    查看作者安装说明

    首次路径:确认平台,读取文档目录

    在当前工作目录创建 brief.md,写入一份自己有权读取的 Docx/Wiki 完整链接、关注章节和摘要目标。在终端执行上方两条安装命令。首次未配置时运行 lark-cli config init,在交互界面选择新建或已有应用及 Feishu/Lark;已有配置先复用,避免重复初始化。按提示由本人完成平台确认,然后运行 lark-cli auth login --scope "docx:document:readonly" 授权。用 lark-cli auth status --json --verify 查看 brand、identity、verified 和用户状态;这一步会联网验证。接着粘贴第一条任务提示词,先取目录,确认标题和章节 ID 属于目标文档。若应用后台尚未开通该权限,先由应用管理员开通再授权。

    阅读作者的身份与授权说明
  2. 把这段话发给 AI

    以下是编辑编写的操作示例。替换路径、链接、字段和 ID 后使用;预期产物不是本站调用账号后的实测结果。

    使用 lark-doc 和 lark-cli,读取 brief.md 中指定的文档,整理决策、待办和未决问题。全程显式使用 --as user;本次只读文档并生成本地摘要,不修改线上内容。 先查看 lark-cli docs +fetch --help。使用 lark-cli docs +fetch --doc "实际文档URL" --scope outline --max-depth 3 --doc-format xml --detail with-ids --as user --format json 获取目录。用实际返回的标题和 block ID 确定相关章节,再用 --scope section --start-block-id "实际blockID" 读取,保留 XML 和 with-ids。 把完整 JSON 响应保存到当前工作目录下的 source/,一起保留 data.document 内的 content、reference_map、revision_id 和 tips。遇到 excerpt、截断评论或内嵌表格引用时说明覆盖范围;需要的内容未取到就继续定位,不能把片段说成全文。 比较目录与章节响应的 revision_id;若接口支持读取该历史版本,后续请求用 --revision-id 固定到同一版本。若版本已变化且旧版不可读取,重新获取目录与目标章节,并说明本次摘要对应的版本。 写 summary.md:每条决策或待办对应来源标题和 block ID;负责人、截止日期只取原文,缺失项注明。把正文、评论意见和你的归纳分开。 核对业务响应 ok、identity 和退出码,并抽查摘要对应的原文。若权限不足,列出缺失 scope 或资源访问问题,以原 user 身份处理,不自动换成 bot。

  3. 检查你拿到的结果

    • 带文档版本、标题和 block ID 的决策/待办摘要。
    • 完整来源 JSON,正文与评论引用共同保留。
    • 实际读取范围、遗漏内容及抽查记录。
    查看这项任务的作者说明
进一步了解这个 Skill

larksuite/cli 是由 larksuite 团队维护的飞书/Lark 命令行工具,仓库同时提供 lark-* 技能。技能负责告诉助手该选哪条命令、怎样组织输入和检查输出;CLI 负责以已配置的应用与身份调用服务。安装技能本身不会获得组织数据权限。

同一任务可以从不同层次进入:带加号的 shortcut 封装常见操作;API 命令对应具体平台方法;lark-cli api 用于直接调用端点。本页围绕文档定位、Base 数据提取和测试记录更新三条路径,优先采用已核对的 shortcut。

最有用的结果不只是“命令执行成功”。文档要保留版本与章节依据,数据提取要确认查询范围和分页完整性,更新要知道修改的是哪些记录。下方提示词把这些检查放进实际步骤,也区分普通 JSON、NDJSON 文件和 dry-run 预览。

来源与核验

资料核对

按固定提交 c910e89 核对;所用核心命令实现与 v1.0.98 发布树一致。未安装、登录、读取本机凭证或调用业务 API。