@thinkingai/ae-cli 6.0.31 → 6.1.4

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 (192) hide show
  1. package/README.md +3 -2
  2. package/README.zh.md +3 -2
  3. package/dist/{capability-SQ2IWKP3.js → capability-QW4AVJHI.js} +1 -1
  4. package/dist/{capability-SEH3JWLN.js → capability-SCRFGODD.js} +1 -1
  5. package/dist/{chunk-N2QORU5D.js → chunk-7OLGDQQ2.js} +5 -2
  6. package/dist/{chunk-TKQJQXWT.js → chunk-TBHBYKXZ.js} +5 -2
  7. package/dist/index.js +51 -24
  8. package/dist/{metadata-X62TKIVK.js → metadata-BFDL6RUK.js} +2 -2
  9. package/dist/{metadata-W6JFFMBA.js → metadata-FCLDBXX2.js} +2 -2
  10. package/dist/{te-analysis-NJGNWZFC.js → te-analysis-PUVF5IF4.js} +1297 -91
  11. package/dist/{te-analysis-YGV5V5EX.js → te-analysis-UJDOKPAN.js} +1297 -91
  12. package/dist/te-common-VUX3VOXZ.js +60 -0
  13. package/dist/te-common-XLAGWNIV.js +60 -0
  14. package/dist/te-engage-K4AEUPK5.js +3894 -0
  15. package/dist/te-engage-QBCCME22.js +3894 -0
  16. package/dist/te-experiment-JINSMHMW.js +606 -0
  17. package/dist/te-experiment-NWNQHJS5.js +606 -0
  18. package/dist/{te-kb-NT33UHAE.js → te-kb-AYCODNU6.js} +56 -17
  19. package/dist/{te-meta-VKWNAWO4.js → te-meta-ARDIW3YI.js} +1 -234
  20. package/dist/{te-meta-MAAUHFQO.js → te-meta-UUROEODR.js} +1 -234
  21. package/package.json +2 -1
  22. package/skills/ae-analysis/SKILL.md +10 -7
  23. package/skills/ae-analysis/references/adhoc_export.md +3 -6
  24. package/skills/ae-analysis/references/adhoc_run.md +5 -9
  25. package/skills/ae-analysis/references/ai_models.md +17 -1
  26. package/skills/ae-analysis/references/analysis_data_retrieval.md +11 -11
  27. package/skills/ae-analysis/references/analysis_drilldown_contract.md +93 -0
  28. package/skills/ae-analysis/references/analysis_gateway_assets.md +9 -8
  29. package/skills/ae-analysis/references/asset_url_get.md +4 -3
  30. package/skills/ae-analysis/references/bi_panel_page_data_export.md +2 -2
  31. package/skills/ae-analysis/references/bi_panel_page_data_run.md +1 -1
  32. package/skills/ae-analysis/references/command_index.md +62 -28
  33. package/skills/ae-analysis/references/create_entity.md +2 -2
  34. package/skills/ae-analysis/references/dashboard_report_data_export.md +2 -2
  35. package/skills/ae-analysis/references/dashboard_report_data_run.md +2 -2
  36. package/skills/ae-analysis/references/drilldown_entities_export.md +26 -0
  37. package/skills/ae-analysis/references/drilldown_entities_run.md +33 -0
  38. package/skills/ae-analysis/references/drilldown_events_export.md +21 -0
  39. package/skills/ae-analysis/references/drilldown_events_run.md +23 -0
  40. package/skills/ae-analysis/references/drilldown_user_events_export.md +6 -3
  41. package/skills/ae-analysis/references/drilldown_user_events_run.md +6 -6
  42. package/skills/ae-analysis/references/entity_detail_export.md +2 -0
  43. package/skills/ae-analysis/references/entity_detail_run.md +8 -1
  44. package/skills/ae-analysis/references/event_detail_export.md +2 -0
  45. package/skills/ae-analysis/references/event_detail_run.md +2 -0
  46. package/skills/ae-analysis/references/event_list.md +10 -2
  47. package/skills/ae-analysis/references/list_entities.md +1 -1
  48. package/skills/ae-analysis/references/metric_create.md +13 -4
  49. package/skills/ae-analysis/references/metric_delete.md +7 -0
  50. package/skills/ae-analysis/references/metric_get.md +6 -0
  51. package/skills/ae-analysis/references/metric_list.md +16 -3
  52. package/skills/ae-analysis/references/metric_update.md +12 -1
  53. package/skills/ae-analysis/references/project_access_detail_get.md +23 -0
  54. package/skills/ae-analysis/references/project_data_power_delete.md +26 -0
  55. package/skills/ae-analysis/references/project_data_power_get.md +24 -0
  56. package/skills/ae-analysis/references/project_data_power_list.md +23 -0
  57. package/skills/ae-analysis/references/project_data_power_upsert.md +24 -0
  58. package/skills/ae-analysis/references/project_entity_create.md +27 -0
  59. package/skills/ae-analysis/references/project_entity_delete.md +25 -0
  60. package/skills/ae-analysis/references/project_entity_event_list.md +24 -0
  61. package/skills/ae-analysis/references/project_entity_get.md +24 -0
  62. package/skills/ae-analysis/references/project_entity_list.md +28 -0
  63. package/skills/ae-analysis/references/project_entity_update.md +28 -0
  64. package/skills/ae-analysis/references/project_function_list.md +24 -0
  65. package/skills/ae-analysis/references/project_info_get.md +23 -0
  66. package/skills/ae-analysis/references/project_info_list.md +26 -0
  67. package/skills/ae-analysis/references/project_info_update.md +25 -0
  68. package/skills/ae-analysis/references/project_mark_time_create.md +27 -0
  69. package/skills/ae-analysis/references/project_mark_time_delete.md +25 -0
  70. package/skills/ae-analysis/references/project_mark_time_list.md +28 -0
  71. package/skills/ae-analysis/references/project_mark_time_update.md +28 -0
  72. package/skills/ae-analysis/references/project_member_add.md +25 -0
  73. package/skills/ae-analysis/references/project_member_batch_update.md +24 -0
  74. package/skills/ae-analysis/references/project_member_candidate_list.md +25 -0
  75. package/skills/ae-analysis/references/project_member_handover_export.md +27 -0
  76. package/skills/ae-analysis/references/project_member_handover_run.md +24 -0
  77. package/skills/ae-analysis/references/project_member_import.md +25 -0
  78. package/skills/ae-analysis/references/project_member_list.md +23 -0
  79. package/skills/ae-analysis/references/project_member_receiver_list.md +23 -0
  80. package/skills/ae-analysis/references/project_member_remove.md +26 -0
  81. package/skills/ae-analysis/references/project_member_update.md +25 -0
  82. package/skills/ae-analysis/references/project_owner_update.md +27 -0
  83. package/skills/ae-analysis/references/project_permission_binding_list.md +24 -0
  84. package/skills/ae-analysis/references/project_receive_status_update.md +25 -0
  85. package/skills/ae-analysis/references/project_role_delete.md +25 -0
  86. package/skills/ae-analysis/references/project_role_function_list.md +27 -0
  87. package/skills/ae-analysis/references/project_role_get.md +23 -0
  88. package/skills/ae-analysis/references/project_role_list.md +25 -0
  89. package/skills/ae-analysis/references/project_role_upsert.md +24 -0
  90. package/skills/ae-analysis/references/project_role_user_list.md +23 -0
  91. package/skills/ae-analysis/references/project_timezone_get.md +23 -0
  92. package/skills/ae-analysis/references/project_timezone_overview.md +23 -0
  93. package/skills/ae-analysis/references/project_timezone_update.md +25 -0
  94. package/skills/ae-analysis/references/project_user_id_items_update.md +24 -0
  95. package/skills/ae-analysis/references/property_list.md +21 -6
  96. package/skills/ae-analysis/references/public_link_create.md +1 -1
  97. package/skills/ae-analysis/references/query_create_result_cluster.md +14 -32
  98. package/skills/ae-analysis/references/report_create.md +1 -1
  99. package/skills/ae-analysis/references/report_data_export.md +2 -2
  100. package/skills/ae-analysis/references/report_data_run.md +2 -2
  101. package/skills/ae-analysis/references/report_get.md +2 -0
  102. package/skills/ae-analysis/references/report_update.md +1 -1
  103. package/skills/ae-analysis/references/user_cluster_create.md +3 -1
  104. package/skills/ae-analysis/references/user_cluster_get.md +4 -0
  105. package/skills/ae-analysis/references/user_cluster_refresh.md +4 -2
  106. package/skills/ae-analysis/references/user_cluster_update.md +3 -1
  107. package/skills/ae-analysis/references/user_tag_create.md +3 -1
  108. package/skills/ae-analysis/references/user_tag_get.md +4 -0
  109. package/skills/ae-analysis/references/user_tag_refresh.md +4 -2
  110. package/skills/ae-analysis/references/user_tag_update.md +3 -1
  111. package/skills/ae-analysis/references/virtual_event_create.md +22 -3
  112. package/skills/ae-analysis/references/virtual_property_create.md +23 -2
  113. package/skills/ae-engage/SKILL.md +202 -7
  114. package/skills/ae-engage/references/activity-activity-type.md +42 -0
  115. package/skills/ae-engage/references/activity-activity.md +70 -0
  116. package/skills/ae-engage/references/activity-approval.md +53 -0
  117. package/skills/ae-engage/references/activity-task.md +87 -0
  118. package/skills/ae-engage/references/activity-topic.md +98 -0
  119. package/skills/ae-engage/references/approval-approver-delete.md +26 -0
  120. package/skills/ae-engage/references/channel-test-send.md +37 -0
  121. package/skills/ae-engage/references/channel-touch-limits-batch-update.md +28 -0
  122. package/skills/ae-engage/references/channel-touch-limits-save.md +37 -0
  123. package/skills/ae-engage/references/channel-touch-limits-toggle.md +28 -0
  124. package/skills/ae-engage/references/channel-update-config.md +36 -0
  125. package/skills/ae-engage/references/client-param.md +58 -0
  126. package/skills/ae-engage/references/common-metric.md +75 -0
  127. package/skills/ae-engage/references/config-table.md +92 -0
  128. package/skills/ae-engage/references/engage-scene-config-item.md +69 -0
  129. package/skills/ae-engage/references/operation-log-query.md +1 -1
  130. package/skills/ae-engage/references/preset-event.md +42 -0
  131. package/skills/ae-engage/references/push-language.md +39 -0
  132. package/skills/ae-engage/references/scene-config-channel.md +58 -0
  133. package/skills/ae-engage/references/scene-config-group.md +62 -0
  134. package/skills/ae-engage/references/scene-config-item.md +68 -0
  135. package/skills/ae-engage/references/scene-config-metric.md +79 -0
  136. package/skills/ae-engage/references/scene-config-param.md +72 -0
  137. package/skills/ae-engage/references/scene-preset-metric.md +45 -0
  138. package/skills/ae-engage/references/scene-strategy.md +47 -0
  139. package/skills/ae-engage/references/scene-template.md +71 -0
  140. package/skills/ae-engage/references/{ops-delete.md → task-delete.md} +3 -3
  141. package/skills/ae-engage/references/whitelist.md +72 -0
  142. package/skills/ae-engage/references/workbench-workbench.md +48 -0
  143. package/skills/ae-experiment/SKILL.md +64 -0
  144. package/skills/ae-experiment/references/batch_delete_experiment.md +11 -0
  145. package/skills/ae-experiment/references/batch_delete_feature.md +11 -0
  146. package/skills/ae-experiment/references/batch_delete_traffic_layer.md +11 -0
  147. package/skills/ae-experiment/references/cancel_experiment_query_by_request_id.md +10 -0
  148. package/skills/ae-experiment/references/check_experiment_ready.md +13 -0
  149. package/skills/ae-experiment/references/delete_metric.md +11 -0
  150. package/skills/ae-experiment/references/manage_experiment.md +15 -0
  151. package/skills/ae-experiment/references/manage_feature_status.md +11 -0
  152. package/skills/ae-experiment/references/query_bucket_list.md +10 -0
  153. package/skills/ae-experiment/references/query_experiment_detail.md +11 -0
  154. package/skills/ae-experiment/references/query_experiment_list.md +10 -0
  155. package/skills/ae-experiment/references/query_experiment_metric_trend.md +16 -0
  156. package/skills/ae-experiment/references/query_experiment_report_summary.md +12 -0
  157. package/skills/ae-experiment/references/query_experiment_sample_size_report.md +16 -0
  158. package/skills/ae-experiment/references/query_feature_detail.md +12 -0
  159. package/skills/ae-experiment/references/query_feature_list.md +10 -0
  160. package/skills/ae-experiment/references/query_metric_detail.md +11 -0
  161. package/skills/ae-experiment/references/query_metric_list.md +10 -0
  162. package/skills/ae-experiment/references/query_traffic_layer_detail.md +11 -0
  163. package/skills/ae-experiment/references/query_traffic_layer_list.md +10 -0
  164. package/skills/ae-experiment/references/save_experiment.md +17 -0
  165. package/skills/ae-experiment/references/save_feature.md +13 -0
  166. package/skills/ae-experiment/references/save_metric.md +13 -0
  167. package/skills/ae-experiment/references/save_submit_experiment.md +13 -0
  168. package/skills/ae-experiment/references/save_traffic_layer.md +13 -0
  169. package/skills/ae-generate-tracking-plan/SKILL.md +8 -5
  170. package/skills/ae-generate-tracking-plan/references/te-api.md +1 -1
  171. package/skills/ae-kb/SKILL.md +34 -8
  172. package/skills/ae-metadata/SKILL.md +1 -1
  173. package/skills/ae-metadata/references/metadata_event_get.md +4 -4
  174. package/skills/ae-metadata/references/metadata_property_dimension_table_bind_existing.md +1 -1
  175. package/skills/ae-metadata/references/metadata_property_get.md +4 -4
  176. package/dist/te-common-5NJLF3XG.js +0 -130
  177. package/dist/te-common-7VTJZPII.js +0 -130
  178. package/dist/te-engage-BUWVSSSK.js +0 -1912
  179. package/dist/te-engage-EPE3QKDE.js +0 -1912
  180. package/skills/ae-analysis/references/create_metric.md +0 -58
  181. package/skills/ae-analysis/references/create_virtual_event.md +0 -60
  182. package/skills/ae-analysis/references/create_virtual_property.md +0 -69
  183. package/skills/ae-analysis/references/delete_metric.md +0 -32
  184. package/skills/ae-analysis/references/drilldown_users_export.md +0 -17
  185. package/skills/ae-analysis/references/drilldown_users_run.md +0 -61
  186. package/skills/ae-analysis/references/get_metric.md +0 -38
  187. package/skills/ae-analysis/references/get_resource_url.md +0 -33
  188. package/skills/ae-analysis/references/list_events.md +0 -46
  189. package/skills/ae-analysis/references/list_metrics.md +0 -52
  190. package/skills/ae-analysis/references/list_properties.md +0 -47
  191. package/skills/ae-analysis/references/update_metric.md +0 -58
  192. package/dist/{chunk-HL2AJQ4Q.js → chunk-PTE56QPL.js} +3 -3
