@amaster.ai/pi-lark 0.1.9 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/README.md +1 -3
  2. package/package.json +2 -2
  3. package/skills/lark-apps/SKILL.md +1 -1
  4. package/skills/lark-apps/references/lark-apps-cache.md +38 -5
  5. package/skills/lark-base/SKILL.md +23 -6
  6. package/skills/lark-base/references/lark-base-app.md +18 -0
  7. package/skills/lark-base/references/lark-base-dashboard-block-config.md +28 -1
  8. package/skills/lark-base/references/lark-base-dashboard.md +29 -11
  9. package/skills/lark-base/references/lark-base-field-schema.md +10 -1
  10. package/skills/lark-base/references/lark-base-form-questions-create.md +36 -5
  11. package/skills/lark-base/references/lark-base-record-history-list.md +19 -2
  12. package/skills/lark-base/references/lark-base-template-center.md +195 -0
  13. package/skills/lark-calendar/SKILL.md +9 -6
  14. package/skills/lark-calendar/references/lark-calendar-transfer.md +89 -0
  15. package/skills/lark-doc/references/lark-doc-fetch.md +1 -1
  16. package/skills/lark-drive/references/lark-drive-add-comment.md +2 -2
  17. package/skills/lark-im/SKILL.md +8 -2
  18. package/skills/lark-im/references/lark-im-message-read-status.md +96 -0
  19. package/skills/lark-mail/references/lark-mail-draft-create.md +12 -12
  20. package/skills/lark-mail/references/lark-mail-forward.md +17 -17
  21. package/skills/lark-mail/references/lark-mail-reply-all.md +8 -8
  22. package/skills/lark-mail/references/lark-mail-reply.md +6 -6
  23. package/skills/lark-mail/references/lark-mail-send.md +20 -20
  24. package/skills/lark-mail/references/lark-mail-template-create.md +7 -6
  25. package/skills/lark-mail/references/lark-mail-template-update.md +7 -6
  26. package/skills/lark-meeting/SKILL.md +146 -0
  27. package/skills/{lark-minutes → lark-meeting}/references/lark-minutes-apply-permission.md +2 -5
  28. package/skills/lark-meeting/references/lark-minutes-detail.md +52 -0
  29. package/skills/{lark-minutes → lark-meeting}/references/lark-minutes-download.md +4 -6
  30. package/skills/{lark-minutes → lark-meeting}/references/lark-minutes-search.md +4 -34
  31. package/skills/{lark-minutes → lark-meeting}/references/lark-minutes-speaker-replace.md +3 -4
  32. package/skills/{lark-minutes → lark-meeting}/references/lark-minutes-summary.md +2 -5
  33. package/skills/{lark-minutes → lark-meeting}/references/lark-minutes-todo.md +5 -15
  34. package/skills/{lark-minutes → lark-meeting}/references/lark-minutes-update.md +2 -3
  35. package/skills/lark-meeting/references/lark-minutes-upload.md +65 -0
  36. package/skills/lark-meeting/references/lark-note-detail.md +15 -0
  37. package/skills/lark-meeting/references/lark-note-transcript.md +19 -0
  38. package/skills/{lark-vc-agent → lark-meeting}/references/lark-vc-agent-meeting-join.md +4 -55
  39. package/skills/{lark-vc-agent → lark-meeting}/references/lark-vc-agent-meeting-leave.md +2 -41
  40. package/skills/lark-meeting/references/lark-vc-detail.md +31 -0
  41. package/skills/{lark-vc → lark-meeting}/references/lark-vc-meeting-events.md +8 -98
  42. package/skills/{lark-vc → lark-meeting}/references/lark-vc-meeting-list-active.md +4 -29
  43. package/skills/{lark-vc → lark-meeting}/references/lark-vc-meeting-message-send.md +3 -5
  44. package/skills/{lark-vc → lark-meeting}/references/lark-vc-recording.md +4 -65
  45. package/skills/{lark-vc → lark-meeting}/references/lark-vc-search.md +9 -28
  46. package/skills/lark-meeting/scenes/create-and-edit-minutes.md +125 -0
  47. package/skills/lark-meeting/scenes/live-meeting-attend.md +107 -0
  48. package/skills/lark-meeting/scenes/live-meeting-interact.md +72 -0
  49. package/skills/lark-meeting/scenes/query-meeting-and-artifacts.md +90 -0
  50. package/skills/lark-meeting/scenes/query-minutes-and-artifacts.md +70 -0
  51. package/skills/lark-meeting/scenes/query-note-and-artifacts.md +127 -0
  52. package/skills/lark-minutes/SKILL.md +5 -203
  53. package/skills/lark-note/SKILL.md +5 -88
  54. package/skills/lark-shared/SKILL.md +25 -224
  55. package/skills/lark-shared/references/lark-shared-config-init.md +12 -0
  56. package/skills/lark-shared/references/lark-shared-high-risk-approval.md +38 -0
  57. package/skills/lark-shared/references/lark-shared-identity-and-permissions.md +105 -0
  58. package/skills/lark-shared/references/lark-shared-output-contract.md +17 -0
  59. package/skills/lark-shared/references/lark-shared-update-notice.md +23 -0
  60. package/skills/lark-slides/SKILL.md +2 -0
  61. package/skills/lark-slides/references/xml/slides_xml_schema_definition.xml +101 -14
  62. package/skills/lark-task/SKILL.md +1 -1
  63. package/skills/lark-vc/SKILL.md +5 -205
  64. package/skills/lark-vc-agent/SKILL.md +5 -206
  65. package/skills/lark-workflow-meeting-summary/SKILL.md +20 -13
  66. package/skills/lark-minutes/references/lark-minutes-detail.md +0 -63
  67. package/skills/lark-minutes/references/lark-minutes-upload.md +0 -104
  68. package/skills/lark-note/references/lark-note-detail.md +0 -29
  69. package/skills/lark-note/references/lark-note-transcript.md +0 -25
  70. package/skills/lark-vc/references/lark-vc-detail.md +0 -49
  71. package/skills/lark-vc/references/vc-domain-boundaries.md +0 -203
