@amaster.ai/pi-lark 0.1.2-beta.58 → 0.1.2-beta.60
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.
- package/package.json +2 -2
- package/skills/lark-base/SKILL.md +143 -166
- package/skills/lark-base/references/{lark-base-role-guide.md → lark-base-advanced-permission-and-role.md} +5 -5
- package/skills/lark-base/references/lark-base-app-block-data-config.md +2 -2
- package/skills/lark-base/references/lark-base-cell-value.md +9 -14
- package/skills/lark-base/references/{dashboard-block-data-config.md → lark-base-dashboard-block-config.md} +1 -1
- package/skills/lark-base/references/lark-base-dashboard-block-get-data.md +1 -1
- package/skills/lark-base/references/lark-base-dashboard.md +9 -9
- package/skills/lark-base/references/lark-base-data-query.md +5 -5
- package/skills/lark-base/references/lark-base-field-create.md +7 -50
- package/skills/lark-base/references/{formula-field-guide.md → lark-base-field-formula.md} +1 -1
- package/skills/lark-base/references/{lookup-field-guide.md → lark-base-field-lookup.md} +1 -1
- package/skills/lark-base/references/{lark-base-field-json.md → lark-base-field-schema.md} +13 -98
- package/skills/lark-base/references/lark-base-field-update.md +13 -51
- package/skills/lark-base/references/lark-base-filter-condition.md +7 -35
- package/skills/lark-base/references/lark-base-record-batch-create.md +5 -1
- package/skills/lark-base/references/lark-base-record-batch-update.md +5 -2
- package/skills/lark-base/references/lark-base-record-history-list.md +19 -2
- package/skills/lark-base/references/{lark-base-data-analysis-cloud.md → lark-base-record-query-and-analysis-cloud-sop.md} +4 -4
- package/skills/lark-base/references/{lark-base-data-analysis-sop.md → lark-base-record-query-and-analysis-sop.md} +27 -18
- package/skills/lark-base/references/{role-config.md → lark-base-role-config.md} +2 -2
- package/skills/lark-base/references/lark-base-view-set-filter.md +1 -1
- package/skills/lark-base/references/lark-base-workflow-schema.md +2 -2
- package/skills/lark-base/references/{lark-base-workflow-guide.md → lark-base-workflow.md} +1 -1
- package/skills/lark-doc/SKILL.md +3 -3
- package/skills/lark-doc/references/lark-doc-fetch.md +8 -3
- package/skills/lark-doc/references/lark-doc-update.md +12 -8
- package/skills/lark-minutes/references/lark-minutes-apply-permission.md +1 -1
- package/skills/lark-minutes/references/lark-minutes-download.md +1 -1
- package/skills/lark-shared/SKILL.md +25 -224
- package/skills/lark-shared/references/lark-shared-config-init.md +12 -0
- package/skills/lark-shared/references/lark-shared-high-risk-approval.md +38 -0
- package/skills/lark-shared/references/lark-shared-identity-and-permissions.md +105 -0
- package/skills/lark-shared/references/lark-shared-output-contract.md +17 -0
- package/skills/lark-shared/references/lark-shared-update-notice.md +23 -0
- package/skills/lark-slides/references/cli/lark-slides-update-slide.md +18 -1
- package/skills/lark-vc/references/lark-vc-recording.md +1 -1
- package/skills/lark-workflow-meeting-summary/SKILL.md +12 -1
- package/skills/lark-base/references/lark-base-data-query-guide.md +0 -67
- package/skills/lark-base/references/lark-base-record-upsert.md +0 -63
|
@@ -1,20 +1,34 @@
|
|
|
1
|
-
# Base
|
|
1
|
+
# Base Record 查询、匹配与分析 SOP
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
任何 Record 读取、预览、搜索、筛选、匹配、统计、聚合、TopN、多表或语义分析,以及写操作中的记录定位和结果验收,都先完整读取本 SOP。先区分需要 LLM 理解原文的语义分析与可程序化计算的确定性分析,再按数据规模与计算复杂度选择路径;即使用户直接要求解释、编写或排错 `+data-query` 命令或 DSL,也先由本 SOP 确认口径和路径,再读取底层 reference。
|
|
4
4
|
|
|
5
5
|
## 分流决策
|
|
6
6
|
|
|
7
|
-
1.
|
|
7
|
+
1. 明确所有需要参与分析的表;上下文已有整表 `records_count` 时用于提前分流,否则直接按下文导出或探测,不为获取规模单独枚举表。
|
|
8
8
|
2. 如果结论必须依赖 LLM 理解原始内容,例如开放文本打标、情绪或意图识别、主题归纳、语义分类、相似性判断或实体消歧,进入下文“LLM 语义分析”路径。
|
|
9
|
-
3.
|
|
9
|
+
3. 对于其余确定性查询,任一分析表已知超过 2000 行或 NDJSON 探测返回 `has_more=true` 时,先从任务意图中提取可在单表内独立执行的日期、状态、关键词等谓词,逐表下推后用 `--field-id '<一个简单标量字段>' --limit 2000 --format ndjson --output <probe>.ndjson --minimal-stdout` 复查。目标是每张表都达到 `has_more=false`;任一表无法压缩到 2000 行以内时,转 [Cloud SOP](lark-base-record-query-and-analysis-cloud-sop.md) 用云端的数据分析能力。
|
|
10
10
|
4. 所有分析表都不超过 2000 行后:若只有一张表且短 jq 可清晰完成筛选、计数、简单分组/聚合/排序、TopN 可以使用 jq。
|
|
11
|
-
5. 其余确定性任务比如多表、日历计算和复杂数据分析,在 Python 可用时使用 Python,否则进入 [Cloud SOP](lark-base-
|
|
11
|
+
5. 其余确定性任务比如多表、日历计算和复杂数据分析,在 Python 可用时使用 Python,否则进入 [Cloud SOP](lark-base-record-query-and-analysis-cloud-sop.md)。
|
|
12
12
|
|
|
13
|
-
进入 Cloud 后先由 Cloud SOP 在原始记录查询与聚合查询之间选路;只有选定 `+data-query` 时才读取 data-query
|
|
13
|
+
进入 Cloud 后先由 Cloud SOP 在原始记录查询与聚合查询之间选路;只有选定 `+data-query` 时才读取 [data-query DSL reference](lark-base-data-query.md)。
|
|
14
14
|
|
|
15
15
|
## 执行与交付
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
所有 records 读取统一使用 `--format ndjson --output <artifact>.ndjson`。NDJSON 将大记录集写入 records 文件,并在 stdout 返回包含摘要、列 schema 和 stats 的 manifest,避免把过长用户数据直接加载进模型上下文。用 Python 或数据分析引擎直接处理 records 文件。未传 `--limit` 时最多读取 2000 条;仅在探测、预览或用户明确要求前 N 条时缩小限制。
|
|
18
|
+
|
|
19
|
+
### NDJSON 读取示例
|
|
20
|
+
|
|
21
|
+
按任务替换真实 token、ID、投影、条件和 artifact 名称;`+record-search` 和 `+record-get` 使用相同的 NDJSON 输出参数。
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
lark-cli base +record-list \
|
|
25
|
+
--base-token <base_token> \
|
|
26
|
+
--table-id <table_id> \
|
|
27
|
+
--field-id <field> \
|
|
28
|
+
--format ndjson \
|
|
29
|
+
--output ./records.ndjson \
|
|
30
|
+
--as user
|
|
31
|
+
```
|
|
18
32
|
|
|
19
33
|
缩小大表记录范围时,展示文本关键词用 `+record-search`,日期、状态、数字、空值、选项、人员和关联等结构化条件用 `+record-list --filter-json`。
|
|
20
34
|
|
|
@@ -45,7 +59,7 @@
|
|
|
45
59
|
}
|
|
46
60
|
```
|
|
47
61
|
|
|
48
|
-
全表分析的常规资源链路是 `+table-list`
|
|
62
|
+
全表分析的常规资源链路是 `+table-list` 确认目标表,并用已有整表 `records_count` 或 NDJSON `has_more` 确认规模;对所有参与分析的表并发执行 `+field-list` 读取所需 schema,再按上述 NDJSON 契约用 `+record-list` 导出记录。已有可信的 `table_id` 时可直接并发读取各表 `+field-list`。`+view-get` 可按需读取,作为用户持久化访问习惯的可选参考;其中的 filter、sort 与字段范围可辅助理解用户常用的查询范围和排序偏好,并结合当前任务确定最终口径。
|
|
49
63
|
|
|
50
64
|
1. 每次读取使用任务所需的最小投影,并包含 JOIN、解释、回查或写入需要的业务 key。
|
|
51
65
|
2. 全局结论以 `has_more=false` 的完整导出或 Cloud 聚合结果为依据;`has_more=true` 时继续收敛单表谓词或选择 Cloud 路径。
|
|
@@ -53,16 +67,12 @@
|
|
|
53
67
|
4. Base 标量空值很常见;聚合前按用户口径确定空值是排除、按零计入还是进入分母。用户未指定且不同处理会实质改变结论时,说明空值数量、采用的口径及其影响;任务涉及业务键、展开、JOIN 或金额分摊时,同样明确目标粒度及与口径直接相关的重复或总量守恒。
|
|
54
68
|
5. 最终结果保留真实表、查询范围和计算口径,展示用户可读字段;内部 ID 用于连接或定位。
|
|
55
69
|
|
|
56
|
-
`+table-list` / `+base-block-list` 返回的 `records_count` 表示整表行数;manifest 的 `records_count` 表示本次查询实际导出的行数。
|
|
57
|
-
|
|
58
70
|
## 复用本轮 NDJSON
|
|
59
71
|
|
|
60
72
|
Agent 上下文曾下载过当前表的 NDJSON 时,按以下规则判断是否复用:
|
|
61
73
|
|
|
62
74
|
1. 短时间内继续分析或表中数据低频变化时,谓词下推口径一致且已有列覆盖计算需求即可优先复用。
|
|
63
|
-
2. 间隔较长或表中数据高频变化时,批量提取 manifests 的 `base_token/table_id/rev
|
|
64
|
-
|
|
65
|
-
> 例:本轮已按“日期在 2026 年”导出 `orders.ndjson`,用户继续要求按负责人聚合;谓词和所需列未变,直接复用。若间隔较长或该表频繁写入,manifest `rev=42` 与 `+table-list` 最新 `rev` 相同则复用,最新 `rev=43` 则重新导出。
|
|
75
|
+
2. 间隔较长或表中数据高频变化时,批量提取 manifests 的 `base_token/table_id/rev`,刷新相关表元数据并校验最新 `rev`;版本一致且谓词口径未变时复用,否则重新导出对应表。
|
|
66
76
|
|
|
67
77
|
## LLM 语义分析
|
|
68
78
|
|
|
@@ -76,7 +86,7 @@ Agent 上下文曾下载过当前表的 NDJSON 时,按以下规则判断是否
|
|
|
76
86
|
|
|
77
87
|
## Manifest
|
|
78
88
|
|
|
79
|
-
`--output <path>.ndjson` 生成 `<path>.ndjson` 与 `<path>.manifest.json`;记录写入 NDJSON,stdout 返回 manifest
|
|
89
|
+
`--output <path>.ndjson` 生成 `<path>.ndjson` 与 `<path>.manifest.json`;记录写入 NDJSON,stdout 返回 manifest。
|
|
80
90
|
|
|
81
91
|
分析 artifact 使用相对路径输出到当前工作目录,例如 `--output ./records.ndjson`。
|
|
82
92
|
|
|
@@ -115,7 +125,6 @@ Agent 上下文曾下载过当前表的 NDJSON 时,按以下规则判断是否
|
|
|
115
125
|
|
|
116
126
|
- stdout 的 `records_count` 和 `has_more` 描述本次导出;确认后无需在分析代码中重读 manifest 或重新统计 NDJSON 行数。
|
|
117
127
|
- `record_file_size_bytes` 是 NDJSON artifact 的实际字节数,用于选择一次读取、预览或分批方式;确定性计算由 jq/Python 直接读取文件。
|
|
118
|
-
- manifest 的 `rev` 是导出首个响应页返回的 table revision;与 `+table-list` 返回的最新 `rev` 比较,可判断本轮 NDJSON 是否仍对应当前表版本。
|
|
119
128
|
- `query_context` 保存导出查询范围;复用本轮 NDJSON 时结合原查询上下文确认谓词下推口径保持一致。
|
|
120
129
|
- 仅在需要 `columns`、example、hint 或执行 artifact 复用判断时读取 `manifest_file`;满足复用条件后直接继续分析现有 NDJSON。
|
|
121
130
|
- `ignored_fields` 和 `record_not_found` 仅在 stdout 返回时关注。
|
|
@@ -174,7 +183,7 @@ Agent 上下文曾下载过当前表的 NDJSON 时,按以下规则判断是否
|
|
|
174
183
|
|
|
175
184
|
NDJSON 每行是一条 record。单表短筛选、计数和简单聚合可直接用 jq;下面筛选“状态”包含“进行中”的记录,并统计记录数和金额合计:
|
|
176
185
|
|
|
177
|
-
默认导出后使用本地 `jq -s`,同一 artifact
|
|
186
|
+
默认导出后使用本地 `jq -s`,同一 artifact 可反复查询而无需重新下载;本地 jq 不可用时,使用 Python 或其他数据分析引擎处理 records 文件。
|
|
178
187
|
|
|
179
188
|
```bash
|
|
180
189
|
lark-cli base +record-list \
|
|
@@ -182,8 +191,8 @@ lark-cli base +record-list \
|
|
|
182
191
|
--table-id <table_id> \
|
|
183
192
|
--field-id 状态 \
|
|
184
193
|
--field-id 金额 \
|
|
185
|
-
--
|
|
186
|
-
--
|
|
194
|
+
--format ndjson \
|
|
195
|
+
--output records.ndjson &&
|
|
187
196
|
jq -s '
|
|
188
197
|
map(select((.["状态"] | index("进行中")) != null)) as $records
|
|
189
198
|
| ($records | map(.["金额"] | select(. != null))) as $amounts
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# Base
|
|
1
|
+
# Base Role Permission Schema
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> **模块入口**: [Advanced Permission 与 Role](lark-base-advanced-permission-and-role.md) | **相关命令**: `+role-create` · `+role-update` · `+role-get`
|
|
4
4
|
|
|
5
5
|
本文档是角色权限 JSON(AdvPermBaseRoleConfig)的单一事实来源(SSOT),供 `+role-create` 和 `+role-update` 构造 `--json` 参数时参考。
|
|
6
6
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
本文档是 Workflow `steps` JSON 的单一事实来源(SSOT),定义完整数据结构,适用于:
|
|
4
4
|
- **查询场景**:理解 `+workflow-get` 返回的 `steps` 结构
|
|
5
5
|
- **创建/修改场景**:构造 `+workflow-create` / `+workflow-update` 的 `--json` body
|
|
6
|
-
> 💡 **本文档是纯字段参考**。如需**创建/修改**工作流的完整示例,请阅读 [
|
|
6
|
+
> 💡 **本文档是纯字段参考**。如需**创建/修改**工作流的完整示例,请阅读 [Workflow](lark-base-workflow.md)。
|
|
7
7
|
---
|
|
8
8
|
## 📖 快速导航
|
|
9
9
|
|
|
@@ -1067,5 +1067,5 @@ $.{stepId}.{fieldId}.fileToken → 文件 Token 列表(array<string>,仅
|
|
|
1067
1067
|
|
|
1068
1068
|
## 参考
|
|
1069
1069
|
|
|
1070
|
-
- [
|
|
1070
|
+
- [Workflow](lark-base-workflow.md) — 完整示例和构造技巧
|
|
1071
1071
|
- 创建/更新时外层只承载 workflow 元信息,核心校验对象是 `steps`;列表只用于拿 workflow ID 和启停状态
|
package/skills/lark-doc/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: lark-doc
|
|
3
|
-
description: "飞书云文档(Docx / Wiki)内容操作:读取、创建、编辑文档,插入或下载图片附件,以及操作思维笔记。用户提供文档 URL/token(包括 doubao.com 的 /docx/、/wiki/)时使用;按 URL 路径/token
|
|
3
|
+
description: "飞书云文档(Docx / Wiki)内容操作:读取、创建、编辑文档,插入或下载图片附件,以及操作思维笔记。用户提供文档 URL/token(包括 doubao.com 的 /docx/、/wiki/)时使用;按 URL 路径/token 而非域名路由。文档内嵌资源按读取参考中的统一规则分流。独立评论操作走 lark-drive;随正文读取评论使用 docs +fetch。表格或 Base 内部数据操作不在本 skill。"
|
|
4
4
|
metadata:
|
|
5
5
|
requires:
|
|
6
6
|
bins: ["lark-cli"]
|
|
@@ -33,7 +33,7 @@ metadata:
|
|
|
33
33
|
### 资源、画板与思维笔记
|
|
34
34
|
|
|
35
35
|
- **插入本地素材 — [`+media-insert`](references/lark-doc-media-insert.md)**:在文末插入本地图片或文件。
|
|
36
|
-
- **预览素材 — [`+media-preview`](references/lark-doc-media-preview.md)
|
|
36
|
+
- **预览素材 — [`+media-preview`](references/lark-doc-media-preview.md)**:预览文档或评论中的图片、附件或素材。
|
|
37
37
|
- **下载素材 — [`+media-download`](references/lark-doc-media-download.md)**:下载文档中的图片、附件、素材或画板缩略图。
|
|
38
38
|
- **Docx 封面 — [`+resource-download` / `+resource-update` / `+resource-delete`](references/lark-doc-resource-cover.md)**:下载、更新或删除 Docx 封面。
|
|
39
39
|
- **画板 — [`画板工作流`](references/lark-doc-whiteboard.md)**:创建或更新画板时先读取工作流;更新已有画板必须复用现有 token,禁止新建空白画板;使用 [`whiteboard +update`](../lark-whiteboard/references/lark-whiteboard-update.md) 写入。
|
|
@@ -46,4 +46,4 @@ metadata:
|
|
|
46
46
|
## 不在本 Skill 范围
|
|
47
47
|
|
|
48
48
|
- **Drive 文件级操作**:找文档、导入导出、云空间文件上传 / 下载 / 权限管理 → [`lark-drive`](../lark-drive/SKILL.md)。复制文档、创建副本或另存为副本时,按其指引使用 `lark-cli drive files copy`;不要用 `docs +fetch` + `docs +create` 重建正文。
|
|
49
|
-
-
|
|
49
|
+
- **独立评论操作**:添加、分页查看、回复评论或增删 reaction → [`lark-drive`](../lark-drive/SKILL.md);只需紧凑评论上下文时,直接使用默认 JSON 响应的 `docs +fetch`。
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
## 常用示例
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
#
|
|
8
|
+
# 读取整篇文档,并附带当前用户可见的未解决评论;
|
|
9
9
|
lark-cli docs +fetch --doc "文档URL或token"
|
|
10
10
|
|
|
11
11
|
# 按 URL 中的 #share 锚点局部读取
|
|
@@ -34,7 +34,6 @@ lark-cli docs +fetch --doc Z1Fj...tnAc --scope section --start-block-id blkTitle
|
|
|
34
34
|
|`--context-before`|否|返回命中项之前的顶层兄弟块数量(默认 `0`)|
|
|
35
35
|
|`--context-after`|否|返回命中项之后的顶层兄弟块数量(默认 `0`)|
|
|
36
36
|
|`--max-depth`|否|`outline` 表示标题层级上限;其它模式表示子树深度(默认 `-1`,不限)|
|
|
37
|
-
|`--format`|否|`json`(默认)\| `pretty`|
|
|
38
37
|
|
|
39
38
|
## 选择详细度:`--detail`
|
|
40
39
|
|
|
@@ -90,6 +89,11 @@ lark-cli docs +fetch --doc Z1Fj...tnAc --scope section --start-block-id blkTitle
|
|
|
90
89
|
"<ref>": {
|
|
91
90
|
"<real-attr-key>": "<real-attr-value>"
|
|
92
91
|
}
|
|
92
|
+
},
|
|
93
|
+
"comments": {
|
|
94
|
+
"c1": {
|
|
95
|
+
"data": "<comment comment-id=\"xx\" block-id=\"xx\"><quote>引用内容</quote><msg>评论内容</msg></comment>"
|
|
96
|
+
}
|
|
93
97
|
}
|
|
94
98
|
},
|
|
95
99
|
"tips": "<safe replay or degradation guidance>"
|
|
@@ -97,7 +101,8 @@ lark-cli docs +fetch --doc Z1Fj...tnAc --scope section --start-block-id blkTitle
|
|
|
97
101
|
}
|
|
98
102
|
}
|
|
99
103
|
```
|
|
100
|
-
`content` 的格式由 `--doc-format` 决定。`reference_map`
|
|
104
|
+
- `content` 的格式由 `--doc-format` 决定。`reference_map` 是结构化 sidecar,一级键表示引用组:普通资源组通常以 `block_type` 命名,二级键 `ref` 对应正文中的临时引用,其值由真实属性组成;保留组 `comments` 使用 `<ref>.data` 保存评论。XML、Markdown 和 IM Markdown 在存在可见评论时都会返回该组;Markdown 正文没有与评论 key 对应的内联引用,这是有意的协议设计。没有提取数据时,`reference_map` 可能为空。`comments.tips.data` 表示评论因数量上限被截断,文档顶层 `tips` 则给出安全回放或依赖降级提示。`content` 和 `reference_map` 属于同一份响应,应保留完整 JSON 响应;`im-markdown` 仅用于获取内容后在 `lark-im` 场景下使用。设置 `--scope` 时会被 `<fragment>` 包裹,详见下文“局部读取的输出结构”。
|
|
105
|
+
- 评论内容不保证全部返回,需要详细信息时使用 `drive +list-comments` 获取完整评论。
|
|
101
106
|
|
|
102
107
|
### 理解局部读取结果
|
|
103
108
|
|
|
@@ -13,12 +13,15 @@ lark-cli docs +fetch --doc "文档URL或token" --scope keyword --keyword "key1|k
|
|
|
13
13
|
# 替换文本;--content "" 可删除文本
|
|
14
14
|
lark-cli docs +update --doc "xx" --command str_replace --pattern "旧内容" --content "新内容"
|
|
15
15
|
|
|
16
|
-
#
|
|
16
|
+
# 替换单个 block,或同父连续范围内的 block
|
|
17
17
|
lark-cli docs +update --doc "xx" --command block_replace --block-id blkTarget --content '<p>新段落</p>'
|
|
18
|
+
lark-cli docs +update --doc "xx" --command block_replace --start-block-id blkFirst --end-block-id blkLast --content '<p></p>'
|
|
19
|
+
|
|
18
20
|
lark-cli docs +update --doc "xx" --command block_insert_after --block-id blkAnchor --content '<h2>新章节</h2><p>章节内容</p>'
|
|
19
21
|
|
|
20
|
-
#
|
|
21
|
-
lark-cli docs +update --doc "xx" --command block_delete --block-id
|
|
22
|
+
# 删除单个 block 或范围内的 block
|
|
23
|
+
lark-cli docs +update --doc "xx" --command block_delete --block-id blkA
|
|
24
|
+
lark-cli docs +update --doc "xx" --command block_delete --start-block-id blkFirst --end-block-id blkLast
|
|
22
25
|
```
|
|
23
26
|
|
|
24
27
|
## 推荐流程
|
|
@@ -29,8 +32,8 @@ lark-cli docs +update --doc "xx" --command block_delete --block-id "blkA,blkB"
|
|
|
29
32
|
- 只有模糊关键词:用 `--scope keyword --keyword "key1|key2" --context-before 1 --context-after 1 --detail with-ids`
|
|
30
33
|
- 明确整篇重构才读 `--detail with-ids` 全文;只读摘要或确认事实时用更轻的 fetch
|
|
31
34
|
2. **Diagnose(诊断问题)**:判断用户目标、当前结构、语气、重复、断流、事实口径和需要保留的资源;识别哪些 block 必须原样保留。
|
|
32
|
-
3. **Patch Plan(制定局部计划)**:把修改拆成最小安全操作:简单行内文本替换用 `str_replace
|
|
33
|
-
4. **Patch(精确修改)**:按 block / section
|
|
35
|
+
3. **Patch Plan(制定局部计划)**:把修改拆成最小安全操作:简单行内文本替换用 `str_replace`,但它不支持资源替换;单个 block 用一个 `--block-id`,同一直接父节点下的连续 block 用 `--start-block-id`/`--end-block-id`。连续范围适用于 `block_replace` 和 `block_delete`。整段/整块重写用 `block_replace`;增补章节用 `block_insert_after`;删冗余用 `block_delete`;调整顺序用 `block_move_after`。
|
|
36
|
+
4. **Patch(精确修改)**:按 block / section 执行局部命令。替换内容必须符合目标父容器的结构;例如替换列表项范围时使用 `<li>...</li>`。保护 `<cite>`、`<img>`、`<source>`、`<whiteboard>`、`<sheet>`、`<bitable>`、`<synced_reference>` 等 token 化内容,不要改成纯文本或占位符。同一 block 的多处修改合并成一次 `block_replace`。
|
|
34
37
|
5. **Verify(fetch 验证)**:每轮写操作后按影响范围重新 fetch,检查用户要求、结构、语气、事实、资源块和 block ID 是否符合预期;不满足就基于最新 fetch 结果继续 Diagnose / Patch,不要沿用上一轮 block ID。
|
|
35
38
|
|
|
36
39
|
除非用户明确要求完全重建,或原文已无保留价值,否则不要使用 `overwrite`;它可能丢失评论和暂不支持的资源。
|
|
@@ -51,7 +54,8 @@ lark-cli docs +update --doc "xx" --command block_delete --block-id "blkA,blkB"
|
|
|
51
54
|
|`--doc-format`|否|`xml`(默认)或 `markdown`|
|
|
52
55
|
|`--content`|视指令|写入内容;`str_replace` 传空字符串可删除文本|
|
|
53
56
|
|`--pattern`|视指令|`str_replace` 的简单行内匹配文本;不要用于多行、整段或多个 block|
|
|
54
|
-
|`--block-id`|视指令|目标 block ID
|
|
57
|
+
|`--block-id`|视指令|目标 block ID;`-1` 表示文档末尾,`0` 表示文档开头(仅适用于支持这些锚点的指令)|
|
|
58
|
+
|`--start-block-id` / `--end-block-id`|视指令|`block_replace` / `block_delete` 的同父连续闭区间,必须成对使用,且不能与 `--block-id` 混用;`--start-block-id` 用 `0` 表示从文档开头开始,`--end-block-id` 用 `-1` 表示到文档末尾结束|
|
|
55
59
|
|`--src-block-ids`|视指令|要复制或移动的源 block ID,多个 ID 用逗号分隔|
|
|
56
60
|
|`--reference-map`|否|保留或回放既有 `reference_map`,需与 `--content` 配合;支持 JSON、任务目录内的相对 `@file` 或 stdin `-`|
|
|
57
61
|
|`--revision-id`|否|基准版本号,默认 `-1`(最新版本)|
|
|
@@ -63,8 +67,8 @@ lark-cli docs +update --doc "xx" --command block_delete --block-id "blkA,blkB"
|
|
|
63
67
|
|`str_replace`|全文查找替换;支持富文本内的文本替换,但不支持资源替换;涉及多个 block 时建议用 `block_replace`;空 `--content` 表示删除|`--pattern`、`--content`|
|
|
64
68
|
|`block_insert_after`|在指定 block 后插入内容;逐章填充时指定对应标题的 block ID|`--block-id`、`--content`|
|
|
65
69
|
|`block_copy_insert_after`|按 ID 顺序复制源 block,源 block 不变;基础标签均支持,资源块仅支持 `img`、`source`、`whiteboard`、`sheet`、`chat_card`、`sub-page-list`,不支持 `task`、`bitable`、`base_ref`、`synced_reference`、`synced_source`、`okr`|`--block-id`、`--src-block-ids`|
|
|
66
|
-
|`block_replace
|
|
67
|
-
|`block_delete
|
|
70
|
+
|`block_replace`|替换单个 block(`--block-id`)或同父连续闭区间(`--start-block-id`/`--end-block-id`);不支持跨容器或反向区间|`--content`,以及 `--block-id` 或 `--start-block-id`+`--end-block-id`|
|
|
71
|
+
|`block_delete`|删除单个 block(`--block-id`)或同父连续闭区间(`--start-block-id`/`--end-block-id`);不支持跨容器或反向区间|`--block-id` 或 `--start-block-id`+`--end-block-id`|
|
|
68
72
|
|`block_move_after`|移动已有 block,支持所有块类型;|`--block-id`、`--src-block-ids`|
|
|
69
73
|
|`append`|仅在文末追加,等价于 `block_insert_after --block-id -1`|`--content`|
|
|
70
74
|
|`overwrite`|清空后重写全文,丢失图片、评论等内容,非必要不使用|`--content`|
|
|
@@ -92,4 +92,4 @@ lark-cli minutes +apply-permission --minute-token obcnxxxxxxxxxxxxxxxxxxxx --per
|
|
|
92
92
|
|
|
93
93
|
- [lark-minutes](../SKILL.md) — 妙记全部命令
|
|
94
94
|
- [minutes +detail](lark-minutes-detail.md) — 妙记内容与产物查询
|
|
95
|
-
- [lark-shared](../../lark-shared/SKILL.md) —
|
|
95
|
+
- [lark-shared](../../lark-shared/SKILL.md) — 身份延续与权限管理
|
|
@@ -121,7 +121,7 @@ API 限流 5 次/秒,批量下载时需注意控制频率。
|
|
|
121
121
|
| 妙记尚未准备好 | 2091003 | 转写未完成 | 等待转写完成后重试 |
|
|
122
122
|
| 资源已删除 | 2091004 | 妙记已被删除 | 确认妙记文件仍然存在 |
|
|
123
123
|
| 权限不足 | 2091005 | 无阅读权限 | 检查是否有该妙记的访问权限 |
|
|
124
|
-
| `missing required scope(s)` | — | 当前身份缺少 scope | `--as user`:运行 `auth login --scope "minutes:minutes.media:export"`;`--as bot`:使用错误中的 `console_url` 去开发者后台开通,**禁止**对 bot 执行 `auth login`(见 [lark-shared](../../lark-shared/SKILL.md)
|
|
124
|
+
| `missing required scope(s)` | — | 当前身份缺少 scope | `--as user`:运行 `auth login --scope "minutes:minutes.media:export"`;`--as bot`:使用错误中的 `console_url` 去开发者后台开通,**禁止**对 bot 执行 `auth login`(见 [lark-shared](../../lark-shared/SKILL.md) 的权限管理) |
|
|
125
125
|
|
|
126
126
|
## 提示
|
|
127
127
|
|
|
@@ -1,247 +1,48 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: lark-shared
|
|
3
|
-
version: 1.
|
|
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
|
-
|
|
12
|
+
所有 `lark-*` skill 共享的底座:身份、认证、输出契约与高风险操作。
|
|
10
13
|
|
|
11
|
-
##
|
|
14
|
+
## 通用准则
|
|
12
15
|
|
|
13
|
-
|
|
16
|
+
1. **调用前先确认用法**:执行前读对应 reference 或跑 `--help`,别猜 flag 盲调。
|
|
14
17
|
|
|
15
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
27
|
+
1. **禁止输出密钥**(appSecret、accessToken等)到终端明文。
|
|
186
28
|
|
|
187
|
-
|
|
29
|
+
2. **写入/删除操作前必须确认用户意图**。
|
|
188
30
|
|
|
189
|
-
|
|
31
|
+
3. 目标命令支持 `--dry-run` 时,用 `--dry-run` 预览危险请求。
|
|
190
32
|
|
|
191
|
-
|
|
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
|
-
|
|
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
|
-
|
|
38
|
+
## Reference 强触发索引
|
|
202
39
|
|
|
203
|
-
|
|
40
|
+
命中任一触发条件时,**MUST 在执行下一步前读取对应 reference**。命中多条时按表中顺序读取,同一reference只读取一次。
|
|
204
41
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
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"`
|