@thinkingai/ae-cli 6.0.33 → 6.0.34

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 (80) hide show
  1. package/README.md +3 -2
  2. package/README.zh.md +3 -2
  3. package/dist/index.js +2 -2
  4. package/dist/{te-engage-GJRVQMK3.js → te-engage-2FSDUOIZ.js} +965 -1578
  5. package/dist/{te-engage-JIXX3WBI.js → te-engage-BMJ6UOUU.js} +965 -1578
  6. package/dist/{te-kb-CIZXRWMO.js → te-kb-E7NSCBRB.js} +25 -6
  7. package/package.json +1 -1
  8. package/skills/ae-engage/SKILL.md +127 -104
  9. package/skills/ae-engage/references/activity-activity-type.md +1 -1
  10. package/skills/ae-engage/references/activity-activity.md +1 -1
  11. package/skills/ae-engage/references/activity-approval.md +5 -7
  12. package/skills/ae-engage/references/activity-task.md +12 -18
  13. package/skills/ae-engage/references/activity-topic.md +39 -22
  14. package/skills/ae-engage/references/add-approver.md +4 -4
  15. package/skills/ae-engage/references/add-channel.md +10 -5
  16. package/skills/ae-engage/references/approval-approver-delete.md +1 -1
  17. package/skills/ae-engage/references/approver-list.md +4 -4
  18. package/skills/ae-engage/references/build-task-save-guide.md +13 -13
  19. package/skills/ae-engage/references/cancel-query-by-request-id.md +7 -6
  20. package/skills/ae-engage/references/channel-detail.md +14 -9
  21. package/skills/ae-engage/references/channel-list.md +15 -10
  22. package/skills/ae-engage/references/channel-mgmt.md +109 -0
  23. package/skills/ae-engage/references/channel-test-send.md +1 -1
  24. package/skills/ae-engage/references/channel-update-config.md +1 -1
  25. package/skills/ae-engage/references/channel_touch_limits_list.md +1 -1
  26. package/skills/ae-engage/references/client-param.md +34 -16
  27. package/skills/ae-engage/references/common-metric.md +85 -18
  28. package/skills/ae-engage/references/config-item-analysis-report.md +8 -27
  29. package/skills/ae-engage/references/config-item-strategy-comparison.md +7 -18
  30. package/skills/ae-engage/references/config-item-trigger-report.md +8 -35
  31. package/skills/ae-engage/references/delete-channel.md +5 -5
  32. package/skills/ae-engage/references/delete-flow.md +5 -5
  33. package/skills/ae-engage/references/flow-ab-split-node-report.md +11 -45
  34. package/skills/ae-engage/references/flow-detail.md +15 -10
  35. package/skills/ae-engage/references/flow-list.md +9 -4
  36. package/skills/ae-engage/references/flow-node-config-schema.md +9 -8
  37. package/skills/ae-engage/references/flow-node-detail-report.md +11 -46
  38. package/skills/ae-engage/references/flow-node-overview-report.md +11 -43
  39. package/skills/ae-engage/references/flow-process-report.md +12 -50
  40. package/skills/ae-engage/references/flow-update-remark.md +19 -0
  41. package/skills/ae-engage/references/manage-flow.md +19 -19
  42. package/skills/ae-engage/references/manage-task.md +5 -5
  43. package/skills/ae-engage/references/modify-flow-base-info.md +8 -8
  44. package/skills/ae-engage/references/preset-event.md +1 -1
  45. package/skills/ae-engage/references/push-language.md +1 -1
  46. package/skills/ae-engage/references/save-flow.md +54 -52
  47. package/skills/ae-engage/references/save-task.md +23 -17
  48. package/skills/ae-engage/references/scene-config-channel.md +90 -10
  49. package/skills/ae-engage/references/scene-config-group.md +1 -1
  50. package/skills/ae-engage/references/scene-config-item.md +27 -4
  51. package/skills/ae-engage/references/scene-config-metric.md +1 -1
  52. package/skills/ae-engage/references/scene-config-param.md +2 -2
  53. package/skills/ae-engage/references/scene-preset-metric.md +1 -1
  54. package/skills/ae-engage/references/scene-strategy.md +19 -3
  55. package/skills/ae-engage/references/scene-template.md +10 -4
  56. package/skills/ae-engage/references/task-data-detail.md +5 -67
  57. package/skills/ae-engage/references/task-data-overview.md +5 -35
  58. package/skills/ae-engage/references/task-detail.md +5 -5
  59. package/skills/ae-engage/references/task-experiment-report.md +5 -38
  60. package/skills/ae-engage/references/task-list.md +4 -4
  61. package/skills/ae-engage/references/task-metric-detail.md +5 -43
  62. package/skills/ae-engage/references/task-stats.md +5 -5
  63. package/skills/ae-engage/references/update-channel-status.md +6 -6
  64. package/skills/ae-engage/references/validate-flow-node-config.md +12 -11
  65. package/skills/ae-engage/references/whitelist-list.md +4 -4
  66. package/skills/ae-engage/references/whitelist.md +1 -1
  67. package/skills/ae-engage/references/workbench-workbench.md +1 -1
  68. package/skills/ae-kb/SKILL.md +9 -5
  69. package/skills/ae-engage/references/config-channel-detail.md +0 -31
  70. package/skills/ae-engage/references/config-channel-list.md +0 -26
  71. package/skills/ae-engage/references/config-item-detail.md +0 -29
  72. package/skills/ae-engage/references/config-item-list.md +0 -18
  73. package/skills/ae-engage/references/copy-config-template.md +0 -28
  74. package/skills/ae-engage/references/delete-config-channel.md +0 -23
  75. package/skills/ae-engage/references/delete-config-item.md +0 -24
  76. package/skills/ae-engage/references/engage-scene-config-item.md +0 -69
  77. package/skills/ae-engage/references/manage-strategy.md +0 -73
  78. package/skills/ae-engage/references/strategy-detail.md +0 -72
  79. package/skills/ae-engage/references/strategy-list.md +0 -20
  80. package/skills/ae-engage/references/update-config-channel-status.md +0 -31