@@ -1,247 +1,48 @@
1
1
  ---
2
2
  name: lark-shared
3
- version: 1.0.0
3
+ version: 1.1.0
4
4
  description: "Use 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."
5
+ metadata:
6
+ requires:
7
+ bins: ["lark-cli"]
5
8
  ---
6
9
 
7
10
  # lark-cli 共享规则
8
11
 
9
- 本技能指导你如何通过lark-cli操作飞书资源, 以及有哪些注意事项。
12
+ 所有 `lark-*` skill 共享的底座:身份、认证、输出契约与高风险操作。
10
13
 
11
- ## 配置初始化
14
+ ## 通用准则
12
15
 
13
- 首次使用需运行 `lark-cli config init` 完成应用配置。
16
+ 1. **调用前先确认用法**:执行前读对应 reference 或跑 `--help`,别猜 flag 盲调。
14
17
 
15
- 当你帮用户初始化配置时,使用background方式使用下面的命令发起配置应用流程,启动后读取输出,从中提取授权链接并发给用户。
18
+ 2. **身份决定你代表谁操作**:`--as user` 代表用户本人(能看到、也能操作其日历、云空间/云盘/云存储等个人资源),`--as bot` 代表应用自己,应用级操作,只能访问bot自己的资源,bot 查用户资源会返回空成功而非报错。动手前先搞清楚身份`identity`。身份模型和权限管理 → [`lark-shared-identity-and-permissions.md`](references/lark-shared-identity-and-permissions.md)。
16
19
 
17
- **URL 转发规则**:当命令输出 `verification_url`、`verification_uri_complete`、`console_url` 等 URL 字段时:**必须生成二维码**:你必须调用 `lark-cli auth qrcode` 将 URL 转为二维码并展示给用户,这是必须步骤,不要跳过。优先生成 PNG 二维码(--output);仅当用户明确要求时才使用 ASCII(--ascii)。**URL 输出规则**:将 URL 视为不可修改的 opaque string,不要做任何修改(包括 URL 编码/解码、添加空格或标点、重新拼接 query),二维码和链接请一起展示给用户。
20
+ 3. **授权 / 配置类 URL 必须配二维码**:当命令输出 `verification_url`、`verification_uri_complete`、`console_url` 等 URL 字段时,必须用 `lark-cli auth qrcode` 生成并在回复中展示,URL 在前二维码在后;优先生成 PNG(`--output`),仅当用户明确要求时才使用 ASCII(`--ascii`)。URL 原样转发——不编解码、不加标点、不重拼 query,二维码和链接请一起展示给用户。
18
21
 
19
- ```bash
20
- # 发起配置(该命令会阻塞直到用户打开链接并完成操作或过期)
21
- lark-cli config init --new
22
- ```
22
+ 4. **`--format json`(默认)下,判断成功用 `ok == true`(或进程退出码 0),不要用 `code == 0`**:成功信封没有顶层 `code` / `msg` 字段,`code` 只出现在错误信封的 `error` 内。按 OpenAPI 老格式 `{"code": 0, "msg": "ok"}`判断会把所有成功调用误判为失败——封装写入类命令时尤其危险。JSON 输出契约 → [`lark-shared-output-contract.md`](references/lark-shared-output-contract.md)。
23
23
 
24
- ## 认证
25
24
 
