ae-metadata

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

ae-metadata

ae-metadata

CLI domain
metadata
routes to the analysis capability gateway (
/api/cli/analysis/v1/...
), using auth header
cli-token
.
Parallel to
ae-analysis
. Use this skill for gateway-backed metadata detail and data-table/dimension-table operations; use
ae-analysis
for metadata list/search, metrics, virtual create, and batch edit.
CLI领域**
metadata
路由至分析能力网关(
/api/cli/analysis/v1/...
),使用认证头
cli-token
**。
与**
ae-analysis
并行使用。如需网关支持的元数据详情、数据表/维度表操作,请使用本技能;如需元数据列表/搜索、指标、虚拟创建及批量编辑,请使用
ae-analysis
**。

Global AE CLI Rules

全局AE CLI规则

ParameterDescription
--format <json|table>
Output format. Default JSON.
--jq <expr>
jq filter on JSON output.
--host <url>
Override active AE host, e.g.
ae-cli metadata data-table list --host <url> ...
.
--validate
Optional: fix params only (
/validate
). Alone while iterating complex
qp
/ payload — then run. Do not stack with
--dry-run
.
--dry-run
Optional: confirm ready to run (
/dry-run
). Alone for risk/output preview. Do not stack with
--validate
.
Output and errors:
  • Success: JSON envelope (default). May include optional
    _notice.host_compat
    .
  • Failure:
    { "ok": false, "error": { "type", "message", "hint" } }
    , non-zero exit.
  • 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:
  • Read-only commands can run directly after IDs/names are verified.
  • Ordinary writes (
    data-table *-write
    ,
    property-bindings-update
    , dimension-table bind/create) execute without
    --yes
    . Delete commands are
    high-risk-write
    : dry-run first, summarize impact, wait for explicit confirmation, then execute with
    --yes
    .
  • Before any command, read the matching
    references/<name>.md
    (filename = command with spaces → underscores, e.g.
    metadata data-table list
    metadata_data_table_list.md
    ).
  • Never invent
    project_id
    , event/property names,
    input_file_id
    , or
    data_table_id
    . Discover names via
    ae-analysis
    and data table IDs via
    metadata data-table list
    .
  • metadata data-table download
    is an async artifact command: plain invocation submits,
    --wait
    waits, and
    --output <file>
    waits then streams atomically. Resume with
    analysis run wait
    ; local interruption never cancels the remote run.
参数描述
--format <json|table>
输出格式,默认JSON。
--jq <expr>
对JSON输出应用jq过滤。
--host <url>
覆盖当前AE主机地址,例如
ae-cli metadata data-table list --host <url> ...
--validate
可选参数:仅校验参数(调用
/validate
接口)。在调试复杂
qp
或请求体时单独使用,之后再执行实际命令。不可与
--dry-run
同时使用。
--dry-run
可选参数:确认是否准备好执行(调用
/dry-run
接口)。用于风险/输出预览,单独使用。不可与
--validate
同时使用。
输出与错误处理:
  • 成功:返回JSON包(默认格式),可能包含可选字段
    _notice.host_compat
  • 失败:返回
    { "ok": false, "error": { "type", "message", "hint" } }
    ,退出码非零。
  • 重要提示——主机兼容性(优先检查):每次
    ae-cli
    执行后,检查标准错误输出和
    _notice.host_compat
    字段。若其中任意一项存在,需在回复开头添加简短⚠️版本警告,并逐字引用
    npm i -g
    /
    npx skills add
    (或update-cluster)命令行
    ,再展示业务结果。即使
    ok: true
    也可能携带该提示。
安全规范:
  • 只读命令在ID/名称验证后可直接运行。
  • 普通写入操作(
    data-table *-write
    property-bindings-update
    、维度表绑定/创建)无需
    --yes
    即可执行。删除命令属于
    high-risk-write
    :先执行dry-run,总结影响,等待明确确认后,再添加
    --yes
    执行。
  • 执行任何命令前,阅读对应的
    references/<name>.md
    文档(文件名规则:将命令中的空格替换为下划线,例如
    metadata data-table list
    对应
    metadata_data_table_list.md
    )。
  • 切勿自行编造
    project_id
    、事件/属性名称、
    input_file_id
    data_table_id
    。需通过
    ae-analysis
    获取名称,通过
    metadata data-table list
    获取数据表ID。
  • metadata data-table download
    是异步产物命令:直接调用会提交任务,添加
    --wait
    会等待任务完成,添加
    --output <file>
    会等待完成后原子性地流式输出到文件。可通过
    analysis run wait
    恢复任务;本地中断不会取消远程任务。

When to Use

使用场景

Switch to
ae-metadata
when the user needs:
  • Metadata data-table list/get/create/update/delete/download
  • For local uploads, switch to
    ae-analysis
    and use
    analysis input-file upload
    with a discovered purpose.
  • Bind an existing data table to a property, or create a CSV dimension table and bind it