@@ -32,5 +32,5 @@ ae-cli engage-setting channel update-config \
32
32
  ## Decision Rules
33
33
 
34
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.
35
+ - `--config` is the channel-specific JSON config; discover the existing config with `ae-cli engage-setting channel get` first rather than inventing it.
36
36
  - Risk is `write`; ordinary update, no confirmation gate.
@@ -25,5 +25,5 @@ ae-cli engage-setting channel-touch-limits list --project-id <project_id> --dry-
25
25
  ## Decision Rules
26
26
 
27
27
  - Use this command when the user asks for project channel touch-limit, delivery-cap, or fatigue-control rules.
28
- - Use `+channel_list` to list channels and `+channel_detail` to inspect one channel; neither returns the project touch-limit rule list.
28
+ - Use `engage-setting channel list` to list channels and `engage-setting channel get` to inspect one channel; neither returns the project touch-limit rule list.
29
29
  - If `items` is empty, do not invent rule IDs or channel IDs; report that no touch-limit rules were returned for the project.
@@ -1,37 +1,53 @@
1
1
  # engage-setting client-param
2
2
 
3
- > Capability ids: `engage-setting.client-param.{update,delete,list}` · Domain: `engage`. (`create` temporarily disabled in CLI.)
3
+ > Capability ids: `engage-setting.client-param.{create,update,delete,list}` · Domain: `engage`.
4
+
5
+ Manage custom client params. `select_type` is derived server-side from `column_type`. `column_type` / `select_type` are immutable after create.
4
6
 
5
7
  ## Commands
6
8
 
7
9
  ```bash
8
- # Update a custom client param
10
+ # Create a custom client param
11
+ ae-cli engage-setting client-param create \
12
+ --project-id <project_id> --column-name <name> --column-type varchar \
13
+ [--column-desc <desc>] [--column-remark <remark>] [--alternative-val '["a","b"]']
14
+
15
+ # Update display metadata (type is immutable)
9
16
  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>]
17
+ --project-id <project_id> --column-name <name> \
18
+ [--column-desc <desc>] [--column-remark <remark>] [--alternative-val '["a","b"]']
12
19
 
13
20
  # Delete a custom client param (high-risk)
14
21
  ae-cli engage-setting client-param delete --project-id <project_id> --column-name <name> --yes
15
22
 
16
- # List custom client params
23
+ # List client params (custom + preset)
17
24
  ae-cli engage-setting client-param list --project-id <project_id>
18
25
  ```
19
26
 
20
27
  ## Parameters
21
28
 
