mirror of
https://github.com/larksuite/cli.git
synced 2026-07-09 10:29:48 +08:00
docs: clarify pretty vs json format choice by processing depth
This commit is contained in:
@@ -43,7 +43,7 @@ metadata:
|
||||
- 仅对**进行中**会议有效,已结束会议返回 `20001 meeting_status_MEETING_END`。
|
||||
- **不能做会后复盘**,**不能替代参会人快照查询**。已结束会议的发言请用 `vc +notes` 取 `verbatim_doc_token`;参会人快照请用 `vc meeting get --with-participants`(见 [`lark-vc`](../lark-vc/SKILL.md))。
|
||||
4. 默认单页;需要完整事件流用 `--page-all` 或 `--page-limit`。
|
||||
5. 输出格式优先 `--format pretty`(时间线更易读);Agent 程序消费场景才用 `--format json`。
|
||||
5. 输出格式按处理深度选:`--format pretty` 每条事件压成一行 summary(`[event_type] 参会人 X joined`),适合**汇总时间线**;`--format json` 保留完整 payload(open_id、聊天原文、share_doc 等),适合**提取字段做进一步处理**(过滤某类事件、联动其他命令)。
|
||||
6. 保留响应里的 `page_token`,下次增量拉取直接续,不要从头再拉。
|
||||
|
||||
### 3. 离开会议(写操作)
|
||||
|
||||
@@ -83,10 +83,12 @@ lark-cli vc +meeting-events --meeting-id <meeting.id>
|
||||
|
||||
### 5. pretty / json 输出差异
|
||||
|
||||
- `--format pretty`:输出“会议主题 / 会议时间 / 时间线”,适合人读,也是默认推荐格式;在多数会议里,`json` 体积会明显大于 pretty
|
||||
- `--format json`:保留原始 `events` 结构,适合 Agent / 程序消费
|
||||
- `--format pretty`:每条事件输出一行 `event_id / event_time / event_type / summary`;summary 由 shortcut 按 event_type 本地生成(如 `participant X (name) joined`、`speaker X: text`、`share N started: title`),**紧凑易读**,适合**汇总时间线、快速向用户汇报**
|
||||
- `--format json`:保留**完整原始 `events[]` 结构**——参会人 open_id、聊天原文、share_doc token 等都在 `events[].payload` 里,**适合提取字段做进一步处理**(过滤某类事件、联动其他命令)
|
||||
|
||||
> **注意**:pretty 输出中的正文文本会做单行转义,像真实换行会显示为 `\n`,避免打乱时间线布局。
|
||||
**选型**按处理深度:只要告诉用户"发生了什么"→ pretty 够用;要拿具体字段→ json。
|
||||
|
||||
> **注意**:pretty 输出中的正文文本会做单行转义,真实换行会显示为 `\n`,避免打乱时间线布局。
|
||||
|
||||
### 6. 关于 `page_token` 的返回与续拉
|
||||
|
||||
|
||||
Reference in New Issue
Block a user