Stay on
ae-analysis
for: metadata event/property detail, metadata event/property/metric list/search, metric CRUD, batch metadata, virtual create, project config, tracking plans.
当用户需要以下功能时,切换至**
ae-metadata
**:
  • 元数据表的列表/查询/创建/更新/删除/下载
  • 本地文件上传请切换至
    ae-analysis
    ,使用
    analysis input-file upload
    并指定用途。
  • 将现有数据表绑定至属性,或创建CSV维度表并完成绑定
以下场景请继续使用**
ae-analysis
**:元数据事件/属性详情、元数据事件/属性/指标列表/搜索、指标增删改查、批量元数据操作、虚拟创建、项目配置、追踪计划。

Command Format

命令格式

bash
ae-cli metadata <resource> <action> [options]
ae-cli metadata property <dimension-table-action> [options]
  • Commands and flags use kebab-case:
    data-table
    ,
    dimension-table
    ,
    --project-id
    ,
    --data-table-id
    .
  • Gateway
    input
    body fields remain snake_case (
    project_id
    ,
    event_name
    , …); ae-cli maps flags automatically.
bash
ae-cli metadata <resource> <action> [options]
ae-cli metadata property <dimension-table-action> [options]
  • 命令和参数使用短横线命名法(kebab-case)
    data-table
    dimension-table
    --project-id
    --data-table-id
  • 网关请求体的
    input
    字段保留下划线命名法(snake_case)(如
    project_id
    event_name
    等);ae-cli会自动完成参数映射。

PROJECT_ID_GATE

PROJECT_ID_GATE

Same rules as
ae-analysis
: reuse verified project context in one conversation; otherwise
ae-cli project info list
(or
ae-analysis
skill) to resolve
project_id
.
ae-analysis
规则相同:同一场会话中复用已验证的项目上下文;否则使用
ae-cli project info list
(或
ae-analysis
技能)获取
project_id

Commands (10)

命令列表(共10个)

User commandCapability idReference
metadata data-table list
metadata.data_table.list
metadata_data_table_list.md
metadata data-table get
metadata.data_table.get
metadata_data_table_get.md
metadata data-table csv-write
metadata.data_table.csv_write
metadata_data_table_csv_write.md
metadata data-table sql-write
metadata.data_table.sql_write
metadata_data_table_sql_write.md
metadata data-table csv-delete
metadata.data_table.csv_delete
metadata_data_table_csv_delete.md
metadata data-table sql-delete
metadata.data_table.sql_delete
metadata_data_table_sql_delete.md
metadata data-table download
metadata.data_table.download
metadata_data_table_download.md
metadata data-table property-bindings-update
metadata.data_table.property_bindings_update
metadata_data_table_property_bindings_update.md
metadata property bind-existing-dimension-table
metadata.property.bind_existing_dimension_table
metadata_property_dimension_table_bind_existing.md
metadata property create-and-bind-csv-dimension-table
metadata.property.create_and_bind_csv_dimension_table
metadata_property_dimension_table_create_and_bind_csv.md
用户命令能力ID参考文档
metadata data-table list
metadata.data_table.list
metadata_data_table_list.md
metadata data-table get
metadata.data_table.get
metadata_data_table_get.md
metadata data-table csv-write
metadata.data_table.csv_write
metadata_data_table_csv_write.md
metadata data-table sql-write
metadata.data_table.sql_write
metadata_data_table_sql_write.md
metadata data-table csv-delete
metadata.data_table.csv_delete
metadata_data_table_csv_delete.md
metadata data-table sql-delete
metadata.data_table.sql_delete
metadata_data_table_sql_delete.md
metadata data-table download
metadata.data_table.download
metadata_data_table_download.md
metadata data-table property-bindings-update
metadata.data_table.property_bindings_update
metadata_data_table_property_bindings_update.md
metadata property bind-existing-dimension-table
metadata.property.bind_existing_dimension_table
metadata_property_dimension_table_bind_existing.md
metadata property create-and-bind-csv-dimension-table
metadata.property.create_and_bind_csv_dimension_table
metadata_property_dimension_table_create_and_bind_csv.md

Quick Verification

快速验证

bash
ae-cli metadata --help
ae-cli metadata data-table list --help
ae-cli metadata data-table list --project-id 1 --dry-run
ae-cli analysis input-file purpose list --project-id 1
bash
ae-cli metadata --help
ae-cli metadata data-table list --help
ae-cli metadata data-table list --project-id 1 --dry-run
ae-cli analysis input-file purpose list --project-id 1

Related Skills

关联技能

  • ae-analysis
    :
    analysis-meta event get
    /
    analysis-meta property get
    for detail, and
    analysis-meta event list
    /
    analysis-meta property list
    to discover names.
  • Dev workflow:
    .cursor/skills/te-cli-capability-gateway
    — inspect gateway schema when adding new metadata capabilities.
  • ae-analysis
    :使用
    analysis-meta event get
    /
    analysis-meta property get
    获取详情,使用
    analysis-meta event list
    /
    analysis-meta property list
    查询名称。
  • 开发工作流
    .cursor/skills/te-cli-capability-gateway
    —— 添加新元数据能力时,可查看网关模式。