@amaster.ai/pi-lark 0.1.6 → 0.1.7

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 (178) hide show
  1. package/README.md +5 -1
  2. package/dist/config.d.ts +1 -1
  3. package/dist/config.d.ts.map +1 -1
  4. package/dist/config.js +2 -2
  5. package/dist/config.js.map +1 -1
  6. package/dist/index.d.ts.map +1 -1
  7. package/dist/index.js +2 -1
  8. package/dist/index.js.map +1 -1
  9. package/package.json +3 -3
  10. package/skills/lark-apps/SKILL.md +24 -12
  11. package/skills/lark-apps/creative-design/agents/assets/vision-probe.png +0 -0
  12. package/skills/lark-apps/creative-design/agents/fork-verifier-agent.md +71 -0
  13. package/skills/lark-apps/creative-design/agents/vision-probe-agent.md +41 -0
  14. package/skills/lark-apps/creative-design/assets/index.html +27 -0
  15. package/skills/lark-apps/creative-design/creative-design.md +239 -0
  16. package/skills/lark-apps/creative-design/references/aily.md +39 -0
  17. package/skills/lark-apps/creative-design/references/animated-video.md +34 -0
  18. package/skills/lark-apps/creative-design/references/charts.md +165 -0
  19. package/skills/lark-apps/creative-design/references/claude.md +36 -0
  20. package/skills/lark-apps/creative-design/references/codex.md +32 -0
  21. package/skills/lark-apps/creative-design/references/data-report.md +108 -0
  22. package/skills/lark-apps/creative-design/references/frontend-design.md +71 -0
  23. package/skills/lark-apps/creative-design/references/hi-fi-design.md +32 -0
  24. package/skills/lark-apps/creative-design/references/interactive-prototype.md +24 -0
  25. package/skills/lark-apps/creative-design/references/make-a-deck.md +133 -0
  26. package/skills/lark-apps/creative-design/references/visual-exposure.md +82 -0
  27. package/skills/lark-apps/creative-design/references/wireframe.md +14 -0
  28. package/skills/lark-apps/creative-design/starter-components/android-frame.jsx +188 -0
  29. package/skills/lark-apps/creative-design/starter-components/animations.jsx +773 -0
  30. package/skills/lark-apps/creative-design/starter-components/browser-window.jsx +122 -0
  31. package/skills/lark-apps/creative-design/starter-components/deck-stage.js +2483 -0
  32. package/skills/lark-apps/creative-design/starter-components/design-canvas.jsx +1432 -0
  33. package/skills/lark-apps/creative-design/starter-components/ios-frame.jsx +270 -0
  34. package/skills/lark-apps/creative-design/starter-components/macos-window.jsx +197 -0
  35. package/skills/lark-apps/creative-design/starter-components/tweaks-panel.jsx +752 -0
  36. package/skills/lark-apps/references/lark-apps-automation.md +80 -2
  37. package/skills/lark-apps/references/lark-apps-cache.md +61 -0
  38. package/skills/lark-apps/references/lark-apps-cloud-dev.md +0 -1
  39. package/skills/lark-apps/references/lark-apps-create.md +1 -2
  40. package/skills/lark-apps/references/lark-apps-db.md +1 -1
  41. package/skills/lark-apps/references/lark-apps-env-pull.md +1 -1
  42. package/skills/lark-apps/references/lark-apps-file.md +2 -2
  43. package/skills/lark-apps/references/lark-apps-git-credential.md +1 -1
  44. package/skills/lark-apps/references/lark-apps-html-publish.md +4 -8
  45. package/skills/lark-apps/references/lark-apps-init.md +1 -1
  46. package/skills/lark-apps/references/lark-apps-list.md +1 -1
  47. package/skills/lark-apps/references/lark-apps-local-dev.md +54 -11
  48. package/skills/lark-apps/references/lark-apps-openapi-key.md +1 -1
  49. package/skills/lark-apps/references/lark-apps-release-create.md +2 -2
  50. package/skills/lark-apps/references/lark-apps-release-get.md +3 -3
  51. package/skills/lark-base/SKILL.md +20 -13
  52. package/skills/lark-base/references/lark-base-cell-value.md +3 -3
  53. package/skills/lark-base/references/lark-base-data-query.md +11 -4
  54. package/skills/lark-base/references/lark-base-field-create.md +4 -0
  55. package/skills/lark-base/references/lark-base-field-json.md +4 -4
  56. package/skills/lark-base/references/lark-base-field-update.md +17 -1
  57. package/skills/lark-base/references/lark-base-filter-condition.md +179 -0
  58. package/skills/lark-base/references/lark-base-form-questions-create.md +40 -7
  59. package/skills/lark-base/references/lark-base-form-questions-update.md +73 -20
  60. package/skills/lark-base/references/lark-base-form-submit.md +16 -7
  61. package/skills/lark-base/references/lark-base-record-batch-create.md +12 -10
  62. package/skills/lark-base/references/lark-base-record-batch-update.md +11 -9
  63. package/skills/lark-base/references/lark-base-record-upsert.md +1 -1
  64. package/skills/lark-base/references/lark-base-role-guide.md +11 -0
  65. package/skills/lark-base/references/lark-base-view-set-filter.md +11 -137
  66. package/skills/lark-base/references/role-config.md +31 -5
  67. package/skills/lark-calendar/SKILL.md +14 -8
  68. package/skills/lark-calendar/references/lark-calendar-create.md +6 -5
  69. package/skills/lark-calendar/references/lark-calendar-recurring.md +1 -0
  70. package/skills/lark-calendar/references/lark-calendar-room-find.md +2 -1
  71. package/skills/lark-calendar/references/lark-calendar-schedule-clear-time.md +1 -0
  72. package/skills/lark-calendar/references/lark-calendar-suggestion.md +1 -1
  73. package/skills/lark-calendar/references/lark-calendar-update.md +10 -4
  74. package/skills/lark-contact/SKILL.md +19 -3
  75. package/skills/lark-contact/references/lark-contact-search-bot.md +60 -0
  76. package/skills/lark-doc/references/lark-doc-fetch.md +10 -2
  77. package/skills/lark-doc/references/lark-doc-whiteboard.md +9 -8
  78. package/skills/lark-doc/references/lark-doc-xml-extended-blocks.md +41 -0
  79. package/skills/lark-doc/references/lark-doc-xml.md +4 -3
  80. package/skills/lark-drive/SKILL.md +25 -45
  81. package/skills/lark-drive/references/lark-drive-add-comment.md +2 -4
  82. package/skills/lark-drive/references/lark-drive-add-reply.md +47 -0
  83. package/skills/lark-drive/references/lark-drive-apply-permission.md +2 -2
  84. package/skills/lark-drive/references/lark-drive-batch-query-comments.md +46 -0
  85. package/skills/lark-drive/references/lark-drive-comment-content.md +50 -0
  86. package/skills/lark-drive/references/lark-drive-comment-location.md +9 -15
  87. package/skills/lark-drive/references/lark-drive-delete-reply.md +48 -0
  88. package/skills/lark-drive/references/lark-drive-download.md +5 -1
  89. package/skills/lark-drive/references/lark-drive-list-comments.md +25 -68
  90. package/skills/lark-drive/references/lark-drive-list-replies.md +54 -0
  91. package/skills/lark-drive/references/lark-drive-member-add.md +2 -2
  92. package/skills/lark-drive/references/lark-drive-member-list.md +65 -0
  93. package/skills/lark-drive/references/lark-drive-permission-get-setting.md +48 -0
  94. package/skills/lark-drive/references/lark-drive-preview.md +11 -1
  95. package/skills/lark-drive/references/lark-drive-react-reply.md +51 -0
  96. package/skills/lark-drive/references/lark-drive-reactions.md +27 -25
  97. package/skills/lark-drive/references/lark-drive-resolve-comment.md +45 -0
  98. package/skills/lark-drive/references/lark-drive-restore-comment.md +46 -0
  99. package/skills/lark-drive/references/lark-drive-search.md +7 -1
  100. package/skills/lark-drive/references/lark-drive-secure-label.md +1 -1
  101. package/skills/lark-drive/references/lark-drive-update-reply.md +46 -0
  102. package/skills/lark-drive/references/lark-drive-upload.md +1 -0
  103. package/skills/lark-drive/references/lark-drive-workflow-permission-governance-commands.md +38 -8
  104. package/skills/lark-drive/references/lark-drive-workflow-permission-governance-outputs.md +10 -10
  105. package/skills/lark-drive/references/lark-drive-workflow-permission-governance.md +22 -20
  106. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-execute.md +273 -0
  107. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-recall.md +202 -0
  108. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-resolve-verify.md +231 -0
  109. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-review-plan.md +248 -0
  110. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-setup.md +174 -0
  111. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector.md +202 -0
  112. package/skills/lark-drive/references/lark-drive-workflow.md +5 -4
  113. package/skills/lark-event/SKILL.md +1 -0
  114. package/skills/lark-event/references/lark-event-application.md +38 -0
  115. package/skills/lark-im/SKILL.md +1 -1
  116. package/skills/lark-im/references/card/card-2.0-schema.md +1 -1
  117. package/skills/lark-im/references/card/lark-im-card-style.md +4 -4
  118. package/skills/lark-im/references/card/resource/icons.md +14 -0
  119. package/skills/lark-im/references/lark-im-flag-list.md +8 -7
  120. package/skills/lark-okr/SKILL.md +71 -26
  121. package/skills/lark-okr/references/lark-okr-batch-create.md +19 -18
  122. package/skills/lark-okr/references/lark-okr-create.md +173 -0
  123. package/skills/lark-okr/references/lark-okr-cycle-list.md +17 -7
  124. package/skills/lark-okr/references/lark-okr-entities.md +1 -0
  125. package/skills/lark-okr/references/lark-okr-indicator-update.md +3 -1
  126. package/skills/lark-okr/references/lark-okr-indicators.md +61 -12
  127. package/skills/lark-okr/references/lark-okr-progress-list.md +21 -9
  128. package/skills/lark-slides/SKILL.md +115 -68
  129. package/skills/lark-slides/references/asset-planning.md +6 -4
  130. package/skills/lark-slides/references/iconpark.md +2 -2
  131. package/skills/lark-slides/references/lark-slides-create.md +16 -8
  132. package/skills/lark-slides/references/lark-slides-history.md +132 -0
  133. package/skills/lark-slides/references/lark-slides-media-upload.md +2 -3
  134. package/skills/lark-slides/references/lark-slides-pptx-template-workflows.md +7 -11
  135. package/skills/lark-slides/references/lark-slides-replace-slide.md +0 -3
  136. package/skills/lark-slides/references/lark-slides-screenshot.md +4 -4
  137. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-create.md +219 -0
  138. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-delete.md +6 -5
  139. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-get.md +2 -2
  140. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-replace.md +2 -3
  141. package/skills/lark-slides/references/lark-slides-xml-presentations-get.md +65 -30
  142. package/skills/lark-slides/references/planning-layer.md +11 -10
  143. package/skills/lark-slides/references/slides_chart_demo.xml +1416 -1
  144. package/skills/lark-slides/references/slides_xml_schema_definition.xml +492 -76
  145. package/skills/lark-slides/references/troubleshooting.md +25 -7
  146. package/skills/lark-slides/references/validation-checklist.md +53 -16
  147. package/skills/lark-slides/references/visual-planning.md +25 -22
  148. package/skills/lark-slides/references/xml-schema-quick-ref.md +281 -45
  149. package/skills/lark-slides/scripts/sxsd_validator.py +908 -0
  150. package/skills/lark-slides/scripts/xml_text_overlap_lint.py +1650 -165
  151. package/skills/lark-slides/scripts/xml_text_overlap_lint_test.py +3139 -513
  152. package/skills/lark-task/SKILL.md +7 -0
  153. package/skills/lark-task/references/lark-task-complete.md +6 -2
  154. package/skills/lark-task/references/lark-task-create.md +9 -0
  155. package/skills/lark-task/references/lark-task-update.md +6 -2
  156. package/skills/lark-whiteboard/SKILL.md +13 -12
  157. package/skills/lark-whiteboard/elements/layout.md +1 -1
  158. package/skills/lark-whiteboard/elements/schema.md +2 -2
  159. package/skills/lark-whiteboard/references/{lark-whiteboard-query.md → lark-whiteboard-export.md} +15 -15
  160. package/skills/lark-whiteboard/references/lark-whiteboard-update.md +3 -3
  161. package/skills/lark-whiteboard/references/lark-whiteboard-workflow.md +7 -17
  162. package/skills/lark-whiteboard/routes/dsl.md +3 -3
  163. package/skills/lark-whiteboard/routes/mermaid.md +2 -2
  164. package/skills/lark-whiteboard/routes/svg-edit.md +4 -4
  165. package/skills/lark-whiteboard/routes/svg.md +11 -6
  166. package/skills/lark-whiteboard/scenes/bar-chart.md +1 -1
  167. package/skills/lark-whiteboard/scenes/fishbone.md +1 -1
  168. package/skills/lark-whiteboard/scenes/flywheel.md +1 -1
  169. package/skills/lark-whiteboard/scenes/line-chart.md +1 -1
  170. package/skills/lark-whiteboard/scenes/treemap.md +1 -1
  171. package/skills/lark-wiki/SKILL.md +1 -0
  172. package/skills/lark-drive/references/lark-drive-comments-guide.md +0 -80
  173. package/skills/lark-slides/references/examples.md +0 -91
  174. package/skills/lark-slides/references/lark-slides-whiteboard.md +0 -331
  175. package/skills/lark-slides/references/lark-slides-xml-get.md +0 -100
  176. package/skills/lark-slides/references/slide-templates.md +0 -201
  177. package/skills/lark-slides/references/slides_demo.xml +0 -226
  178. package/skills/lark-slides/references/xml-format-guide.md +0 -433