26
- ### 认证任务速查
27
-
28
- 认证、scope、业务域、登录态、退出登录态、撤销授权问题都走本技能。
29
-
30
- | 用户意图 | 首选命令 / 回答 |
31
- |---|---|
32
- | 获取全部权限 | `lark-cli auth login --domain all --no-wait --json` |
33
- | 按业务域授权 | `lark-cli auth login --domain docs --domain drive --no-wait --json`;`--domain` 可重复,也可用逗号分隔 |
34
- | 指定单个 scope 授权 | `lark-cli auth login --scope "<scope>" --no-wait --json` |
35
- | 检查当前登录态、是谁登录、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` |
36
- | 快速查看当前身份状态 | `lark-cli whoami`;实际生效的那一个身份 |
37
- | 退出当前机器的用户登录态 | `lark-cli auth logout --json`;`loggedOut:true` 表示注销成功 |
38
- | bot 缺少权限 | 不要执行 `auth login`;引导用户在开发者后台开通 bot scope,优先复用错误里的 `console_url` |
39
- | 取消用户对应用的全部服务端授权 | `auth logout` 只清本机登录态;服务端授权需用户在飞书授权管理页取消 |
40
- | 只取消一个 scope | CLI 不支持单独撤销一个已授予 scope;可重新走最小 scope 授权,或让用户在授权管理页处理 |
41
-
42
- 机器读取 JSON 时,为减少 `_notice` 干扰,可在命令前加:
43
-
44
- ```bash
45
- LARKSUITE_CLI_NO_UPDATE_NOTIFIER=1 LARKSUITE_CLI_NO_SKILLS_NOTIFIER=1 lark-cli auth status --json --verify
46
- ```
47
-
48
- ### 身份类型
49
-
50
- 两种身份类型,通过 `--as` 切换:
51
-
52
- | 身份 | 标识 | 获取方式 | 适用场景 |
53
- |------|------|---------|---------|
54
- | user 用户身份 | `--as user` | `lark-cli auth login` 等 | 访问用户自己的资源(日历、云空间/云盘/云存储等) |
55
- | bot 应用身份 | `--as bot` | 自动,只需 appId + appSecret | 应用级操作,访问bot自己的资源 |
56
-
57
- ### 身份选择原则
58
-
59
- 输出的 `[identity: bot/user]` 代表当前身份。bot 与 user 表现差异很大,需确认身份符合目标需求:
60
-
61
- - **Bot 看不到用户资源**:无法访问用户的日历、云空间(云盘/云存储)文档、邮箱等个人资源。例如 `--as bot` 查日程返回 bot 自己的(空)日历
62
- - **Bot 无法代表用户操作**:发消息以应用名义发送,创建文档归属 bot
63
- - **Bot 权限**:只需在飞书开发者后台开通 scope,无需 `auth login`
64
- - **User 权限**:后台开通 scope + 用户通过 `auth login` 授权,两层都要满足
65
-
66
-
67
- ### 身份延续(跨命令工作流)
68
-
69
- 身份是**整个工作流的状态**,不是单条命令的局部参数。CLI 不会在进程之间继承"上一步用的身份"——省略 `--as` 不代表"保持当前身份",而是把身份选择交回下面这条优先级链:
70
-
71
- ```text
72
- 显式 --as > profile default-as > credential auto-detect
73
- ```
74
-
75
- 因此,只要用户显式选择了身份,或某个 ID / Token 是通过某个身份取得的(例如 `vc +detail --as bot` 返回的 `note_id`),**后续每一条消费该 ID/Token 的命令都必须显式带上相同的 `--as`**,跨 skill 传递也不例外:
76
-
77
- - 禁止依赖 profile 默认身份让后续命令"自动"沿用同一身份。
78
- - 禁止仅仅因为遇到权限错误就切换身份去绕过它——先如实报告,只有用户明确同意才切换。
79
- - 下游命令根本不支持来源身份时(如 `--as bot` 拿到的 `note_id` 指向 `note_display_type=unified`,而 `note +transcript` 仅支持 `--as user`),停止并向用户说明这个边界,不要静默省略 `--as` 把身份交给默认值。
80
- - 命令支持的精确身份以 `<command> --help` / `schema` 为准;各 skill 的身份小节只标注会影响路由决策的例外,不重复维护完整矩阵。
81
-
82
- ```bash
83
- # GOOD — note_id 来自 bot 链路,下一步显式沿用 bot
84
- lark-cli vc +detail --meeting-ids <meeting_id> --as bot
85
- lark-cli note +detail --note-id <note_id> --as bot
86
- lark-cli docs +fetch --doc <note_doc_token> --as bot
87
-
88
- # BAD — 省略 --as,身份可能被 profile 默认值悄悄换成 user
89
- lark-cli vc +detail --meeting-ids <meeting_id> --as bot
90
- lark-cli note +detail --note-id <note_id>
91
- ```
92
-
93
- ### 权限不足处理
94
-
95
- 遇到权限相关错误时,**根据当前身份类型采取不同解决方案**。
96
-
97
- 错误响应中包含关键信息:
98
- - `missing_scopes`:列出缺失的 scope (N选1)
99
- - `console_url`:飞书开发者后台的权限配置链接
100
- - `hint`:建议的修复命令
101
-
102
- **missing_scope 与资源 ACL(无权访问某具体资源)是两类不同问题**,恢复方式也不同:
103
-
104
- | 失败类型 | user | bot |
105
- |---------|---------|---------|
106
- | missing scope(应用/用户完全没有这个权限) | `auth login --scope ...` | 使用错误中的 `console_url` 去开发者后台开通,**禁止** `auth login` |
107
- | 资源 ACL(有 scope,但对这一条具体资源没有访问权限) | 请求资源所有者给当前用户授权 | 请求资源所有者给当前应用/bot 授权 |
108
- | 资源在当前身份下不可见 | 保持当前身份,如实报告不可见,不要切换身份重试 | 保持当前身份,如实报告不可见,不要切换身份重试 |
109
-
110
- 任何权限恢复完成后,都必须用**触发错误时的原身份**重试,不要在恢复过程中换成另一个身份。
111
-
112
- #### Bot 身份(`--as bot`)
113
-
114
- 将错误中的 `console_url` 原样提供给用户,引导去后台开通 scope。**禁止**对 bot 执行 `auth login`。
115
-
116
- #### User 身份(`--as user`)
117
-
118
- ```bash
119
- lark-cli auth login --domain <domain> --no-wait --json # 按业务域发起授权
120
- lark-cli auth login --scope "<missing_scope>" --no-wait --json # 按具体 scope 发起授权(推荐,符合最小权限原则)
121
- ```
122
-
123
- **规则**:auth login 必须指定范围(`--domain` 或 `--scope`)。多次 login 的 scope 会累积(增量授权)。
124
-
125
- #### Agent 代理发起认证(推荐)
126
-
127
- 当你作为 AI agent 需要帮用户完成认证时,优先使用 split-flow,避免在同一轮对话中阻塞等待用户授权:
128
-
129
- ```bash
130
- # 发起授权(立即返回 device_code 和 verification_url)
131
- lark-cli auth login --scope "calendar:calendar:readonly" --no-wait --json
132
- ```
133
-
134
- 拿到 `verification_url` 后,将它原样作为本轮最终消息发给用户,并结束本轮/交还控制权。不要在同一轮中展示 URL 后立刻执行 `--device-code` 阻塞轮询;在不透传中间输出的 agent harness 里,这会导致用户永远看不到 URL。
135
-
136
- 用户回复已完成授权后,再在后续步骤执行:
137
-
138
- ```bash
139
- lark-cli auth login --device-code <device_code>
140
- ```
141
-
142
- **Split-Flow 完整步骤**:
143
-
144
- **第一步:发起授权(当前轮)**
145
-
146
- 1. 执行 `lark-cli auth login --scope "xxx" --no-wait --json`(必须加 `--no-wait --json`)
147
- 2. 从 JSON 输出中提取 `verification_url` 和 `device_code`
148
- 3. 生成二维码:`lark-cli auth qrcode <verification_url> --output "xxx"`
149
- 4. 将 URL 和二维码展示给用户(先 URL,后二维码)
150
- 5. **结束本轮对话前,必须明确告知用户**:"请完成授权后,回来告诉我已授权完成,我会帮你完成后续步骤"
151
-
152
- **第二步:完成授权(后续轮)**
153
-
154
- 1. 等待用户回复"已完成授权"
155
- 2. **由你(AI agent)亲自执行**:`lark-cli auth login --device-code <device_code>`
156
- 3. 此命令会轮询授权状态并完成登录
157
- 4. 如果返回授权成功,流程结束
158
-
159
- **关键规则**:
160
-
161
- - **你必须亲自执行 `--device-code` 命令**,不要指示用户自行执行
162
- - **不要在同一轮中展示 URL 后立刻执行 `--device-code`**,这会导致用户看不到 URL
163
- - **禁止缓存 `verification_url` 或 `device_code`**:每次需要重新发起授权时,必须沿用所需的 `--scope`、`--domain` 或 `--recommend` 选择以及任何 `--exclude` 值,并附加 `--no-wait --json` 生成新的链接。不要复用已过期的授权链接或 device code
164
-
165
- ## 更新检查
166
-
167
- lark-cli 命令执行后,如果检测到新版本,JSON 输出中会包含 `_notice.update` 字段(含 `message`、`command` 等)。
168
-
169
- 除非用户正在询问更新、版本或 notice,否则不要把 `_notice` 原样复制为当前任务的主要答案,也不要为了 notice 中断当前任务去反复查 help。
170
-
171
- 需要稳定 JSON 给脚本或机器读取时,可以在命令前设置:
172
-
173
- ```bash
174
- LARKSUITE_CLI_NO_UPDATE_NOTIFIER=1 LARKSUITE_CLI_NO_SKILLS_NOTIFIER=1 <lark-cli command>
175
- ```
176
-
177
- 当你在输出中看到 `_notice.update` 时,先完成用户当前请求;如仍相关,再简短告知可运行:
178
-
179
- ```bash
180
- lark-cli update
181
- ```
182
-
183
- **重要**:始终使用 `lark-cli update` 更新,它会同时更新 CLI 和 AI Skills。
25
+ ## 安全规则
184
26
 
185
- ## JSON 输出契约
27
+ 1. **禁止输出密钥**(appSecret、accessToken等)到终端明文。
186
28
 
187
- `--format json`(默认)下,成功与错误的信封结构不同:
29
+ 2. **写入/删除操作前必须确认用户意图**。
188
30
 
189
- 成功信封写入 **stdout**(退出码 0):
31
+ 3. 目标命令支持 `--dry-run` 时,用 `--dry-run` 预览危险请求。
190
32
 
191
- ```json
192
- { "ok": true, "identity": "user", "data": { "guid": "..." }, "meta": { "count": 1 } }
193
- ```
33
+ 4. **退出码 10 是高风险确认门禁(`risk: "high-risk-write"`),不是错误**:停下 → **向用户确认**(展示 `action`、`risk` 和关键参数)→ 取得**用户显式同意**后,将 `hint` 指出的确认 flag **追加到你原始 argv 的末尾**后重试;**绝不**静默加确认 flag 绕过 → [`lark-shared-high-risk-approval.md`](references/lark-shared-high-risk-approval.md)。
194
34
 
195
- 错误信封写入 **stderr**(退出码非 0):
35
+ 5. **文件路径只接受相对路径**:`--file`、`--output`、`--output-dir`、`@file` 等路径参数只接受 cwd 下的相对路径,传绝对路径会报 `unsafe file path`。数据输入(`@file`、大 JSON)优先用 stdin 传入,避免路径和转义问题。
196
36
 
197
- ```json
198
- { "ok": false, "identity": "user", "error": { "type": "authorization", "subtype": "missing_scope", "code": 99991679, "message": "...", "hint": "...", "missing_scopes": ["..."] } }
199
- ```
200
37
 
201
- **判断成功必须用 `ok == true`(或进程退出码 0),不要用 `code == 0`**:成功信封没有顶层 `code` / `msg` 字段,`code` 只出现在错误信封的 `error` 内,含义是上游 OpenAPI 的 numeric code。按 OpenAPI 老格式 `{"code": 0, "msg": "ok"}` 判断会把所有成功调用误判为失败;封装写入类命令(如 `task +create`)时尤其危险,误判会绕过幂等逻辑导致重复创建。
38
+ ## Reference 强触发索引
202
39
 
203
- ## 安全规则
40
+ 命中任一触发条件时,**MUST 在执行下一步前读取对应 reference**。命中多条时按表中顺序读取,同一reference只读取一次。
204
41
 
205
- - **禁止输出密钥**(appSecret、accessToken)到终端明文。
206
- - **写入/删除操作前必须确认用户意图**。
207
- - 用 `--dry-run` 预览危险请求。
208
- - **文件路径只接受相对路径**:`--file`、`--output`、`--output-dir`、`@file` 等路径参数只接受 cwd 下的相对路径,传绝对路径会报 `unsafe file path`。数据输入(`@file`、大 JSON)优先用 stdin 传入,避免路径和转义问题。
209
-
210
- ## 高风险操作的审批协议(exit 10)
211
-
212
- lark-cli 对高风险写操作(`risk: "high-risk-write"`)有强制确认门禁。当你不带 `--yes` 调用这类命令时,CLI 会退出码 `10`、并在 stderr 返回如下结构化 envelope:
213
-
214
- ```json
215
- {
216
- "ok": false,
217
- "identity": "bot",
218
- "error": {
219
- "type": "confirmation",
220
- "subtype": "confirmation_required",
221
- "message": "drive +delete requires confirmation",
222
- "hint": "add --yes to confirm",
223
- "risk": "high-risk-write",
224
- "action": "drive +delete"
225
- }
226
- }
227
- ```
228
-
229
- **遇到这种情况,不要当普通错误放弃。** 按以下流程处理:
230
-
231
- 1. **识别**:看到子进程 exit code = `10` 且 stderr JSON 里 `error.type == "confirmation"`、`error.subtype == "confirmation_required"`
232
- 2. **向用户确认**:把 `error.action`、`error.risk` 和关键参数展示给用户,明确告知"这是高风险操作",等待用户显式同意
233
- 3. **用户同意** → 在你**原始 argv 的末尾追加 `--yes`** 后重试
234
- 4. **用户拒绝** → 终止流程,不要擅自改写参数或跳过门禁
235
-
236
- **绝对不允许**:
237
- - 看到 exit 10 就默认加 `--yes` 静默重试(这等于禁用门禁)
238
- - 把 `confirmation_required` 当网络错误/权限错误处理
239
- - 在用户没明确同意的前提下追加 `--yes` 重试
240
- - 用 `sh -c` 等 shell 方式拼接命令重试——用 `exec.Command(argv...)` 参数数组形式,避免 shell 解析把用户参数当作语法
241
-
242
- 提前预判:想先让用户 review 危险操作的具体请求,调用时加 `--dry-run`——它不触发门禁,会打印完整请求详情(URL / body / params),你可以把这个预览给用户看过再去真正执行。
243
-
244
- ### 如何识别一条命令是高风险
245
-
246
- - shortcut:`lark-cli <service> +<cmd> --help` 顶部会显示 `Risk: high-risk-write`
247
- - service 命令:`lark-cli schema <service>.<resource>.<method> --format json` 的返回值里 `"risk": "high-risk-write"`
42
+ | 强触发条件(命中任一即必读) | Reference |
43
+ |---|---|
44
+ | 查看自己是谁(user/bot)、获取当前身份详细字段信息、身份诊断、`--as`选择逻辑、身份延续、登录态、认证、scope、授权和权限管理、`missing_scopes` 或 `console_url`、Agent 准备发起或完成 `auth login` | [`lark-shared-identity-and-permissions.md`](references/lark-shared-identity-and-permissions.md) |
45
+ | 需要依赖 JSON 输出契约判断成功 / 失败、读取 stdout / stderr,或为命令编写脚本与封装 | [`lark-shared-output-contract.md`](references/lark-shared-output-contract.md) |
46
+ | 准备执行high-risk-write(高风险操作)、判断命令风险等级、遇到退出码 exit 10、`confirmation_required`、确认后重试 | [`lark-shared-high-risk-approval.md`](references/lark-shared-high-risk-approval.md) |
47
+ | 首次使用CLI需运行 `lark-cli config init` 完成应用配置、或 CLI 明确提示 `config init --new` | [`lark-shared-config-init.md`](references/lark-shared-config-init.md) |
48
+ | 用户询问 notice、CLI版本更新、或输出含 `_notice`(升级 / skills 落后 / 废弃命令提示)| [`lark-shared-update-notice.md`](references/lark-shared-update-notice.md) |
@@ -0,0 +1,12 @@
1
+ # 首次配置 lark-cli
2
+
3
+ 首次使用需运行 `lark-cli config init` 完成应用配置。
4
+
5
+ 当你帮用户初始化配置时,使用background方式使用下面的命令发起配置应用流程,启动后读取输出,从中提取授权链接并发给用户。
6
+
7
+ **URL 转发规则**:当命令输出 `verification_url`、`verification_uri_complete`、`console_url` 等 URL 字段时:**必须生成二维码**:你必须调用 `lark-cli auth qrcode` 将 URL 转为二维码并展示给用户,这是必须步骤,不要跳过。优先生成 PNG 二维码(--output);仅当用户明确要求时才使用 ASCII(--ascii)。**URL 输出规则**:将 URL 视为不可修改的 opaque string,不要做任何修改(包括 URL 编码/解码、添加空格或标点、重新拼接 query),二维码和链接请一起展示给用户。
8
+
9
+ ```bash
10
+ # 发起配置(该命令会阻塞直到用户打开链接并完成操作或过期)
11
+ lark-cli config init --new
12
+ ```
@@ -0,0 +1,38 @@
1
+ # 高风险操作的审批协议(exit 10)
2
+
3
+ lark-cli 对高风险写操作(`risk: "high-risk-write"`)有强制确认门禁。当缺少命令要求的确认 flag(通常是 `--yes`)时,CLI 会退出码 `10`、并在 stderr 返回如下结构化 envelope:
4
+
5
+ ```json
6
+ {
7
+ "ok": false,
8
+ "identity": "bot",
9
+ "error": {
10
+ "type": "confirmation",
11
+ "subtype": "confirmation_required",
12
+ "message": "drive +delete requires confirmation",
13
+ "hint": "add --yes to confirm",
14
+ "risk": "high-risk-write",
15
+ "action": "drive +delete"
16
+ }
17
+ }
18
+ ```
19
+
20
+ **遇到这种情况,不要当普通错误放弃。** 按以下流程处理:
21
+
22
+ 1. **识别**:看到子进程 exit code = `10` 且 stderr JSON 里 `error.type == "confirmation"`、`error.subtype == "confirmation_required"`
23
+ 2. **向用户确认**:把 `error.action`、`error.risk` 和关键参数展示给用户,明确告知"这是高风险操作",等待用户显式同意
24
+ 3. **用户同意** → 按 `error.hint` 确定确认 flag,并追加到你**自己的原始 argv** 后重试。多数命令使用 `--yes`
25
+ 4. **用户拒绝** → 终止流程,不要擅自改写参数或跳过门禁
26
+
27
+ **绝对不允许**:
28
+ - 看到 exit 10 就默认加确认 flag 静默重试(这等于禁用门禁)
29
+ - 把 `confirmation_required` 当网络错误/权限错误处理
30
+ - 在用户没明确同意的前提下追加确认 flag 重试
31
+ - 用 `sh -c` 等 shell 方式拼接命令重试——用参数数组(argv)形式传参,避免 shell 解析把用户参数当作语法
32
+
33
+ 提前预判:想先让用户 review 危险操作的具体请求,且目标命令支持 `--dry-run` 时,调用时加 `--dry-run`——它不触发确认门禁,会打印完整请求详情(URL / body / params),你可以把这个预览给用户看过再去真正执行。
34
+
35
+ ## 如何识别一条命令是高风险
36
+
37
+ - shortcut:`lark-cli <service> +<cmd> --help` 顶部会显示 `Risk: high-risk-write`
38
+ - service 命令:`lark-cli schema <service>.<resource>.<method> --format json` 的返回值里 `"risk": "high-risk-write"`
@@ -0,0 +1,105 @@
1
+ # 身份与权限
2
+
3
+ ## 认证任务速查
4
+
5
+ | 用户意图 | 首选命令 / 回答 |
6
+ |---|---|
7
+ | 获取全部权限 | `lark-cli auth login --domain all --no-wait --json` |
8
+ | 按业务域授权 | `lark-cli auth login --domain docs --domain drive --no-wait --json`;`--domain` 可重复,也可用逗号分隔 |
9
+ | 指定单个 scope 授权 | `lark-cli auth login --scope "<scope>" --no-wait --json` |
10
+ | 检查当前登录态、是谁登录、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` |
11
+ | 快速查看当前身份状态 | `lark-cli whoami`;实际生效的那一个身份 |
12
+ | 退出当前机器的用户登录态 | `lark-cli auth logout --json`;`loggedOut:true` 表示注销成功 |
13
+ | bot 缺少权限 | 不要执行 `auth login`;引导用户在开发者后台开通 bot scope,优先复用错误里的 `console_url` |
14
+ | 取消用户对应用的全部服务端授权 | `auth logout` 只清本机登录态;服务端授权需用户在飞书授权管理页取消 |
15
+ | 只取消一个 scope | CLI 不支持单独撤销一个已授予 scope;可重新走最小 scope 授权,或让用户在授权管理页处理 |
16
+
17
+ 机器读取 JSON 时,为减少 `_notice` 干扰,可在命令前加:
18
+
19
+ ```bash
20
+ LARKSUITE_CLI_NO_UPDATE_NOTIFIER=1 LARKSUITE_CLI_NO_SKILLS_NOTIFIER=1 lark-cli auth status --json --verify
21
+ ```
22
+
23
+ ## 身份类型
24
+
25
+ 两种身份类型,通过 `--as` 切换:
26
+
27
+ | 身份 | 标识 | 获取方式 | 适用场景 |
28
+ |------|------|---------|---------|
29
+ | user 用户身份 | `--as user` | `lark-cli auth login` 等 | 访问用户自己的资源(日历、云空间/云盘/云存储等) |
30
+ | bot 应用身份 | `--as bot` | 自动,只需 appId + appSecret | 应用级操作,访问bot自己的资源 |
31
+
32
+ ## 身份选择原则
33
+
34
+ 输出的 `[identity: bot/user]` 代表当前身份。bot 与 user 表现差异很大,需确认身份符合目标需求:
35
+
36
+ - **Bot 看不到用户资源**:无法访问用户的日历、云空间(云盘/云存储)文档、邮箱等个人资源。例如 `--as bot` 查日程返回 bot 自己的(空)日历
37
+ - **Bot 无法代表用户操作**:发消息以应用名义发送,创建文档归属 bot
38
+ - **Bot 权限**:只需在飞书开发者后台开通 scope,无需 `auth login`
39
+ - **User 权限**:后台开通 scope + 用户通过 `auth login` 授权,两层都要满足
40
+
41
+ ## 身份延续
42
+ - CLI命令执行时,身份选择优先级为:显式 `--as` 优先;省略时由 CLI 根据当前配置和可用凭证自动选择(可通过 `lark-cli whoami` 查看 `identity` 和选择逻辑)。
43
+ - 因此,盲目省略 `--as` 是不可控的,在明确需要保持某一身份时,建议全程显式选择。
44
+
45
+ ## 权限不足处理
46
+
47
+ 遇到权限相关错误时,**根据当前身份类型采取不同解决方案**。
48
+
49
+ 错误响应中包含关键信息:
50
+ - `missing_scopes`:列出缺失的 scope (N选1)
51
+ - `console_url`:飞书开发者后台的权限配置链接
52
+ - `hint`:建议的修复命令
53
+
54
+ ### Bot 身份(`--as bot`)
55
+
56
+ 将错误中的 `console_url` 原样提供给用户,引导去后台开通 scope。**禁止**对 bot 执行 `auth login`。
57
+
58
+ ### User 身份(`--as user`)
59
+
60
+ ```bash
61
+ lark-cli auth login --domain <domain> --no-wait --json # 按业务域发起授权
62
+ lark-cli auth login --scope "<missing_scope>" --no-wait --json # 按具体 scope 发起授权(推荐,符合最小权限原则)
63
+ ```
64
+
65
+ **规则**:auth login 必须指定范围(`--scope`、`--domain` 或 `--recommend`)。多次 login 的 scope 会累积(增量授权)。
66
+
67
+ ### Agent 代理发起认证(推荐)
68
+
69
+ 当你作为 AI agent 需要帮用户完成认证时,优先使用 split-flow,避免在同一轮对话中阻塞等待用户授权:
70
+
71
+ ```bash
72
+ # 发起授权(立即返回 device_code 和 verification_url)
73
+ lark-cli auth login --scope "calendar:calendar:readonly" --no-wait --json
74
+ ```
75
+
76
+ 拿到 `verification_url` 后,将它原样作为本轮最终消息发给用户,并结束本轮/交还控制权。不要在同一轮中展示 URL 后立刻执行 `--device-code` 阻塞轮询;在不透传中间输出的 agent harness 里,这会导致用户永远看不到 URL。
77
+
78
+ 用户回复已完成授权后,再在后续步骤执行:
79
+
80
+ ```bash
81
+ lark-cli auth login --device-code <device_code>
82
+ ```
83
+
84
+ **Split-Flow 完整步骤**:
85
+
86
+ **第一步:发起授权(当前轮)**
87
+
88
+ 1. 执行 `lark-cli auth login --scope "xxx" --no-wait --json`(必须加 `--no-wait --json`)
89
+ 2. 从 JSON 输出中提取 `verification_url` 和 `device_code`
90
+ 3. 生成二维码:`lark-cli auth qrcode <verification_url> --output "xxx"`
91
+ 4. 将 URL 和二维码展示给用户(先 URL,后二维码)
92
+ 5. **结束本轮对话前,必须明确告知用户**:"请完成授权后,回来告诉我已授权完成,我会帮你完成后续步骤"
93
+
94
+ **第二步:完成授权(后续轮)**
95
+
96
+ 1. 等待用户回复"已完成授权"
97
+ 2. **由你(AI agent)亲自执行**:`lark-cli auth login --device-code <device_code>`
98
+ 3. 此命令会轮询授权状态并完成登录
99
+ 4. 如果返回授权成功,流程结束
100
+
101
+ **关键规则**:
102
+
103
+ - **你必须亲自执行 `--device-code` 命令**,不要指示用户自行执行
104
+ - **不要在同一轮中展示 URL 后立刻执行 `--device-code`**,这会导致用户看不到 URL
105
+ - **禁止跨流程缓存 `verification_url` 或 `device_code`**:每次需要重新发起授权时,必须沿用所需的 `--scope`、`--domain` 或 `--recommend` 选择以及任何 `--exclude` 值,并附加 `--no-wait --json` 生成新的链接。不要复用已过期的授权链接或 device code
@@ -0,0 +1,17 @@
1
+ # JSON 输出契约
2
+
3
+ `--format json`(默认)下,成功与错误的信封结构不同:
4
+
5
+ 成功信封写入 **stdout**(退出码 0):
6
+
7
+ ```json
8
+ { "ok": true, "identity": "user", "data": { "guid": "..." }, "meta": { "count": 1 } }
9
+ ```
10
+
11
+ 错误信封写入 **stderr**(退出码非 0):
12
+
13
+ ```json
14
+ { "ok": false, "identity": "user", "error": { "type": "authorization", "subtype": "missing_scope", "code": 99991679, "message": "...", "hint": "...", "missing_scopes": ["..."] } }
15
+ ```
16
+
17
+ **判断成功必须用 `ok == true`(或进程退出码 0),不要用 `code == 0`**:成功信封没有顶层 `code` / `msg` 字段,`code` 只出现在错误信封的 `error` 内,含义是上游 OpenAPI 的 numeric code。按 OpenAPI 老格式 `{"code": 0, "msg": "ok"}` 判断会把所有成功调用误判为失败;封装写入类命令(如 `task +create`)时尤其危险,误判会绕过幂等逻辑导致重复创建。
@@ -0,0 +1,23 @@
1
+ # 更新与 `_notice`
2
+
3
+ lark-cli 命令执行后,如果检测到新版本,JSON 输出中会包含 `_notice.update` 字段(含 `message`、`command` 等)。
4
+
5
+ 除非用户正在询问更新、版本或 notice,否则不要把 `_notice` 原样复制为当前任务的主要答案,也不要为了 notice 中断当前任务去反复查 help。
6
+
7
+ 需要稳定 JSON 给脚本或机器读取时,可以在命令前设置:
8
+
9
+ ```bash
10
+ LARKSUITE_CLI_NO_UPDATE_NOTIFIER=1 LARKSUITE_CLI_NO_SKILLS_NOTIFIER=1 <lark-cli command>
11
+ ```
12
+
13
+ 当你在输出中看到 `_notice.update` 时,先完成用户当前请求;如仍相关,再简短告知可运行:
14
+
15
+ ```bash
16
+ lark-cli update
17
+ ```
18
+
19
+ **重要**:始终使用 `lark-cli update` 更新,它会同时更新 CLI 和 AI Skills。
20
+
21
+ 另外两类 notice:
22
+ - `_notice.skills`:本地 Skills 与当前 CLI 不同步。
23
+ - `_notice.deprecated_command`:本次使用了兼容保留的旧命令;后续调用改用 `replacement`。如果同时提供 `action: "lark-cli update"`,同样建议升级。
@@ -88,6 +88,7 @@ metadata:
88
88
  | 读取或分析已有 PPT | 解析 slides/wiki token,用 shortcut 回读全文 XML 或读取单页 XML,保存 `xml_presentation_id`、`slide_id`、`revision_id` | `slides +xml-get`、`xml_presentation.slide.get`、`cli/lark-slides-xml-presentations-get.md` |
