@thinkingai/ae-cli 6.1.4 → 6.1.6
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/README.md +3 -2
- package/README.zh.md +3 -2
- package/dist/{auth-MEJ642P4.js → auth-ENM3FE6L.js} +3 -2
- package/dist/{auth-7H3HAAJ3.js → auth-UPGUOKTW.js} +13 -6
- package/dist/{capability-QW4AVJHI.js → capability-AJC5CBRT.js} +49 -17
- package/dist/{capability-SCRFGODD.js → capability-TQ5KU5Q6.js} +49 -17
- package/dist/chunk-24BAVOX3.js +51 -0
- package/dist/{chunk-MDJGDI6K.js → chunk-3KI3RRXX.js} +5 -5
- package/dist/{chunk-PKRD2IEM.js → chunk-3P3562ZX.js} +9 -7
- package/dist/{chunk-R77JT7XD.js → chunk-4Q5TNP4Q.js} +4 -4
- package/dist/{chunk-7OLGDQQ2.js → chunk-6CHYBI64.js} +2 -2
- package/dist/{chunk-6LEYLOV3.js → chunk-CPVTECJ3.js} +9 -7
- package/dist/{chunk-KCA6BA5D.js → chunk-DB4Q3ANU.js} +5 -3
- package/dist/{chunk-2NDGFQHW.js → chunk-E7UXXHO3.js} +11 -3
- package/dist/{chunk-I4A62X3N.js → chunk-HQ2A7ITL.js} +23 -14
- package/dist/chunk-IMMGMU54.js +674 -0
- package/dist/{chunk-AJTH7LT3.js → chunk-IR4ZLVPW.js} +4 -2
- package/dist/{chunk-TBHBYKXZ.js → chunk-ISY6HMHM.js} +2 -2
- package/dist/{chunk-KGJQCYVC.js → chunk-LCXU3AAT.js} +4 -2
- package/dist/chunk-LYVNONC4.js +86 -0
- package/dist/{chunk-DYOS6YY7.js → chunk-RGXCNC4N.js} +23 -14
- package/dist/{chunk-YCLVYFK7.js → chunk-V6FR6WTW.js} +45 -87
- package/dist/chunk-VTWMIC5L.js +27 -0
- package/dist/{cli-token-TVQRSE46.js → cli-token-4SBMXAUK.js} +6 -3
- package/dist/{client-2643Z5AG.js → client-PP5FETMW.js} +4 -3
- package/dist/community-report-client-KK2QBANO.js +145 -0
- package/dist/{config-7UZWDE74.js → config-RCCGHHYA.js} +6 -3
- package/dist/index.js +506 -221
- package/dist/{metadata-BFDL6RUK.js → metadata-3M5F2AED.js} +14 -13
- package/dist/{metadata-FCLDBXX2.js → metadata-W2MEOI4Z.js} +14 -13
- package/dist/{model-T3KZJWLW.js → model-OYQLXCQY.js} +3 -2
- package/dist/{raw-CN542NGT.js → raw-TPB7KSZO.js} +6 -4
- package/dist/{sync-ERNHDPB5.js → sync-EFJKFZK2.js} +6 -3
- package/dist/{te-agent-FCCWUDTJ.js → te-agent-K2OWMZXT.js} +3 -2
- package/dist/{te-analysis-PUVF5IF4.js → te-analysis-I73ZS4NK.js} +903 -33
- package/dist/{te-analysis-UJDOKPAN.js → te-analysis-Q7AZCDU4.js} +903 -33
- package/dist/{te-common-XLAGWNIV.js → te-common-ST3QPSXJ.js} +7 -6
- package/dist/{te-common-VUX3VOXZ.js → te-common-WSLIKKPC.js} +7 -6
- package/dist/te-community-WXGB6IOX.js +1659 -0
- package/dist/te-community-X2AHXGCA.js +1659 -0
- package/dist/{te-dataops-ZNJBQ6VT.js → te-dataops-MJV54MNY.js} +10 -8
- package/dist/{te-dataops-F36T656A.js → te-dataops-OA7I6HBG.js} +10 -8
- package/dist/{te-engage-QBCCME22.js → te-engage-2FSDUOIZ.js} +973 -1585
- package/dist/{te-engage-K4AEUPK5.js → te-engage-BMJ6UOUU.js} +973 -1585
- package/dist/te-experiment-4JC7WUKW.js +590 -0
- package/dist/te-experiment-KYRWAUZY.js +590 -0
- package/dist/{te-kb-AYCODNU6.js → te-kb-E7NSCBRB.js} +74 -12
- package/dist/{te-meta-ARDIW3YI.js → te-meta-Q4L6EE3Q.js} +7 -6
- package/dist/{te-meta-UUROEODR.js → te-meta-VHCN4Q62.js} +7 -6
- package/dist/{te-team-OKCOX7OE.js → te-team-PDKKW7Q5.js} +7 -6
- package/dist/tracking/i18n/resources/cli/en.json +4 -3
- package/dist/tracking/i18n/resources/cli/ja.json +4 -3
- package/dist/tracking/i18n/resources/cli/ko.json +4 -3
- package/dist/tracking/i18n/resources/cli/zh.json +4 -3
- package/package.json +7 -3
- package/skills/ae-agent/SKILL.md +2 -1
- package/skills/ae-analysis/SKILL.md +12 -1
- package/skills/ae-analysis/references/adhoc_export.md +2 -0
- package/skills/ae-analysis/references/adhoc_run.md +2 -0
- package/skills/ae-analysis/references/alert_create.md +25 -0
- package/skills/ae-analysis/references/alert_definition_schema_get.md +24 -0
- package/skills/ae-analysis/references/alert_delete.md +26 -0
- package/skills/ae-analysis/references/alert_detail_list.md +27 -0
- package/skills/ae-analysis/references/alert_get.md +25 -0
- package/skills/ae-analysis/references/alert_job_list.md +24 -0
- package/skills/ae-analysis/references/alert_list.md +27 -0
- package/skills/ae-analysis/references/alert_notice_config_list.md +24 -0
- package/skills/ae-analysis/references/alert_start.md +25 -0
- package/skills/ae-analysis/references/alert_stop.md +25 -0
- package/skills/ae-analysis/references/alert_update.md +26 -0
- package/skills/ae-analysis/references/bi_panel_create.md +3 -3
- package/skills/ae-analysis/references/check_delete.md +27 -0
- package/skills/ae-analysis/references/check_export.md +27 -0
- package/skills/ae-analysis/references/check_get.md +27 -0
- package/skills/ae-analysis/references/check_list.md +24 -0
- package/skills/ae-analysis/references/check_retry.md +27 -0
- package/skills/ae-analysis/references/check_run.md +25 -0
- package/skills/ae-analysis/references/command_index.md +61 -27
- package/skills/ae-analysis/references/dashboard_create.md +3 -3
- package/skills/ae-analysis/references/dashboard_daily_report_send.md +1 -0
- package/skills/ae-analysis/references/dashboard_daily_report_update.md +2 -0
- package/skills/ae-analysis/references/dashboard_report_data_export.md +3 -3
- package/skills/ae-analysis/references/dashboard_report_data_run.md +3 -3
- package/skills/ae-analysis/references/event_blacklist_add.md +25 -0
- package/skills/ae-analysis/references/event_blacklist_list.md +24 -0
- package/skills/ae-analysis/references/event_blacklist_update.md +26 -0
- package/skills/ae-analysis/references/ingest_error_list.md +27 -0
- package/skills/ae-analysis/references/ingest_summary.md +26 -0
- package/skills/ae-analysis/references/live_data_export.md +27 -0
- package/skills/ae-analysis/references/live_data_list.md +27 -0
- package/skills/ae-analysis/references/plan_change_log_export.md +27 -0
- package/skills/ae-analysis/references/plan_change_log_list.md +24 -0
- package/skills/ae-analysis/references/plan_delete_items.md +30 -0
- package/skills/ae-analysis/references/plan_export.md +26 -0
- package/skills/ae-analysis/references/plan_generate.md +27 -0
- package/skills/ae-analysis/references/plan_get.md +24 -0
- package/skills/ae-analysis/references/plan_import_excel.md +26 -0
- package/skills/ae-analysis/references/plan_save_items.md +27 -0
- package/skills/ae-analysis/references/plan_sync_from_meta.md +24 -0
- package/skills/ae-analysis/references/project_role_delete.md +4 -3
- package/skills/ae-analysis/references/project_role_get.md +4 -3
- package/skills/ae-analysis/references/project_role_user_list.md +4 -3
- package/skills/ae-analysis/references/query_create_result_cluster.md +2 -1
- package/skills/ae-analysis/references/report_data_export.md +3 -1
- package/skills/ae-analysis/references/report_data_run.md +12 -2
- package/skills/ae-analysis/references/sdk_sample_generate.md +24 -0
- package/skills/ae-analysis/references/user_cluster_create.md +2 -0
- package/skills/ae-analysis/references/user_cluster_create_id.md +2 -0
- package/skills/ae-analysis/references/user_cluster_update.md +2 -0
- package/skills/ae-analysis/references/user_cluster_update_id.md +2 -0
- package/skills/ae-analysis/references/user_tag_create.md +2 -0
- package/skills/ae-analysis/references/user_tag_create_id.md +2 -0
- package/skills/ae-analysis/references/user_tag_update.md +2 -0
- package/skills/ae-analysis/references/user_tag_update_id.md +2 -0
- package/skills/ae-analysis-global/SKILL.md +2 -0
- package/skills/ae-capability/SKILL.md +7 -5
- package/skills/ae-community/SKILL.md +72 -8
- package/skills/ae-community/references/community-chat-analysis.md +341 -0
- package/skills/ae-community/references/community-data-report.md +301 -0
- package/skills/ae-dataops/SKILL.md +2 -1
- package/skills/ae-engage/SKILL.md +129 -105
- package/skills/ae-engage/references/activity-activity-type.md +1 -1
- package/skills/ae-engage/references/activity-activity.md +1 -1
- package/skills/ae-engage/references/activity-approval.md +5 -7
- package/skills/ae-engage/references/activity-task.md +12 -18
- package/skills/ae-engage/references/activity-topic.md +39 -22
- package/skills/ae-engage/references/add-approver.md +4 -4
- package/skills/ae-engage/references/add-channel.md +10 -5
- package/skills/ae-engage/references/approval-approver-delete.md +1 -1
- package/skills/ae-engage/references/approver-list.md +4 -4
- package/skills/ae-engage/references/build-task-save-guide.md +13 -13
- package/skills/ae-engage/references/cancel-query-by-request-id.md +7 -6
- package/skills/ae-engage/references/channel-detail.md +14 -9
- package/skills/ae-engage/references/channel-list.md +15 -10
- package/skills/ae-engage/references/channel-mgmt.md +109 -0
- package/skills/ae-engage/references/channel-test-send.md +1 -1
- package/skills/ae-engage/references/channel-update-config.md +1 -1
- package/skills/ae-engage/references/channel_touch_limits_list.md +1 -1
- package/skills/ae-engage/references/client-param.md +34 -16
- package/skills/ae-engage/references/common-metric.md +85 -18
- package/skills/ae-engage/references/config-item-analysis-report.md +8 -27
- package/skills/ae-engage/references/config-item-strategy-comparison.md +7 -18
- package/skills/ae-engage/references/config-item-trigger-report.md +8 -35
- package/skills/ae-engage/references/delete-channel.md +5 -5
- package/skills/ae-engage/references/delete-flow.md +5 -5
- package/skills/ae-engage/references/flow-ab-split-node-report.md +11 -45
- package/skills/ae-engage/references/flow-detail.md +15 -10
- package/skills/ae-engage/references/flow-list.md +9 -4
- package/skills/ae-engage/references/flow-node-config-schema.md +9 -8
- package/skills/ae-engage/references/flow-node-detail-report.md +11 -46
- package/skills/ae-engage/references/flow-node-overview-report.md +11 -43
- package/skills/ae-engage/references/flow-process-report.md +12 -50
- package/skills/ae-engage/references/flow-update-remark.md +19 -0
- package/skills/ae-engage/references/manage-flow.md +19 -19
- package/skills/ae-engage/references/manage-task.md +5 -5
- package/skills/ae-engage/references/modify-flow-base-info.md +8 -8
- package/skills/ae-engage/references/preset-event.md +1 -1
- package/skills/ae-engage/references/push-language.md +1 -1
- package/skills/ae-engage/references/save-flow.md +54 -52
- package/skills/ae-engage/references/save-task.md +23 -17
- package/skills/ae-engage/references/scene-config-channel.md +90 -10
- package/skills/ae-engage/references/scene-config-group.md +1 -1
- package/skills/ae-engage/references/scene-config-item.md +27 -4
- package/skills/ae-engage/references/scene-config-metric.md +1 -1
- package/skills/ae-engage/references/scene-config-param.md +2 -2
- package/skills/ae-engage/references/scene-preset-metric.md +1 -1
- package/skills/ae-engage/references/scene-strategy.md +19 -3
- package/skills/ae-engage/references/scene-template.md +10 -4
- package/skills/ae-engage/references/task-data-detail.md +5 -67
- package/skills/ae-engage/references/task-data-overview.md +5 -35
- package/skills/ae-engage/references/task-detail.md +5 -5
- package/skills/ae-engage/references/task-experiment-report.md +5 -38
- package/skills/ae-engage/references/task-list.md +4 -4
- package/skills/ae-engage/references/task-metric-detail.md +5 -43
- package/skills/ae-engage/references/task-stats.md +5 -5
- package/skills/ae-engage/references/update-channel-status.md +6 -6
- package/skills/ae-engage/references/validate-flow-node-config.md +12 -11
- package/skills/ae-engage/references/whitelist-list.md +4 -4
- package/skills/ae-engage/references/whitelist.md +1 -1
- package/skills/ae-engage/references/workbench-workbench.md +1 -1
- package/skills/ae-experiment/SKILL.md +30 -20
- package/skills/ae-experiment/references/batch_delete_experiment.md +4 -4
- package/skills/ae-experiment/references/batch_delete_feature.md +3 -3
- package/skills/ae-experiment/references/batch_delete_traffic_layer.md +4 -4
- package/skills/ae-experiment/references/cancel_experiment_query_by_request_id.md +5 -4
- package/skills/ae-experiment/references/check_experiment_ready.md +7 -5
- package/skills/ae-experiment/references/check_experiment_traffic_layer_conflict.md +37 -0
- package/skills/ae-experiment/references/delete_metric.md +4 -4
- package/skills/ae-experiment/references/manage_experiment.md +8 -6
- package/skills/ae-experiment/references/manage_feature_status.md +3 -3
- package/skills/ae-experiment/references/query_bucket_list.md +5 -3
- package/skills/ae-experiment/references/query_experiment_detail.md +6 -4
- package/skills/ae-experiment/references/query_experiment_list.md +12 -4
- package/skills/ae-experiment/references/query_experiment_list_archived.md +15 -0
- package/skills/ae-experiment/references/query_experiment_metric_trend.md +6 -10
- package/skills/ae-experiment/references/query_experiment_operation_log.md +17 -0
- package/skills/ae-experiment/references/query_experiment_report_summary.md +5 -6
- package/skills/ae-experiment/references/query_experiment_sample_size_report.md +6 -10
- package/skills/ae-experiment/references/query_feature_detail.md +6 -4
- package/skills/ae-experiment/references/query_feature_list.md +5 -3
- package/skills/ae-experiment/references/query_feature_operation_log.md +19 -0
- package/skills/ae-experiment/references/query_feature_version_list.md +20 -0
- package/skills/ae-experiment/references/query_metric_detail.md +6 -4
- package/skills/ae-experiment/references/query_metric_list.md +5 -3
- package/skills/ae-experiment/references/query_traffic_layer_detail.md +6 -4
- package/skills/ae-experiment/references/query_traffic_layer_list.md +5 -3
- package/skills/ae-experiment/references/save_experiment.md +148 -9
- package/skills/ae-experiment/references/save_feature.md +3 -3
- package/skills/ae-experiment/references/save_metric.md +3 -3
- package/skills/ae-experiment/references/save_submit_experiment.md +6 -6
- package/skills/ae-experiment/references/save_traffic_layer.md +3 -3
- package/skills/ae-experiment/references/update_experiment_group.md +20 -0
- package/skills/ae-generate-tracking-code/SKILL.md +4 -4
- package/skills/ae-generate-tracking-plan/SKILL.md +132 -11
- package/skills/ae-generate-tracking-plan/references/business-dimension-mapping.md +98 -33
- package/skills/ae-generate-tracking-plan/references/xlsx-schema.md +16 -14
- package/skills/ae-kb/SKILL.md +11 -6
- package/skills/ae-metadata/SKILL.md +2 -1
- package/skills/ae-team/SKILL.md +2 -1
- package/dist/chunk-NOO24N7W.js +0 -11
- package/dist/chunk-TNW2CI4W.js +0 -129
- package/dist/te-community-PEZ2VEF7.js +0 -687
- package/dist/te-community-TSKJ652U.js +0 -687
- package/dist/te-experiment-JINSMHMW.js +0 -606
- package/dist/te-experiment-NWNQHJS5.js +0 -606
- package/skills/ae-engage/references/config-channel-detail.md +0 -31
- package/skills/ae-engage/references/config-channel-list.md +0 -26
- package/skills/ae-engage/references/config-item-detail.md +0 -29
- package/skills/ae-engage/references/config-item-list.md +0 -18
- package/skills/ae-engage/references/copy-config-template.md +0 -28
- package/skills/ae-engage/references/delete-config-channel.md +0 -23
- package/skills/ae-engage/references/delete-config-item.md +0 -24
- package/skills/ae-engage/references/engage-scene-config-item.md +0 -69
- package/skills/ae-engage/references/manage-strategy.md +0 -73
- package/skills/ae-engage/references/strategy-detail.md +0 -72
- package/skills/ae-engage/references/strategy-list.md +0 -20
- package/skills/ae-engage/references/update-config-channel-status.md +0 -31
|
@@ -18,11 +18,12 @@ Global parameters:
|
|
|
18
18
|
|---|---|
|
|
19
19
|
| `--format <json\|table>` | Output format. Default is JSON. |
|
|
20
20
|
| `--jq <expr>` | jq filter expression for JSON output. |
|
|
21
|
-
| `--host <url>` | Override the active AE host. Available on every command and may be placed after the subcommand, e.g. `ae-cli engage
|
|
21
|
+
| `--host <url>` | Override the active AE host. Available on every command and may be placed after the subcommand, e.g. `ae-cli engage-flow flow list --host <url>`. |
|
|
22
22
|
|
|
23
23
|
Output and errors:
|
|
24
|
-
- Successful commands return machine-readable JSON by default.
|
|
24
|
+
- Successful commands return machine-readable JSON by default. Envelope may include optional `_notice.host_compat`.
|
|
25
25
|
- Failed commands return `{ "ok": false, "error": { "type": "...", "message": "...", "hint": "..." } }` and exit non-zero.
|
|
26
|
+
- **CRITICAL — Host compat (do this first):** After each `ae-cli` run, check stderr and `_notice.host_compat`. If either is present, open the user reply with a short ⚠️ version warning and **quote the `npm i -g` / `npx skills add` (or update-cluster) lines verbatim**, then present the business result. Soft tip; `ok: true` can still carry the notice.
|
|
26
27
|
|
|
27
28
|
Safety constraints:
|
|
28
29
|
- Read commands can execute directly after required IDs and references are verified.
|
|
@@ -32,7 +33,7 @@ Safety constraints:
|
|
|
32
33
|
|
|
33
34
|
## Overview
|
|
34
35
|
|
|
35
|
-
The `ae-engage` package provides Hermes Engage
|
|
36
|
+
The `ae-engage` package provides Hermes Engage capabilities across config items, flows, channel settings, and task data. Use capability-gateway commands through `ae-cli engage-flow|engage-task|engage-setting|engage-scene <resource> <action>`; low-frequency reports use the L3 references below.
|
|
36
37
|
|
|
37
38
|
Typical use cases include:
|
|
38
39
|
|
|
@@ -44,19 +45,25 @@ Typical use cases include:
|
|
|
44
45
|
|
|
45
46
|
## Parameter Conventions
|
|
46
47
|
|
|
47
|
-
- Use regular flags for simple parameters, for example `--
|
|
48
|
-
- Use JSON flags for array parameters, for example `--
|
|
49
|
-
- Use named JSON flags for object parameters, for example `--req '{...}'` and `--
|
|
48
|
+
- Use regular flags for simple parameters, for example `--project-id`, `--task-id`, and `--flow-uuid`
|
|
49
|
+
- Use JSON flags for array parameters, for example `--strategy-uuid-list '["id1","id2"]'`
|
|
50
|
+
- Use named JSON flags for object parameters, for example `--req '{...}'` and `--flow-list '[...]'`
|
|
50
51
|
- Optional global parameters work the same way as in other domains, for example `--host`, `--mcp-url`, and `--dry-run`
|
|
51
52
|
|
|
53
|
+
Naming boundary:
|
|
54
|
+
|
|
55
|
+
- CLI flags use kebab-case; outer Capability input and all Capability response keys use snake_case.
|
|
56
|
+
- Nested business DTOs passed through `--req` or `--payload` keep their documented native camelCase fields. Do not mechanically convert those nested DTO keys to snake_case.
|
|
57
|
+
- Successful migrated commands return their business payload under `data`; read the matching reference's Response shape before selecting fields.
|
|
58
|
+
|
|
52
59
|
## JSON Parameter Format
|
|
53
60
|
|
|
54
61
|
Common JSON flag examples:
|
|
55
62
|
|
|
56
63
|
```bash
|
|
57
|
-
--
|
|
58
|
-
--
|
|
59
|
-
--
|
|
64
|
+
--provider-list '["webhook","fcm"]'
|
|
65
|
+
--strategy-uuid-list '["strategy_a","strategy_b"]'
|
|
66
|
+
--flow-id-list '["flow_1","flow_2"]'
|
|
60
67
|
--req '{"pageNum":1,"pageSize":20}'
|
|
61
68
|
```
|
|
62
69
|
|
|
@@ -66,13 +73,13 @@ Common JSON flag examples:
|
|
|
66
73
|
|
|
67
74
|
```bash
|
|
68
75
|
# Query the channel list
|
|
69
|
-
ae-cli engage
|
|
76
|
+
ae-cli engage-setting channel list --project-id 1
|
|
70
77
|
|
|
71
78
|
# Filter by provider
|
|
72
|
-
ae-cli engage
|
|
79
|
+
ae-cli engage-setting channel list --project-id 1 --provider-list '["webhook","fcm"]'
|
|
73
80
|
|
|
74
|
-
# Query config channels
|
|
75
|
-
ae-cli engage
|
|
81
|
+
# Query config channels (config center channel management — use engage-scene, not legacy +config_channel_*)
|
|
82
|
+
ae-cli engage-scene config-channel list --project-id 1 --channel-type 0
|
|
76
83
|
|
|
77
84
|
# Query project channel touch-limit rules
|
|
78
85
|
ae-cli engage-setting channel-touch-limits list --project-id <project_id>
|
|
@@ -97,16 +104,17 @@ ae-cli engage-setting whitelist update --project-id <project_id> --whitelist-id
|
|
|
97
104
|
ae-cli engage-setting whitelist delete --project-id <project_id> --whitelist-ids '["wl-1"]' --yes
|
|
98
105
|
ae-cli engage-setting whitelist verify --project-id <project_id> --prop-code <prop_code> --column-type string --whitelist-prop-list '["v1"]'
|
|
99
106
|
|
|
100
|
-
# Push-language (
|
|
107
|
+
# Push-language (localization) get / set
|
|
101
108
|
ae-cli engage-setting push-language get --project-id <project_id>
|
|
102
109
|
ae-cli engage-setting push-language set --project-id <project_id> --push-language-column <prop_code>
|
|
103
110
|
|
|
104
|
-
# Client param
|
|
105
|
-
ae-cli engage-setting client-param
|
|
111
|
+
# Client param update / delete / list
|
|
112
|
+
ae-cli engage-setting client-param create --project-id <project_id> --column-name level --column-type varchar --column-desc Level
|
|
113
|
+
ae-cli engage-setting client-param update --project-id <project_id> --column-name level --column-desc Level
|
|
106
114
|
ae-cli engage-setting client-param delete --project-id <project_id> --column-name level --yes
|
|
107
115
|
ae-cli engage-setting client-param list --project-id <project_id>
|
|
108
116
|
|
|
109
|
-
# Config table
|
|
117
|
+
# Config table upload / save / list / query-data / update-data / delete
|
|
110
118
|
ae-cli engage-setting config-table upload --project-id <project_id> --request-id <rid> --file-name data.csv --file-content "$(base64 -i data.csv)"
|
|
111
119
|
ae-cli engage-setting config-table save --project-id <project_id> --request-id <rid> --info-name <table_name>
|
|
112
120
|
ae-cli engage-setting config-table list --project-id <project_id>
|
|
@@ -114,14 +122,15 @@ ae-cli engage-setting config-table query-data --project-id <project_id> --info-i
|
|
|
114
122
|
ae-cli engage-setting config-table update-data --project-id <project_id> --request-id <rid> --info-name <table_name> --info-id <info_id>
|
|
115
123
|
ae-cli engage-setting config-table delete --project-id <project_id> --info-id <info_id> --yes
|
|
116
124
|
|
|
117
|
-
# Preset event
|
|
125
|
+
# Preset event list / update
|
|
118
126
|
ae-cli engage-setting preset-event list --project-id <project_id>
|
|
119
127
|
ae-cli engage-setting preset-event update --project-id <project_id> --add-event-desc <qp>
|
|
120
128
|
|
|
121
|
-
# Common metric
|
|
129
|
+
# Common metric list / get / create / update / delete
|
|
122
130
|
ae-cli engage-setting common-metric list --project-id <project_id>
|
|
123
131
|
ae-cli engage-setting common-metric get --project-id <project_id> --metric-name <name>
|
|
124
|
-
ae-cli engage-setting common-metric
|
|
132
|
+
ae-cli engage-setting common-metric create --project-id <project_id> --metric-type 1 --metric-name <name> --metric-qp '<qp_json>' --metric-window-num 1 --metric-window-time-unit day --display-name <display>
|
|
133
|
+
ae-cli engage-setting common-metric update --project-id <project_id> --metric-type 1 --metric-name <name> --metric-qp '<qp_json>' --metric-window-num 1 --metric-window-time-unit day --display-name <display>
|
|
125
134
|
ae-cli engage-setting common-metric delete --project-id <project_id> --metric-name <name> --yes
|
|
126
135
|
```
|
|
127
136
|
|
|
@@ -129,50 +138,50 @@ ae-cli engage-setting common-metric delete --project-id <project_id> --metric-na
|
|
|
129
138
|
|
|
130
139
|
```bash
|
|
131
140
|
# Query the task list
|
|
132
|
-
ae-cli engage
|
|
141
|
+
ae-cli engage-task task list --project-id 1 --req '{"pageNum":1,"pageSize":20}'
|
|
133
142
|
|
|
134
143
|
# Build a save_task guide before composing the final req
|
|
135
|
-
ae-cli engage
|
|
144
|
+
ae-cli engage-task task build-save-guide --project-id 1 --req '{"context":{"triggerType":2,"channelId":"channel_123"}}'
|
|
136
145
|
|
|
137
146
|
# Save a task draft (create when req.taskId is omitted)
|
|
138
|
-
ae-cli engage
|
|
147
|
+
ae-cli engage-task task save --project-id 1 --req '{"baseInfo":{"taskName":"Demo Task"},"channelConfig":{"channelType":1,"channelId":"channel_123","groupContentList":[{"contentList":[{"pushLanguageCode":"default","content":"[]"}]}]},"targetConfig":{"targetClusterType":3},"triggerConfig":{"triggerType":2},"controlConfig":{"completionIndicatorDef":{"completionIndicators":[]}}}'
|
|
139
148
|
|
|
140
149
|
# Query task details
|
|
141
|
-
ae-cli engage
|
|
150
|
+
ae-cli engage-task task get --project-id 1 --task-id task_123
|
|
142
151
|
|
|
143
|
-
# Query the task overview
|
|
144
|
-
ae-cli engage +task_data_overview --project_id 1 --task_id task_123
|
|
145
152
|
```
|
|
146
153
|
|
|
154
|
+
For L3 task reports, read `references/task-data-overview.md`, `references/task-data-detail.md`,
|
|
155
|
+
`references/task-metric-detail.md`, or `references/task-experiment-report.md` before invocation.
|
|
156
|
+
|
|
147
157
|
### 3. config
|
|
148
158
|
|
|
149
159
|
```bash
|
|
150
160
|
# Query the config item list
|
|
151
|
-
ae-cli engage
|
|
161
|
+
ae-cli engage-scene config-item list --project-id 1
|
|
152
162
|
|
|
153
163
|
# Query the strategy list
|
|
154
|
-
ae-cli engage
|
|
155
|
-
|
|
156
|
-
# Query a config item report
|
|
157
|
-
ae-cli engage +config_item_trigger_report \
|
|
158
|
-
--project_id 1 --config_id cfg_123 \
|
|
159
|
-
--start_time 2026-04-01 --end_time 2026-04-07
|
|
164
|
+
ae-cli engage-scene strategy list --project-id 1 --config-id cfg_123
|
|
160
165
|
```
|
|
161
166
|
|
|
167
|
+
For L3 config reports, read `references/config-item-trigger-report.md`,
|
|
168
|
+
`references/config-item-analysis-report.md`, or `references/config-item-strategy-comparison.md` before invocation.
|
|
169
|
+
|
|
162
170
|
### 4. flow
|
|
163
171
|
|
|
164
172
|
```bash
|
|
165
173
|
# Query the flow list
|
|
166
|
-
ae-cli engage
|
|
174
|
+
ae-cli engage-flow flow list --project-id 1
|
|
167
175
|
|
|
168
176
|
# Query flow details
|
|
169
|
-
ae-cli engage
|
|
177
|
+
ae-cli engage-flow flow get --project-id 1 --flow-uuid flow_uuid_123
|
|
170
178
|
|
|
171
179
|
# Query flow operation records and application logs
|
|
172
180
|
ae-cli engage-flow operation-log query --project-id 1 --flow-id flow_id_123
|
|
173
181
|
|
|
174
182
|
# Query flow versions and task push records
|
|
175
183
|
ae-cli engage-flow version list --project-id 1 --flow-id flow_id_123
|
|
184
|
+
ae-cli engage-flow flow update-remark --project-id 1 --flow-uuid flow_uuid_123 --flow-version-desc "Second version"
|
|
176
185
|
ae-cli engage-task operation-log query --project-id 1 --task-id task_id_123
|
|
177
186
|
ae-cli engage-task push-record query --project-id 1 --task-id task_id_123 --page-num 1 --page-size 20
|
|
178
187
|
ae-cli engage-task segment-list query --project-id 1 --task-id task_id_123
|
|
@@ -182,54 +191,61 @@ ae-cli engage-task channel-ref stats --project-id 1 --channel-id channel_123
|
|
|
182
191
|
ae-cli engage-task task delete --project-id 1 --task-id task_id_123 --yes
|
|
183
192
|
|
|
184
193
|
# Query the node schema
|
|
185
|
-
ae-cli engage
|
|
194
|
+
ae-cli engage-flow node-config schema --project-id 1 --node-type message_push
|
|
186
195
|
```
|
|
187
196
|
|
|
188
|
-
### 5. scene (
|
|
197
|
+
### 5. scene (scene management / config center)
|
|
189
198
|
|
|
190
|
-
New capability-gateway command group `engage-scene` covers
|
|
199
|
+
New capability-gateway command group `engage-scene` covers the config center: config items, params, groups, preset/related metrics, config channels, strategies, and templates. Complex DTOs are passed with `--payload` (native camelCase JSON).
|
|
191
200
|
|
|
192
201
|
```bash
|
|
193
|
-
# Config item
|
|
202
|
+
# Config item list / get / create / update / delete
|
|
194
203
|
ae-cli engage-scene config-item list --project-id <project_id>
|
|
204
|
+
ae-cli engage-scene config-item get --project-id <project_id> --config-id <config_id>
|
|
195
205
|
ae-cli engage-scene config-item create --project-id <project_id> --config-id <config_id> --config-name <name> --business-type params
|
|
196
206
|
ae-cli engage-scene config-item update --project-id <project_id> --config-id <config_id> --config-name <name>
|
|
207
|
+
ae-cli engage-scene config-item delete --project-id <project_id> --config-id <config_id> --open-id <open_id> --yes
|
|
197
208
|
|
|
198
|
-
# Config param
|
|
209
|
+
# Config param list / batch-add / update / batch-delete
|
|
199
210
|
ae-cli engage-scene config-param list --project-id <project_id> --config-id <config_id>
|
|
200
211
|
ae-cli engage-scene config-param batch-add --project-id <project_id> --config-id <config_id> --params '[{"param_name":"a","param_type":"string"}]'
|
|
201
212
|
ae-cli engage-scene config-param update --project-id <project_id> --config-id <config_id> --param-id <param_id> --param-name a
|
|
202
213
|
ae-cli engage-scene config-param batch-delete --project-id <project_id> --param-ids '[1,2]' --yes
|
|
203
214
|
|
|
204
|
-
# Config group
|
|
215
|
+
# Config group list / batch-add / update / batch-delete
|
|
205
216
|
ae-cli engage-scene config-group list --project-id <project_id>
|
|
206
217
|
ae-cli engage-scene config-group batch-add --project-id <project_id> --group-names '["g1"]'
|
|
207
218
|
ae-cli engage-scene config-group update --project-id <project_id> --group-id <group_id> --group-name g2
|
|
208
219
|
ae-cli engage-scene config-group batch-delete --project-id <project_id> --group-ids '[1,2]' --yes
|
|
209
220
|
|
|
210
|
-
# Preset metric
|
|
221
|
+
# Preset metric get / set
|
|
211
222
|
ae-cli engage-scene preset-metric get --project-id <project_id> --config-id <config_id>
|
|
212
223
|
ae-cli engage-scene preset-metric set --project-id <project_id> --config-id <config_id> --impression-event-qp '<qp>'
|
|
213
224
|
|
|
214
|
-
# Config metric
|
|
225
|
+
# Config metric list / get / batch-add / update-rule / batch-delete
|
|
215
226
|
ae-cli engage-scene config-metric list --project-id <project_id> --config-id <config_id>
|
|
216
227
|
ae-cli engage-scene config-metric get --project-id <project_id> --metric-id <metric_id>
|
|
217
228
|
ae-cli engage-scene config-metric batch-add --project-id <project_id> --config-id <config_id> --ta-metric-ids '[1,2]'
|
|
218
229
|
ae-cli engage-scene config-metric update-rule --project-id <project_id> --metric-id <metric_id> --event-list '[{"event_name":"e1","filter":"true"}]'
|
|
219
230
|
ae-cli engage-scene config-metric batch-delete --project-id <project_id> --config-id <config_id> --metric-ids '[1,2]' --yes
|
|
220
231
|
|
|
221
|
-
# Config channel
|
|
232
|
+
# Config channel list / get / create / update / update-status / delete / query-log
|
|
233
|
+
# Workflows: references/channel-mgmt.md · schema: references/scene-config-channel.md
|
|
234
|
+
ae-cli engage-scene config-channel list --project-id <project_id> [--channel-type 0|1]
|
|
235
|
+
ae-cli engage-scene config-channel get --project-id <project_id> --channel-id <channel_id>
|
|
222
236
|
ae-cli engage-scene config-channel create --project-id <project_id> --channel-name <name> --channel-type 0 --config '<json>'
|
|
223
237
|
ae-cli engage-scene config-channel update --project-id <project_id> --channel-id <channel_id> --channel-name <name> [--config '<json>']
|
|
238
|
+
ae-cli engage-scene config-channel update-status --project-id <project_id> --channel-id <channel_id> --channel-status 1|2
|
|
239
|
+
ae-cli engage-scene config-channel delete --project-id <project_id> --channel-id <channel_id> --yes
|
|
224
240
|
ae-cli engage-scene config-channel query-log --project-id <project_id> --channel-id <channel_id>
|
|
225
241
|
|
|
226
|
-
# Strategy
|
|
242
|
+
# Strategy create / update / log / batch-copy
|
|
227
243
|
ae-cli engage-scene strategy create --project-id <project_id> --payload '{"configId":"cfg-1","templateId":"tpl-1","strategyName":"s1"}'
|
|
228
244
|
ae-cli engage-scene strategy update --project-id <project_id> --payload '{"strategyUuid":"uuid-1"}'
|
|
229
245
|
ae-cli engage-scene strategy log --project-id <project_id> --strategy-uuid <uuid>
|
|
230
246
|
ae-cli engage-scene strategy batch-copy --project-id <project_id> --config-id <config_id> --strategy-ids '["s1"]'
|
|
231
247
|
|
|
232
|
-
# Template
|
|
248
|
+
# Template list / get / create / update / update-status / delete
|
|
233
249
|
ae-cli engage-scene template list --project-id <project_id> --config-id <config_id>
|
|
234
250
|
ae-cli engage-scene template get --project-id <project_id> --config-id <config_id> --template-id <template_id>
|
|
235
251
|
ae-cli engage-scene template create --project-id <project_id> --payload '{"configId":"cfg-1","templateId":"tpl-1","templateName":"t1"}'
|
|
@@ -238,12 +254,12 @@ ae-cli engage-scene template update-status --project-id <project_id> --config-id
|
|
|
238
254
|
ae-cli engage-scene template delete --project-id <project_id> --config-id <config_id> --template-id <template_id> --yes
|
|
239
255
|
```
|
|
240
256
|
|
|
241
|
-
### 6. activity (
|
|
257
|
+
### 6. activity (campaign activities)
|
|
242
258
|
|
|
243
|
-
New capability-gateway command group `engage-activity` covers
|
|
259
|
+
New capability-gateway command group `engage-activity` covers campaign activities: activities, approval workflow, topics, activity types, and standalone tasks. Complex DTOs are passed with `--payload` (native camelCase JSON).
|
|
244
260
|
|
|
245
261
|
```bash
|
|
246
|
-
# Activity
|
|
262
|
+
# Activity create / update / delete / list / get / pause / end / stats / info-list
|
|
247
263
|
ae-cli engage-activity activity create --project-id <project_id> --payload '{"activityName":"a1","activityType":"other_type","tzOffset":8,"periodType":0}'
|
|
248
264
|
ae-cli engage-activity activity update --project-id <project_id> --payload '{"activityId":"act-1","activityName":"a1","activityType":"other_type","tzOffset":8,"periodType":0}'
|
|
249
265
|
ae-cli engage-activity activity delete --project-id <project_id> --activity-id <activity_id> --yes
|
|
@@ -254,51 +270,49 @@ ae-cli engage-activity activity end --project-id <project_id> --activity-id <act
|
|
|
254
270
|
ae-cli engage-activity activity stats --project-id <project_id>
|
|
255
271
|
ae-cli engage-activity activity info-list --project-id <project_id> --activity-id <activity_id>
|
|
256
272
|
|
|
257
|
-
# Approval
|
|
258
|
-
|
|
273
|
+
# Approval approve / reject / cancel
|
|
274
|
+
# Note: engage-activity.approval.submit is temporarily disabled (testing issues); do not call it.
|
|
259
275
|
ae-cli engage-activity approval approve --project-id <project_id> --activity-id <activity_id>
|
|
260
276
|
ae-cli engage-activity approval reject --project-id <project_id> --activity-id <activity_id> --reason <reason>
|
|
261
277
|
ae-cli engage-activity approval cancel --project-id <project_id> --activity-id <activity_id>
|
|
262
278
|
|
|
263
|
-
# Topic
|
|
264
|
-
#
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
# ae-cli engage-activity topic update --project-id <project_id> --payload '{"topicId":"topic-1", ...}'
|
|
279
|
+
# Topic create / update / remove-task / delete / get / copy
|
|
280
|
+
# See references/activity-topic.md for topicClusterKey vs task clusterKey and triggerType notes.
|
|
281
|
+
ae-cli engage-activity topic create --project-id <project_id> --payload '{"activityId":"act-1","topicName":"t1","targetClusterType":2,"topicClusterKey":"<cluster>","channelType":1,"channelId":"c1","triggerType":0,"triggerTime":"2026-12-31 12:00","enableChannelTouchLimits":false,"frequencyLimits":"{}","tasks":[...]}'
|
|
282
|
+
ae-cli engage-activity topic update --project-id <project_id> --payload '{"topicId":"topic-1", ...}'
|
|
268
283
|
ae-cli engage-activity topic remove-task --project-id <project_id> --task-id <task_id> --yes
|
|
269
284
|
ae-cli engage-activity topic delete --project-id <project_id> --topic-id <topic_id> --yes
|
|
270
285
|
ae-cli engage-activity topic get --project-id <project_id> --topic-id <topic_id>
|
|
271
286
|
ae-cli engage-activity topic copy --project-id <project_id> --topic-id <topic_id> [--new-name <name>]
|
|
272
287
|
|
|
273
|
-
# Activity type
|
|
288
|
+
# Activity type list / batch-add / update / batch-delete
|
|
274
289
|
ae-cli engage-activity activity-type list --project-id <project_id>
|
|
275
290
|
ae-cli engage-activity activity-type batch-add --project-id <project_id> --type-names '["t1","t2"]'
|
|
276
291
|
ae-cli engage-activity activity-type update --project-id <project_id> --id <type_id> --type-name t3
|
|
277
292
|
ae-cli engage-activity activity-type batch-delete --project-id <project_id> --ids '["id1","id2"]' --yes
|
|
278
293
|
|
|
279
|
-
# Standalone task
|
|
280
|
-
# Temporarily disabled: task create / task update
|
|
294
|
+
# Standalone task get / create / update / copy
|
|
281
295
|
ae-cli engage-activity task get --project-id <project_id> --task-id <task_id>
|
|
282
|
-
|
|
283
|
-
|
|
296
|
+
ae-cli engage-activity task create --project-id <project_id> --payload '{"taskName":"t1","activityId":"act-1", ...}'
|
|
297
|
+
ae-cli engage-activity task update --project-id <project_id> --payload '{"taskId":"task-1", ...}'
|
|
284
298
|
ae-cli engage-activity task copy --project-id <project_id> --task-id <task_id> [--new-name <name>]
|
|
285
299
|
```
|
|
286
300
|
|
|
287
|
-
### 7. workbench
|
|
301
|
+
### 7. workbench
|
|
288
302
|
|
|
289
|
-
New capability-gateway command group `engage-workbench` covers
|
|
303
|
+
New capability-gateway command group `engage-workbench` covers workbench metric slots: each user configures up to 4 metric cards per project. Slots are per-user; `update`/`delete` only affect the caller's own slots. The first `list` auto-initialises 4 default slots.
|
|
290
304
|
|
|
291
305
|
```bash
|
|
292
|
-
# Workbench slot
|
|
306
|
+
# Workbench slot list / add / update / delete
|
|
293
307
|
ae-cli engage-workbench workbench list --project-id <project_id>
|
|
294
308
|
ae-cli engage-workbench workbench add --project-id <project_id> --metric-type <metric_type> --date-type <date_type> --order-id 1
|
|
295
309
|
ae-cli engage-workbench workbench update --project-id <project_id> --slot-id <slot_id> --metric-type <metric_type> --date-type <date_type> --order-id 1
|
|
296
310
|
ae-cli engage-workbench workbench delete --project-id <project_id> --slot-id <slot_id> --yes
|
|
297
311
|
```
|
|
298
312
|
|
|
299
|
-
##
|
|
313
|
+
## `engage-flow flow save` Critical Constraints
|
|
300
314
|
|
|
301
|
-
When the user wants to "create a flow / generate a flow canvas / save a flow", do not treat
|
|
315
|
+
When the user wants to "create a flow / generate a flow canvas / save a flow", do not treat `engage-flow flow save` as a normal single command. You must follow the workflow below.
|
|
302
316
|
|
|
303
317
|
### Required Workflow
|
|
304
318
|
|
|
@@ -318,11 +332,11 @@ ae-cli analysis user-cluster get --project-id <projectId> --cluster-names '["<co
|
|
|
318
332
|
4. Before building touchpoint nodes such as `message_push`, `wechat_push`, or `webhook_push`, you must call:
|
|
319
333
|
|
|
320
334
|
```bash
|
|
321
|
-
ae-cli engage
|
|
335
|
+
ae-cli engage-setting channel list --project-id <projectId>
|
|
322
336
|
```
|
|
323
337
|
|
|
324
|
-
5.
|
|
325
|
-
6. Run the lifecycle: `build` (returns `ready_to_preview` or `need_input`) → resolve any `
|
|
338
|
+
5. `engage-flow flow save` is **operation-based** (protocol v2). The `--req` object must carry an `operation` of `build`, `preview`, or `commit`. Do **not** use the old `nodeList` / `edgeList` field names — use `nodes` / `edges` with `operation=build`. A legacy `nodeList`/`edgeList` payload (or a missing `operation`) is rejected with `Unsupported save_flow operation: null`.
|
|
339
|
+
6. Run the lifecycle: `build` (returns `data.result.status = ready_to_preview` or `need_input`) → resolve any `data.result.next_slot` → `preview` (re-issues response fields `data.result.draft_version` + `data.result.confirm_token`) → `commit` (maps those values to request fields `draftVersion` + `confirmToken`) → reads the final ID from `data.result.result.flow_uuid`.
|
|
326
340
|
7. `nodes[].config` / `edges[].config` may be a JSON object or a JSON string. If `targetClusterQp` appears inside a node `config`, its value is usually a `JSON.stringify`'d string, not a raw object.
|
|
327
341
|
8. You must self-check before previewing/committing:
|
|
328
342
|
- There is exactly one entry node
|
|
@@ -344,11 +358,11 @@ ae-cli engage +channel_list --project_id <projectId>
|
|
|
344
358
|
User request
|
|
345
359
|
-> Organize intent
|
|
346
360
|
-> analysis user-cluster create/get
|
|
347
|
-
->
|
|
361
|
+
-> engage-setting channel list --project-id <projectId>
|
|
348
362
|
-> Build nodes / edges
|
|
349
363
|
-> Self-check
|
|
350
|
-
->
|
|
351
|
-
->
|
|
364
|
+
-> engage-flow flow save operation=build -> (need_input?) -> preview -> commit
|
|
365
|
+
-> engage-flow flow get (verify)
|
|
352
366
|
```
|
|
353
367
|
|
|
354
368
|
For more detailed generation rules, consult these references first:
|
|
@@ -360,18 +374,22 @@ For more detailed generation rules, consult these references first:
|
|
|
360
374
|
## Dry-Run Debugging
|
|
361
375
|
|
|
362
376
|
```bash
|
|
363
|
-
ae-cli --dry-run engage
|
|
364
|
-
ae-cli --dry-run engage
|
|
365
|
-
ae-cli --dry-run engage
|
|
366
|
-
ae-cli --dry-run engage
|
|
367
|
-
ae-cli --dry-run engage
|
|
377
|
+
ae-cli --dry-run engage-setting channel list --project-id 1
|
|
378
|
+
ae-cli --dry-run engage-task task list --project-id 1 --req '{"pageNum":1,"pageSize":20}'
|
|
379
|
+
ae-cli --dry-run engage-task task build-save-guide --project-id 1 --req '{}'
|
|
380
|
+
ae-cli --dry-run engage-task task save --project-id 1 --req '{"baseInfo":{"taskName":"Demo Task"},"channelConfig":{"channelType":1,"channelId":"channel_123","groupContentList":[{"contentList":[{"pushLanguageCode":"default","content":"[]"}]}]},"targetConfig":{"targetClusterType":3},"triggerConfig":{"triggerType":2},"controlConfig":{"completionIndicatorDef":{"completionIndicators":[]}}}'
|
|
381
|
+
ae-cli --dry-run engage-flow flow list --project-id 1
|
|
368
382
|
```
|
|
369
383
|
|
|
370
384
|
## References
|
|
371
385
|
|
|
372
386
|
More detailed single-command guidance is available in the business-oriented `references/` directory:
|
|
373
387
|
|
|
374
|
-
- `references/channel-list.md`
|
|
388
|
+
- `references/channel-list.md` (`engage-setting.channel.list`)
|
|
389
|
+
- `references/channel-detail.md` (`engage-setting.channel.get`)
|
|
390
|
+
- `references/add-channel.md` (`engage-setting.channel.create`)
|
|
391
|
+
- `references/update-channel-status.md` (`engage-setting.channel.update-status`)
|
|
392
|
+
- `references/delete-channel.md` (`engage-setting.channel.delete`)
|
|
375
393
|
- `references/channel_touch_limits_list.md` (`engage-setting.channel-touch-limits.list`)
|
|
376
394
|
- `references/channel-touch-limits-batch-update.md` (`engage-setting.channel-touch-limits.batch-update`)
|
|
377
395
|
- `references/channel-touch-limits-toggle.md` (`engage-setting.channel-touch-limits.toggle`)
|
|
@@ -379,34 +397,40 @@ More detailed single-command guidance is available in the business-oriented `ref
|
|
|
379
397
|
- `references/channel-update-config.md` (`engage-setting.channel.update-config`)
|
|
380
398
|
- `references/channel-test-send.md` (`engage-setting.channel.test-send`)
|
|
381
399
|
- `references/approval-approver-delete.md` (`engage-setting.approval-approver.delete`)
|
|
382
|
-
- `references/
|
|
400
|
+
- `references/add-approver.md` / `references/approver-list.md` (`engage-setting.approval-approver.{add,list}`)
|
|
401
|
+
- `references/whitelist-list.md` / `references/whitelist.md` (`engage-setting.whitelist.{list,add,update,delete,verify}`)
|
|
402
|
+
- `references/cancel-query-by-request-id.md` (`engage-setting.query.cancel`, L3)
|
|
383
403
|
- `references/push-language.md` (`engage-setting.push-language.{get,set}`)
|
|
384
|
-
- `references/client-param.md` (`engage-setting.client-param.{update,delete,list}
|
|
404
|
+
- `references/client-param.md` (`engage-setting.client-param.{create,update,delete,list}`)
|
|
385
405
|
- `references/config-table.md` (`engage-setting.config-table.{upload,save,list,query-data,update-data,delete}`)
|
|
386
406
|
- `references/preset-event.md` (`engage-setting.preset-event.{list,update}`)
|
|
387
|
-
- `references/common-metric.md` (`engage-setting.common-metric.{list,get,update,delete}
|
|
388
|
-
- `references/scene-config-item.md` (`engage-scene.config-item.{list,create,update}`)
|
|
407
|
+
- `references/common-metric.md` (`engage-setting.common-metric.{list,get,create,update,delete}`)
|
|
408
|
+
- `references/scene-config-item.md` (`engage-scene.config-item.{list,get,create,update,delete}`)
|
|
389
409
|
- `references/scene-config-param.md` (`engage-scene.config-param.{list,batch-add,update,batch-delete}`)
|
|
390
410
|
- `references/scene-config-group.md` (`engage-scene.config-group.{list,batch-add,update,batch-delete}`)
|
|
391
411
|
- `references/scene-preset-metric.md` (`engage-scene.preset-metric.{get,set}`)
|
|
392
412
|
- `references/scene-config-metric.md` (`engage-scene.config-metric.{list,get,batch-add,update-rule,batch-delete}`)
|
|
393
|
-
- `references/scene-config-channel.md` (`engage-scene.config-channel.{create,update,query-log}`)
|
|
394
|
-
- `references/
|
|
395
|
-
- `references/scene-
|
|
413
|
+
- `references/scene-config-channel.md` (`engage-scene.config-channel.{list,get,create,update,update-status,delete,query-log}`)
|
|
414
|
+
- `references/channel-mgmt.md` (config channel management workflows)
|
|
415
|
+
- `references/scene-strategy.md` (`engage-scene.strategy.{list,get,create,update,log,batch-copy,manage}`)
|
|
416
|
+
- `references/scene-template.md` (`engage-scene.template.{list,get,copy,create,update,update-status,delete}`)
|
|
417
|
+
- `references/config-item-trigger-report.md` (`engage-scene.report.config-item-trigger`, L3)
|
|
418
|
+
- `references/config-item-analysis-report.md` (`engage-scene.report.config-item-analysis`, L3)
|
|
419
|
+
- `references/config-item-strategy-comparison.md` (`engage-scene.report.strategy-comparison`, L3)
|
|
396
420
|
- `references/activity-activity.md` (`engage-activity.activity.{create,update,delete,list,get,pause,end,stats,info-list}`)
|
|
397
|
-
- `references/activity-approval.md` (`engage-activity.approval.{
|
|
398
|
-
- `references/activity-topic.md` (`engage-activity.topic.{remove-task,delete,get,copy}
|
|
421
|
+
- `references/activity-approval.md` (`engage-activity.approval.{approve,reject,cancel}`; `submit` temporarily disabled)
|
|
422
|
+
- `references/activity-topic.md` (`engage-activity.topic.{create,update,remove-task,delete,get,copy}`)
|
|
399
423
|
- `references/activity-activity-type.md` (`engage-activity.activity-type.{list,batch-add,update,batch-delete}`)
|
|
400
|
-
- `references/activity-task.md` (`engage-activity.task.{get,copy}
|
|
424
|
+
- `references/activity-task.md` (`engage-activity.task.{get,create,update,copy}`)
|
|
401
425
|
- `references/workbench-workbench.md` (`engage-workbench.workbench.{list,add,update,delete}`)
|
|
402
426
|
- `references/build-task-save-guide.md`
|
|
403
427
|
- `references/save-task.md`
|
|
404
428
|
- `references/task-list.md`
|
|
405
|
-
- `references/config-item-list.md`
|
|
406
429
|
- `references/flow-list.md`
|
|
407
430
|
- `references/operation-log-query.md` (`engage-flow.operation-log.query`)
|
|
408
431
|
- `references/task-operation-log-query.md` (`engage-task.operation-log.query`)
|
|
409
432
|
- `references/version-list.md` (`engage-flow.version.list`)
|
|
433
|
+
- `references/flow-update-remark.md` (`ae-cli engage-flow flow update-remark`; capability `engage-flow.version.update-remark`)
|
|
410
434
|
- `references/push-record-query.md` (`engage-task.push-record.query`)
|
|
411
435
|
- `references/segment-list-query.md` (`engage-task.segment-list.query`)
|
|
412
436
|
- `references/group-list.md` (`engage-task.group.list`)
|
|
@@ -418,24 +442,23 @@ This split documentation structure is easier to extend later, because commands w
|
|
|
418
442
|
|
|
419
443
|
### setting
|
|
420
444
|
|
|
421
|
-
`channel-touch-limits list` / `channel-touch-limits batch-update` / `channel-touch-limits toggle` / `channel-touch-limits save` / `channel update-config` / `channel test-send` / `approval-approver delete` / `whitelist add` / `whitelist update` / `whitelist delete` / `whitelist verify` / `push-language get` / `push-language set` / `client-param update` / `client-param delete` / `client-param list` / `config-table upload` / `config-table save` / `config-table list` / `config-table query-data` / `config-table update-data` / `config-table delete` / `preset-event list` / `preset-event update` / `common-metric list` / `common-metric get` / `common-metric update` / `common-metric delete` (via `engage-setting`),
|
|
445
|
+
`channel-touch-limits list` / `channel-touch-limits batch-update` / `channel-touch-limits toggle` / `channel-touch-limits save` / `channel update-config` / `channel test-send` / `channel list` / `channel get` / `channel create` / `channel update-status` / `channel delete` / `approval-approver add` / `approval-approver list` / `approval-approver delete` / `whitelist list` / `whitelist add` / `whitelist update` / `whitelist delete` / `whitelist verify` / `push-language get` / `push-language set` / `client-param create` / `client-param update` / `client-param delete` / `client-param list` / `config-table upload` / `config-table save` / `config-table list` / `config-table query-data` / `config-table update-data` / `config-table delete` / `preset-event list` / `preset-event update` / `common-metric list` / `common-metric get` / `common-metric create` / `common-metric update` / `common-metric delete` (via `engage-setting`), plus L3 capability `engage-setting.query.cancel`
|
|
422
446
|
|
|
423
447
|
### task
|
|
424
448
|
|
|
425
|
-
`operation-log query` / `push-record query` / `segment-list *` / `ops *` / `metric *` / `race release` / `channel-ref stats` / `group *`
|
|
449
|
+
`operation-log query` / `push-record query` / `segment-list *` / `ops *` / `metric *` / `race release` / `channel-ref stats` / `group *` / `task delete` / `task modify-group` / `task get` / `task list` / `task stats` / `task build-save-guide` / `task save` / `task manage` (via `engage-task`), plus L3 capabilities `engage-task.task-data.{overview,detail,metric-detail,experiment-report}`
|
|
426
450
|
|
|
427
451
|
### config
|
|
428
452
|
|
|
429
|
-
|
|
453
|
+
Legacy config MCP commands are migrated into the `scene` L2 group and the three L3 report capabilities below.
|
|
430
454
|
|
|
431
455
|
### scene
|
|
432
456
|
|
|
433
|
-
`config-item list` / `config-item create` / `config-item update` / `config-param list` / `config-param batch-add` / `config-param update` / `config-param batch-delete` / `config-group list` / `config-group batch-add` / `config-group update` / `config-group batch-delete` / `preset-metric get` / `preset-metric set` / `config-metric list` / `config-metric get` / `config-metric batch-add` / `config-metric update-rule` / `config-metric batch-delete` / `config-channel create` / `config-channel update` / `config-channel query-log` / `strategy create` / `strategy update` / `strategy log` / `strategy batch-copy` / `template list` / `template get` / `template create` / `template update` / `template update-status` / `template delete` (via `engage-scene`), capability ids `engage-scene.config-item.{list,create,update}`, `engage-scene.config-param.{list,batch-add,update,batch-delete}`, `engage-scene.config-group.{list,batch-add,update,batch-delete}`, `engage-scene.preset-metric.{get,set}`, `engage-scene.config-metric.{list,get,batch-add,update-rule,batch-delete}`, `engage-scene.config-channel.{create,update,query-log}`, `engage-scene.strategy.{create,update,log,batch-copy}`, `engage-scene.template.{list,get,create,update,update-status,delete}`
|
|
457
|
+
`config-item list` / `config-item get` / `config-item create` / `config-item update` / `config-item delete` / `config-param list` / `config-param batch-add` / `config-param update` / `config-param batch-delete` / `config-group list` / `config-group batch-add` / `config-group update` / `config-group batch-delete` / `preset-metric get` / `preset-metric set` / `config-metric list` / `config-metric get` / `config-metric batch-add` / `config-metric update-rule` / `config-metric batch-delete` / `config-channel list` / `config-channel get` / `config-channel create` / `config-channel update` / `config-channel update-status` / `config-channel delete` / `config-channel query-log` / `strategy list` / `strategy get` / `strategy create` / `strategy update` / `strategy log` / `strategy batch-copy` / `strategy manage` / `template list` / `template get` / `template copy` / `template create` / `template update` / `template update-status` / `template delete` (via `engage-scene`), capability ids `engage-scene.config-item.{list,get,create,update,delete}`, `engage-scene.config-param.{list,batch-add,update,batch-delete}`, `engage-scene.config-group.{list,batch-add,update,batch-delete}`, `engage-scene.preset-metric.{get,set}`, `engage-scene.config-metric.{list,get,batch-add,update-rule,batch-delete}`, `engage-scene.config-channel.{list,get,create,update,update-status,delete,query-log}`, `engage-scene.strategy.{list,get,create,update,log,batch-copy,manage}`, `engage-scene.template.{list,get,copy,create,update,update-status,delete}`, plus L3 capabilities `engage-scene.report.{config-item-trigger,config-item-analysis,strategy-comparison}`
|
|
434
458
|
|
|
435
459
|
### activity
|
|
436
460
|
|
|
437
|
-
`activity create` / `activity update` / `activity delete` / `activity list` / `activity get` / `activity pause` / `activity end` / `activity stats` / `activity info-list` / `approval
|
|
438
|
-
<!-- Temporarily disabled: topic create / topic update / task create / task update -->
|
|
461
|
+
`activity create` / `activity update` / `activity delete` / `activity list` / `activity get` / `activity pause` / `activity end` / `activity stats` / `activity info-list` / `approval approve` / `approval reject` / `approval cancel` / `topic create` / `topic update` / `topic remove-task` / `topic delete` / `topic get` / `topic copy` / `activity-type list` / `activity-type batch-add` / `activity-type update` / `activity-type batch-delete` / `task get` / `task create` / `task update` / `task copy` (via `engage-activity`), capability ids `engage-activity.activity.{create,update,delete,list,get,pause,end,stats,info-list}`, `engage-activity.approval.{approve,reject,cancel}`, `engage-activity.topic.{create,update,remove-task,delete,get,copy}`, `engage-activity.activity-type.{list,batch-add,update,batch-delete}`, `engage-activity.task.{get,create,update,copy}`
|
|
439
462
|
|
|
440
463
|
### workbench
|
|
441
464
|
|
|
@@ -443,7 +466,7 @@ This split documentation structure is easier to extend later, because commands w
|
|
|
443
466
|
|
|
444
467
|
### flow
|
|
445
468
|
|
|
446
|
-
`operation-log query` / `version list`
|
|
469
|
+
`operation-log query` / `version list` / `flow update-remark` / `flow save` / `node-config schema` / `flow get` / `flow list` / `flow manage` / `node-config validate` / `flow delete` / `flow modify-base-info` (via `engage-flow`), plus L3 capabilities `engage-flow.report.{node-overview,process,node-detail,ab-split-node}`
|
|
447
470
|
|
|
448
471
|
## Date Format
|
|
449
472
|
|
|
@@ -453,20 +476,21 @@ Commands that accept date parameters usually use `yyyy-MM-dd`, for example `--st
|
|
|
453
476
|
|
|
454
477
|
High-risk delete commands (`risk: high-risk-write`) require explicit user authorization before execution. Ordinary write commands (`risk: write`) do not:
|
|
455
478
|
|
|
456
|
-
- Channels
|
|
457
|
-
-
|
|
458
|
-
-
|
|
459
|
-
-
|
|
479
|
+
- Channels: `engage-setting channel create` (write), `engage-setting channel delete` (high-risk-write), `engage-setting channel update-status` (write)
|
|
480
|
+
- Config channels (config center channel management): `engage-scene config-channel create|update|update-status` (write), `engage-scene config-channel delete` (high-risk-write)
|
|
481
|
+
- Strategies and config items: `engage-scene config-item delete` (high-risk-write), `engage-scene template copy` and `engage-scene strategy manage` (write)
|
|
482
|
+
- Flows: `engage-flow flow update-remark` (write), `engage-flow flow save` (write), `engage-flow flow modify-base-info` (write), `engage-flow flow manage` (write), `engage-flow flow delete` (high-risk-write)
|
|
483
|
+
- Tasks: `engage-task task save` (write), `engage-task task manage` (write)
|
|
460
484
|
|
|
461
485
|
For task draft creation or update, use this workflow:
|
|
462
486
|
|
|
463
|
-
1. `ae-cli engage
|
|
464
|
-
2. `ae-cli engage
|
|
487
|
+
1. `ae-cli engage-setting channel list --project-id <projectId>`
|
|
488
|
+
2. `ae-cli engage-task task build-save-guide --project-id <projectId> --req '{...}'`
|
|
465
489
|
3. If the guide says QP-derived fields are needed, create the audience with `analysis user-cluster create`, then read its server-authored definition with `analysis user-cluster get`
|
|
466
|
-
4. `ae-cli engage
|
|
490
|
+
4. `ae-cli engage-task task save --project-id <projectId> --req '{...}'`
|
|
467
491
|
|
|
468
|
-
|
|
492
|
+
`engage-task task build-save-guide` is a read-only helper. It returns scenario-specific required fields, channel content schema, unsupported combinations, examples, and a handoff template for `save_task`.
|
|
469
493
|
|
|
470
|
-
|
|
494
|
+
`engage-task task save` only saves a draft. It does not submit approval, does not start sending, and does not trigger task execution. If `req.taskId` is omitted it creates a new draft; if `req.taskId` is present it updates an existing draft. Update mode only supports draft tasks, and omitted fields can inherit from the existing draft before validation.
|
|
471
495
|
|
|
472
496
|
Audience creation is not a fixed preflight step. Use direct `analysis user-cluster create` only when the guide requires a condition audience, and prefer the returned `cluster_name`/`clusterKey`. If the Engage schema explicitly requires QP-derived fields such as `targetConfig.qp`, `triggerConfig.triggerRule`, `clientConfig.clientQp`, or `completionIndicatorDef.event`, read the saved server-authored definition with `analysis user-cluster get`; never assemble raw QP manually.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> Capability ids: `engage-activity.activity-type.{list,batch-add,update,batch-delete}` · Domain: `engage`.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Campaign activities — activity types (system + custom). Batch add/delete loops single-item backend calls inside the capability service (no dedicated batch backend API).
|
|
6
6
|
|
|
7
7
|
## Commands
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> Capability ids: `engage-activity.activity.{create,update,delete,list,get,pause,end,stats,info-list}` · Domain: `engage`.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Campaign activities — activity entity management. `create`/`update` pass backend DTOs via `--payload` (native camelCase structure; `project_id` is supplied separately as a flag).
|
|
6
6
|
|
|
7
7
|
## Commands
|
|
8
8
|
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# engage-activity approval
|
|
2
2
|
|
|
3
|
-
> Capability ids: `engage-activity.approval.{
|
|
3
|
+
> Capability ids: `engage-activity.approval.{approve,reject,cancel}` · Domain: `engage`.
|
|
4
|
+
>
|
|
5
|
+
> **Temporarily disabled:** `engage-activity.approval.submit` — do not call until re-enabled.
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
Campaign activities — activity approval workflow. Current actions target an activity (`ApprovalActivityIdDealDTO`: `projectId` + `activityId` + `reason`); each is a state-changing `write` and does not support dry-run. `reject` requires `reason`; other actions treat `reason` as optional.
|
|
6
8
|
|
|
7
9
|
## Commands
|
|
8
10
|
|
|
9
11
|
```bash
|
|
10
|
-
# Submit an activity for approval
|
|
11
|
-
ae-cli engage-activity approval submit --project-id <project_id> --activity-id <activity_id>
|
|
12
|
-
|
|
13
12
|
# Approve an activity
|
|
14
13
|
ae-cli engage-activity approval approve --project-id <project_id> --activity-id <activity_id>
|
|
15
14
|
|
|
@@ -24,7 +23,6 @@ ae-cli engage-activity approval cancel --project-id <project_id> --activity-id <
|
|
|
24
23
|
|
|
25
24
|
| Command | Required flags | Notes |
|
|
26
25
|
|---|---|---|
|
|
27
|
-
| submit | `--project-id`, `--activity-id` | `--reason` optional. |
|
|
28
26
|
| approve | `--project-id`, `--activity-id` | `--reason` optional. |
|
|
29
27
|
| reject | `--project-id`, `--activity-id`, `--reason` | `--reason` required, max 72 characters. |
|
|
30
28
|
| cancel | `--project-id`, `--activity-id` | `--reason` optional. |
|
|
@@ -37,13 +35,13 @@ ae-cli engage-activity approval cancel --project-id <project_id> --activity-id <
|
|
|
37
35
|
|
|
38
36
|
- All approval actions are `write` (real state changes) and do not support dry-run; they do not require `--yes` (only `high-risk-write` does).
|
|
39
37
|
- Approve/reject require the caller to be a valid approver of the activity (enforced server-side).
|
|
38
|
+
- Do **not** call `engage-activity.approval.submit`; it is temporarily unavailable.
|
|
40
39
|
|
|
41
40
|
## Common Errors
|
|
42
41
|
|
|
43
42
|
| code | when |
|
|
44
43
|
|---|---|
|
|
45
44
|
| `ACTIVITY_NOT_FOUND` | activity id missing in project |
|
|
46
|
-
| `ACTIVITY_NO_APPROVAL_TASK` | submit with no standalone/topic tasks |
|
|
47
45
|
| `ACTIVITY_STATUS_INVALID` | activity not in draft/pending |
|
|
48
46
|
| `APPROVAL_NOT_PENDING` | no under-approval record |
|
|
49
47
|
| `NOT_APPROVER` | caller is not a project approver |
|