@@ -38,6 +38,13 @@ metadata:
38
38
  > Task OpenAPI 中用于更新/操作任务的 `guid` 是任务的全局唯一标识(GUID),不是客户端展示的任务编号(例如 `t104121` / `suite_entity_num`)。
39
39
  > 对于 Feishu 的任务 applink(例如 `.../client/todo/task?guid=...`),必须使用 URL query 里的 `guid` 参数作为 task guid。
40
40
 
41
+ > **从任务清单定位并修改任务的最短路径**:
42
+ > 1. 已知任务清单 GUID 时直接使用,不要先搜索;已知任务清单 applink 时,取 URL query 中的 `guid` 作为 `tasklist_guid`。
43
+ > 2. 只有清单名称或关键词、没有 GUID/applink 时,才调用一次 `+tasklist-search` 解析目标清单。
44
+ > 3. 按原生 API 规则先执行 `lark-cli schema task.tasklists.tasks`,再执行 `lark-cli task tasklists tasks --params '{"tasklist_guid":"<tasklist_guid>"}' --as user`。
45
+ > 4. 从清单任务结果中取任务的 `guid`,直接传给 `+update` 或 `+complete`;禁止传客户端展示编号(例如 `t104121`)。这两个 shortcut 也可直接接收包含 `guid=` 的任务 applink。
46
+ > 5. `+update` 返回 `updated_fields` 和每个任务的服务端 `confirmed` 字段;`+complete` 返回 `status`、`completed_at`、`already_completed`。这些字段已确认目标状态时,不要例行追加 `tasks get`;仅在服务端未返回所需字段或用户明确要求完整复核时再查询详情。
47
+
41
48
  | Shortcut | 说明 |
