@thinkingai/ae-cli 1.0.1 → 1.0.15
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 +38 -64
- package/README.zh.md +203 -0
- package/dist/{auth-JXELJNDS.js → auth-4GAHTBVH.js} +2 -2
- package/dist/{auth-L3G3A74I.js → auth-U2GHFMFY.js} +20 -6
- package/dist/{chunk-OVQOK35G.js → chunk-EBFUVWIZ.js} +25 -6
- package/dist/{chunk-3GM5LJZR.js → chunk-OQ4XEG77.js} +7 -4
- package/dist/{chunk-JD5DXMKL.js → chunk-TJIMDNAU.js} +10 -8
- package/dist/{chunk-RJNLN3KQ.js → chunk-UK6HO5O5.js} +7 -6
- package/dist/{client-5QSQBBDB.js → client-HU63573O.js} +3 -3
- package/dist/{config-Q7J3Z7Z2.js → config-OLF7RBPM.js} +5 -5
- package/dist/index.js +18 -17
- package/dist/{raw-ZNVURYMR.js → raw-GDO4IWNW.js} +8 -6
- package/dist/{te-analysis-7NN3SY3I.js → te-analysis-ZDJXMWZY.js} +64 -26
- package/dist/{te-audience-P43BWMHM.js → te-audience-T5B52EEB.js} +65 -25
- package/dist/{te-common-H3IPTI2I.js → te-common-BPTXXTHQ.js} +11 -38
- package/dist/{community-GMALVSRF.js → te-community-FPB5LH56.js} +59 -59
- package/dist/{te-dataops-WCGDBJLF.js → te-dataops-2NUJVG47.js} +3 -28
- package/dist/{te-engage-UTRVNTGU.js → te-engage-K3EANZ5P.js} +502 -520
- package/dist/{te-meta-HGYNXVGF.js → te-meta-JJMV75KB.js} +88 -20
- package/package.json +9 -7
- package/skills/ae-analysis/SKILL.md +229 -0
- package/skills/{te-meta/references/batch-create-metadata.md → ae-analysis/references/batch_create_metadata.md} +5 -5
- package/skills/{te-meta/references/batch-edit-metadata.md → ae-analysis/references/batch_edit_metadata.md} +4 -4
- package/skills/{te-analysis/references/build-entity-details-sql.md → ae-analysis/references/build_entity_details_sql.md} +14 -14
- package/skills/{te-analysis/references/build-event-details-sql.md → ae-analysis/references/build_event_details_sql.md} +14 -14
- package/skills/{te-analysis/references/create-alert.md → ae-analysis/references/create_alert.md} +7 -7
- package/skills/{te-audience/references/create-cluster.md → ae-analysis/references/create_cluster.md} +26 -22
- package/skills/{te-analysis/references/create-dashboard.md → ae-analysis/references/create_dashboard.md} +5 -5
- package/skills/{te-meta/references/create-metric.md → ae-analysis/references/create_metric.md} +16 -16
- package/skills/{te-analysis/references/create-or-update-dashboard-note.md → ae-analysis/references/create_or_update_dashboard_note.md} +5 -5
- package/skills/{te-meta/references/create-project-mark-time.md → ae-analysis/references/create_project_mark_time.md} +5 -5
- package/skills/{te-analysis/references/create-public-access-link.md → ae-analysis/references/create_public_access_link.md} +5 -5
- package/skills/{te-analysis/references/create-report.md → ae-analysis/references/create_report.md} +14 -14
- package/skills/{te-analysis/references/create-result-cluster.md → ae-analysis/references/create_result_cluster.md} +8 -8
- package/skills/{te-audience/references/create-tag.md → ae-analysis/references/create_tag.md} +18 -17
- package/skills/{te-meta/references/create-virtual-event.md → ae-analysis/references/create_virtual_event.md} +14 -14
- package/skills/{te-meta/references/create-virtual-property.md → ae-analysis/references/create_virtual_property.md} +11 -11
- package/skills/{te-meta/references/delete-project-mark-times.md → ae-analysis/references/delete_project_mark_times.md} +4 -4
- package/skills/{te-meta/references/delete-track-items.md → ae-analysis/references/delete_track_items.md} +4 -4
- package/skills/{te-analysis/references/drilldown-user-events.md → ae-analysis/references/drilldown_user_events.md} +11 -11
- package/skills/{te-analysis/references/drilldown-users.md → ae-analysis/references/drilldown_users.md} +12 -9
- package/skills/ae-analysis/references/generate_track_program.md +51 -0
- package/skills/ae-analysis/references/generate_track_sdk_sample.md +43 -0
- package/skills/{te-analysis/references/get-alert.md → ae-analysis/references/get_alert.md} +4 -4
- package/skills/{te-analysis/references/get-alert-definition-schema.md → ae-analysis/references/get_alert_definition_schema.md} +4 -4
- package/skills/ae-analysis/references/get_analysis_query_schema.md +61 -0
- package/skills/ae-analysis/references/get_cluster_definition_schema.md +53 -0
- package/skills/ae-analysis/references/get_clusters_by_name.md +69 -0
- package/skills/{te-analysis/references/get-filter-schema.md → ae-analysis/references/get_filter_schema.md} +4 -4
- package/skills/{te-analysis/references/get-groupby-schema.md → ae-analysis/references/get_groupby_schema.md} +4 -4
- package/skills/{te-meta/references/get-metric.md → ae-analysis/references/get_metric.md} +4 -4
- package/skills/{te-meta/references/get-project-config.md → ae-analysis/references/get_project_config.md} +4 -4
- package/skills/{te-analysis/references/get-report-definition.md → ae-analysis/references/get_report_definition.md} +4 -4
- package/skills/{te-common/references/get-resource-url.md → ae-analysis/references/get_resource_url.md} +7 -7
- package/skills/{te-analysis/references/get-table-columns.md → ae-analysis/references/get_table_columns.md} +4 -4
- package/skills/ae-analysis/references/get_tag_definition_schema.md +49 -0
- package/skills/ae-analysis/references/get_tags_by_name.md +69 -0
- package/skills/{te-meta/references/get-track-program.md → ae-analysis/references/get_track_program.md} +4 -4
- package/skills/{te-analysis/references/list-alerts.md → ae-analysis/references/list_alerts.md} +8 -5
- package/skills/{te-audience/references/list-cluster-members.md → ae-analysis/references/list_cluster_members.md} +13 -6
- package/skills/{te-audience/references/list-clusters.md → ae-analysis/references/list_clusters.md} +12 -6
- package/skills/{te-analysis/references/list-dashboards.md → ae-analysis/references/list_dashboards.md} +10 -6
- package/skills/{te-meta/references/list-entities.md → ae-analysis/references/list_entities.md} +12 -5
- package/skills/{te-meta/references/list-events.md → ae-analysis/references/list_events.md} +10 -7
- package/skills/ae-analysis/references/list_metrics.md +41 -0
- package/skills/ae-analysis/references/list_project_mark_times.md +42 -0
- package/skills/{te-meta/references/list-project-users.md → ae-analysis/references/list_project_users.md} +4 -4
- package/skills/{te-common/references/list-projects.md → ae-analysis/references/list_projects.md} +9 -7
- package/skills/{te-meta/references/list-properties.md → ae-analysis/references/list_properties.md} +11 -6
- package/skills/ae-analysis/references/list_public_access_links.md +41 -0
- package/skills/{te-analysis/references/list-reports.md → ae-analysis/references/list_reports.md} +10 -6
- package/skills/{te-audience/references/list-tag-members.md → ae-analysis/references/list_tag_members.md} +13 -6
- package/skills/{te-audience/references/list-tags.md → ae-analysis/references/list_tags.md} +12 -6
- package/skills/{te-analysis/references/load-filters.md → ae-analysis/references/load_filters.md} +5 -5
- package/skills/{te-analysis/references/query-adhoc.md → ae-analysis/references/query_adhoc.md} +19 -14
- package/skills/{te-analysis/references/query-dashboard-detail.md → ae-analysis/references/query_dashboard_detail.md} +4 -4
- package/skills/{te-analysis/references/query-dashboard-report-data.md → ae-analysis/references/query_dashboard_report_data.md} +13 -13
- package/skills/{te-analysis/references/query-entity-details.md → ae-analysis/references/query_entity_details.md} +15 -15
- package/skills/{te-analysis/references/query-event-details.md → ae-analysis/references/query_event_details.md} +17 -17
- package/skills/{te-analysis/references/query-report-data.md → ae-analysis/references/query_report_data.md} +16 -16
- package/skills/{te-audience/references/refresh-cluster.md → ae-analysis/references/refresh_cluster.md} +4 -4
- package/skills/{te-audience/references/refresh-tag.md → ae-analysis/references/refresh_tag.md} +4 -4
- package/skills/{te-meta/references/save-track-items.md → ae-analysis/references/save_track_items.md} +4 -4
- package/skills/{te-analysis/references/update-alert.md → ae-analysis/references/update_alert.md} +7 -7
- package/skills/{te-audience/references/update-cluster.md → ae-analysis/references/update_cluster.md} +17 -15
- package/skills/{te-analysis/references/update-dashboard.md → ae-analysis/references/update_dashboard.md} +5 -5
- package/skills/{te-meta/references/update-metric.md → ae-analysis/references/update_metric.md} +14 -14
- package/skills/{te-meta/references/update-project-mark-time.md → ae-analysis/references/update_project_mark_time.md} +5 -5
- package/skills/{te-analysis/references/update-public-access-link.md → ae-analysis/references/update_public_access_link.md} +5 -5
- package/skills/{te-audience/references/update-tag.md → ae-analysis/references/update_tag.md} +17 -16
- package/skills/ae-community/SKILL.md +305 -0
- package/skills/ae-community/references/community-activity-analysis.md +67 -0
- package/skills/ae-community/references/community-analyzing-official-content.md +71 -0
- package/skills/ae-community/references/community-analyzing-theme-comment.md +123 -0
- package/skills/ae-community/references/community-character-analysis.md +70 -0
- package/skills/ae-community/references/community-daily-report.md +84 -0
- package/skills/ae-community/references/community-hottopic-insight.md +113 -0
- package/skills/ae-community/references/community-weekly-report.md +84 -0
- package/skills/ae-community/references/get_channel_info.md +20 -0
- package/skills/ae-community/references/get_comment_tag_analysis.md +29 -0
- package/skills/ae-community/references/get_comments_summary.md +32 -0
- package/skills/ae-community/references/get_corpus_tags.md +20 -0
- package/skills/ae-community/references/get_daily_summary.md +22 -0
- package/skills/ae-community/references/get_hot_topics.md +25 -0
- package/skills/ae-community/references/get_livestream_analysis.md +22 -0
- package/skills/ae-community/references/get_livestream_detail.md +33 -0
- package/skills/ae-community/references/get_livestream_list.md +25 -0
- package/skills/ae-community/references/get_livestream_overview.md +24 -0
- package/skills/ae-community/references/get_livestream_room_metrics.md +25 -0
- package/skills/ae-community/references/get_livestream_rooms.md +25 -0
- package/skills/ae-community/references/get_overview_metrics.md +25 -0
- package/skills/ae-community/references/get_post_detail.md +37 -0
- package/skills/ae-community/references/get_risk_content.md +42 -0
- package/skills/ae-community/references/get_sentiment_overview.md +33 -0
- package/skills/ae-community/references/get_tag_trends.md +27 -0
- package/skills/ae-community/references/get_topic_detail.md +26 -0
- package/skills/ae-community/references/search_posts.md +47 -0
- package/skills/ae-dataops/SKILL.md +706 -0
- package/skills/ae-dataops/references/dataops-flow-create.md +163 -0
- package/skills/ae-dataops/references/dataops-flow-monitor.md +118 -0
- package/skills/ae-dataops/references/dataops-integration.md +251 -0
- package/skills/ae-dataops/references/dataops-query.md +111 -0
- package/skills/ae-dataops/references/dataops-table.md +122 -0
- package/skills/ae-engage/SKILL.md +311 -0
- package/skills/ae-engage/references/add-approver.md +24 -0
- package/skills/ae-engage/references/add-channel.md +74 -0
- package/skills/ae-engage/references/approver-list.md +19 -0
- package/skills/ae-engage/references/cancel-query-by-request-id.md +23 -0
- package/skills/ae-engage/references/channel-detail.md +52 -0
- package/skills/ae-engage/references/channel-list.md +41 -0
- package/skills/ae-engage/references/config-channel-detail.md +32 -0
- package/skills/ae-engage/references/config-channel-list.md +27 -0
- package/skills/ae-engage/references/config-item-analysis-report.md +34 -0
- package/skills/ae-engage/references/config-item-detail.md +30 -0
- package/skills/ae-engage/references/config-item-list.md +19 -0
- package/skills/ae-engage/references/config-item-strategy-comparison.md +25 -0
- package/skills/ae-engage/references/config-item-trigger-report.md +42 -0
- package/skills/ae-engage/references/copy-config-template.md +29 -0
- package/skills/ae-engage/references/delete-channel.md +24 -0
- package/skills/ae-engage/references/delete-config-channel.md +24 -0
- package/skills/ae-engage/references/delete-config-item.md +25 -0
- package/skills/ae-engage/references/delete-flow.md +24 -0
- package/skills/ae-engage/references/flow-ab-split-node-report.md +54 -0
- package/skills/ae-engage/references/flow-detail.md +79 -0
- package/skills/ae-engage/references/flow-list.md +19 -0
- package/skills/ae-engage/references/flow-node-config-schema.md +44 -0
- package/skills/ae-engage/references/flow-node-detail-report.md +55 -0
- package/skills/ae-engage/references/flow-node-overview-report.md +52 -0
- package/skills/ae-engage/references/flow-process-report.md +59 -0
- package/skills/ae-engage/references/manage-flow.md +94 -0
- package/skills/ae-engage/references/manage-strategy.md +74 -0
- package/skills/ae-engage/references/manage-task.md +37 -0
- package/skills/ae-engage/references/modify-flow-base-info.md +27 -0
- package/skills/ae-engage/references/save-flow.md +871 -0
- package/skills/ae-engage/references/strategy-detail.md +73 -0
- package/skills/ae-engage/references/strategy-list.md +21 -0
- package/skills/ae-engage/references/task-data-detail.md +74 -0
- package/skills/ae-engage/references/task-data-overview.md +42 -0
- package/skills/ae-engage/references/task-detail.md +61 -0
- package/skills/ae-engage/references/task-experiment-report.md +45 -0
- package/skills/ae-engage/references/task-list.md +91 -0
- package/skills/ae-engage/references/task-metric-detail.md +50 -0
- package/skills/ae-engage/references/task-stats.md +89 -0
- package/skills/ae-engage/references/update-channel-status.md +32 -0
- package/skills/ae-engage/references/update-config-channel-status.md +32 -0
- package/skills/ae-engage/references/validate-flow-node-config.md +52 -0
- package/skills/ae-engage/references/whitelist-list.md +19 -0
- package/skills/te-analysis/SKILL.md +0 -107
- package/skills/te-analysis/references/get-analysis-query-schema.md +0 -36
- package/skills/te-analysis/references/list-public-access-links.md +0 -31
- package/skills/te-audience/SKILL.md +0 -63
- package/skills/te-audience/references/get-cluster-definition-schema.md +0 -37
- package/skills/te-audience/references/get-clusters-by-name.md +0 -32
- package/skills/te-audience/references/get-tag-definition-schema.md +0 -32
- package/skills/te-audience/references/get-tags-by-name.md +0 -32
- package/skills/te-common/SKILL.md +0 -135
- package/skills/te-community/SKILL.md +0 -133
- package/skills/te-community/references/community-activity-analysis.md +0 -68
- package/skills/te-community/references/community-analyzing-official-content.md +0 -72
- package/skills/te-community/references/community-analyzing-theme-comment.md +0 -124
- package/skills/te-community/references/community-character-analysis.md +0 -71
- package/skills/te-community/references/community-daily-report.md +0 -82
- package/skills/te-community/references/community-hottopic-insight.md +0 -120
- package/skills/te-community/references/community-release-analysis.md +0 -79
- package/skills/te-community/references/community-weekly-report.md +0 -84
- package/skills/te-community/references/get_channel_info.md +0 -21
- package/skills/te-community/references/get_comment_tag_analysis.md +0 -30
- package/skills/te-community/references/get_comments_summary.md +0 -33
- package/skills/te-community/references/get_corpus_tags.md +0 -21
- package/skills/te-community/references/get_daily_summary.md +0 -23
- package/skills/te-community/references/get_hot_topics.md +0 -26
- package/skills/te-community/references/get_livestream_analysis.md +0 -23
- package/skills/te-community/references/get_livestream_detail.md +0 -34
- package/skills/te-community/references/get_livestream_list.md +0 -26
- package/skills/te-community/references/get_livestream_overview.md +0 -25
- package/skills/te-community/references/get_livestream_room_metrics.md +0 -26
- package/skills/te-community/references/get_livestream_rooms.md +0 -26
- package/skills/te-community/references/get_overview_metrics.md +0 -26
- package/skills/te-community/references/get_post_detail.md +0 -38
- package/skills/te-community/references/get_risk_content.md +0 -43
- package/skills/te-community/references/get_sentiment_overview.md +0 -34
- package/skills/te-community/references/get_tag_trends.md +0 -28
- package/skills/te-community/references/get_topic_detail.md +0 -27
- package/skills/te-community/references/search_posts.md +0 -48
- package/skills/te-dataops/SKILL.md +0 -645
- package/skills/te-dataops/references/dataops-flow-create.md +0 -163
- package/skills/te-dataops/references/dataops-flow-monitor.md +0 -118
- package/skills/te-dataops/references/dataops-integration.md +0 -246
- package/skills/te-dataops/references/dataops-operations.md +0 -107
- package/skills/te-dataops/references/dataops-query.md +0 -111
- package/skills/te-dataops/references/dataops-table.md +0 -122
- package/skills/te-engage/SKILL.md +0 -211
- package/skills/te-engage/references/add-approver.md +0 -24
- package/skills/te-engage/references/add-channel.md +0 -74
- package/skills/te-engage/references/approver-list.md +0 -19
- package/skills/te-engage/references/cancel-query-by-request-id.md +0 -23
- package/skills/te-engage/references/channel-detail.md +0 -52
- package/skills/te-engage/references/channel-list.md +0 -41
- package/skills/te-engage/references/config-channel-detail.md +0 -32
- package/skills/te-engage/references/config-channel-list.md +0 -27
- package/skills/te-engage/references/config-item-analysis-report.md +0 -34
- package/skills/te-engage/references/config-item-detail.md +0 -30
- package/skills/te-engage/references/config-item-list.md +0 -19
- package/skills/te-engage/references/config-item-strategy-comparison.md +0 -25
- package/skills/te-engage/references/config-item-trigger-report.md +0 -42
- package/skills/te-engage/references/copy-config-template.md +0 -29
- package/skills/te-engage/references/delete-channel.md +0 -24
- package/skills/te-engage/references/delete-config-channel.md +0 -24
- package/skills/te-engage/references/delete-config-item.md +0 -25
- package/skills/te-engage/references/delete-flow.md +0 -24
- package/skills/te-engage/references/flow-ab-split-node-report.md +0 -54
- package/skills/te-engage/references/flow-detail.md +0 -79
- package/skills/te-engage/references/flow-list.md +0 -19
- package/skills/te-engage/references/flow-node-config-schema.md +0 -44
- package/skills/te-engage/references/flow-node-detail-report.md +0 -55
- package/skills/te-engage/references/flow-node-overview-report.md +0 -52
- package/skills/te-engage/references/flow-process-report.md +0 -59
- package/skills/te-engage/references/manage-flow.md +0 -94
- package/skills/te-engage/references/manage-strategy.md +0 -74
- package/skills/te-engage/references/manage-task.md +0 -37
- package/skills/te-engage/references/modify-flow-base-info.md +0 -27
- package/skills/te-engage/references/save-flow.md +0 -870
- package/skills/te-engage/references/strategy-detail.md +0 -73
- package/skills/te-engage/references/strategy-list.md +0 -21
- package/skills/te-engage/references/task-data-detail.md +0 -81
- package/skills/te-engage/references/task-data-overview.md +0 -48
- package/skills/te-engage/references/task-detail.md +0 -61
- package/skills/te-engage/references/task-experiment-report.md +0 -51
- package/skills/te-engage/references/task-list.md +0 -91
- package/skills/te-engage/references/task-metric-detail.md +0 -56
- package/skills/te-engage/references/task-stats.md +0 -89
- package/skills/te-engage/references/update-channel-status.md +0 -32
- package/skills/te-engage/references/update-config-channel-status.md +0 -32
- package/skills/te-engage/references/validate-flow-node-config.md +0 -52
- package/skills/te-engage/references/whitelist-list.md +0 -19
- package/skills/te-meta/SKILL.md +0 -71
- package/skills/te-meta/references/list-metrics.md +0 -33
- package/skills/te-meta/references/list-project-mark-times.md +0 -33
- package/skills/te-shared/SKILL.md +0 -115
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: dataops-table
|
|
3
|
+
version: 1.0.0
|
|
4
|
+
description: "Data table and view management: search tables, view table details, create physical tables/views, batch create linked views. Trigger keywords: create table, table creation, view, data dictionary, table details, linked view, linkview, datatable, DDL."
|
|
5
|
+
metadata:
|
|
6
|
+
requires:
|
|
7
|
+
bins: ["ae-cli"]
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# DataOps Data Table and View Management
|
|
11
|
+
|
|
12
|
+
> **Prerequisites:** Read [`ae-dataops/SKILL.md`](../SKILL.md) for general rules.
|
|
13
|
+
|
|
14
|
+
Use the `dataops_datatable` subcommand to manage data tables.
|
|
15
|
+
|
|
16
|
+
**Core Rules:**
|
|
17
|
+
- Creating/modifying/deleting workspace task tables **must use dataops_datatable**, prohibited to use dataops_ide
|
|
18
|
+
- Confirm no table with the same name exists before creation
|
|
19
|
+
- When creating views or data tables, generate DDL according to **Trino DDL specifications**
|
|
20
|
+
- Create task tables in DEV environment first, then PROD environment (can create simultaneously)
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Workflow A: Search and View Table Information
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# Search tables in data dictionary (fuzzy match by table name/description)
|
|
28
|
+
ae-cli dataops_datatable +dict_search_tables --spaceCode "${spaceCode}" --search "user" --maxResults 20
|
|
29
|
+
|
|
30
|
+
# Get detailed table information (fields, DDL, data lineage)
|
|
31
|
+
ae-cli dataops_datatable +get_table_detail --spaceCode "${spaceCode}" --tableName "dwd_user_info"
|
|
32
|
+
|
|
33
|
+
# Paginated query of registered tables in workspace
|
|
34
|
+
ae-cli dataops_datatable +list_tables_by_page --spaceCode "${spaceCode}" --search "user" --pageNum 1 --pageSize 20
|
|
35
|
+
|
|
36
|
+
# Get table hierarchy by repository dimension (repo→catalog→schema→tables)
|
|
37
|
+
ae-cli dataops_datatable +struct_by_repo --spaceCode "${spaceCode}"
|
|
38
|
+
|
|
39
|
+
# Search system tables (event tables, user tables, dimension tables)
|
|
40
|
+
ae-cli dataops_datatable +list_system_tables --spaceCode "${spaceCode}" --projectName "my_project"
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Workflow B: Create Physical Table
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Step 1: Confirm no table with same name exists
|
|
49
|
+
ae-cli dataops_datatable +dict_search_tables --spaceCode "${spaceCode}" --search "dwd_user_info"
|
|
50
|
+
|
|
51
|
+
# Step 2: Create physical table in DEV environment (DDL must follow Trino specifications)
|
|
52
|
+
ae-cli dataops_datatable +create_table --spaceCode "${spaceCode}" \
|
|
53
|
+
--ddl "CREATE TABLE dwd_user_info (user_id VARCHAR, user_name VARCHAR, age INTEGER) WITH (format = 'ORC')" \
|
|
54
|
+
--repoCode "te_etl" --catalog "hive" --schema "ws_default_dev" --confirmed true
|
|
55
|
+
|
|
56
|
+
# Step 3: Create physical table in PROD environment (same DDL, change schema to product database)
|
|
57
|
+
ae-cli dataops_datatable +create_table --spaceCode "${spaceCode}" \
|
|
58
|
+
--ddl "CREATE TABLE dwd_user_info (user_id VARCHAR, user_name VARCHAR, age INTEGER) WITH (format = 'ORC')" \
|
|
59
|
+
--repoCode "te_etl" --catalog "hive" --schema "ws_default_product" --confirmed true
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Workflow C: Create View
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
# Step 1: Confirm no view with same name exists
|
|
68
|
+
ae-cli dataops_datatable +dict_search_tables --spaceCode "${spaceCode}" --search "v_user_info"
|
|
69
|
+
|
|
70
|
+
# Step 2: Create view (defaults to v_${source_table_name} if view name not specified)
|
|
71
|
+
ae-cli dataops_datatable +create_view --spaceCode "${spaceCode}" \
|
|
72
|
+
--ddl "CREATE VIEW v_user_info AS SELECT user_id, user_name FROM hive.ws_default_dev.dwd_user_info" \
|
|
73
|
+
--repoCode "te_etl" --catalog "hive" --schema "ws_default_dev" --confirmed true
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Workflow D: Batch Create Linked Views
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
# Step 1: List source tables available for creating linked views
|
|
82
|
+
ae-cli dataops_datatable +linkview_list_source_tables --spaceCode "${spaceCode}" \
|
|
83
|
+
--srcRepoCode "te_etl" --srcCatalog "hive" --srcSchema "ws_default_hidden"
|
|
84
|
+
|
|
85
|
+
# Step 2: Batch create linked views (async execution)
|
|
86
|
+
ae-cli dataops_datatable +batch_create --spaceCode "${spaceCode}" \
|
|
87
|
+
--srcRepoCode "te_etl" --srcCatalog "hive" --srcSchema "ws_default_hidden" \
|
|
88
|
+
--processType 2 --batchCreationMode 1 --owner "${ownerOpenId}" \
|
|
89
|
+
--viewInfos '[{"viewName":"v_orders","srcTableName":"ta_event_123","srcTableType":"TABLE"}]' \
|
|
90
|
+
--confirmed true
|
|
91
|
+
|
|
92
|
+
# Step 3: Poll batch creation status (recommend 3-5 second interval)
|
|
93
|
+
# status: WAIT / RUNNING / SUCCESS / STOP
|
|
94
|
+
ae-cli dataops_datatable +linkview_get_batch_status --spaceCode "${spaceCode}" --batchId "${batchId}"
|
|
95
|
+
|
|
96
|
+
# View historical batch creation records
|
|
97
|
+
ae-cli dataops_datatable +list_batches --spaceCode "${spaceCode}"
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Command Quick Reference
|
|
103
|
+
|
|
104
|
+
| Command | Purpose | Key Flags |
|
|
105
|
+
|---------|---------|-----------|
|
|
106
|
+
| `+dict_search_tables` | Data dictionary search | `--spaceCode` `--search` `--maxResults` |
|
|
107
|
+
| `+get_table_detail` | Table details | `--spaceCode` `--tableName` |
|
|
108
|
+
| `+list_tables_by_page` | Paginated list | `--spaceCode` `--search` `--pageNum` `--pageSize` |
|
|
109
|
+
| `+struct_by_repo` | By repository hierarchy | `--spaceCode` `--search` |
|
|
110
|
+
| `+list_system_tables` | System table list | `--spaceCode` `--projectId`/`--projectName` `--pageNum` `--pageSize` |
|
|
111
|
+
| `+create_table` | Create physical table | `--spaceCode` `--ddl` `--repoCode` `--catalog` `--schema` `--confirmed` |
|
|
112
|
+
| `+create_view` | Create view | `--spaceCode` `--ddl` `--repoCode` `--catalog` `--schema` `--confirmed` |
|
|
113
|
+
| `+batch_create` | Batch create views | `--spaceCode` `--srcRepoCode` `--srcCatalog` `--srcSchema` `--processType` `--batchCreationMode` `--owner` `--viewInfos` `--confirmed` |
|
|
114
|
+
| `+linkview_get_batch_status` | Batch creation status | `--spaceCode` `--batchId` |
|
|
115
|
+
| `+list_batches` | Historical batch records | `--spaceCode` `--status` |
|
|
116
|
+
|
|
117
|
+
## Parameter Notes
|
|
118
|
+
|
|
119
|
+
- **schema naming**: DEV environment uses `ws_${spaceCode}_dev`, PROD environment uses `ws_${spaceCode}_product`
|
|
120
|
+
- **processType**: `1`=DEV only | `2`=DEV+PROD
|
|
121
|
+
- **batchCreationMode**: `1`=full sync | `2`=retry failures
|
|
122
|
+
- **Table name rule**: `^[a-z][0-9a-z_]{0,127}$`
|
|
@@ -0,0 +1,311 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ae-engage
|
|
3
|
+
version: 1.0.0
|
|
4
|
+
description: "AE Engage MCP: config items, flows, channel settings, task data query, and management"
|
|
5
|
+
metadata:
|
|
6
|
+
requires:
|
|
7
|
+
bins: ["ae-cli"]
|
|
8
|
+
cliHelp: "ae-cli engage --help"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# ae-engage
|
|
12
|
+
|
|
13
|
+
AE CLI (`ae-cli`) is the command-line tool for the ThinkingEngine data analysis platform, used by AI Agents and human users.
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
You must authenticate before use. Authentication priority:
|
|
18
|
+
|
|
19
|
+
1. Environment variable `TE_TOKEN` (highest priority, suitable for CI/scripts)
|
|
20
|
+
2. Cached token (`~/.ae-cli/tokens.json`, valid for 20 hours)
|
|
21
|
+
3. macOS automatically extracts it from Chrome (macOS only)
|
|
22
|
+
|
|
23
|
+
### Authentication Commands
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Automatic macOS authentication (extract token from Chrome)
|
|
27
|
+
ae-cli auth login
|
|
28
|
+
|
|
29
|
+
# Manually set token
|
|
30
|
+
ae-cli auth set-token <token>
|
|
31
|
+
|
|
32
|
+
# View authentication status
|
|
33
|
+
ae-cli auth status
|
|
34
|
+
|
|
35
|
+
# Log out
|
|
36
|
+
ae-cli auth logout
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Multi-environment Support
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
# Specify host
|
|
43
|
+
ae-cli auth login --host ta-staging.example.com
|
|
44
|
+
ae-cli auth set-token <token> --host ta-staging.example.com
|
|
45
|
+
|
|
46
|
+
# Configure default host
|
|
47
|
+
ae-cli config set defaultHost ta-staging.example.com
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Global Parameters
|
|
51
|
+
|
|
52
|
+
All commands support the following global parameters:
|
|
53
|
+
|
|
54
|
+
| Parameter | Description | Default |
|
|
55
|
+
|------|------|--------|
|
|
56
|
+
| `--host <host>` | AE instance address | defaultHost from config or ta.thinkingdata.cn |
|
|
57
|
+
| `--format <json\|table>` | Output format | json |
|
|
58
|
+
| `--jq <expr>` | jq filter expression | - |
|
|
59
|
+
| `--dry-run` | Show the request only, do not execute it | false |
|
|
60
|
+
| `--yes` | Skip confirmation for write operations | false |
|
|
61
|
+
|
|
62
|
+
## Output Format
|
|
63
|
+
|
|
64
|
+
### JSON (default)
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"ok": true,
|
|
69
|
+
"data": { ... }
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Table
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
ae-cli engage +channel_list --project_id <YOUR_PROJECT_ID> --format table
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### jq Filtering
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
ae-cli engage +channel_list --project_id <YOUR_PROJECT_ID> --jq '.'
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Error Handling
|
|
86
|
+
|
|
87
|
+
Error output goes to stderr, in the following format:
|
|
88
|
+
|
|
89
|
+
```json
|
|
90
|
+
{
|
|
91
|
+
"ok": false,
|
|
92
|
+
"error": {
|
|
93
|
+
"type": "auth | api | validation | config",
|
|
94
|
+
"message": "...",
|
|
95
|
+
"hint": "..."
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Exit code: success `0`, error `1`.
|
|
101
|
+
|
|
102
|
+
## Security Constraints
|
|
103
|
+
|
|
104
|
+
- Commands with `risk: read` execute directly
|
|
105
|
+
- Commands with `risk: write` require confirmation unless `--yes` is passed
|
|
106
|
+
- Use `--dry-run` to preview the request that will be sent
|
|
107
|
+
|
|
108
|
+
## Command Structure
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
ae-cli <domain> +<command> [flags]
|
|
112
|
+
ae-cli api <METHOD> <PATH> [--params] [--data]
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## Overview
|
|
116
|
+
|
|
117
|
+
The `ae-engage` package provides Hermes Engage MCP capabilities across config items, flows, channel settings, and task data. Commands are invoked through `ae-cli engage <command>`.
|
|
118
|
+
|
|
119
|
+
Typical use cases include:
|
|
120
|
+
|
|
121
|
+
- Querying and managing channels, config channels, approvers, and whitelists
|
|
122
|
+
- Querying task lists, task details, experiment reports, and metric reports
|
|
123
|
+
- Querying config items and strategies, copying templates, and managing strategy status
|
|
124
|
+
- Querying flow lists, node schemas, and flow reports, and saving or managing flows
|
|
125
|
+
|
|
126
|
+
## Parameter Conventions
|
|
127
|
+
|
|
128
|
+
- Use regular flags for simple parameters, for example `--project_id`, `--task_id`, and `--flow_uuid`
|
|
129
|
+
- Use JSON flags for array parameters, for example `--strategy_id_list '["id1","id2"]'`
|
|
130
|
+
- Use named JSON flags for object parameters, for example `--req '{...}'` and `--flow_list '[...]'`
|
|
131
|
+
- Optional global parameters work the same way as in other domains, for example `--host`, `--mcp-url`, and `--dry-run`
|
|
132
|
+
|
|
133
|
+
## JSON Parameter Format
|
|
134
|
+
|
|
135
|
+
Common JSON flag examples:
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
--provider_list '["webhook","fcm"]'
|
|
139
|
+
--strategy_id_list '["strategy_a","strategy_b"]'
|
|
140
|
+
--flow_id_list '["flow_1","flow_2"]'
|
|
141
|
+
--req '{"pageNum":1,"pageSize":20}'
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## Common Scenarios
|
|
145
|
+
|
|
146
|
+
### 1. setting
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
# Query the channel list
|
|
150
|
+
ae-cli engage +channel_list --project_id 1
|
|
151
|
+
|
|
152
|
+
# Filter by provider
|
|
153
|
+
ae-cli engage +channel_list --project_id 1 --provider_list '["webhook","fcm"]'
|
|
154
|
+
|
|
155
|
+
# Query config channels
|
|
156
|
+
ae-cli engage +config_channel_list --project_id 1
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### 2. task
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
# Query the task list
|
|
163
|
+
ae-cli engage +task_list --project_id 1 --req '{"pageNum":1,"pageSize":20}'
|
|
164
|
+
|
|
165
|
+
# Query task details
|
|
166
|
+
ae-cli engage +task_detail --project_id 1 --task_id task_123
|
|
167
|
+
|
|
168
|
+
# Query the task overview
|
|
169
|
+
ae-cli engage +task_data_overview --project_id 1 --task_id task_123
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### 3. config
|
|
173
|
+
|
|
174
|
+
```bash
|
|
175
|
+
# Query the config item list
|
|
176
|
+
ae-cli engage +config_item_list --project_id 1
|
|
177
|
+
|
|
178
|
+
# Query the strategy list
|
|
179
|
+
ae-cli engage +strategy_list --project_id 1 --config_id cfg_123
|
|
180
|
+
|
|
181
|
+
# Query a config item report
|
|
182
|
+
ae-cli engage +config_item_trigger_report \
|
|
183
|
+
--project_id 1 --config_id cfg_123 \
|
|
184
|
+
--start_time 2026-04-01 --end_time 2026-04-07
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### 4. flow
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
# Query the flow list
|
|
191
|
+
ae-cli engage +flow_list --project_id 1
|
|
192
|
+
|
|
193
|
+
# Query flow details
|
|
194
|
+
ae-cli engage +flow_detail --project_id 1 --flow_uuid flow_uuid_123
|
|
195
|
+
|
|
196
|
+
# Query the node schema
|
|
197
|
+
ae-cli engage +flow_node_config_schema --node_type message_push
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
## `+save_flow` Critical Constraints
|
|
201
|
+
|
|
202
|
+
When the user wants to "create a flow / generate a flow canvas / save a flow", do not treat `+save_flow` as a normal single command. You must follow the workflow below.
|
|
203
|
+
|
|
204
|
+
### Required Workflow
|
|
205
|
+
|
|
206
|
+
1. First confirm that the user intent is specific enough. At minimum you need:
|
|
207
|
+
- The business scenario
|
|
208
|
+
- The target users
|
|
209
|
+
- The touchpoint or delivery method
|
|
210
|
+
- Whether branching is needed, and the branching conditions
|
|
211
|
+
2. Do not jump directly from natural language to `--req`. You must first organize a stable intermediate intent structure, then map it to the final `req`.
|
|
212
|
+
3. Before building any condition-related nodes, you must call:
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
ae-cli analysis_audience +get_cluster_definition_schema --cluster_type condition
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
4. Before building touchpoint nodes such as `message_push`, `wechat_push`, or `webhook_push`, you must call:
|
|
219
|
+
|
|
220
|
+
```bash
|
|
221
|
+
ae-cli engage +channel_list --project_id <projectId>
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
5. The final `--req` for `+save_flow` must be the complete canvas request payload, not an intent description. It must contain at least:
|
|
225
|
+
- `flowName`
|
|
226
|
+
- `flowDesc`
|
|
227
|
+
- `nodeList`
|
|
228
|
+
- `edgeList`
|
|
229
|
+
6. `nodeList[].config` and `edgeList[].config` must be JSON strings, not JSON objects.
|
|
230
|
+
7. If `targetClusterQp` appears inside a node `config`, its value should usually also be a string produced by `JSON.stringify`, not a raw object.
|
|
231
|
+
8. You must self-check before submitting:
|
|
232
|
+
- There is exactly one entry node
|
|
233
|
+
- There is at least one `exit_flow`
|
|
234
|
+
- `edge.source` and `edge.target` both reference valid nodes
|
|
235
|
+
- Any branch node `sourceBranchId` has already been declared in the upstream node `config`
|
|
236
|
+
- The whole graph is a DAG and contains no cycles
|
|
237
|
+
|
|
238
|
+
### Explicitly Forbidden
|
|
239
|
+
|
|
240
|
+
- Do not invent a `channelId`
|
|
241
|
+
- Do not fill in branching logic when the user has not provided enough information
|
|
242
|
+
- Do not submit business-semantic nodes directly as final `nodeList` nodes
|
|
243
|
+
- Do not put `config` into `--req` as an object
|
|
244
|
+
|
|
245
|
+
### Recommended Order
|
|
246
|
+
|
|
247
|
+
```text
|
|
248
|
+
User request
|
|
249
|
+
-> Organize intent
|
|
250
|
+
-> analysis_audience +get_cluster_definition_schema --cluster_type condition
|
|
251
|
+
-> +channel_list --project_id <projectId>
|
|
252
|
+
-> Build nodeList / edgeList
|
|
253
|
+
-> Self-check
|
|
254
|
+
-> +save_flow
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
For more detailed generation rules, consult these references first:
|
|
258
|
+
|
|
259
|
+
- `references/save-flow.md`
|
|
260
|
+
- `references/flow-node-config-schema.md`
|
|
261
|
+
- `references/validate-flow-node-config.md`
|
|
262
|
+
|
|
263
|
+
## Dry-Run Debugging
|
|
264
|
+
|
|
265
|
+
```bash
|
|
266
|
+
ae-cli --dry-run engage +channel_list --project_id 1
|
|
267
|
+
ae-cli --dry-run engage +task_list --project_id 1 --req '{"pageNum":1,"pageSize":20}'
|
|
268
|
+
ae-cli --dry-run engage +flow_list --project_id 1
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
## References
|
|
272
|
+
|
|
273
|
+
More detailed single-command guidance is available in the business-oriented `references/` directory:
|
|
274
|
+
|
|
275
|
+
- `references/channel-list.md`
|
|
276
|
+
- `references/task-list.md`
|
|
277
|
+
- `references/config-item-list.md`
|
|
278
|
+
- `references/flow-list.md`
|
|
279
|
+
|
|
280
|
+
This split documentation structure is easier to extend later, because commands with more complex object inputs can stay centralized in the `references/` root directory.
|
|
281
|
+
|
|
282
|
+
## Command Groups
|
|
283
|
+
|
|
284
|
+
### setting
|
|
285
|
+
|
|
286
|
+
`+channel_list`, `+channel_detail`, `+update_channel_status`, `+delete_channel`, `+add_channel`, `+whitelist_list`, `+add_approver`, `+approver_list`, `+cancel_query_by_request_id`, `+config_channel_detail`, `+config_channel_list`, `+delete_config_channel`, `+update_config_channel_status`
|
|
287
|
+
|
|
288
|
+
### task
|
|
289
|
+
|
|
290
|
+
`+task_data_overview`, `+task_data_detail`, `+task_metric_detail`, `+task_experiment_report`, `+task_detail`, `+task_list`, `+task_stats`, `+manage_task`
|
|
291
|
+
|
|
292
|
+
### config
|
|
293
|
+
|
|
294
|
+
`+config_item_trigger_report`, `+config_item_analysis_report`, `+config_item_strategy_comparison`, `+config_item_list`, `+config_item_detail`, `+delete_config_item`, `+copy_config_template`, `+strategy_list`, `+strategy_detail`, `+manage_strategy`
|
|
295
|
+
|
|
296
|
+
### flow
|
|
297
|
+
|
|
298
|
+
`+save_flow`, `+flow_node_config_schema`, `+flow_detail`, `+flow_list`, `+flow_node_overview_report`, `+manage_flow`, `+flow_ab_split_node_report`, `+flow_process_report`, `+validate_flow_node_config`, `+flow_node_detail_report`, `+delete_flow`, `+modify_flow_base_info`
|
|
299
|
+
|
|
300
|
+
## Date Format
|
|
301
|
+
|
|
302
|
+
Commands that accept date parameters usually use `yyyy-MM-dd`, for example `--start_time 2026-04-01`.
|
|
303
|
+
|
|
304
|
+
## Write Operation Reminder
|
|
305
|
+
|
|
306
|
+
The following commands are write operations. Confirm that the user intent is explicit before executing them:
|
|
307
|
+
|
|
308
|
+
- Channels and config channels: `+add_channel`, `+delete_channel`, `+update_channel_status`, `+delete_config_channel`, `+update_config_channel_status`
|
|
309
|
+
- Strategies and config items: `+delete_config_item`, `+copy_config_template`, `+manage_strategy`
|
|
310
|
+
- Flows: `+save_flow`, `+modify_flow_base_info`, `+manage_flow`, `+delete_flow`
|
|
311
|
+
- Tasks: `+manage_task`
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ae-engage +add_approver
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../../ae-shared/SKILL.md`](../../ae-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Batch add approvers.
|
|
6
|
+
|
|
7
|
+
Mapped command: `ae-cli engage +add_approver`
|
|
8
|
+
|
|
9
|
+
## Flags
|
|
10
|
+
|
|
11
|
+
| Flag | Type | Required | Description |
|
|
12
|
+
|------|------|------|------|
|
|
13
|
+
| `--project_id` / `-p` | number | Yes | Project ID |
|
|
14
|
+
| `--approvers` | json | Yes | approver open ID JSON array |
|
|
15
|
+
|
|
16
|
+
## Safety Constraints
|
|
17
|
+
|
|
18
|
+
This command is a **write operation** and and modifies the project approver configuration.
|
|
19
|
+
|
|
20
|
+
## Examples
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
ae-cli engage +add_approver --project_id 1 --approvers '["ou_xxx","ou_yyy"]'
|
|
24
|
+
```
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# ae-engage +add_channel
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../../ae-shared/SKILL.md`](../../ae-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Create a new Engage channel.
|
|
6
|
+
|
|
7
|
+
Mapped command: `ae-cli engage +add_channel`
|
|
8
|
+
|
|
9
|
+
## Flags
|
|
10
|
+
|
|
11
|
+
| Flag | Type | Required | Description |
|
|
12
|
+
|------|------|------|------|
|
|
13
|
+
| `--project_id` / `-p` | number | Yes | Project ID |
|
|
14
|
+
| `--req` | json | Yes | Channel creation request JSON object |
|
|
15
|
+
|
|
16
|
+
## `--req` Object Fields
|
|
17
|
+
|
|
18
|
+
| Field | Type | Required | Description |
|
|
19
|
+
|------|------|------|------|
|
|
20
|
+
| `channelType` | number | Yes | channel type |
|
|
21
|
+
| `channelSubBizType` | string | Yes | channel subtype, for example `webhook`、`fcm`、`aurora` |
|
|
22
|
+
| `channelName` | string | Yes | channel name |
|
|
23
|
+
| `pushIdType` | string | Yes | push target ID field name |
|
|
24
|
+
| `config` | string | Yes | channel config JSON string |
|
|
25
|
+
| `enableTouchEvent` | number | Yes | touch event switch |
|
|
26
|
+
| `eventClickName` | string | Yes | click event name |
|
|
27
|
+
| `eventDeliveryName` | string | Yes | delivery event name |
|
|
28
|
+
| `touchEventSource` | string | Yes | touch event source |
|
|
29
|
+
|
|
30
|
+
`projectId` is automatically written into the `--req` object by the CLI, so you do not need to fill it manually. If you provide a field with the same name, the top-level `--project_id` takes precedence.
|
|
31
|
+
|
|
32
|
+
## Enum Notes
|
|
33
|
+
|
|
34
|
+
### `req.channelType`
|
|
35
|
+
|
|
36
|
+
- `1`: `WEBHOOK`
|
|
37
|
+
- `2`: `APP_PUSH`
|
|
38
|
+
- `3`: `CLIENT_PUSH`
|
|
39
|
+
- `4`: `WECHAT`
|
|
40
|
+
- `5`: `DOU_YIN`
|
|
41
|
+
|
|
42
|
+
### `req.channelSubBizType`
|
|
43
|
+
|
|
44
|
+
Common values are listed below and should usually match `channelType`:
|
|
45
|
+
|
|
46
|
+
- `webhook`: Webhook channel
|
|
47
|
+
- `fcm`: App Push, Firebase Cloud Messaging
|
|
48
|
+
- `aurora`: App Push, Aurora
|
|
49
|
+
- `apns`: App Push, Apple Push Notification Service
|
|
50
|
+
- `client`: Client Push
|
|
51
|
+
- `wechat_mini_game`: WeChat mini game
|
|
52
|
+
- `dou_yin_recommended_game_card`: Douyin recommended game card
|
|
53
|
+
|
|
54
|
+
### `req.enableTouchEvent`
|
|
55
|
+
|
|
56
|
+
- `0`: disable touch events
|
|
57
|
+
- `1`: enable touch events
|
|
58
|
+
|
|
59
|
+
## Additional Constraints
|
|
60
|
+
|
|
61
|
+
- `req.config` must be a JSON string, not a JSON object.
|
|
62
|
+
- `req.channelSubBizType` should match the actual channel capability; for example, when `channelType=1`, `webhook` is usually used.
|
|
63
|
+
- If delivery or click callbacks are required, also check that `eventDeliveryName`, `eventClickName`, and `touchEventSource` are complete.
|
|
64
|
+
|
|
65
|
+
## Safety Constraints
|
|
66
|
+
|
|
67
|
+
This command is a **write operation** and creates a new channel. Check that the `--req` fields are complete before executing.
|
|
68
|
+
|
|
69
|
+
## Examples
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
ae-cli engage +add_channel --project_id 1 \
|
|
73
|
+
--req '{"channelType":1,"channelSubBizType":"webhook","channelName":"demo","pushIdType":"user_id","config":"{}","enableTouchEvent":0,"eventClickName":"","eventDeliveryName":"","touchEventSource":""}'
|
|
74
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ae-engage +approver_list
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../../ae-shared/SKILL.md`](../../ae-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Query the project approver list.
|
|
6
|
+
|
|
7
|
+
Mapped command: `ae-cli engage +approver_list`
|
|
8
|
+
|
|
9
|
+
## Flags
|
|
10
|
+
|
|
11
|
+
| Flag | Type | Required | Description |
|
|
12
|
+
|------|------|------|------|
|
|
13
|
+
| `--project_id` / `-p` | number | Yes | Project ID |
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
ae-cli engage +approver_list --project_id 1
|
|
19
|
+
```
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ae-engage +cancel_query_by_request_id
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../../ae-shared/SKILL.md`](../../ae-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Cancel a running data query by requestId.
|
|
6
|
+
|
|
7
|
+
Mapped command: `ae-cli engage +cancel_query_by_request_id`
|
|
8
|
+
|
|
9
|
+
## Flags
|
|
10
|
+
|
|
11
|
+
| Flag | Type | Required | Description |
|
|
12
|
+
|------|------|------|------|
|
|
13
|
+
| `--request_id` | string | Yes | Query requestId |
|
|
14
|
+
|
|
15
|
+
## Safety Constraints
|
|
16
|
+
|
|
17
|
+
This command is a **write operation** and cancels an existing query.
|
|
18
|
+
|
|
19
|
+
## Examples
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
ae-cli engage +cancel_query_by_request_id --request_id 00000000-0000-0000-0000-000000000000
|
|
23
|
+
```
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# ae-engage +channel_detail
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../../ae-shared/SKILL.md`](../../ae-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Query the details of a single Engage channel.
|
|
6
|
+
|
|
7
|
+
Mapped command: `ae-cli engage +channel_detail`
|
|
8
|
+
|
|
9
|
+
## Flags
|
|
10
|
+
|
|
11
|
+
| Flag | Type | Required | Description |
|
|
12
|
+
|------|------|------|------|
|
|
13
|
+
| `--project_id` / `-p` | number | Yes | Project ID |
|
|
14
|
+
| `--channel_id` | string | Yes | channel ID |
|
|
15
|
+
|
|
16
|
+
## Common enums in the response
|
|
17
|
+
|
|
18
|
+
### `channelStatus`
|
|
19
|
+
|
|
20
|
+
- `0`: disabled
|
|
21
|
+
- `1`: enabled
|
|
22
|
+
|
|
23
|
+
### `channelType`
|
|
24
|
+
|
|
25
|
+
- `1`: `WEBHOOK`
|
|
26
|
+
- `2`: `APP_PUSH`
|
|
27
|
+
- `3`: `CLIENT_PUSH`
|
|
28
|
+
- `4`: `WECHAT`
|
|
29
|
+
- `5`: `DOU_YIN`
|
|
30
|
+
|
|
31
|
+
### `channelSubBizType`
|
|
32
|
+
|
|
33
|
+
Common values include:
|
|
34
|
+
|
|
35
|
+
- `webhook`
|
|
36
|
+
- `fcm`
|
|
37
|
+
- `aurora`
|
|
38
|
+
- `apns`
|
|
39
|
+
- `client`
|
|
40
|
+
- `wechat_mini_game`
|
|
41
|
+
- `dou_yin_recommended_game_card`
|
|
42
|
+
|
|
43
|
+
### `enableTouchEvent`
|
|
44
|
+
|
|
45
|
+
- `0`: disable the touch funnel
|
|
46
|
+
- `1`: enable the touch funnel
|
|
47
|
+
|
|
48
|
+
## Examples
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
ae-cli engage +channel_detail --project_id 1 --channel_id <channel_id>
|
|
52
|
+
```
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# ae-engage +channel_list
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../../ae-shared/SKILL.md`](../../ae-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Query the list of Engage channels in a project.
|
|
6
|
+
|
|
7
|
+
Mapped command: `ae-cli engage +channel_list`
|
|
8
|
+
|
|
9
|
+
## Flags
|
|
10
|
+
|
|
11
|
+
| Flag | Type | Required | Description |
|
|
12
|
+
|------|------|------|------|
|
|
13
|
+
| `--project_id` / `-p` | number | Yes | Project ID |
|
|
14
|
+
| `--provider_list` | json | No | Provider list JSON array |
|
|
15
|
+
| `--channel_status` | number | No | Channel status filter |
|
|
16
|
+
|
|
17
|
+
## Enum Notes
|
|
18
|
+
|
|
19
|
+
### `--channel_status`
|
|
20
|
+
|
|
21
|
+
- `0`: disabled
|
|
22
|
+
- `1`: enabled
|
|
23
|
+
|
|
24
|
+
### `--provider_list`
|
|
25
|
+
|
|
26
|
+
Common provider / channelSubBizType values:
|
|
27
|
+
|
|
28
|
+
- `webhook`
|
|
29
|
+
- `fcm`
|
|
30
|
+
- `aurora`
|
|
31
|
+
- `apns`
|
|
32
|
+
- `client`
|
|
33
|
+
- `wechat_mini_game`
|
|
34
|
+
- `dou_yin_recommended_game_card`
|
|
35
|
+
|
|
36
|
+
## Examples
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
ae-cli engage +channel_list --project_id 1
|
|
40
|
+
ae-cli engage +channel_list --project_id 1 --provider_list '["webhook","fcm"]'
|
|
41
|
+
```
|