29
+ ### create
30
+
31
+ | Parameter | Required | Description |
32
+ |---|---|---|
33
+ | `--project-id` / `-p` | Yes | Numeric project ID. |
34
+ | `--column-name` | Yes | Must match `^[A-Za-z][A-Za-z0-9_]*$`, max 80. |
35
+ | `--column-type` | Yes | `varchar` \| `bigint` \| `double` \| `boolean`. `timestamp` is not supported. `select_type` is derived server-side (`varchar→string`, `bigint/double→number`, `boolean→bool`). |
36
+ | `--column-desc` | No | Display name. Defaults to an empty string. |
37
+ | `--column-remark` | No | Description/remark. |
38
+ | `--alternative-val` | No | JSON array of alternative values. Only allowed when `--column-type` is `varchar`. |
39
+
22
40
  ### update
23
41
 
24
42
  | Parameter | Required | Description |
25
43
  |---|---|---|
26
44
  | `--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. |
45
+ | `--column-name` | Yes | Existing custom client param name. |
46
+ | `--column-desc` | No | Display name. Omit to keep existing. |
47
+ | `--column-remark` | No | Description/remark. Omit to keep existing. |
48
+ | `--alternative-val` | No | JSON array of alternative values. Only allowed when existing `column_type` is `varchar`. Omit to keep existing. |
49
+
50
+ Do **not** pass `--column-type` / `--select-type` on update they are rejected and cannot be changed.
35
51
 
36
52
  ### delete
37
53
 
@@ -48,11 +64,13 @@ ae-cli engage-setting client-param list --project-id <project_id>
48
64
 
49
65
  ## Output
50
66
 
51
- - `update`: `data.success` — whether the operation succeeded.
67
+ - `create` / `update`: `data.success`.
52
68
  - `delete`: `data.success` and `data.task_list` (tasks still referencing the param, which block deletion; each item has `task_id`, `task_name`).
53
69
  - `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
70
 
55
71
  ## Decision Rules
56
72
 
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.
73
+ - Prefer `list` first to avoid duplicate `column_name` and to confirm existing type before update.
74
+ - Use only the four allowed `column_type` values; never invent types like `string` / `single`.
75
+ - After create, re-`list` to verify the stored row.
76
+ - `delete` is `high-risk-write` and requires `--yes`. When `data.success` is false, report `data.task_list` instead of forcing deletion.
@@ -1,6 +1,7 @@
1
1
  # engage-setting common-metric
2
2
 
3
- > Capability ids: `engage-setting.common-metric.{list,get,update,delete}` · Domain: `engage`. (`create` temporarily disabled in CLI.)
3
+ > Capability ids: `engage-setting.common-metric.{list,get,create,update,delete}` · Domain: `engage`.
4
+ > Auth: read uses `opsViewSetting` (list also allows `opsViewOperationTask`); write/delete use `opsEditSetting`.
4
5
 
5
6
  ## Commands
6
7
 
@@ -11,10 +12,15 @@ ae-cli engage-setting common-metric list --project-id <project_id>
11
12
  # Get a common metric detail
12
13
  ae-cli engage-setting common-metric get --project-id <project_id> --metric-name <name>
13
14
 
15
+ # Create a PRESET common metric (metric-type must be 1)
16
+ ae-cli engage-setting common-metric create \
17
+ --project-id <project_id> --metric-type 1 --metric-name <name> --metric-qp '<qp_json>' \
18
+ --metric-window-num 1 --metric-window-time-unit day --display-name <display>
19
+
14
20
  # Update a common metric
15
21
  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>
22
+ --project-id <project_id> --metric-type 1 --metric-name <name> --metric-qp '<qp_json>' \
23
+ --metric-window-num <num> --metric-window-time-unit day --display-name <display>
18
24
 
19
25
  # Delete a common metric (high-risk)
20
26
  ae-cli engage-setting common-metric delete --project-id <project_id> --metric-name <name> --yes
@@ -35,27 +41,85 @@ ae-cli engage-setting common-metric delete --project-id <project_id> --metric-na
35
41
  | `--project-id` / `-p` | Yes | Numeric project ID. |
36
42
  | `--metric-name` | Yes | Metric name. |
37
43
 
38
- ### update
44
+ ### create / update
39
45
 
40
46
  | Parameter | Required | Description |
41
47
  |---|---|---|