89
89
  | 查看或回滚历史版本 | 先用 `+history-list` 找 `history_version_id`,再 `+history-revert`,必要时 `+history-revert-status` 轮询 | [`cli/lark-slides-history.md`](references/cli/lark-slides-history.md) |
90
90
  | 获取幻灯片页面截图 | 按页码用 `--slide-number`,按 ID 用 `--slide-id`;单张用 `--output`,批量或全量用 `--output-dir`,每批最多 10 页串行执行;截图目录复用同一任务的 deck/task 标识,后续读取返回的实际路径 | `slides +screenshot`、`cli/lark-slides-screenshot.md` |
91
+ | 下载图片 | `--output` 选填;传入时指定单个文件路径,未传时自动保存到默认目录 `.lark-slides/media`,并按响应文件名/类型生成路径;调用后读取返回的 `path`,不要猜测文件名;直连被拒时自动回退到源文件预览 | `slides +media-download --file-token <file_token>` |
91
92
  | 上传或使用图片 | 先上传为 `file_token`,禁止直接写 http(s) 外链 | `slides +media-upload`、`cli/lark-slides-media-upload.md`,或 `+create --slides` 的 XML 里写 `<img src="@./path">` 占位符 |
92
93
  | 绘制图表 | 原生图表(柱状、条形、折线、面积、饼(环)、雷达、组合图)用 `<chart>`,其他(漏斗图、金字塔图、象限图、矩阵图等)用 `<shape>` + `<line>` 模拟 | `xml/xml-schema-quick-ref.md`、`xml/slides_chart_demo.xml` |