@@ -0,0 +1,37 @@
1
+ # engage-setting channel test-send
2
+
3
+ > Capability id: `engage-setting.channel.test-send` · Domain: `engage`.
4
+
5
+ ## Command
6
+
7
+ ```bash
8
+ ae-cli engage-setting channel test-send \
9
+ --project-id <project_id> --channel-id <channel_id> --push-id <send_id> \
10
+ --content-list '[{"key":"title","value":"hello"}]' \
11
+ [--user-params-list '<json_array>'] [--push-environment dev|pro] \
12
+ [--mock-push] [--channel-template-id <id>]
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Required | Description |
18
+ |---|---|---|
19
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
20
+ | `--channel-id` | Yes | Channel ID to test. |
21
+ | `--push-id` | Yes | Recipient send ID (e.g. a test device id). |
22
+ | `--content-list` | Yes | JSON array of key/value content pairs, e.g. `[{"key":"title","value":"hello"}]`. |
23
+ | `--user-params-list` | No | JSON array of custom user params for the test push. |
24
+ | `--push-environment` | No | Push environment: `dev` or `pro`. |
25
+ | `--mock-push` | No | Mock the push (build request only, do not send). |
26
+ | `--channel-template-id` | No | WeChat channel template ID. |
27
+
28
+ ## Output
29
+
30
+ - `data.push_succeeded`: whether the test push succeeded.
31
+
32
+ ## Decision Rules
33
+
34
+ - Use this command when the user asks to send a test message to a channel / verify channel delivery.
35
+ - Discover the real channel id with `ae-cli engage +channel_list` first; never invent a channel id.
36
+ - `--mock-push` is useful to inspect the request body/headers without actually delivering a message.
37
+ - Risk is `write`; sending a real test push to a recipient is a write action.
@@ -0,0 +1,28 @@
1
+ # engage-setting channel-touch-limits batch-update
2
+
3
+ > Capability id: `engage-setting.channel-touch-limits.batch-update` · Domain: `engage`.
4
+
5
+ ## Command
6
+
7
+ ```bash
8
+ ae-cli engage-setting channel-touch-limits batch-update \
9
+ --project-id <project_id> \
10
+ --items '[{"rule_id":"r1","enable":true,"rule_def":"[]"},{"rule_id":"r2","enable":false,"rule_def":"[]"}]'
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Required | Description |
16
+ |---|---|---|
17
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
18
+ | `--items` | Yes | JSON array of rule updates. Each item: `rule_id`, `enable` (boolean), `rule_def` (rule definition JSON string). |
19
+
20
+ ## Output
21
+
22
+ - `data.success`: whether the batch update succeeded.
23
+
24
+ ## Decision Rules
25
+
26
+ - Use this command when the user asks to batch edit/update multiple touch-limit (fatigue-control) rules at once.
27
+ - Discover existing rule IDs with `ae-cli engage-setting channel-touch-limits list --project-id <project_id>` first; never invent rule IDs.
28
+ - Risk is `write`; ordinary update, no confirmation gate.
@@ -0,0 +1,37 @@
1
+ # engage-setting channel-touch-limits save
2
+
3
+ > Capability id: `engage-setting.channel-touch-limits.save` · Domain: `engage`.
4
+
5
+ ## Command
6
+
7
+ ```bash
8
+ # Create a new touch-limit rule (omit --rule-id)
9
+ ae-cli engage-setting channel-touch-limits save \
10
+ --project-id <project_id> --channel-biz-type <biz_type> \
11
+ --rule-def '<rule_def_json>' --enable true
12
+
13
+ # Update an existing touch-limit rule (provide --rule-id)
14
+ ae-cli engage-setting channel-touch-limits save \
15
+ --project-id <project_id> --channel-biz-type <biz_type> \
16
+ --rule-def '<rule_def_json>' --enable false --rule-id <rule_id>
17
+ ```
18
+
19
+ ## Parameters
20
+
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
24
+ | `--channel-biz-type` | Yes | Channel business type the rule belongs to. |
25
+ | `--rule-def` | Yes | Touch-limit rule definition (JSON string, see ChannelTouchLimitRuleDTO). |
26
+ | `--enable` | Yes | Whether the touch-limit rule is enabled. |
27
+ | `--rule-id` | No | Existing rule ID. When omitted a new rule is created. |
28
+
29
+ ## Output
30
+
31
+ - `data.success`: whether the save succeeded.
32
+
33
+ ## Decision Rules
34
+
35
+ - Use this command when the user asks to create or update a single touch-limit (fatigue-control) rule.
36
+ - For updates, discover the real rule ID with `ae-cli engage-setting channel-touch-limits list --project-id <project_id>` first.
37
+ - Risk is `write`; ordinary write, no confirmation gate.
@@ -0,0 +1,28 @@
1
+ # engage-setting channel-touch-limits toggle
2
+
3
+ > Capability id: `engage-setting.channel-touch-limits.toggle` · Domain: `engage`.
4
+
5
+ ## Command
6
+
7
+ ```bash
8
+ ae-cli engage-setting channel-touch-limits toggle \
9
+ --project-id <project_id> --rule-id <rule_id> --enable <true|false>
10
+ ```
11
+
12
+ ## Parameters
13
+
14
+ | Parameter | Required | Description |
15
+ |---|---|---|
16
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
17
+ | `--rule-id` | Yes | Touch-limit rule ID to enable/disable. |
18
+ | `--enable` | Yes | Whether the touch-limit rule is enabled. |
19
+
20
+ ## Output
21
+
22
+ - `data.success`: whether the toggle succeeded.
23
+
24
+ ## Decision Rules
25
+
26
+ - Use this command when the user asks to enable or disable a single touch-limit (fatigue-control) rule.
27
+ - Discover the real rule ID with `ae-cli engage-setting channel-touch-limits list --project-id <project_id>` first.
28
+ - Risk is `write`; ordinary update, no confirmation gate.
@@ -0,0 +1,36 @@
1
+ # engage-setting channel update-config
2
+
3
+ > Capability id: `engage-setting.channel.update-config` · Domain: `engage`.
4
+
5
+ ## Command
6
+
7
+ ```bash
8
+ ae-cli engage-setting channel update-config \
9
+ --project-id <project_id> --channel-id <channel_id> --enable-touch-event <0|1> \
10
+ [--channel-name <name>] [--push-id-type <prop>] [--config '<json_string>'] \
11
+ [--touch-event-source <src>] [--event-delivery-name <name>] [--event-click-name <name>]
12
+ ```
13
+
14
+ ## Parameters
15
+
16
+ | Parameter | Required | Description |
17
+ |---|---|---|
18
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
19
+ | `--channel-id` | Yes | Channel ID to update. |
20
+ | `--enable-touch-event` | Yes | Reach funnel toggle: `1` enabled, `0` disabled. |
21
+ | `--channel-name` | No | New channel name. |
22
+ | `--push-id-type` | No | User property used as the push ID. |
23
+ | `--config` | No | Channel-specific JSON config string (see ChannelConfigDTO). |
24
+ | `--touch-event-source` | No | Reach event source. |
25
+ | `--event-delivery-name` | No | Actual delivery event name. |
26
+ | `--event-click-name` | No | Click event name. |
27
+
28
+ ## Output
29
+
30
+ - `data.success`: whether the channel config was updated.
31
+
32
+ ## Decision Rules
33
+
34
+ - Use this command when the user asks to edit/update an existing channel's name, config, push-id type, or reach-funnel settings.
35
+ - `--config` is the channel-specific JSON config; discover the existing config with `ae-cli engage +channel_detail` first rather than inventing it.
36
+ - Risk is `write`; ordinary update, no confirmation gate.
@@ -0,0 +1,58 @@
1
+ # engage-setting client-param
2
+
3
+ > Capability ids: `engage-setting.client-param.{update,delete,list}` · Domain: `engage`. (`create` temporarily disabled in CLI.)
4
+
5
+ ## Commands
6
+
7
+ ```bash
8
+ # Update a custom client param
9
+ ae-cli engage-setting client-param update \
10
+ --project-id <project_id> --column-name <name> --column-type <type> --select-type <select> \
11
+ [--column-desc <desc>]
12
+
13
+ # Delete a custom client param (high-risk)
14
+ ae-cli engage-setting client-param delete --project-id <project_id> --column-name <name> --yes
15
+
16
+ # List custom client params
17
+ ae-cli engage-setting client-param list --project-id <project_id>
18
+ ```
19
+
20
+ ## Parameters
21
+
22
+ ### update
23
+
24
+ | Parameter | Required | Description |
25
+ |---|---|---|
26
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
27
+ | `--column-name` | Yes | Client param column name. |
28
+ | `--column-type` | Yes | Column type (see ColumnTypeEnum). |
29
+ | `--select-type` | Yes | Select type (see SelectTypeEnum). |
30
+ | `--column-source` | No | Param source: preset or custom. |
31
+ | `--column-desc` | No | Display name of the param. Defaults to an empty string. |
32
+ | `--column-remark` | No | Description/remark for the param. |
33
+ | `--alternative-val` | No | JSON array of alternative values. |
34
+ | `--system-id-param` | No | Whether this is a system identifier param. |
35
+
36
+ ### delete
37
+
38
+ | Parameter | Required | Description |
39
+ |---|---|---|
40
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
41
+ | `--column-name` | Yes | Client param column name to delete. |
42
+
43
+ ### list
44
+
45
+ | Parameter | Required | Description |
46
+ |---|---|---|
47
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
48
+
49
+ ## Output
50
+
51
+ - `update`: `data.success` — whether the operation succeeded.
52
+ - `delete`: `data.success` and `data.task_list` (tasks still referencing the param, which block deletion; each item has `task_id`, `task_name`).
53
+ - `list`: `data.items` (each with `column_name`, `column_type`, `select_type`, `column_source`, `column_desc`, `column_remark`, `alternative_val`, `system_id_param`) and `data.total`.
54
+
55
+ ## Decision Rules
56
+
57
+ - Use these commands when the user asks to manage custom client params (客户端参数).
58
+ - `delete` is `high-risk-write` and requires `--yes` (or interactive confirmation). When `data.success` is false, `data.task_list` lists tasks that still reference the param — report them instead of forcing deletion.
@@ -0,0 +1,75 @@
1
+ # engage-setting common-metric
2
+
3
+ > Capability ids: `engage-setting.common-metric.{list,get,update,delete}` · Domain: `engage`. (`create` temporarily disabled in CLI.)
4
+
5
+ ## Commands
6
+
7
+ ```bash
8
+ # List common metrics
9
+ ae-cli engage-setting common-metric list --project-id <project_id>
10
+
11
+ # Get a common metric detail
12
+ ae-cli engage-setting common-metric get --project-id <project_id> --metric-name <name>
13
+
14
+ # Update a common metric
15
+ ae-cli engage-setting common-metric update \
16
+ --project-id <project_id> --metric-type <type> --metric-name <name> --metric-qp <qp> \
17
+ --metric-window-num <num> --metric-window-time-unit DAY --display-name <display>
18
+
19
+ # Delete a common metric (high-risk)
20
+ ae-cli engage-setting common-metric delete --project-id <project_id> --metric-name <name> --yes
21
+ ```
22
+
23
+ ## Parameters
24
+
25
+ ### list
26
+
27
+ | Parameter | Required | Description |
28
+ |---|---|---|
29
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
30
+
31
+ ### get / delete
32
+
33
+ | Parameter | Required | Description |
34
+ |---|---|---|
35
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
36
+ | `--metric-name` | Yes | Metric name. |
37
+
38
+ ### update
39
+
40
+ | Parameter | Required | Description |
41
+ |---|---|---|
42
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
43
+ | `--metric-type` | Yes | Metric type (see MetricTypeEunm). |
44
+ | `--metric-name` | Yes | Metric name. |
45
+ | `--metric-qp` | Yes | Metric qp (event/property expression). |
46
+ | `--metric-window-num` | Yes | Metric window number. |
47
+ | `--metric-window-time-unit` | Yes | Metric window time unit (MINUTE/HOUR/DAY). |
48
+ | `--display-name` | Yes | Display name of the metric. |
49
+ | `--note` | No | Metric note/remark. |
50
+ | `--order-id` | No | Sort order id. |
51
+ | `--metric-setting-id` | No | Metric setting id (when binding to a setting). |
52
+ | `--metric-params` | No | Metric params JSON string. |
53
+
54
+ ## Output
55
+
56
+ - `list`: `data.items` (each with `project_id`, `metric_type`, `metric_name`, `metric_qp`, `metric_window_num`, `metric_window_time_unit`, `note`, `last_editer`, `last_update_time`, `order_id`, `display_name`, `metric_setting_id`, `metric_params`) and `data.total`.
57
+ - `get`: `data.metric` — a single metric object with the same fields, or `null`.
58
+ - `update` / `delete`: `data.success`.
59
+
60
+ ## Preflight for config-metric batch-add
61
+
62
+ `engage-scene config-metric batch-add --ta-metric-ids` requires TA common metrics to exist in the project. List them first:
63
+
64
+ ```bash
65
+ ae-cli engage-setting common-metric list --project-id <project_id>
66
+ ```
67
+
68
+ If `items` is empty, common metrics must be created in the Engage console before binding them to a config item, or treat the case as environment-blocked.
69
+
70
+ ## Decision Rules
71
+
72
+ - Use these commands when the user asks to manage common metrics (常用指标) for the analysis workbench.
73
+ - Discover existing metric names with `common-metric list` first; never invent names for `get`/`update`/`delete`.
74
+ - `--metric-qp` must be a complete metric QP expression; do not pass `{}` as a placeholder.
75
+ - `delete` is `high-risk-write` and requires `--yes` (or interactive confirmation).
@@ -0,0 +1,92 @@
1
+ # engage-setting config-table
2
+
3
+ > Capability ids: `engage-setting.config-table.{upload,save,list,query-data,update-data,delete}` · Domain: `engage`.
4
+
5
+ ## Commands
6
+
7
+ ```bash
8
+ # 1. Upload and parse a config table file (base64 content) → caches rows under request-id
9
+ ae-cli engage-setting config-table upload \
10
+ --project-id <project_id> --request-id <request_id> --file-name data.csv \
11
+ --file-content "$(base64 -i data.csv)"
12
+
13
+ # 2. Persist the parsed rows as a new config table
14
+ ae-cli engage-setting config-table save \
15
+ --project-id <project_id> --request-id <request_id> --info-name <table_name>
16
+
17
+ # List config tables
18
+ ae-cli engage-setting config-table list --project-id <project_id>
19
+
20
+ # Query rows of a config table
21
+ ae-cli engage-setting config-table query-data --project-id <project_id> --info-id <info_id>
22
+
23
+ # Replace an existing config table's data with a freshly uploaded file
24
+ ae-cli engage-setting config-table update-data \
25
+ --project-id <project_id> --request-id <request_id> --info-name <table_name> --info-id <info_id>
26
+
27
+ # Delete a config table and its data (high-risk)
28
+ ae-cli engage-setting config-table delete --project-id <project_id> --info-id <info_id> --yes
29
+ ```
30
+
31
+ ## Parameters
32
+
33
+ ### upload
34
+
35
+ | Parameter | Required | Description |
36
+ |---|---|---|
37
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
38
+ | `--request-id` | Yes | Client-supplied request id used to cache parsed rows for the subsequent save/update-data. |
39
+ | `--file-name` | Yes | Original file name including extension (.csv/.xlsx). |
40
+ | `--file-content` | Yes | Base64-encoded file content. |
41
+
42
+ ### save
43
+
44
+ | Parameter | Required | Description |
45
+ |---|---|---|
46
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
47
+ | `--request-id` | Yes | Request id returned by a prior upload. |
48
+ | `--info-name` | Yes | Config table name. |
49
+
50
+ ### list
51
+
52
+ | Parameter | Required | Description |
53
+ |---|---|---|
54
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
55
+
56
+ ### query-data
57
+
58
+ | Parameter | Required | Description |
59
+ |---|---|---|
60
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
61
+ | `--info-id` | Yes | Config table ID. |
62
+
63
+ ### update-data
64
+
65
+ | Parameter | Required | Description |
66
+ |---|---|---|
67
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
68
+ | `--request-id` | Yes | Request id returned by a prior upload. |
69
+ | `--info-name` | Yes | Config table name. |
70
+ | `--info-id` | Yes | Config table ID to update. |
71
+
72
+ ### delete
73
+
74
+ | Parameter | Required | Description |
75
+ |---|---|---|
76
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
77
+ | `--info-id` | Yes | Config table ID to delete. |
78
+
79
+ ## Output
80
+
81
+ - `upload`: `data.file_name`, `data.data_num` (parsed row count), `data.data_list` (preview of up to 10 rows, each with `data_key`, `data_value`).
82
+ - `save`: `data.info_id` — created config table ID.
83
+ - `list`: `data.items` (each with `id`, `project_id`, `info_id`, `info_name`, `creator_open_id`, `login_name`, `create_time`, `update_time`) and `data.total`.
84
+ - `query-data`: `data.items` (each with `project_id`, `info_id`, `data_key`, `data_value`) and `data.total`.
85
+ - `update-data` / `delete`: `data.success`.
86
+
87
+ ## Decision Rules
88
+
89
+ - Creating or replacing a config table is a two-step flow: `upload` (parse + cache by `request-id`) then `save` (new table) or `update-data` (replace existing). Always use a fresh `--request-id` per upload.
90
+ - The upload cache is keyed by `project-id` + `request-id`, expires after 10 minutes, and is consumed after a successful `save` or `update-data`.
91
+ - Discover existing `info_id` values with `config-table list` first; never invent them.
92
+ - `delete` is `high-risk-write` and requires `--yes` (or interactive confirmation).
@@ -0,0 +1,69 @@
1
+ # engage-scene config-item
2
+
3
+ > Capability ids: `engage-scene.config-item.{list,create,update}` · Domain: `engage`.
4
+
5
+ `config-item` 是配置中心(场景管理)里的配置项。create 走 multipart,可携带可选头像文件。
6
+
7
+ ## Commands
8
+
9
+ ```bash
10
+ # List config items of a project
11
+ ae-cli engage-scene config-item list --project-id <project_id>
12
+
13
+ # Create a config item (business type, group, optional avatar)
14
+ ae-cli engage-scene config-item create \
15
+ --project-id <project_id> --config-id <config_id> --config-name <name> \
16
+ --business-type <config_file|params> \
17
+ [--config-remark <remark>] [--group-id <group_id>] \
18
+ [--avatar-word '["A","B"]'] [--file-name avatar.png] [--file-content "$(base64 -i avatar.png)"]
19
+
20
+ # Update a config item's basic info and bound channel
21
+ ae-cli engage-scene config-item update \
22
+ --project-id <project_id> --config-id <config_id> \
23
+ [--config-name <name>] [--config-remark <remark>] [--business-type <type>] \
24
+ [--group-id <group_id>] [--channel-id <channel_id>]
25
+ ```
26
+
27
+ ## Parameters
28
+
29
+ ### list
30
+
31
+ | Parameter | Required | Description |
32
+ |---|---|---|
33
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
34
+
35
+ ### create
36
+
37
+ | Parameter | Required | Description |
38
+ |---|---|---|
39
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
40
+ | `--config-id` | Yes | Config item ID (unique within the project). |
41
+ | `--config-name` | Yes | Config item display name (<=80 chars). |
42
+ | `--business-type` | Yes | Business type: `config_file` or `params`. |
43
+ | `--config-remark` | No | Remark (<=200 chars). |
44
+ | `--group-id` | No | Group ID (0 = default group). |
45
+ | `--avatar-word` | No | JSON array of avatar words for the icon. |
46
+ | `--file-name` | No | Avatar file name incl. extension. |
47
+ | `--file-content` | No | Base64-encoded avatar file content. |
48
+
49
+ ### update
50
+
51
+ | Parameter | Required | Description |
52
+ |---|---|---|
53
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
54
+ | `--config-id` | Yes | Config item ID to update. |
55
+ | `--config-name` | No | New display name. |
56
+ | `--config-remark` | No | New remark. |
57
+ | `--business-type` | No | New business type. |
58
+ | `--group-id` | No | New group ID. |
59
+ | `--channel-id` | No | Config channel ID to bind. |
60
+
61
+ ## Output
62
+
63
+ - `list`: `data.items` + `data.total`.
64
+ - `create` / `update`: `data.success` — whether the operation succeeded.
65
+
66
+ ## Decision Rules
67
+
68
+ - `create` / `update` are `write`; `list` is read.
69
+ - Use `config-item list` (or `engage +config_item_list`) to discover existing config items first; never invent IDs.
@@ -5,7 +5,7 @@ Use this command to query aggregated operation records and application logs for
5
5
  > Capability id: `engage-flow.operation-log.query` · Domain: `engage`.