42
48
  | `--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. |
49
+ | `--metric-type` | Yes | `1` = PRESET (common metric). **create requires `1`**. Do not use `2` (CUSTOM / task-side). |
50
+ | `--metric-name` | Yes | Technical name; prefer `^[a-z][0-9a-z_]{0,79}$`. |
51
+ | `--metric-qp` | Yes | Complete metric QP **JSON object string** (`type=0` event or `type=1` formula). |
52
+ | `--metric-window-num` | Yes | Window size (integer ≥ 1). |
53
+ | `--metric-window-time-unit` | Yes | `minute` / `hour` / `day` (lowercase). |
54
+ | `--display-name` | Yes | Display name. |
55
+ | `--note` | No | Remark. |
56
+ | `--order-id` | No | Sort order (usually omit on setting-page create). |
57
+ | `--metric-setting-id` | No | Binding id (task/config metricMap; usually omit on setting-page create). |
58
+ | `--metric-params` | No | Params JSON string; for formula metrics often `{"format":"float"}`. |
53
59
 
54
60
  ## Output
55
61
 
56
62
  - `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
63
  - `get`: `data.metric` — a single metric object with the same fields, or `null`.
58
- - `update` / `delete`: `data.success`.
64
+ - `create` / `update` / `delete`: `data.success`.
65
+
66
+ ## Agent workflow (Pattern A: discover → match → assemble QP → write)
67
+
68
+ Unlike the Engage console (user picks events in a picker), Agents must discover real project metadata first. Never invent `event_name` / property names / `--metric-qp` placeholders such as `event`.
69
+
70
+ ```bash
71
+ # 1) Discover candidate events (keyword: payment / recharge / purchase / ...)
72
+ ae-cli analysis-meta event list --project-id <project_id> --query <keyword> \
73
+ --fields '["event_name","event_desc","authentication_status"]' --limit 20
74
+
75
+ # Optional soft hint: project recharge-success event name
76
+ ae-cli engage-setting preset-event list --project-id <project_id>
77
+ # → data.recharge_event_desc may contain eventName (not a ready metric_qp)
78
+
79
+ # 2) If filters are needed, list properties for the matched event
80
+ ae-cli analysis-meta property list --project-id <project_id> \
81
+ --scope event --event-name <matched_event_name>
82
+
83
+ # 3) Assemble a type=0 metric QP object from the matched event, then create
84
+ ae-cli engage-setting common-metric create --project-id <project_id> \
85
+ --metric-type 1 --metric-name <name> --metric-qp '<qp_json>' \
86
+ --metric-window-num 1 --metric-window-time-unit day --display-name <display>
87
+ ```
88
+
89
+ If multiple events remain plausible after discovery, stop and ask the user which `event_name` to use.
90
+
91
+ ## `--metric-qp` example (type=0 event analysis)
92
+
93
+ Pass as a single JSON **object string**. Minimal shape aligned with the Engage setting-page event metric:
94
+
95
+ ```json
96
+ {
97
+ "type": 0,
98
+ "eventName": "purchase",
99
+ "eventDesc": "Purchase",
100
+ "eventType": "event",
101
+ "analysis": "A100",
102
+ "analysisDesc": "Total count",
103
+ "analysisParams": "",
104
+ "quota": "",
105
+ "quotaDesc": "",
106
+ "filts": [],
107
+ "relation": 1,
108
+ "customEvent": "",
109
+ "customFilters": [],
110
+ "eventNameDisplay": "Purchase total count",
111
+ "subTableType": "",
112
+ "taPropQuota": {
113
+ "analysis": "A100",
114
+ "analysisDesc": "Total count",
115
+ "analysisParams": "",
116
+ "quota": "",
117
+ "quotaDesc": ""
118
+ }
119
+ }
120
+ ```
121
+
122
+ CLI rejects non-JSON, non-object, and `{}` values before the request is sent.
59
123
 
60
124
  ## Preflight for config-metric batch-add
61
125
 
@@ -65,11 +129,14 @@ ae-cli engage-setting common-metric delete --project-id <project_id> --metric-na
65
129
  ae-cli engage-setting common-metric list --project-id <project_id>
