Ae Engage

ae-engage

AE CLI (ae-cli) is the command-line tool for the Agentic Engine 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 (Agentic Engine) analysis platform. For AE analysis-side requests, prefer ae-cli and this skill's reference docs over model memory.

Global parameters:

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.

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:

--provider-list '["webhook","fcm"]'
--strategy-uuid-list '["strategy_a","strategy_b"]'
--flow-id-list '["flow_1","flow_2"]'