6
6
 
7
7
  ```bash
8
- ae-cli engage-flow operation-log query --project-id <project-id> --flow-uuid <flow-uuid>
8
+ ae-cli engage-flow operation-log query --project-id <project-id> --flow-id <flow-id>
9
9
  ```
10
10
 
11
11
  The result contains `operation_record_list` and `app_log_list`, grouped by flow version.
@@ -0,0 +1,42 @@
1
+ # engage-setting preset-event
2
+
3
+ > Capability ids: `engage-setting.preset-event.{list,update}` · Domain: `engage`.
4
+
5
+ ## Commands
6
+
7
+ ```bash
8
+ # Query the project preset-event config
9
+ ae-cli engage-setting preset-event list --project-id <project_id>
10
+
11
+ # Update the project preset-event config
12
+ ae-cli engage-setting preset-event update --project-id <project_id> [--add-event-desc <qp>] [--active-event-desc <qp>] [--recharge-event-desc <qp>]
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ ### list
18
+
19
+ | Parameter | Required | Description |
20
+ |---|---|---|
21
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
22
+
23
+ ### update
24
+
25
+ | Parameter | Required | Description |
26
+ |---|---|---|
27
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
28
+ | `--add-event-desc` | No | Add-event qp definition. |
29
+ | `--active-event-desc` | No | Active-event qp definition. |
30
+ | `--recharge-event-desc` | No | Recharge-success-event qp definition. |
31
+
32
+ At least one `*-event-desc` must be provided for `update`.
33
+
34
+ ## Output
35
+
36
+ - `list`: `data.add_event_desc`, `data.active_event_desc`, `data.recharge_event_desc` (each may be `null`).
37
+ - `update`: `data.success` — whether the config was updated.
38
+
39
+ ## Decision Rules
40
+
41
+ - Use these commands when the user asks to query or configure preset events (预置事件) for the analysis workbench.
42
+ - `update` replaces the provided desc fields; omitting a field clears it. Before clearing a field that is in use, the backend rejects the update if metrics still depend on it.
@@ -0,0 +1,39 @@
1
+ # engage-setting push-language
2
+
3
+ > Capability ids: `engage-setting.push-language.{get,set}` · Domain: `engage`.
4
+
5
+ ## Commands
6
+
7
+ ```bash
8
+ # Query the project push-language property field
9
+ ae-cli engage-setting push-language get --project-id <project_id>
10
+
11
+ # Set the project push-language property field
12
+ ae-cli engage-setting push-language set --project-id <project_id> --push-language-column <prop_code>
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ ### get
18
+
19
+ | Parameter | Required | Description |
20
+ |---|---|---|
21
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
22
+
23
+ ### set
24
+
25
+ | Parameter | Required | Description |
26
+ |---|---|---|
27
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
28
+ | `--push-language-column` | Yes | User property code used as the push language field. |
29
+
30
+ ## Output
31
+
32
+ - `get`: `data.push_language_column` — configured push-language property code, or `null` if unset.
33
+ - `set`: `data.success` — whether the field was updated.
34
+
35
+ ## Decision Rules
36
+
37
+ - Use these commands when the user asks to query or configure the project push-language (本地化) property field.
38
+ - `--push-language-column` must be a real user property code; discover available properties via the analysis metadata commands first.
39
+ - `set` is `write`; ordinary update, no confirmation gate.
@@ -0,0 +1,58 @@
1
+ # engage-scene config-channel
2
+
3
+ > Capability ids: `engage-scene.config-channel.{create,update,query-log}` · Domain: `engage`.
4
+
5
+ 场景管理 / 配置中心 - 配置通道管理与操作日志。
6
+
7
+ ## Commands
8
+
9
+ ```bash
10
+ # Create a config channel and enable it
11
+ ae-cli engage-scene config-channel create \
12
+ --project-id <project_id> --channel-name <name> --channel-type <0|1> --config '<json string>'
13
+
14
+ # Update a config channel's name and optionally its config
15
+ ae-cli engage-scene config-channel update \
16
+ --project-id <project_id> --channel-id <channel_id> --channel-name <name> [--config '<json string>']
17
+
18
+ # Query a config channel's operation log
19
+ ae-cli engage-scene config-channel query-log --project-id <project_id> --channel-id <channel_id>
20
+ ```
21
+
22
+ ## Parameters
23
+
24
+ ### create
25
+
26
+ | Parameter | Required | Description |
27
+ |---|---|---|
28
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
29
+ | `--channel-name` | Yes | Channel name. |
30
+ | `--channel-type` | Yes | Channel type: **0 webhook**, **1 client** (not the same as engage push `channelType`, where 1=webhook). |
31
+ | `--config` | Yes | Channel-specific JSON config string. Webhook (`0`) requires `config.url`; client (`1`) must not include `url`. |
32
+
33
+ ### update
34
+
35
+ | Parameter | Required | Description |
36
+ |---|---|---|
37
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
38
+ | `--channel-id` | Yes | Channel ID to update. |
39
+ | `--channel-name` | Yes | New channel name. |
40
+ | `--config` | No | Channel-specific JSON config string. Omit to keep the current config (typical when renaming an enabled channel). Required when changing webhook URL, auth, or parameter definitions on a disabled channel. |
41
+
42
+ ### query-log
43
+
44
+ | Parameter | Required | Description |
45
+ |---|---|---|
46
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
47
+ | `--channel-id` | Yes | Channel ID whose operation log to query. |
48
+
49
+ ## Output
50
+
51
+ - `create`: `data.channel_id` — the created channel ID.
52
+ - `update`: `data.success`.
53
+ - `query-log`: `data.items` + `data.total`.
54
+
55
+ ## Decision Rules
56
+
57
+ - `create`/`update` are `write`; `query-log` is read.
58
+ - Discover real `channel_id`s with `ae-cli engage +config_channel_list --project_id <project_id>` first.
@@ -0,0 +1,62 @@
1
+ # engage-scene config-group
2
+
3
+ > Capability ids: `engage-scene.config-group.{list,batch-add,update,batch-delete}` · Domain: `engage`.
4
+
5
+ 场景管理 / 配置中心 - 配置项分组管理。
6
+
7
+ ## Commands
8
+
9
+ ```bash
10
+ # List config groups of a project
11
+ ae-cli engage-scene config-group list --project-id <project_id>
12
+
13
+ # Batch-create config groups
14
+ ae-cli engage-scene config-group batch-add --project-id <project_id> --group-names '["g1","g2"]'
15
+
16
+ # Rename a config group
17
+ ae-cli engage-scene config-group update --project-id <project_id> --group-id <group_id> --group-name <name>
18
+
19
+ # Batch-delete config groups (high-risk)
20
+ ae-cli engage-scene config-group batch-delete --project-id <project_id> --group-ids '[1,2]' --yes
21
+ ```
22
+
23
+ ## Parameters
24
+
25
+ ### list
26
+
27
+ | Parameter | Required | Description |
28
+ |---|---|---|
29
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
30
+
31
+ ### batch-add
32
+
33
+ | Parameter | Required | Description |
34
+ |---|---|---|
35
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
36
+ | `--group-names` | Yes | JSON array of group names (<=80 chars each). |
37
+
38
+ ### update
39
+
40
+ | Parameter | Required | Description |
41
+ |---|---|---|
42
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
43
+ | `--group-id` | Yes | Group ID to update. |
44
+ | `--group-name` | Yes | New group name (<=80 chars). |
45
+
46
+ ### batch-delete
47
+
48
+ | Parameter | Required | Description |
49
+ |---|---|---|
50
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
51
+ | `--group-ids` | Yes | JSON array of group IDs. |
52
+
53
+ ## Output
54
+
55
+ - `list`: `data.items` + `data.total`.
56
+ - `batch-add` / `batch-delete`: `data.success_num` + `data.fail_list` (looped single calls; non-atomic).
57
+ - `update`: `data.success`.
58
+
59
+ ## Decision Rules
60
+
61
+ - Discover real `group_id`s with `list` before update/delete; never invent IDs.
62
+ - `batch-delete` is `high-risk-write` and requires `--yes`.