ae-engage
AE Engage capability gateway: config center, flows, push/config channels, strategies, templates, task management, operation activities, and query lifecycle. Trigger words: config center, scene config, push channel, config channel, operation strategy, operation task, operation activity, query lifecyc
By thinkingaiagenticengine · 526 installs
npx skills add thinkingaiagenticengine/ae-cli --skill ae-engage
Source repository · Upstream listing
ae engage
AE CLI ( ae cli ) is the command line tool for the ThinkingEngine data analysis platform, used by AI Agents and human users.
Global AE CLI Rules
AE CLI ( ae cli ) is the command line tool for the AE / TE / ThinkingEngine analysis platform. For AE analysis side requests, prefer ae cli and this skill's reference docs over model memory.
Global parameters:
Parameter Description
format <json\ table Output format. Default is JSON.
jq <expr jq filter expression for JSON output.
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 .
Output and errors:
Successful commands return machine readable JSON by default. Envelope may include optional notice.host compat .
Failed commands return { "ok": false, "error": { "type": "...", "message": "...", "hint": "..." } } and exit non zero.
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.
Safety constraints:
Read commands can execute directly after required IDs and references are verified.
Write commands require explicit user intent. Ordinary write commands execute without CLI confirmation; only high risk write commands use the confirmation gate.
Never invent command names, flags, JSON payloads, project id , resource IDs, field names, event names, property names, metric definitions, or date formats. Read the matching command reference and discover real project metadata first.
NEVER fabricate or guess resource names (reports, dashboards, events, properties, metrics, clusters, tags, alerts). Always use list commands to discover real resources first. If a resource is not found after fuzzy search and full list fallback, explicitly tell the user "resource not found" and stop do not proceed with fabricated names.
Overview
The ae engage package provides Hermes Engage capabilities across config items, flows, channel settings, task data, and query lifecycle. Use capability gateway commands through ae cli engage flow engage task engage setting engage scene engage query <resource <action ; low frequency reports use the L3 references below.
Typical use cases include:
Querying and managing channels, config channels, approvers, and whitelists
Querying project channel touch limit or fatigue control rules
Querying task lists, task details, experiment reports, and metric reports
Querying config items and strategies, copying templates, and managing strategy status
Querying flow lists, node schemas, and flow reports, and saving or managing flows
Keyword Routing
When the user mentions a product term below (including common Chinese UI labels), open the listed reference(s) first — do not guess commands or IDs.
Keyword Product meaning CLI domain Primary reference Related references
Config center Engage scene management / config center overview engage scene references/scene config item.md scene config param.md , scene config group.md , scene preset metric.md , scene config metric.md , scene config channel.md , channel mgmt.md , scene strategy.md , scene template.md ; L3 reports: config item trigger report.md , config item analysis report.md , config item strategy comparison.md
Scene config Same as config center; params, groups, metrics, channels, strategies, and templates under a config item engage scene references/scene config item.md Same as above; params/groups/metrics: scene config param.md , scene config group.md , scene preset metric.md , scene config metric.md
Config item A single config item in the config center engage scene references/scene config item.md scene config param.md , scene preset metric.md , scene config metric.md , scene strategy.md , scene template.md
Push channel Project level message push channels (Webhook, FCM, APNS, etc.) engage setting references/channel list.md channel detail.md , add channel.md ( Webhook vs Client differ : url = HTTP vs scene key; custom params user: vs user: / client: ), update channel status.md , delete channel.md , channel update config.md , channel test send.md , channel touch limits list.md
Config channel Config center Webhook/client config channels (not the same as push channels) engage scene references/scene config channel.md channel mgmt.md (create/enable disable/copy/delete workflows). User params in config.customsParamList require columnName with user: prefix (e.g. user: account id ); preflight names with ae analysis analysis meta property list/get .
Operation strategy Ops/delivery strategies under a config item engage scene references/scene strategy.md Custom audience: [ scene strategy audience.md ](references/scene strategy audience.md) — semantic definitionRequest (Analysis condition shape); do not pass targetClusterQp / qp ; preflight props (stop + list if missing); template: scene template.md
Operation task Hermes push/engagement tasks (list, save, lifecycle, reports) engage task references/task list.md task detail.md (get), save task.md , build task save guide.md , task stats.md , task delete.md , push record query.md , task user detail export.md , task indicator user.md , task data overview.md , task data detail.md , task metric detail.md , task experiment report.md
Operation activity Campaign activity management and delivery trends by activity, topic, or standalone task engage activity references/activity activity.md activity data detail.md , activity topic.md , activity task.md , activity approval.md
Template Strategy templates under a config item engage scene references/scene template.md scene config param.md (template fields reference paramId ); enable via template update then template update status before strategy create
Easy to confuse:
Push channel → ae cli engage setting channel … (Hermes push channel settings)
Config channel → ae cli engage scene config channel … (config center channels; see channel mgmt.md )
Flow / Task canvas nodes use channelId from push channels ; config items bind channel id from config channels
Parameter Conventions
Use regular flags for simple parameters, for example project id , task id , and flow uuid
Use JSON flags for array parameters, for example strategy uuid list '["id1","id2"]'
Use named JSON flags for object parameters, for example req '{...}' and flow list '[...]'
Optional global parameters work the same way as in other domains, for example host , mcp url , and dry run
Naming boundary:
CLI flags use kebab case; outer Capability input and all Capability response keys use snake case.
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.
Semantic audience, event, trigger, completion, and metric definitions are closed contracts. The CLI rejects malformed or unknown semantic fields locally; validate applies the same precise Hermes capability schema without writing.
Successful migrated commands return their business payload under data ; read the matching reference's Response shape before selecting fields.
JSON Parameter Format
Common JSON flag examples:
Common Scenarios
1. setting
2. task
For L3 task reports, read references/task data overview.md , references/task data detail.md ,
references/task metric detail.md , or references/task experiment report.md before invocation.
Before using engage task indicator user , read references/task indicator user.md ; its grouping,
indicator, summary/detail, metric, experiment, and timezone flags have conditional compatibility rules.
3. config
For L3 config reports, read references/config item trigger report.md ,
references/config item analysis report.md , or references/config item strategy comparison.md before invocation.
4. flow
User detail run commands are for bounded inline rows and accept request id , limit , and timeout seconds ; metric detail run returns the report object. Export commands accept request id , artifact format csv jsonl (default jsonl ), and timeout seconds , then return run id and artifact id ; poll with ae cli engage query run inspect run id RUN ID , then download with ae cli engage query artifact download run id RUN ID artifact id ARTIFACT ID output ./artifact.jsonl.gz . Cancel running async work with ae cli engage query query cancel run id RUN ID .
For flow report/user detail commands, read the matching reference before composing non trivial input:
Flow canvas custom metric configuration: references/flow metric update.md
Metric detail report object or flattened report export: references/flow metric detail report.md
Users behind a process level metric segment: references/flow metric user.md
Users behind a node level data segment: references/flow node user.md
Users behind a node level metric segment: references/flow node metric user.md
5. scene (scene management / config center)
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).
6. activity (campaign activities)
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).
Activity payload guardrails
Before generating any activity topic or standalone task payload, enforce the same subset exposed by the Hermes activity UI:
triggerType must be 0 (schedule single) or 1 (schedule repeat). Activity tasks do not support manual ( 2 ) or triggered ( 3 6 ) task types.
Do not configure A/B or horse race experiments. Omit expConfig or use only {"enableExp":false} , and provide exactly one non experiment groupContentList group.
Standalone activity tasks must use triggerTimeStrategy: "fixed time zone" and the parent activity tzOffset . Schedule times must remain inside the activity period.
A topic root supports audience types 1 (custom) and 2 (existing cluster), not 3 (all users). A standalone activity task may use 1 , 2 , or 3 .
Topic tasks inherit schedule, timezone, channel, frequency limits, channel touch limits, whitelist, and experiment settings from the topic. They may only add an inclusion only custom definitionRequest ; never generate task level clusterKey , trigger rules, or shared setting overrides. topic get may return the canonical task marker targetClusterType=1 ; preserve it for update if present, but never use another task level value.
Resolve the parent activity first and confirm it is editable ( mappingStatus 0 , 2 , or 5 ). Limits for topics, tasks, and languages are project configuration values; do not hardcode defaults.
approval submit and approval approve validate every persisted activity task. Approval does not normalize unsupported task data. On ACTIVITY TASK COMPATIBILITY VIOLATION , cancel/withdraw approval as needed, correct or recreate each reported task, and submit again.
7. workbench
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 aut