66
130
  ```
67
131
 
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.
132
+ If `items` is empty, create PRESET metrics with `common-metric create` (Pattern A above) or treat the case as environment-blocked.
69
133
 
70
134
  ## Decision Rules
71
135
 
72
- - Use these commands when the user asks to manage common metrics (常用指标) for the analysis workbench.
136
+ - Use these commands when the user asks to manage common metrics for the analysis workbench.
73
137
  - 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.
138
+ - For create/update, discover events/properties via `ae-analysis` (`analysis-meta event list` / `property list`) before assembling `--metric-qp`.
139
+ - `--metric-type` for setting-page common metrics is always `1` (PRESET). create rejects any other value.
140
+ - `--metric-window-time-unit` must be lowercase `minute` / `hour` / `day` (not `DAY`).
141
+ - `--metric-qp` must be a complete metric QP JSON object; do not pass `{}` or placeholder strings.
75
142
  - `delete` is `high-risk-write` and requires `--yes` (or interactive confirmation).
@@ -1,33 +1,14 @@
1
- # ae-engage +config_item_analysis_report
1
+ # engage-scene.report.config-item-analysis
2
2
 
3
+ Query config item analysis results through the L3 Capability Gateway.
3
4
 
4
- Query the config item analysis report.
5
+ Mapped command: `ae-cli capability run engage-scene.report.config-item-analysis --input '<json>'`
5
6
 
6
- Mapped command: `ae-cli engage +config_item_analysis_report`
7
-
8
- ## Flags
9
-
10
- | Flag | Type | Required | Description |
11
- |------|------|------|------|
12
- | `--project_id` / `-p` | number | Yes | Project ID |
13
- | `--config_id` | string | Yes | config item ID |
14
- | `--start_time` | string | Yes | Start date |
15
- | `--end_time` | string | Yes | End date |
16
- | `--request_id` | string | No | Query requestId |
17
- | `--template_id_list` | json | No | template ID JSON array |
18
- | `--strategy_id_list` | json | No | strategy ID JSON array |
19
- | `--show_time_zone` | number | No | display timezone offset |
20
-
21
- ## Parameter Constraints
22
-
23
- - `--template_id_list` and `--strategy_id_list` cannot be used together.
24
- - If neither is provided, query config-item-level data.
25
- - `--start_time`、`--end_time` use `yyyy-MM-dd`.
26
-
27
- ## Examples
7
+ Required input: `project_id`, `config_id`, `start_time`, `end_time`. Optional input: `request_id`,
8
+ `template_id_list`, `strategy_id_list`, `show_time_zone`. `template_id_list` and `strategy_id_list`
9
+ are mutually exclusive.
28
10
 
29
11
  ```bash
30
- ae-cli engage +config_item_analysis_report \
31
- --project_id 1 --config_id cfg_123 \
32
- --start_time 2026-04-01 --end_time 2026-04-07
12
+ ae-cli capability run engage-scene.report.config-item-analysis \
13
+ --input '{"project_id":1,"config_id":"cfg_123","start_time":"2026-04-01","end_time":"2026-04-07"}'
33
14
  ```
@@ -1,24 +1,13 @@
1
- # ae-engage +config_item_strategy_comparison
1
+ # engage-scene.report.strategy-comparison
2
2
 
3
+ Compare config strategy results through the L3 Capability Gateway.
3
4
 
4
- Compare multiple strategies under the same config item.
5
+ Mapped command: `ae-cli capability run engage-scene.report.strategy-comparison --input '<json>'`
5
6
 
6
- Mapped command: `ae-cli engage +config_item_strategy_comparison`
7
-
8
- ## Flags
9
-
10
- | Flag | Type | Required | Description |
11
- |------|------|------|------|
12
- | `--project_id` / `-p` | number | Yes | Project ID |
13
- | `--config_id` | string | Yes | config item ID |
14
- | `--strategy_id_list` | json | Yes | strategy ID JSON array with at least two entries |
15
- | `--request_id` | string | No | query requestId |
16
- | `--show_time_zone` | number | No | display timezone offset |
17
-
18
- ## Examples
7
+ Required input: `project_id`, `config_id`, `strategy_id_list` with at least two IDs. Optional input:
8
+ `request_id`, `show_time_zone`.
19
9
 
20
10
  ```bash