42
49
  |----------|------|
43
50
  | [`+create`](references/lark-task-create.md) | create a task |
@@ -9,19 +9,23 @@ Mark a task as completed.
9
9
  ```bash
10
10
  # Complete a task
11
11
  lark-cli task +complete --task-id "<task_guid>"
12
+
13
+ # A task applink is accepted directly; the CLI extracts its guid query value
14
+ lark-cli task +complete --task-id "https://applink.larksuite.com/client/todo/task?guid=<task_guid>"
12
15
  ```
13
16
 
14
17
  ## Parameters
15
18
 
16
19
  | Parameter | Required | Description |
17
20
  |-----------|----------|-------------|
18
- | `--task-id <guid>` | Yes | The task GUID to complete. For Feishu task applinks, use the `guid` query parameter, not the `suite_entity_num` / display task ID like `t104121`. |
21
+ | `--task-id <guid-or-applink>` | Yes | Task OpenAPI GUID or a task applink containing `guid=`. Display task IDs such as `t104121` / `suite_entity_num` are rejected. |
19
22
 
20
23
  ## Workflow
21
24
 
22
25
  1. Confirm the task to complete.
23
26
  2. Execute the command.
24
- 3. Report success.
27
+ 3. Read `data.status`, `data.completed_at`, and `data.already_completed` from the result. `already_completed: true` means the shortcut observed an already-completed task and skipped the PATCH.
28
+ 4. Do not routinely call `task tasks get` when the result already reports `status: done` and a non-zero `completed_at`. Query details only if confirmation fields are absent or the user explicitly asks for a full verification.
25
29
 
26
30
  > [!CAUTION]
27
31
  > This is a **Write Operation** -- You must confirm the user's intent before executing.
@@ -24,6 +24,12 @@ lark-cli task +create \
24
24
  lark-cli task +create \
25
25
  --summary "Buy milk"
26
26
 
27
+ # Create a milestone by passing an API field without a named flag
28
+ lark-cli task +create \
29
+ --summary "Release v2.0" \
30
+ --due "2026-08-15" \
31
+ --data '{"is_milestone":true}'
32
+
27
33
  # Preview the API call without executing
28
34
  lark-cli task +create --summary "Test Task" --dry-run
29
35
  ```
@@ -39,8 +45,11 @@ lark-cli task +create --summary "Test Task" --dry-run
39
45
  | `--due <time>` | No | Due date. Supports ISO 8601, `YYYY-MM-DD`, relative time (e.g., `+2d`), or ms timestamp. `YYYY-MM-DD` and relative time will automatically set it as an all-day task. |
40
46
  | `--tasklist-id <id>` | No | The GUID of the tasklist, or a full AppLink URL (the CLI will automatically extract the `guid` parameter from the URL). |
41
47
  | `--idempotency-key <key>` | No | Client token to ensure idempotency of the request. |
48
+ | `--data <json>` | No | JSON object merged into the task create request for API fields without dedicated flags, such as `{"is_milestone":true}`. Explicit named flags override same-named fields in this object. |
42
49
  | `--dry-run` | No | Preview the API call (JSON payload) without actually creating the task. |
43
50
 
51
+ Use `lark-cli schema task.tasks.create` to confirm that an extra field is supported before passing it through `--data`. Prefer this shortcut over the raw `tasks create` command when `--data` can express the request. Do not assume that other shortcuts support `--data`; check each shortcut's `--help` output first.
52
+
44
53
  ## Workflow
45
54
 
46
55
  1. Confirm with the user: task summary, due date, assignee, and tasklist if necessary.
@@ -13,6 +13,9 @@ lark-cli task +update --task-id "<task_guid>" --summary "New Summary"
13
13
  # Update multiple tasks' due dates
14
14
  lark-cli task +update --task-id "<task_guid>,<another_task_guid>" --due "+2d"
15
15
 
16
+ # A task applink is accepted directly; the CLI extracts its guid query value
17
+ lark-cli task +update --task-id "https://applink.larksuite.com/client/todo/task?guid=<task_guid>" --summary "New Summary"
18
+
16
19
  # Update with JSON data
17
20
  lark-cli task +update --task-id "<task_guid>" --data '{"description": "New description"}'
18
21
  ```
@@ -21,7 +24,7 @@ lark-cli task +update --task-id "<task_guid>" --data '{"description": "New descr
21
24
 
22
25
  | Parameter | Required | Description |
23
26
  |-----------|----------|-------------|
24
- | `--task-id <guid>` | Yes | The task GUID to update. Comma-separated task GUIDs are supported for multiple tasks. For Feishu task applinks, use the `guid` query parameter, not the `suite_entity_num` / display task ID like `t104121`. |
27
+ | `--task-id <guid-or-applink>` | Yes | Task OpenAPI GUID or a task applink containing `guid=`. Comma-separated GUIDs/applinks are supported for multiple tasks. Display task IDs such as `t104121` / `suite_entity_num` are rejected. |
25
28
  | `--summary <text>` | No | New summary/title for the task. |
26
29
  | `--description <text>` | No | New description for the task. |
27
30
  | `--due <time>` | No | New due date (supports relative time). |
@@ -31,7 +34,8 @@ lark-cli task +update --task-id "<task_guid>" --data '{"description": "New descr
31
34
 
32
35
  1. Confirm with the user the tasks to update and the fields.
33
36
  2. Execute `lark-cli task +update --task-id "..." ...`
34
- 3. Report the successful updates.
37
+ 3. Read `data.updated_fields` and `data.tasks[].confirmed` from the result and report only the fields confirmed by the server.
38
+ 4. Do not routinely call `task tasks get` after the update when `confirmed` already contains the required state. Query details only if a required field is absent or the user explicitly asks for a full verification.
35
39
 
36
40
  > [!CAUTION]
37
41
  > This is a **Write Operation** -- You must confirm the user's intent before executing.
@@ -12,7 +12,7 @@ metadata:
12
12
 
13
13
  > [!IMPORTANT]
14
14
  > - 运行 `lark-cli --version`,确认可用,无需询问用户。
15
- > - 运行 `npx -y @larksuite/whiteboard-cli@^0.2.12 -v`,确认可用,无需询问用户。
15
+ > - 运行 `npx -y @larksuite/whiteboard-cli@^0.2.13 -v`,确认可用,无需询问用户。
16
16
 
17
17
  **CRITICAL — 开始前 MUST 先用 Read 工具读取 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md),其中包含认证、权限处理**
18
18
 
@@ -22,21 +22,22 @@ metadata:
22
22
 
23
23
  **身份**:画板操作默认使用 `--as user`。仅当需要以应用身份上传时使用 `--as bot`。
24
24
 
