$npx -y skills add larksuite/cli --skill lark-sharedUse for lark-cli setup/auth tasks: auth login/status/logout, user vs bot identity, business-domain permissions (--domain, including all/docs/drive), missing scopes, revoking authorization, or handling _notice JSON.
| 1 | # lark-cli 共享规则 |
| 2 | |
| 3 | 本技能指导你如何通过lark-cli操作飞书资源, 以及有哪些注意事项。 |
| 4 | |
| 5 | ## 配置初始化 |
| 6 | |
| 7 | 首次使用需运行 `lark-cli config init` 完成应用配置。 |
| 8 | |
| 9 | 当你帮用户初始化配置时,使用background方式使用下面的命令发起配置应用流程,启动后读取输出,从中提取授权链接并发给用户。 |
| 10 | |
| 11 | **URL 转发规则**:当命令输出 `verification_url`、`verification_uri_complete`、`console_url` 等 URL 字段时:**必须生成二维码**:你必须调用 `lark-cli auth qrcode` 将 URL 转为二维码并展示给用户,这是必须步骤,不要跳过。优先生成 PNG 二维码(--output);仅当用户明确要求时才使用 ASCII(--ascii)。**URL 输出规则**:将 URL 视为不可修改的 opaque string,不要做任何修改(包括 URL 编码/解码、添加空格或标点、重新拼接 query),二维码和链接请一起展示给用户。 |
| 12 | |
| 13 | ```bash |
| 14 | # 发起配置(该命令会阻塞直到用户打开链接并完成操作或过期) |
| 15 | lark-cli config init --new |
| 16 | ``` |
| 17 | |
| 18 | ## 认证 |
| 19 | |
| 20 | ### 认证任务速查 |
| 21 | |
| 22 | 认证、scope、业务域、登录态、退出登录态、撤销授权问题都走本技能。 |
| 23 | |
| 24 | | 用户意图 | 首选命令 / 回答 | |
| 25 | |---|---| |
| 26 | | 获取全部权限 | `lark-cli auth login --domain all --no-wait --json` | |
| 27 | | 按业务域授权 | `lark-cli auth login --domain docs --domain drive --no-wait --json`;`--domain` 可重复,也可用逗号分隔 | |
| 28 | | 指定单个 scope 授权 | `lark-cli auth login --scope "<scope>" --no-wait --json` | |
| 29 | | 检查当前登录态、是谁登录、token 是否有效 | `lark-cli auth status --json --verify`;回答时引用 `identity`、`verified`、`identities.user.status`、`identities.user.userName`、`identities.user.openId`(用户 open id)、`identities.user.tokenStatus`、`identities.user.scope` | |
| 30 | | 快速查看当前身份状态 | `lark-cli whoami`;实际生效的那一个身份 | |
| 31 | | 退出当前机器的用户登录态 | `lark-cli auth logout --json`;`loggedOut:true` 表示注销成功 | |
| 32 | | bot 缺少权限 | 不要执行 `auth login`;引导用户在开发者后台开通 bot scope,优先复用错误里的 `console_url` | |
| 33 | | 取消用户对应用的全部服务端授权 | `auth logout` 只清本机登录态;服务端授权需用户在飞书授权管理页取消 | |
| 34 | | 只取消一个 scope | CLI 不支持单独撤销一个已授予 scope;可重新走最小 scope 授权,或让用户在授权管理页处理 | |
| 35 | |
| 36 | 机器读取 JSON 时,为减少 `_notice` 干扰,可在命令前加: |
| 37 | |
| 38 | ```bash |
| 39 | LARKSUITE_CLI_NO_UPDATE_NOTIFIER=1 LARKSUITE_CLI_NO_SKILLS_NOTIFIER=1 lark-cli auth status --json --verify |
| 40 | ``` |
| 41 | |
| 42 | ### 身份类型 |
| 43 | |
| 44 | 两种身份类型,通过 `--as` 切换: |
| 45 | |
| 46 | | 身份 | 标识 | 获取方式 | 适用场景 | |
| 47 | |------|------|---------|---------| |
| 48 | | user 用户身份 | `--as user` | `lark-cli auth login` 等 | 访问用户自己的资源(日历、云空间/云盘/云存储等) | |
| 49 | | bot 应用身份 | `--as bot` | 自动,只需 appId + appSecret | 应用级操作,访问bot自己的资源 | |
| 50 | |
| 51 | ### 身份选择原则 |
| 52 | |
| 53 | 输出的 `[identity: bot/user]` 代表当前身份。bot 与 user 表现差异很大,需确认身份符合目标需求: |
| 54 | |
| 55 | - **Bot 看不到用户资源**:无法访问用户的日历、云空间(云盘/云存储)文档、邮箱等个人资源。例如 `--as bot` 查日程返回 bot 自己的(空)日历 |
| 56 | - **Bot 无法代表用户操作**:发消息以应用名义发送,创建文档归属 bot |
| 57 | - **Bot 权限**:只需在飞书开发者后台开通 scope,无需 `auth login` |
| 58 | - **User 权限**:后台开通 scope + 用户通过 `auth login` 授权,两层都要满足 |
| 59 | |
| 60 | |
| 61 | ### 权限不足处理 |
| 62 | |
| 63 | 遇到权限相关错误时,**根据当前身份类型采取不同解决方案**。 |
| 64 | |
| 65 | 错误响应中包含关键信息: |
| 66 | - `missing_scopes`:列出缺失的 scope (N选1) |
| 67 | - `console_url`:飞书开发者后台的权限配置链接 |
| 68 | - `hint`:建议的修复命令 |
| 69 | |
| 70 | #### Bot 身份(`--as bot`) |
| 71 | |
| 72 | 将错误中的 `console_url` 原样提供给用户,引导去后台开通 scope。**禁止**对 bot 执行 `auth login`。 |
| 73 | |
| 74 | #### User 身份(`--as user`) |
| 75 | |
| 76 | ```bash |
| 77 | lark-cli auth login --domain <domain> # 按业务域授权 |
| 78 | lark-cli auth login --scope "<missing_scope>" # 按具体 scope 授权(推荐,符合最小权限原则) |
| 79 | ``` |
| 80 | |
| 81 | **规则**:auth login 必须指定范围(`--domain` 或 `--scope`)。多次 login 的 scope 会累积(增量授权)。 |
| 82 | |
| 83 | #### Agent 代理发起认证(推荐) |
| 84 | |
| 85 | 当你作为 AI agent 需要帮用户完成认证时,优先使用 split-flow,避免在同一轮对话中阻塞等待用户授权: |
| 86 | |
| 87 | ```bash |
| 88 | # 发起授权(立即返回 device_code 和 verification_url) |
| 89 | lark-cli auth login --scope "calendar:calendar:readonly" --no-wait --json |
| 90 | ``` |
| 91 | |
| 92 | 拿到 `verification_url` 后,将它原样作为本轮最终消息发给用户,并结束本轮/交还控制权。不要在同一轮中展示 URL 后立刻执行 `--device-code` 阻塞轮询;在不透传中间输出的 agent harness 里,这会导致用户永远看不到 URL。 |
| 93 | |
| 94 | 用户回复已完成授权后,再在后续步骤执行: |
| 95 | |
| 96 | ```bash |
| 97 | lark-cli auth login --device-code <device_code> |
| 98 | ``` |
| 99 | |
| 100 | **Split-Flow 完整步骤**: |
| 101 | |
| 102 | **第一步:发起授权(当前轮)** |
| 103 | |
| 104 | 1. 执行 `lark-cli auth login --scope "xxx" --no-wait --json`(必须加 `--no-wait --json`) |
| 105 | 2. 从 JSON 输出中提取 `verification_url` 和 `device_code` |
| 106 | 3. 生成二维码:`lark-cli auth qrcode <verification_url> --output "xxx"` |
| 107 | 4. 将 URL 和二维码展示给用户(先 URL,后二维码) |
| 108 | 5. **结束本轮对话前,必须明确告知用户**:"请完成授权后,回来告诉我已授权完成,我会帮你完成后续步骤" |
| 109 | |
| 110 | **第二步:完成授权(后续轮)** |
| 111 | |
| 112 | 1. 等待用户回复"已完成授权" |
| 113 | 2. **由你(AI agent)亲自执行**:`lark-cli auth login --device-code <device_code>` |
| 114 | 3. 此命令会轮询授权状态并完成登录 |
| 115 | 4. 如果返回授权成功,流程结束 |
| 116 | |
| 117 | **关键规则**: |
| 118 | |
| 119 | - **你必须亲自执行 `--device-code` 命令**,不要指示用户自行执行 |
| 120 | - **不要在同一轮中展示 URL 后立刻执行 `--device-code`**,这会导致用户看不到 URL |
| 121 | - **禁止缓存 `verification_url` 或 `device_code`**:每次需要授权时,必须重新执行 `lark-cli auth login --no-wait --json` 生成新的链接。不要将授权链接和 device code 存入上下文供后续复用 |
| 122 | |
| 123 | ## 更新检查 |
| 124 | |
| 125 | lark-cli 命令执行后,如果检测到新版本,JSON 输出中会包含 `_notice.update` 字段(含 `message`、`command` 等)。 |
| 126 | |
| 127 | 除非用户正在询问更新、版本或 notice,否则不要把 `_notice` 原样复制为当前任务的主要答案,也不要为了 notice 中断当前任务去反复查 help。 |
| 128 | |
| 129 | 需要稳定 JSON 给脚本或机器读取时,可以在命令前设置: |
| 130 | |
| 131 | ```bash |
| 132 | LARKSUITE_CLI_NO_UPDATE_NOTIFIER=1 LARKSUITE_CLI_NO_SKILLS_NOTIFIER=1 <lark-cli command> |
| 133 | ``` |
| 134 | |
| 135 | 当你在输出中看到 `_notice.update` 时,先完成用户当前请求;如仍相关,再简短告知可运行: |
| 136 | |
| 137 | ```bash |
| 138 | lark-cli update |
| 139 | ``` |
| 140 | |
| 141 | **重要**:始终使用 `lark-cli update` 更新,它会同时更新 CLI 和 AI Skills。 |
| 142 | |
| 143 | ## JSON 输出契约 |
| 144 | |
| 145 | `--format json`(默认)下,成功与错误的信封结构不同: |
| 146 | |
| 147 | 成功信封写入 **stdout**(退出码 0): |
| 148 | |
| 149 | ```json |
| 150 | { "ok": true, "identity": "user", "data": { "guid": "..." }, "meta": { "count": 1 } } |
| 151 | ``` |
| 152 | |
| 153 | 错误信封写入 **stderr**(退出码非 0): |
| 154 | |
| 155 | ```json |
| 156 | { "ok": false, "identity": "user", "error": { "type": "authorization", "subtype": "missing_scope", "code": 99991679, "message": "...", "hint": "...", "missing_scopes": ["..."] } } |
| 157 | ``` |
| 158 | |
| 159 | **判断成功必须用 `ok == true`(或进程退出码 0),不要用 `code == 0`**:成功信封没 |