21
- ae-cli engage +config_item_strategy_comparison \
22
- --project_id 1 --config_id cfg_123 \
23
- --strategy_id_list '["strategy_a","strategy_b"]'
11
+ ae-cli capability run engage-scene.report.strategy-comparison \
12
+ --input '{"project_id":1,"config_id":"cfg_123","strategy_id_list":["strategy_a","strategy_b"]}'
24
13
  ```
@@ -1,41 +1,14 @@
1
- # ae-engage +config_item_trigger_report
1
+ # engage-scene.report.config-item-trigger
2
2
 
3
+ Query config item publish and trigger trends through the L3 Capability Gateway.
3
4
 
4
- Query the publish and trigger trend report for a config item.
5
+ Mapped command: `ae-cli capability run engage-scene.report.config-item-trigger --input '<json>'`
5
6
 
6
- Mapped command: `ae-cli engage +config_item_trigger_report`
7
-
8
- ## Flags
9
-
10
- | Flag | Type | Required | Description |
11
- |------|------|------|------|
12
- | `--project_id` / `-p` | number | Yes | Project ID |
13
- | `--config_id` | string | Yes | config item ID |
14
- | `--start_time` | string | Yes | Start date |
15
- | `--end_time` | string | Yes | End date |
16
- | `--request_id` | string | No | query requestId |
17
- | `--template_id_list` | json | No | template ID JSON array |
18
- | `--strategy_id_list` | json | No | strategy ID JSON array |
19
- | `--show_time_zone` | number | No | display timezone offset |
20
- | `--analyze_report_internal_query` | boolean | No | internal analysis switch |
21
-
22
- ## Enum Notes
23
-
24
- ### `--analyze_report_internal_query`
25
-
26
- - `true`: use the internal analysis-report query path
27
- - `false`: use the default query path
28
-
29
- ## Parameter Constraints
30
-
31
- - `--template_id_list` and `--strategy_id_list` cannot be used together.
32
- - If neither is provided, query config-item-level data.
33
- - `--start_time`、`--end_time` use `yyyy-MM-dd`.
34
-
35
- ## Examples
7
+ Required input: `project_id`, `config_id`, `start_time`, `end_time`. Optional input: `request_id`,
8
+ `template_id_list`, `strategy_id_list`, `show_time_zone`, `analyze_report_internal_query`.
9
+ `template_id_list` and `strategy_id_list` are mutually exclusive.
36
10
 
37
11
  ```bash
38
- ae-cli engage +config_item_trigger_report \
39
- --project_id 1 --config_id cfg_123 \
40
- --start_time 2026-04-01 --end_time 2026-04-07
12
+ ae-cli capability run engage-scene.report.config-item-trigger \
13
+ --input '{"project_id":1,"config_id":"cfg_123","start_time":"2026-04-01","end_time":"2026-04-07"}'
41
14
  ```
@@ -1,16 +1,16 @@
1
- # ae-engage +delete_channel
1
+ # ae-engage engage-setting channel delete
2
2
 
3
3
 
4
4
  Delete an Engage channel.
5
5
 
6
- Mapped command: `ae-cli engage +delete_channel`
6
+ Mapped command: `ae-cli engage-setting channel delete`
7
7
 
8
8
  ## Flags
9
9
 
10
10
  | Flag | Type | Required | Description |
11
11
  |------|------|------|------|
12
- | `--project_id` / `-p` | number | Yes | Project ID |
13
- | `--channel_id` | string | Yes | channel ID |
12
+ | `--project-id` / `-p` | number | Yes | Project ID |
13
+ | `--channel-id` | string | Yes | channel ID |
14
14
 
15
15
  ## Safety Constraints
16
16
 
@@ -19,5 +19,5 @@ This command is a **write operation** and Before executing, confirm that this ch
19
19
  ## Examples
20
20
 
21
21
  ```bash
22
- ae-cli engage +delete_channel --project_id 1 --channel_id <channel_id>
22
+ ae-cli engage-setting channel delete --project-id 1 --channel-id <channel_id>
23
23
  ```
@@ -1,16 +1,16 @@
1
- # ae-engage +delete_flow
1
+ # ae-cli engage-flow flow delete
2
2
 
3
3
 
4
4
  Batch delete flows.
5
5
 
6
- Mapped command: `ae-cli engage +delete_flow`
6
+ Mapped command: `ae-cli engage-flow flow delete`
7
7
 
8
8
  ## Flags
9
9
 
10
10
  | Flag | Type | Required | Description |
11
11
  |------|------|------|------|
12
- | `--project_id` / `-p` | number | Yes | Project ID |
13
- | `--flow_uuid_list` | json | Yes | Flow UUID JSON array |
12
+ | `--project-id` / `-p` | number | Yes | Project ID |
13
+ | `--flow-uuid-list` | json | Yes | Flow UUID JSON array |
14
14
 
15
15
  ## Safety Constraints
16
16
 
@@ -19,5 +19,5 @@ This command is a **write operation** and and deletes flows.
19
19
  ## Examples
20
20
 
21
21
  ```bash