25
- | 用户需求 | 行动 |
26
- |-----------------------------------------|-----------------------------------------------------------------------------------------------|
27
- | 查看画板内容 / 导出图片 / 导出 SVG 矢量图 | [`+query --output_as image/svg`](references/lark-whiteboard-query.md) |
28
- | 获取画板的 Mermaid/PlantUML 代码 | [`+query --output_as code`](references/lark-whiteboard-query.md) |
29
- | 检查画板是否由代码绘制 | [`+query --output_as code`](references/lark-whiteboard-query.md) |
30
- | 仅微调节点文字/颜色 | `+query --output_as raw` → 手动改 JSON → `+update --input_format raw` |
25
+ | 用户需求 | 行动 |
26
+ |-----------------------------------------|---------------------------------------------------------------------------------------------------|
27
+ | 查看画板内容 / 导出图片 | [`+export --output-type preview`](references/lark-whiteboard-export.md) |
28
+ | 导出 SVG 矢量图 | [`+export --output-type svg`](references/lark-whiteboard-export.md) |
29
+ | 获取画板的 Mermaid/PlantUML 代码 | [`+export --output-type source`](references/lark-whiteboard-export.md) |
30
+ | 检查画板是否由代码绘制 | [`+export --output-type source`](references/lark-whiteboard-export.md) |
31
+ | 仅微调节点文字/颜色 | `+export --output-type raw` → 手动改 JSON → `+update --input_format raw` |
31
32
  | 用户**已提供** Mermaid/PlantUML/SVG 代码,或明确指定用该格式 | 自己生成/使用代码 → [`+update --input_format mermaid/plantuml/svg`](references/lark-whiteboard-update.md) |