93
94
  | 绘制表格 | 优先用 `rect` 和 `text` 模拟,其他用 `<table>` | `xml/xml-schema-quick-ref.md` |
@@ -289,6 +290,7 @@ Shortcut 是对常用操作的高级封装(`lark-cli slides +<verb> [flags]`
289
290
  | [`+xml-get`](references/cli/lark-slides-xml-presentations-get.md) | 读取全文 XML,用 `--presentation` 指定演示文稿的 `xml_presentation_id`,用 `--output` 把 XML 存到本地文件(必须是 CWD 内的相对路径,如 `.lark-slides/plan/<deck>/readback.xml`) |
290
291
  | [`+screenshot`](references/cli/lark-slides-screenshot.md) | 把幻灯片页面截图保存为本地图片;用 `--slide-number` 指定页码(从 1 开始,多页重复传入)或用 `--slide-id` 指定页面;单张用 `--output .lark-slides/screenshots/<deck-or-task-id>/page-01`,批量用 `--output-dir .lark-slides/screenshots/<deck-or-task-id>`(一次最多 10 页);后续必须读取返回的 `output` / `screenshots[].path` |
291
292
  | [`+media-upload`](references/cli/lark-slides-media-upload.md) | 上传本地图片到指定演示文稿,返回 `file_token`(用作 `<img src="...">`),最大 20 MB |
293
+ | `+media-download` | 根据 Slides 图片 `file_token` 下载本地图片;`--output` 选填,未传时使用 `--output-dir` 默认值 `.lark-slides/media` 并自动生成文件名;调用后使用返回的 `path`,不要猜测实际路径;直连下载无权限时自动回退到源文件预览 |
292
294
  | [`+replace-slide`](references/cli/lark-slides-replace-slide.md) | 对已有幻灯片页面进行块级替换/插入(`block_replace` / `block_insert`),自动注入 id 和 `<content/>`,不改变页序 |
293
295
  | [`+update-slide`](references/cli/lark-slides-update-slide.md) | 把一整页 XML 交给已有页面,页面变成 `--content` 描述的样子;能一次改样式/插入/删除/备注/背景,`slide_id` 和页序不变。**没写进 `--content` 的元素会被删除** |
294
296