22
- ae-cli engage +delete_flow --project_id 1 --flow_uuid_list '["flow_uuid_1"]'
22
+ ae-cli engage-flow flow delete --project-id 1 --flow-uuid-list '["flow_uuid_1"]'
23
23
  ```
@@ -1,53 +1,19 @@
1
- # ae-engage +flow_ab_split_node_report
1
+ # engage-flow.report.ab-split-node
2
2
 
3
+ Query an AB split node report through the L3 Capability Gateway.
3
4
 
4
- Query the AB split node report.
5
+ Mapped command: `ae-cli capability run engage-flow.report.ab-split-node --input '<json>'`
5
6
 
6
- Mapped command: `ae-cli engage +flow_ab_split_node_report`
7
+ ## Input
7
8
 
8
- ## Flags
9
+ - Required: `project_id`, `report_type`, `node_uuid`, `start_time`, `end_time`.
10
+ - Provide at least one of `flow_id` or `flow_uuid`.
11
+ - `report_type` is `overview` or `detail`.
12
+ - Optional: `request_id`, `push_language_code`, `indicators_uuid`, `show_time_zone`.
9
13
 
10
- | Flag | Type | Required | Description |
11
- |------|------|------|------|
12
- | `--project_id` / `-p` | number | Yes | Project ID |
13
- | `--report_type` | string | Yes | report type: `overview` or `detail` |
14
- | `--node_uuid` | string | Yes | AB node UUID |
15
- | `--start_time` | string | Yes | Start date |
16
- | `--end_time` | string | Yes | End date |
17
- | `--flow_id` | string | No | Flow ID |
18
- | `--flow_uuid` | string | No | Flow UUID |
19
- | `--request_id` | string | No | Query requestId |
20
- | `--push_language_code` | string | No | push language code |
21
- | `--indicators_uuid` | string | No | indicator UUID |
22
- | `--show_time_zone` | string | No | display timezone offset |
23
-
24
- ## Enum Notes
25
-
26
- ### `--report_type`
27
-
28
- - `overview`: AB split node overview report
29
- - `detail`: AB split node detail report
30
-
31
- ### `--push_language_code`
32
-
33
- Common values include:
34
-
35
- - `default`
36
- - `en`
37
- - `zh-Hans`
38
- - `zh-Hant`
39
- - `ja`
40
- - `ko`
41
-
42
- ## Parameter Constraints
43
-
44
- - `--flow_id` At least one of `--flow_id` and `--flow_uuid` must be provided.
45
- - `--start_time`、`--end_time` use `yyyy-MM-dd`.
46
-
47
- ## Examples
14
+ ## Example
48
15
 
49
16
  ```bash
50
- ae-cli engage +flow_ab_split_node_report \
51
- --project_id 1 --flow_uuid flow_uuid_123 --node_uuid node_123 \
52
- --report_type overview --start_time 2026-04-01 --end_time 2026-04-07
17
+ ae-cli capability run engage-flow.report.ab-split-node --input \
18
+ '{"project_id":1,"flow_uuid":"flow_uuid_123","node_uuid":"node_123","report_type":"overview","start_time":"2026-04-01","end_time":"2026-04-07"}'
53
19
  ```
@@ -1,20 +1,25 @@
1
- # ae-engage +flow_detail
1
+ # ae-cli engage-flow flow get
2
2
 
3
3
 
4
4
  Query flow details.
5
5
 
6
- Mapped command: `ae-cli engage +flow_detail`
6
+ Mapped command: `ae-cli engage-flow flow get`
7
+
8
+ ## Response shape
9
+
10
+ The flow detail is under `data.flow`. Every response key is snake_case, for example
11
+ `data.flow.mapping_status`, `data.flow.version_type`, and `data.flow.node_list[].type`.
7
12
 
8
13
  ## Flags
9
14
 
10
15
  | Flag | Type | Required | Description |
11
16
  |------|------|------|------|
12
- | `--project_id` / `-p` | number | Yes | Project ID |
13
- | `--flow_uuid` | string | Yes | Flow UUID |
17
+ | `--project-id` / `-p` | number | Yes | Project ID |
18
+ | `--flow-uuid` | string | Yes | Flow UUID |
14
19
 
15
20
  ## Common enums in the response
16
21
 
17
- ### `status`
22
+ ### `data.flow.status`
18
23
 
19
24
  - `0`: `DRAFT`
20
25
  - `1`: `WAITING`
@@ -22,7 +27,7 @@ Mapped command: `ae-cli engage +flow_detail`
22
27
  - `3`: `PENDING`
23
28
  - `4`: `COMPLETE`
24
29
 
25
- ### `mappingStatus`
30
+ ### `data.flow.mapping_status`
26
31
 
27
32
  - `0`: `DRAFT`
28
33
  - `1`: `APPROVE`
@@ -34,7 +39,7 @@ Mapped command: `ae-cli engage +flow_detail`
34
39
  - `7`: `PENDING`
35
40
  - `8`: `COMPLETE`
36
41
 
37
- ### `versionType`
42
+ ### `data.flow.version_type`
38
43
 
39
44
  - `0`: history version
40
45
  - `1`: current version
@@ -42,13 +47,13 @@ Mapped command: `ae-cli engage +flow_detail`
42
47
  - `3`: new version
43
48
  - `4`: test version
44
49
 
45
- ### `entryTriggerType`
50
+ ### `data.flow.entry_trigger_type`
46
51
 
47
52
  - `0`: scheduled single trigger
48
53
  - `1`: scheduled recurring trigger
49
54
  - `2`: event trigger
50
55
 
51
- ### `nodeList[].type`
56
+ ### `data.flow.node_list[].type`
52
57
 
53
58
  Common node types include:
54
59
 
@@ -74,5 +79,5 @@ Common node types include:
74
79
  ## Examples
75
80
 
76
81
  ```bash