32
- | 新建/创作复杂图表(架构/流程/组织等) | → **[§ 创作 Workflow](references/lark-whiteboard-workflow.md#创作-workflow)** |
33
- | 修改/重绘已有画板 | → **[§ 修改 Workflow](references/lark-whiteboard-workflow.md#修改-workflow)** |
33
+ | 新建/创作复杂图表(架构/流程/组织等) | → **[§ 创作 Workflow](references/lark-whiteboard-workflow.md#创作-workflow)** |
34
+ | 修改/重绘已有画板 | → **[§ 修改 Workflow](references/lark-whiteboard-workflow.md#修改-workflow)** |
34
35
 
35
36
  ## Shortcuts
36
37
 
37
- | Shortcut | 说明 |
38
- |---|---|
39
- | [`+query`](references/lark-whiteboard-query.md) | 查询画板,导出为预览图片、SVG 矢量图、代码或原始节点结构。 |
38
+ | Shortcut | 说明 |
39
+ |---------------------------------------------------|---|
40
+ | [`+export`](references/lark-whiteboard-export.md) | 导出画板为预览图片、SVG 矢量图、代码或原始节点结构。 |
40
41
  | [`+update`](references/lark-whiteboard-update.md) | 更新画板,支持 PlantUML、Mermaid、SVG 或 OpenAPI 原生格式 |
41
42
 
42
43
  ---
@@ -336,7 +336,7 @@ DSL 的语法是严格白名单,不能写原生 CSS 属性(不支持 `alignS
336
336
  先出骨架图导出坐标,再基于坐标补充连线和注解:
337
337
 
338
338
  ```bash
339
- npx -y @larksuite/whiteboard-cli@^0.2.12 -i skeleton.json -o step1.png -l coords.json
339
+ npx -y @larksuite/whiteboard-cli@^0.2.13 -i skeleton.json -o step1.png -l coords.json
340
340
  ```
341
341
 
342
342
  `coords.json` 包含每个带 id 节点的精确坐标(absX, absY, width, height)。
@@ -272,14 +272,14 @@ SVG 通过 `image/svg+xml` Blob 加载到画布,**不在 HTML DOM 中**,因
272
272
  x?: number; y?: number;
273
273
  width?: WBSizeValue; // 默认 48
274
274
  height?: WBSizeValue; // 默认 48,保持正方形
275
- name: string; // 图标名称,从 npx -y @larksuite/whiteboard-cli@^0.2.12 --icons 输出中选取
275
+ name: string; // 图标名称,从 npx -y @larksuite/whiteboard-cli@^0.2.13 --icons 输出中选取
276
276
  color?: string; // 可选颜色覆盖,hex 格式如 '#FF6600'
277
277
  }
278
278
  ```
279
279
 
280
280
  **获取可用图标**:规划好内容和布局后,运行以下命令查看所有可用图标名,从中选取:
281
281
  ```bash
282
- npx -y @larksuite/whiteboard-cli@^0.2.12 --icons
282
+ npx -y @larksuite/whiteboard-cli@^0.2.13 --icons
283
283
  ```
284
284
 
285
285
  用法:
@@ -1,23 +1,23 @@
1
- # whiteboard +query(查询画板)
1
+ # whiteboard +export(导出画板)
2
2
 
3
3
  > **前置条件:** 先阅读 [`../../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
4
4
 
5
- 查询画板内容,支持导出为预览图片、SVG 矢量图、提取 PlantUML/Mermaid 代码,或获取飞书 OpenAPI 原生画板节点格式。
5
+ 导出画板内容,支持导出为预览图片、SVG 矢量图、提取 PlantUML/Mermaid 代码,或获取飞书 OpenAPI 原生画板节点格式。
6
6
 
7
7
  ## 参数
8
8
 
9
9
  | 参数 | 必填 | 说明 |
10
10
  |----------------------|----|------------------------------------------------------------------------|
11
11
  | `--whiteboard-token` | 是 | 画板 token,需要拥有画板的读权限 |
12
- | `--output_as` | 是 | 输出格式:`image`(预览图片)、`svg`(SVG 矢量图)、`code`(PlantUML/Mermaid 代码)、`raw`(OpenAPI 原生画板节点格式) |
13
- | `--output` | 否 | 输出路径。当 `--output_as image` 时必填;当 `--output_as svg/code/raw` 时可选,不填则直接输出到终端 |
12
+ | `--output-type` | 是 | 输出格式:`preview`(预览图片)、`svg`(SVG 矢量图)、`source`(PlantUML/Mermaid 代码)、`raw`(OpenAPI 原生画板节点格式) |
13
+ | `--output` | 否 | 输出路径。当 `--output-type preview` 时必填,推荐传入无后缀文件路径(如 `./preview`);当 `--output-type svg/source/raw` 时可选,不填则直接输出到终端 |
14
14
  | `--overwrite` | 否 | 覆盖已存在的文件,默认为 false |
15
15
 
16
16
  ## 输出格式
17
17
 
18
- - `image`:预览图片
18
+ - `preview`:预览图片。推荐 `--output ./preview` 这类无后缀文件路径,CLI 会按实际图片类型保存为 `./preview.png` 或 `./preview.jpg`。如果 `--output` 是目录,会保存为该目录下的 `whiteboard_<whiteboard-token>.png/.jpg`;如果显式写了后缀,需要和实际图片类型匹配。`--overwrite` 检查的是补齐后缀后的最终路径,例如返回 PNG 时 `--output ./preview` 对应覆盖 `./preview.png`。
19
19
  - `svg`:导出画板为标准 SVG 矢量图。可用于 SVG 编辑后回写画板(见 [`routes/svg-edit.md`](../routes/svg-edit.md))。注意:导出为纯视觉快照,思维导图层级、表格结构、连接器绑定等语义信息会丢失。
20
- - `code`:PlantUML/Mermaid 代码。仅限画板内有且仅有一个 PlantUML/Mermaid 图时,才可导出代码,否则会在返回值中告知不存在/有多个节点。
20
+ - `source`:PlantUML/Mermaid 代码。仅限画板内有且仅有一个 PlantUML/Mermaid 图时,才可导出代码,否则会在返回值中告知不存在/有多个节点。
21
21
  - `raw`:飞书 OpenAPI 原生画板节点格式。这一 json 格式不适合直接编辑复杂布局或内容,建议仅限于需要修改简单的文本内容/颜色等细节时使用。需要进行更复杂的设计/修改时,建议参考 [§ 渲染 & 写入画板](../SKILL.md#渲染--写入画板)。
22
22
 
23
23
  ## 示例
@@ -25,26 +25,26 @@
25
25
  ### 示例 1:导出画板为预览图片
26
26
 
27
27
  ```bash
28
- lark-cli whiteboard +query \
28
+ lark-cli whiteboard +export \
29
29
  --whiteboard-token "wbcnxxxxxxxx" \
30
- --output_as image \
31
- --output ./preview.png
30
+ --output-type preview \
31
+ --output ./preview
32
32
  ```
33
33
 
34
34
  ### 示例 2:提取画板中的代码并直接输出
35
35
 
36
36
  ```bash
37
- lark-cli whiteboard +query \
37
+ lark-cli whiteboard +export \
38
38
  --whiteboard-token "wbcnxxxxxxxx" \
39
- --output_as code
39
+ --output-type source
40
40
  ```
41
41
 
42
42
  ### 示例 3:导出画板为 SVG 矢量图
43
43
 
44
44
  ```bash
45
- lark-cli whiteboard +query \
45
+ lark-cli whiteboard +export \
46
46
  --whiteboard-token "wbcnxxxxxxxx" \
47
- --output_as svg \
47
+ --output-type svg \
48
48
  --output ./whiteboard.svg \
49
49
  --as user
50
50
  ```
@@ -52,9 +52,9 @@ lark-cli whiteboard +query \
52
52
  ### 示例 4:导出画板原始节点结构到文件
53
53
 
54
54
  ```bash
55
- lark-cli whiteboard +query \
55
+ lark-cli whiteboard +export \
56
56
  --whiteboard-token "wbcnxxxxxxxx" \
57
- --output_as raw \
57
+ --output-type raw \
58
58
  --output ./nodes.json \
59
59
  --overwrite
60
60
  ```
@@ -16,7 +16,7 @@
16
16
  | 参数 | 必填 | 说明 |
17
17
  |----------------------|----|--------------------------------------------|
18
18
  | `--whiteboard-token` | 是 | 画板 token,需要拥有画板的编辑权限 |
19
- | `--idempotent-token` | 否 | 幂等 token,确保更新操作幂等,最小长度 10 个字符 |
19
+ | `--idempotent-token` | 否 | 幂等 token,确保更新操作幂等;最少 10 个字符,建议使用时间戳 + 场景标识拼接(如 `1744800000-board-1`)。同一次逻辑更新只生成一次该 token,重试时须原样复用;切勿在每次重试时重新生成时间戳或幂等 key,否则会重复写入 |
20
20
  | `--overwrite` | 否 | 覆盖更新,在更新前删除所有现有内容,默认为 false |
21
21
  | `--source` | 是 | 输入画板内容,支持使用 `@path` 从文件读取,或 `-` 从 stdin 读取 |
22
22
  | `--input_format` | 否 | 输入格式:`raw`、`plantuml`、`mermaid`、`svg`,默认为 `raw` |
@@ -75,7 +75,7 @@ whiteboard-cli 工具的具体用法请参考 [§ 渲染 & 写入画板](../SKIL
75
75
 
76
76
  ```bash
77
77
  # 使用 whiteboard-cli 生成 OpenAPI 格式并通过管道传递
78
- npx -y @larksuite/whiteboard-cli@^0.2.12 -i <产物文件> --to openapi --format json \
78
+ npx -y @larksuite/whiteboard-cli@^0.2.13 -i <产物文件> --to openapi --format json \
79
79
  | lark-cli whiteboard +update \
80
80
  --whiteboard-token <画板Token> \
81
81
  --source - --input_format raw \
@@ -89,7 +89,7 @@ whiteboard-cli 工具的具体用法请参考 [§ 渲染 & 写入画板](../SKIL
89
89
 
90
90
  ```bash
91
91
  # 生成 OpenAPI 格式到文件
92
- npx -y @larksuite/whiteboard-cli@^0.2.12 -i <DSL 文件> --to openapi --format json -o ./temp.json
92
+ npx -y @larksuite/whiteboard-cli@^0.2.13 -i <DSL 文件> --to openapi --format json -o ./temp.json
93
93
 
94
94
  # 从文件读取并更新
95
95
  lark-cli whiteboard +update \
@@ -26,12 +26,12 @@
26
26
  **Step 2:判断修改策略**
27
27
 
28
28
  ```
29
- +query --output_as code
29
+ +export --output-type source
30
30
  ├─ 返回 Mermaid/PlantUML 代码
31
31
  │ → 在原代码上修改 → +update --input_format mermaid/plantuml
32
32
  ├─ 无代码(SVG/DSL 或其他方式绘制的画板)
33
33
  │ ├─ 需纯新增(思维导图、流程图、时序图、类图、饼图、甘特图)图表节点
34
- │ │ → +query --output_as image → 看图 → +query --output_as raw → 确定新节点坐标和层级 → [§ 渲染 & 写入画板]
34
+ │ │ → +export --output-type preview → 看图 → +export --output-type raw → 确定新节点坐标和层级 → [§ 渲染 & 写入画板]
35
35
  │ └─ 其他改动(几何变动/增删元素/结构调整/混合编辑等)
36
36
  │ → [`../routes/svg-edit.md`](../routes/svg-edit.md)(视觉高保真还原,大部分场景适用)
37
37
  └─ 用户有明确要求 → 以用户要求优先
@@ -79,19 +79,9 @@ diagram.png ← 渲染结果
79
79
 
80
80
  ### 写入画板
81
81
 
82
- > 关于 --overwrite
83
- > 画板更新命令中,若不携带 --overwrite flag,则是增量更新画板内容,若画板内已有内容的话,新增内容可能会和已有内容重叠,导致问题。
84
- > 因此,若需要整体更新画板内容,需携带 --overwrite flag 覆盖式更新。
85
-
86
- ```bash
87
- npx -y @larksuite/whiteboard-cli@^0.2.12 -i <产物文件> --to openapi --format json \
88
- | lark-cli whiteboard +update \
89
- --whiteboard-token <Token> \
90
- --source - --input_format raw \
91
- --idempotent-token <10+字符唯一串> \
92
- --as user \
93
- --overwrite
94
- ```
82
+ 写入画板时按最终产物类型选择 `+update --input_format`:
83
+
84
+ - Mermaid / PlantUML / SVG 产物直接用对应的 `mermaid` / `plantuml` / `svg` 写入。
85
+ - 只有 DSL 产物或已明确需要 OpenAPI 原生节点格式时,才先用 `npx -y @larksuite/whiteboard-cli@^0.2.13 --to openapi --format json` 转换,再用 `raw` 写入。
95
86
 
96
- > `--idempotent-token` 最少 10 字符,建议用时间戳+标识拼接(如 `1744800000-board-1`),避免重试导致重复写入。
97
- > 如需应用身份上传,将 `--as user` 替换为 `--as bot`。
87
+ 具体命令示例、`--overwrite`、`--idempotent-token` 和 `--as user/bot` 的使用方式,统一参考 [`whiteboard +update`](./lark-whiteboard-update.md)。
@@ -13,7 +13,7 @@ Step 1: 路由 & 读取知识
13
13
  Step 2: 生成完整 DSL(含颜色)
14
14
  - 按 content.md 规划信息量和分组
15
15
  - 按 layout.md 选择布局模式和间距
16
- - 推荐使用图标让图表更直观,运行 `npx -y @larksuite/whiteboard-cli@^0.2.12 --icons` 查看可用图标
16
+ - 推荐使用图标让图表更直观,运行 `npx -y @larksuite/whiteboard-cli@^0.2.13 --icons` 查看可用图标
17
17
  - 按 style.md 上色(用户没指定时用默认经典色板)
18
18
  - 按 schema.md 语法输出完整 JSON
19
19
  - 连线参考 connectors.md,排版参考 typography.md
@@ -25,12 +25,12 @@ Step 2: 生成完整 DSL(含颜色)
25
25
 
26
26
  Step 3: 渲染 & 审查 → 交付
27
27
  - 渲染前自查(见下方检查清单)
28
- - 渲染 PNG(仅用于预览验证,不是最终产物):npx -y @larksuite/whiteboard-cli@^0.2.12 -i diagram.json -o diagram.png
28
+ - 渲染 PNG(仅用于预览验证,不是最终产物):npx -y @larksuite/whiteboard-cli@^0.2.13 -i diagram.json -o diagram.png
29
29
  - 检查:信息完整?布局合理?配色协调?文字无截断?连线无交叉?
30
30
  - 有问题 → 按症状表修复 → 重新渲染(最多 2 轮)
31
31
  - 2 轮后仍有严重问题 → 考虑走 Mermaid 路径兜底
32
32
  - 写入画板:用 whiteboard-cli 将 diagram.json 转换为 OpenAPI 格式并 pipe 给 +update:
33
- npx -y @larksuite/whiteboard-cli@^0.2.12 -i diagram.json --to openapi --format json \
33
+ npx -y @larksuite/whiteboard-cli@^0.2.13 -i diagram.json --to openapi --format json \
34
34
  | lark-cli whiteboard +update --whiteboard-token <board_token> \
35
35
  --source - --input_format raw --idempotent-token <时间戳+标识> --as user
36
36
  → 完整 dry-run / 确认流程见 SKILL.md [§ 写入画板](../SKILL.md#写入画板)
@@ -16,10 +16,10 @@ Step 3: 渲染验证 & 写入画板 & 交付
16
16
  1. 创建产物目录 ./diagrams/YYYY-MM-DDTHHMMSS/
17
17
  2. 保存为 diagram.mmd
18
18
  3. 渲染(仅用于预览验证,PNG 不是最终产物):
19
- npx -y @larksuite/whiteboard-cli@^0.2.12 -i diagram.mmd -o diagram.png
19
+ npx -y @larksuite/whiteboard-cli@^0.2.13 -i diagram.mmd -o diagram.png
20
20
  4. 审查 PNG,有问题修改后重新渲染(最多 2 轮)
21
21
  5. 写入画板:用 whiteboard-cli 将 diagram.mmd 转换为 OpenAPI 格式并 pipe 给 +update:
22
- npx -y @larksuite/whiteboard-cli@^0.2.12 -i diagram.mmd --to openapi --format json \
22
+ npx -y @larksuite/whiteboard-cli@^0.2.13 -i diagram.mmd --to openapi --format json \
23
23
  | lark-cli whiteboard +update --whiteboard-token <board_token> \
24
24
  --source - --input_format raw --idempotent-token <时间戳+标识> --as user
25
25
  → 完整 dry-run / 确认流程见 SKILL.md [§ 写入画板](../SKILL.md#写入画板)
@@ -25,9 +25,9 @@ SVG 导出是**纯视觉快照**,再次导入后画板语义(思维导图层
25
25
  ### 1. 导出当前画板 SVG
26
26
 
27
27
  ```bash
28
- lark-cli whiteboard +query \
28
+ lark-cli whiteboard +export \
29
29
  --whiteboard-token <TOKEN> \
30
- --output_as svg \
30
+ --output-type svg \
31
31
  --output <dir>/original.svg \
32
32
  --as user
33
33
  ```
@@ -53,10 +53,10 @@ lark-cli whiteboard +query \
53
53
 
54
54
  ```bash
55
55
  # 渲染 PNG 预览
56
- npx -y @larksuite/whiteboard-cli@^0.2.12 -i <dir>/edited.svg -o <dir>/edited.png -f svg
56
+ npx -y @larksuite/whiteboard-cli@^0.2.13 -i <dir>/edited.svg -o <dir>/edited.png -f svg
57
57
 
58
58
  # 几何检查(text-overflow / node-overlap)
59
- npx -y @larksuite/whiteboard-cli@^0.2.12 -i <dir>/edited.svg -f svg --check
59
+ npx -y @larksuite/whiteboard-cli@^0.2.13 -i <dir>/edited.svg -f svg --check
60
60
  ```
61
61
 
62
62
  结合 PNG 视觉效果和 `--check` 报告进行调整,有问题则修改 SVG 后重新渲染(最多 2 轮)。
@@ -4,6 +4,7 @@
4
4
  最终交付是**画板跨越重排渲染的节点**(你写 SVG → 画板解析)
5
5
 
6
6
  **核心心智纠正 (重要)**:
7
+
7
8
  - 大多数 AI 如果只考虑“绝对不报错/完美映射”, 最终给出的都是全篇纯白底色加单层 `<rect>` 的方正卡片网格, 极其死板单调, **这将被视为不及格!**
8
9
  - **SVG 给你了完全的设计自由**, 请大胆使用你脑内的图标路径 (`<path>`), 连接指引 (`流畅的 <path>`), 各种环境氛围点缀, 大胆一点, 充分信任你的品味, 发挥出你的顶级艺术创造力!
9
10
 
@@ -20,6 +21,7 @@
20
21
  [!IMPORTANT] 布局, 配色, 信息密度, 装饰物——**全部由你判断**, 打破单调的 `<rect>` 牢笼, 严禁通篇用矩形和文字应付用户
21
22
 
22
23
  操作边界约束:
24
+
23
25
  - **语言跟随用户**:图表文字的语言与用户 prompt 保持一致, 技术术语用行业里通用的写法, 不机械翻译
24
26
  - 文字用 `<text>`(不是 `<path>`), 容器宽度留够——画板按 CJK ≈ 1em / Latin ≈ 0.6em 重排
25
27
  - 连线使用正交折线替代斜直线(`<polyline>` 带水平/垂直折点)视觉效果更好
@@ -30,16 +32,16 @@
30
32
  ```
31
33
  建目录 ./diagrams/YYYY-MM-DDTHHMMSS/ (例:./diagrams/2026-04-15T143022/)
32
34
  写文件 <dir>/diagram.svg
33
- 渲染 npx -y @larksuite/whiteboard-cli@^0.2.12 -i <dir>/diagram.svg -o <dir>/diagram.png -f svg
34
- 检查 npx -y @larksuite/whiteboard-cli@^0.2.12 -i <dir>/diagram.svg -f svg --check
35
- 导出 npx -y @larksuite/whiteboard-cli@^0.2.12 -i <dir>/diagram.svg -f svg --to openapi --format json > <dir>/diagram.json
35
+ 渲染 npx -y @larksuite/whiteboard-cli@^0.2.13 -i <dir>/diagram.svg -o <dir>/diagram.png -f svg
36
+ 检查 npx -y @larksuite/whiteboard-cli@^0.2.13 -i <dir>/diagram.svg -f svg --check
37
+ 导出 npx -y @larksuite/whiteboard-cli@^0.2.13 -i <dir>/diagram.svg -f svg --to openapi --format json > <dir>/diagram.json
36
38
  ```
37
39
 
38
- `npx -y @larksuite/whiteboard-cli@^0.2.12 --check` 检测 `text-overflow` 和 `node-overlap`, 并结合视觉效果(查看 PNG)进行调整
40
+ `npx -y @larksuite/whiteboard-cli@^0.2.13 --check` 检测 `text-overflow` 和 `node-overlap`, 并结合视觉效果(查看 PNG)进行调整
39
41
 
40
42
  ## 画板怎么处理 SVG
41
43
 
42
- 画板的 svg-parser 把可识别元素转成可编辑节点, 其余降级为内嵌图片(渲染没问题, 虽然不可编辑, 但是可以正常显示);但 `<radialGradient>` / `<filter>` / `<clipPath>` 等装饰特性画板完全不支持,会导致渲染问题(见下方⚠️)
44
+ 画板的 svg-parser 把可识别元素转成可编辑节点, 其余降级为内嵌图片(渲染没问题, 虽然不可编辑, 但是可以正常显示);但非阴影用途的 `<filter>` / `<clipPath>` 等装饰特性画板不支持(见下方⚠️)
43
45
  **不需要所有元素都可编辑, 但必须避免使用不支持的装饰特性, 且要兼顾可编辑和美观漂亮**
44
46
 
45
47
  **可识别的元素**
@@ -49,6 +51,9 @@
49
51
  - 文本:`<text>` / `<tspan>` 画板硬编码 Noto Sans SC **文字必须用 `<text>`**
50
52
  - 分组:`<g>` / `<a>` / `<use>` 引用 `<symbol>`
51
53
  - 变换:`translate` / `rotate` / `scale` 正常;`skewX` / `skewY` / `matrix(...)` 降级
54
+ - 阴影:`<filter>` 里放 `<feDropShadow>` 或标准 drop/inner primitive 链 (`<feGaussianBlur in="SourceAlpha">` + `<feOffset>` + `<feFlood>` + `<feComposite>` + `<feMerge>`), 会被识别成节点阴影, drop 至多 1 个, inner 至多 1 个; 其余 filter 效果不识别
55
+ - 渐变:`<linearGradient>` / `<radialGradient>` 在 `<defs>` 中定义, 通过 `fill="url(#id)"` 引用 (载体限 `<rect>` / `<circle>` / `<ellipse>` / `<polygon>` / `<path>`), 需要至少 2 个 `<stop>`, `gradientUnits` 只支持默认的 `objectBoundingBox` (不写即可);
52
56
 
53
57
  **⚠️ [!IMPORTANT] 不支持的装饰特性**
54
- - `<radialGradient>` / `<filter>` / `<pattern>` / `<clipPath>` / `<mask>` → 画板都不支持,**请避免使用,否则会导致画板渲染问题**
58
+ - `<pattern>` / `<clipPath>` / `<mask>` / 非阴影用途的 `<filter>` (blur / hue-rotate / 复合合成 / `flood-color=url(...)` / 多个 `<feDropShadow>` 等) → 画板不支持,**请避免使用,否则会导致画板渲染问题**
59
+ - 渐变边界:`gradientUnits="userSpaceOnUse"` / `spreadMethod="reflect|repeat"` / stops 少于 2 个 / 复杂 `gradientTransform` 会变成不可编辑图片, 视觉正确但失去可编辑性, 若无必要请沿用默认 `objectBoundingBox`
@@ -8,7 +8,7 @@
8
8
 
9
9
  ## Layout 选型
10
10
 
11
- - **脚本生成坐标**(推荐):用 .cjs 脚本计算柱体位置和高度,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.12` 渲染
11
+ - **脚本生成坐标**(推荐):用 .cjs 脚本计算柱体位置和高度,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.13` 渲染
12
12
  - **绝对定位手写**:简单柱状图(≤ 5 个柱)可手写坐标
13
13
 
14
14
  ## Layout 规则
@@ -10,7 +10,7 @@
10
10
 
11
11
  ## Layout 选型
12
12
 
13
- - **脚本生成坐标**(必须):用 .cjs 脚本通过三角函数计算鱼骨坐标,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.12` 渲染
13
+ - **脚本生成坐标**(必须):用 .cjs 脚本通过三角函数计算鱼骨坐标,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.13` 渲染
14
14
 
15
15
  ## Layout 规则
16
16
 
@@ -9,7 +9,7 @@
9
9
 
10
10
  ## Layout 选型
11
11
 
12
- - **脚本生成坐标**(必须):用 .cjs 脚本极坐标计算阶段标签位置、SVG 圆环切割,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.12` 渲染
12
+ - **脚本生成坐标**(必须):用 .cjs 脚本极坐标计算阶段标签位置、SVG 圆环切割,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.13` 渲染
13
13
 
14
14
  ## Layout 规则
15
15
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  ## Layout 选型
10
10
 
11
- - **脚本生成坐标**(推荐):用 .cjs 脚本计算数据点坐标和折线路径,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.12` 渲染
11
+ - **脚本生成坐标**(推荐):用 .cjs 脚本计算数据点坐标和折线路径,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.13` 渲染
12
12
 
13
13
  ## Layout 规则
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  ## Layout 选型
10
10
 
11
- - **脚本生成坐标**(推荐):Treemap 需要精确的面积比例计算,用 .cjs 脚本递归切分矩形,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.12` 渲染
11
+ - **脚本生成坐标**(推荐):Treemap 需要精确的面积比例计算,用 .cjs 脚本递归切分矩形,脚本输出 JSON 文件后调用 `npx -y @larksuite/whiteboard-cli@^0.2.13` 渲染
12
12
  - 不适合手动心算坐标
13
13
 
14
14
  ## Layout 规则
@@ -24,6 +24,7 @@ metadata:
24
24
 
25
25
  ## 快速决策
26
26
 
27
+ - 用户要**按特定主题 / 关键词 / 内容线索查找资料并收集到知识库节点或新建知识库节点下**,必须先阅读 [`../lark-drive/references/lark-drive-workflow.md`](../lark-drive/references/lark-drive-workflow.md),再按其中 `Workflow Registry` 进入 [`topic_move_collector`](../lark-drive/references/lark-drive-workflow-topic-move-collector.md) workflow。该 workflow 使用 Drive 全量搜索召回,再按 Wiki 目标解析、确认和移动;不要只用 Wiki 节点列表做局部遍历。
27
28
  - 用户要**整理 / 盘点 / 归类 / 重构知识库、个人文档库、文档库目录或 Wiki 节点结构**,或要生成整理方案、目标目录树、移动计划时,不要只使用 Wiki 节点 API。必须先阅读 [`../lark-drive/references/lark-drive-workflow.md`](../lark-drive/references/lark-drive-workflow.md),再按其中 `Workflow Registry` 进入 [`knowledge_organize`](../lark-drive/references/lark-drive-workflow-knowledge-organize.md) workflow;该 workflow 负责 Drive / Wiki / 个人文档库的统一入口解析、资源盘点、分类计划、写前确认和结果验证。
28
29
  - 用户要把**已有 Wiki 节点移出知识库,放到 Drive 文件夹或“我的空间”根目录**:使用 `wiki +move-to-drive`,不要使用 `wiki +move` 或 `drive +move`。这是会改变节点归属和权限继承的写操作,执行前确认源节点与目标位置。
29
30
  - 用户给的是知识库 URL(`.../wiki/<token>`),且后续要查成员/加成员/删成员:先调用 `lark-cli wiki spaces get_node --params '{"token":"<wiki_token>"}'` 获取 `space_id`,后续成员接口统一使用 `space_id`。
@@ -1,80 +0,0 @@
1
- # Drive 评论查询、统计与回复指南
2
-
3
- > 前置条件:先阅读 [`../SKILL.md`](../SKILL.md) 的“评论能力入口”,添加评论参数细节见 [`lark-drive-add-comment.md`](lark-drive-add-comment.md),获取评论列表优先使用 [`lark-drive-list-comments.md`](lark-drive-list-comments.md),reaction 见 [`lark-drive-reactions.md`](lark-drive-reactions.md)。
4
-
5
- ## 评论模式
6
-
7
- - `drive +add-comment` 支持全文评论和局部评论。
8
- - 全文评论:未传 `--block-id` 时默认启用,也可显式传 `--full-comment`;支持 `docx`、旧版 `doc` URL、白名单扩展名的 Drive file,以及最终解析为 `doc` / `docx` / `file` 的 wiki URL。
9
- - 局部评论:传 `--block-id` 时启用;`docx` 支持文本定位或 block id,`sheet` 支持 `<sheetId>!<cell>`,`slides` 支持 `<slide-block-type>!<xml-id>`,wiki URL 解析到这些类型时也支持对应局部评论。
10
- - Drive file 只支持全文评论,不支持局部评论。支持扩展名:`.md`、`.txt`、`.json`、`.csv`、`.go`、`.js`、`.py`、`.pptx`、`.png`、`.jpg`、`.jpeg`、`.zip`、`.mp3`、`.mp4`。`.pdf`、`.docx`、`.xlsx` 等未在白名单内的普通文件暂不支持。
11
- - Review / 审阅 / 校对 / 逐条指出问题场景优先使用局部评论,不要把多个可定位问题汇总成一条全文评论。
12
- - `drive +add-comment` 的 `--content` 需要传 `reply_elements` JSON 数组字符串,例如 `--content '[{"type":"text","text":"正文"}]'`。
13
- - `slides` 评论要求显式传 `--block-id <slide-block-type>!<xml-id>`;CLI 会将其拆分后写入 `anchor.block_id` 和 `anchor.slide_block_type`。其中 `<xml-id>` 是 PPT XML 协议中的元素 `id`;不支持 `--selection-with-ellipsis` 和 `--full-comment`。
14
- - 评论写入内容里的文本不能直接出现 `<`、`>`;提交前应转义为 `&lt;`、`&gt;`。`drive +add-comment` 会对 `type=text` 文本元素自动兜底转义;直接调用原生评论 API 时需要自行转义。
15
- - 如果 wiki 解析后不是 `doc` / `docx` / `file` / `sheet` / `slides`,不要用 `+add-comment`。
16
-
17
- ## 查询默认口径
18
-
19
- 优先使用 `drive +list-comments`,不要优先手写 `drive file.comments list`。shortcut 默认 `--solved-status false`,即仅查询未解决评论。即使用户说“所有评论”“全部评论”“把评论都列出来”,只要没有明确提到包含已解决评论,仍然按默认口径查询未解决评论;仅当用户明确要求包含已解决评论时,才传 `--solved-status all`。只查已解决评论时传 `--solved-status true`。
20
-
21
- ```bash
22
- # 默认查询:仅未解决评论
23
- lark-cli drive +list-comments --url '<DOC_URL>'
24
-
25
- # 全部评论:包含已解决和未解决
26
- lark-cli drive +list-comments --url '<DOC_URL>' --solved-status all
27
-
28
- # 已解决评论
29
- lark-cli drive +list-comments --url '<DOC_URL>' --solved-status true
30
-
31
- # 裸 wiki token
32
- lark-cli drive +list-comments --token '<WIKI_TOKEN>' --type wiki
33
-
34
- ```
35
-
36
- ## 评论卡片与统计
37
-
38
- - `drive file.comments list` 返回的 `items` 是评论卡片列表,每个 `item` 对应用户界面中的一张评论卡片,不是平铺的互动消息列表。
39
- - 创建第一条评论时会同时创建该卡片里的第一条 reply;真正承载正文的是 `item.reply_list.replies`,其中第一条 reply 在用户视角下就是这张卡片里的“评论本身”。
40
- - 统计“评论数”或“评论卡片数”:统计 `items` 长度;全量统计时对所有分页返回的 `items` 长度累加。
41
- - 统计“回复数”:统计所有 `item.reply_list.replies` 长度之和,再减去 `items` 长度。
42
- - 统计“总互动数”:统计所有 `item.reply_list.replies` 长度之和,包含每张评论卡片里的首条评论。
43
- - 如果 `item.has_more=true`,说明该评论卡片下还有更多回复未包含在当前返回中;需要继续调用 `drive file.comment.replys list` 拉全后,再做全量回复数或总互动数统计。
44
-
45
- ## 排序
46
-
47
- - 只有当用户明确提到“最新评论”“最后评论”“最早评论”时,才需要按 `create_time` 排序。
48
- - 排序前必须拉完所有评论分页,不能只取第一页。
49
- - “最新评论”/“最后评论”:按 `create_time` 降序取第一条。
50
- - “最早评论”:按 `create_time` 升序取第一条。
51
- - 用户只说“第一条评论”时,直接使用 `drive file.comments list` 返回的第一条,不需要额外排序。
52
-
53
- ## 回复限制
54
-
55
- - 回复前先检查目标评论状态。
56
- - `is_whole=true` 的全文评论不支持回复;遇到时提示“全文评论不支持回复”。
57
- - `is_solved=true` 的已解决评论不支持回复;遇到时提示“该评论已被解决,无法回复”。
58
- - 当目标评论不能回复时,只提示限制,不要自动替用户寻找其他可回复评论。
59
-
60
- ## batch_query 与 list
61
-
62
- - `drive file.comments batch_query` 用于已知评论 ID 后的批量查询,需要传入具体评论 ID 列表。
63
- - `drive +list-comments` 用于分页获取评论列表;如果要统计全量评论数、遍历包含已解决评论在内的所有评论、获取全量最新评论或最后 N 条评论,请先传 `--solved-status all` 并拉完所有分页。它会处理 URL、wiki token 和 token/type 匹配问题。
64
- - `drive file.comments list` 是原生命令。需要 shortcut 未暴露的字段时才使用。
65
-
66
- ## 评论定位字段
67
-
68
- - 需要根据评论定位到文档正文位置时(例如根据评论 review 文档、区分多处相同引用文本、把评论落点映射到 `docs +fetch` 的 block),先确认目标是 `file_type=docx`,再阅读 [`lark-drive-comment-location.md`](lark-drive-comment-location.md),并使用 `drive +list-comments --need-relation`。
69
- - `--need-relation` 仅 docx 生效;其他文档类型会静默忽略。
70
-
71
- ## 原生 API
72
-
73
- 需要更底层地直接调用评论 V2 协议时,先查看 schema,再调用原生命令。全文评论省略 `anchor`,局部评论传 `anchor.block_id`。
74
-
75
- ```bash
76
- lark-cli schema drive.file.comments.create_v2
77
- lark-cli drive file.comments create_v2 \
78
- --params '{"file_token":"<DOC_TOKEN>"}' \
79
- --data '{"file_type":"docx","reply_elements":[{"type":"text","text":"全文评论内容"}]}'
80
- ```