安装方式
命令行安装
在项目根目录执行以下命令,完成 Skill 安装。
npx bzskills add larksuite/cli --skill lark-shared 适用于首次设置 lark-cli、运行 auth login、切换用户/机器人身份(--as)、处理权限拒绝或作用域错误、需要更新 lark-cli,或在 JSON 输出中看到 _notice 时使用。
103.3k
下载量
命令行安装
在项目根目录执行以下命令,完成 Skill 安装。
npx bzskills add larksuite/cli --skill lark-shared name: lark-shared
version: 1.0.0
description: 适用于首次设置 lark-cli、运行 auth login、切换用户/机器人身份(--as)、处理权限拒绝或作用域错误、需要更新 lark-cli,或在 JSON 输出中看到 _notice 时使用。本技能指导你如何通过lark-cli操作飞书资源, 以及有哪些注意事项。
首次使用需运行 lark-cli config init 完成应用配置。
当你帮用户初始化配置时,使用background方式使用下面的命令发起配置应用流程,启动后读取输出,从中提取授权链接并发给用户。
URL 转发规则:当命令输出 verification_url、verification_uri_complete、console_url 等 URL 字段时:必须生成二维码:你必须调用 lark-cli auth qrcode 将 URL 转为二维码并展示给用户,这是必须步骤,不要跳过。优先生成 PNG 二维码(--output);仅当用户明确要求时才使用 ASCII(--ascii)。URL 输出规则:将 URL 视为不可修改的 opaque string,不要做任何修改(包括 URL 编码/解码、添加空格或标点、重新拼接 query),二维码和链接请一起展示给用户。
# 发起配置(该命令会阻塞直到用户打开链接并完成操作或过期)
lark-cli config init --new
两种身份类型,通过 --as 切换:
| 身份 | 标识 | 获取方式 | 适用场景 |
|---|---|---|---|
| user 用户身份 | --as user | lark-cli auth login 等 | 访问用户自己的资源(日历、云空间/云盘/云存储等) |
| bot 应用身份 | --as bot | 自动,只需 appId + appSecret | 应用级操作,访问bot自己的资源 |
输出的 [identity: bot/user] 代表当前身份。bot 与 user 表现差异很大,需确认身份符合目标需求:
--as bot 查日程返回 bot 自己的(空)日历auth loginauth login 授权,两层都要满足遇到权限相关错误时,根据当前身份类型采取不同解决方案。
错误响应中包含关键信息:
permission_violations:列出缺失的 scope (N选1)console_url:飞书开发者后台的权限配置链接hint:建议的修复命令#### Bot 身份(--as bot)
将错误中的 console_url 原样提供给用户,引导去后台开通 scope。禁止对 bot 执行 auth login。
#### User 身份(--as user)
lark-cli auth login --domain <domain> # 按业务域授权
lark-cli auth login --scope "<missing_scope>" # 按具体 scope 授权(推荐,符合最小权限原则)
规则:auth login 必须指定范围(--domain 或 --scope)。多次 login 的 scope 会累积(增量授权)。
#### Agent 代理发起认证(推荐)
当你作为 AI agent 需要帮用户完成认证时,优先使用 split-flow,避免在同一轮对话中阻塞等待用户授权:
# 发起授权(立即返回 device_code 和 verification_url)
lark-cli auth login --scope "calendar:calendar:readonly" --no-wait --json
拿到 verification_url 后,将它原样作为本轮最终消息发给用户,并结束本轮/交还控制权。不要在同一轮中展示 URL 后立刻执行 --device-code 阻塞轮询;在不透传中间输出的 agent harness 里,这会导致用户永远看不到 URL。
用户回复已完成授权后,再在后续步骤执行:
lark-cli auth login --device-code <device_code>
Split-Flow 完整步骤:
第一步:发起授权(当前轮)
lark-cli auth login --scope "xxx" --no-wait --json(必须加 --no-wait --json)verification_url 和 device_codelark-cli auth qrcode <verification_url> --output "xxx"第二步:完成授权(后续轮)
lark-cli auth login --device-code <device_code>关键规则:
--device-code 命令,不要指示用户自行执行--device-code,这会导致用户看不到 URLverification_url 或 device_code:每次需要授权时,必须重新执行 lark-cli auth login --no-wait --json 生成新的链接。不要将授权链接和 device code 存入上下文供后续复用lark-cli 命令执行后,如果检测到新版本,JSON 输出中会包含 _notice.update 字段(含 message、command 等)。
当你在输出中看到 _notice.update 时,完成用户当前请求后,主动提议帮用户更新:
lark-cli update
重要:始终使用 lark-cli update 更新,它会同时更新 CLI 和 AI Skills。
规则:不要静默忽略更新提示。即使当前任务与更新无关,也应在完成用户请求后补充告知。
--dry-run 预览危险请求。lark-cli 对高风险写操作(risk: "high-risk-write")有强制确认门禁。当你不带 --yes 调用这类命令时,CLI 会退出码 10、并在 stderr 返回如下结构化 envelope:
{
"ok": false,
"error": {
"type": "confirmation_required",
"message": "drive +delete requires confirmation",
"hint": "add --yes to confirm",
"risk": {
"level": "high-risk-write",
"action": "drive +delete"
}
}
}
遇到这种情况,不要当普通错误放弃。 按以下流程处理:
10 且 stderr JSON 里 error.type == "confirmation_required"error.risk.action 和关键参数展示给用户,明确告知"这是高风险操作",等待用户显式同意--yes 后重试绝对不允许:
--yes 静默重试(这等于禁用门禁)confirmation_required 当网络错误/权限错误处理--yes 重试sh -c 等 shell 方式拼接命令重试——用 exec.Command(argv...) 参数数组形式,避免 shell 解析把用户参数当作语法提前预判:想先让用户 review 危险操作的具体请求,调用时加 --dry-run——它不触发门禁,会打印完整请求详情(URL / body / params),你可以把这个预览给用户看过再去真正执行。
lark-cli <service> +<cmd> --help 顶部会显示 Risk: high-risk-writelark-cli schema <service>.<resource>.<method> --format json 的返回值里 "risk": "high-risk-write"