77
- ae-cli engage +flow_detail --project_id 1 --flow_uuid flow_uuid_123
82
+ ae-cli engage-flow flow get --project-id 1 --flow-uuid flow_uuid_123
78
83
  ```
@@ -1,18 +1,23 @@
1
- # ae-engage +flow_list
1
+ # ae-cli engage-flow flow list
2
2
 
3
3
 
4
4
  Query the flow list.
5
5
 
6
- Mapped command: `ae-cli engage +flow_list`
6
+ Mapped command: `ae-cli engage-flow flow list`
7
+
8
+ ## Response shape
9
+
10
+ The result is `{ data: { items, total } }`. Each item recursively uses snake_case fields,
11
+ for example `data.items[].flow_id`, `data.items[].flow_uuid`, and `data.items[].mapping_status`.
7
12
 
8
13
  ## Flags
9
14
 
10
15
  | Flag | Type | Required | Description |
11
16
  |------|------|------|------|
12
- | `--project_id` / `-p` | number | Yes | Project ID |
17
+ | `--project-id` / `-p` | number | Yes | Project ID |
13
18
 
14
19
  ## Examples
15
20
 
16
21
  ```bash
17
- ae-cli engage +flow_list --project_id 1
22
+ ae-cli engage-flow flow list --project-id 1
18
23
  ```
@@ -1,15 +1,16 @@
1
- # ae-engage +flow_node_config_schema
1
+ # ae-cli engage-flow node-config schema
2
2
 
3
3
 
4
4
  Query the configuration schema for one flow node type before constructing a `save_flow` node config.
5
5
 
6
- Mapped command: `ae-cli engage +flow_node_config_schema`
6
+ Mapped command: `ae-cli engage-flow node-config schema`
7
7
 
8
8
  ## Flags
9
9
 
10
10
  | Flag | Type | Required | Description |
11
11
  |------|------|------|------|
12
- | `--node_type` | string | Yes | Flow node type |
12
+ | `--project-id` / `-p` | number | Yes | Project ID |
13
+ | `--node-type` | string | Yes | Flow node type |
13
14
 
14
15
  ## When To Use
15
16
 
@@ -34,7 +35,7 @@ Do not use this command to build an old full `FlowSaveReqDTO`, `nodeList`, or `e
34
35
 
35
36
  ## Enum Notes
36
37
 
37
- ### `--node_type`
38
+ ### `--node-type`
38
39
 
39
40
  Schema-backed node types include:
40
41
 
@@ -55,13 +56,13 @@ Schema-backed node types include:
55
56
  ## Examples
56
57
 
57
58
  ```bash
58
- ae-cli engage +flow_node_config_schema --node_type message_push
59
+ ae-cli engage-flow node-config schema --project-id 1 --node-type message_push
59
60
  ```
60
61
 
61
62
  Typical flow:
62
63
 
63
64
  ```bash
64
- ae-cli engage +flow_node_config_schema --node_type event_trigger
65
- ae-cli engage +validate_flow_node_config \
66
- --node_type event_trigger --operation_mode save_flow --config '<config-json-string>'
65
+ ae-cli engage-flow node-config schema --project-id 1 --node-type event_trigger
66
+ ae-cli engage-flow node-config validate \
67
+ --project-id 1 --node-type event_trigger --operation-mode save_flow --config '<config-json-string>'
67
68
  ```