跳到主要内容

命令清单

本文按功能分组介绍 OpenInsight CLI 当前支持的命令，每个子命令独立成节。命令默认在已初始化的 project 目录下执行，初始化和升级类命令除外。

CLI 管理​

openinsight man​

输出 OpenInsight Domain / Knowledge / Utils 子命令树，供 Agent 了解 CLI 能力。

openinsight man

使用 --all 输出全部 CLI 分组，包括 CLI 管理命令：

openinsight man --all

openinsight skills​

将内置 Agent skills 安装到 Cursor / Claude Code / Codex / 生意高手。

openinsight skills

使用参数指定目标工具和安装范围：

openinsight skills --tool <tool> --scope <scope>
  • --tool <tool>：支持 cursor / claude / codex / shengyigaoshou。
  • --scope <scope>：支持 global / project。

openinsight update​

检查并安装最新版本的 OpenInsight CLI。

openinsight update

使用 --base-url <url> 指定更新源：

openinsight update --base-url <url>

openinsight setup​

引导完成数据分析库初始化。

openinsight setup [path]

也可以用参数跳过交互：

openinsight setup ./analytics-repo \
  --project sales \
  --provider yuce \
  --endpoint https://your-yuce-host \
  --token your-personal-access-token

可选参数：

参数说明
--project <project>初始化时创建的 project 名称。
--provider <provider_code>数据平台 provider code，目前支持 yuce。
--endpoint <endpoint>预策站点根地址或 API endpoint。
--token <token>Personal Access Token。
--force当模板文件已存在时覆盖写入。
--skip-skills初始化完成后跳过 Agent skills 安装。

Project 与 Provider​

openinsight current​

查看当前 project，并输出关键资源路径。

openinsight current

openinsight location​

从数据产品 URL 中解析 provider、领域对象和远端业务对象 ID；调度实例 URL 会同时返回关联 task。

openinsight location <url>

openinsight feedback​

根据 SessionId 查找本地 Agent 会话日志，并将对话、thinking、tool 调用上报到 Sentry。

openinsight feedback <session-id>

支持 --client-type <type>，目前仅支持 codex。上报消息会带上 SessionId 前缀，且不包含 tool 执行结果。

openinsight provider list​

列出当前 project 已配置的 provider。

openinsight provider list

openinsight provider add​

新增 provider。

openinsight provider add <provider_code> --endpoint <endpoint> --token <token>

支持 --provider <provider> 指定 provider 类型，目前支持 yuce。

openinsight provider update​

修改 provider 连接配置。

openinsight provider update <provider_code>

支持通过 --endpoint <endpoint> 和 --token <token> 更新连接地址和 Personal Access Token。

openinsight provider update-auth​

直接更新 provider 在本地 .open-insight.json 中的 Personal Access Token。

openinsight provider update-auth <provider_code> <access_token>

当前 project 只有一个 provider 时，可以省略 provider code：

openinsight provider update-auth <access_token>

如果当前 project 配置了多个 provider，必须显式传入 provider code。

openinsight provider delete​

删除 provider，并清理它同步到本地的缓存。

openinsight provider delete <provider_code>

数据查询与语义数据集​

openinsight cluster query​

在计算集群上执行 SQL 并输出结果。

openinsight cluster query [sql...]

对于包含引号或换行的复杂 SQL，可以使用 --sql：

openinsight cluster query --sql <sql>

使用 --format auto/table/records/json 指定输出格式。

openinsight cluster history​

按时间范围查询计算引擎 SQL 执行历史（审计日志）。

openinsight cluster history --start-time <time> --end-time <time>
  • --start-time / --end-time：必传，格式为 YYYY-MM-DD HH:mm 或带秒时间。
  • --cursor <timestamp>|<queryId>：从指定游标继续分页。
  • --limit <limit>：默认 50，最大 200。
  • --order-by <field>：可重复或用逗号分隔；字段支持 cpu-cost-ns / mem-cost-bytes / scan-rows / query-time，可带 :asc / :desc，裸字段默认 desc。
  • --stmt-like <pattern>：按 SQL 文本筛选。
  • --format <format>：默认 records。

默认按时间升序分页，页满时输出 nextCursor。使用 --order-by 时不可与 --cursor 同用，也不输出 nextCursor。

openinsight cluster score​

按时间窗口评估魔方服务健康分（0-100），并输出各风险扣分项。

openinsight cluster score

支持 --start-time <time> 和 --end-time <time>，默认时间范围为昨天 00:00:00 到 23:59:59。命令内部按 query-time DESC 拉取耗时不低于 5 分钟的执行历史，分页至不足一页，再按失败、内存超限、慢查、大扫描、重复热点等风险项从 100 分扣分，输出总分与扣分明细。

openinsight dataset list​

列出当前 project 下的数据集清单，只读本地 datasets/*.md。

openinsight dataset list

openinsight dataset get​

查看单个数据集定义。

openinsight dataset get <id>

openinsight dataset create​

创建本地数据集定义。

openinsight dataset create <id> --title <title>

支持 --owner <owner> 和 --source <source>。

openinsight dataset delete​

删除本地数据集定义。

openinsight dataset delete <id>

openinsight table find​

优先按表名和 table.yaml 内容查找本地表；未命中或缓存过期时自动查询远端。

openinsight table find <pattern>

使用 --force-pull 可以忽略缓存时间，先同步远端 table 元信息。

openinsight table get​

查看当前 project 下的本地 table.yaml。

openinsight table get <remote_id>
  • --name：按 table name 匹配。
  • --force-pull：强制同步远端 table 元信息。

openinsight table lineage​

查询表或数据节点的上游数据血缘。

openinsight table lineage <node_id>
  • --max-level <level>：最大查询层级，默认 3。
  • --format json/table：指定输出格式。

调度任务与产出排查​

openinsight task list​

列出当前 project 下的调度任务清单。

openinsight task list

支持 --page-size <size>。

openinsight task get​

实时查看远端任务详情，task_type 当前支持 etl / sql。

openinsight task get <task_id> --task-type <task_type>

支持 --version <version> 和 --force-pull。

openinsight task instances​

按时间范围分页查询指定任务的远端调度实例，输出完整 JSON。

openinsight task instances --task-code <code>
  • --task-code <code>：必填。
  • --page-index <page>：默认 1。
  • --page-size <size>：默认 100。
  • --start-time <time>：默认今天 00:00。
  • --end-time <time>：默认今天 23:59。

该命令只查询指定分页，不写本地文件。

openinsight task lineage​

查询调度任务的上下游任务血缘。

openinsight task lineage <task_id>
  • --max-level <level>：最大查询层级，默认 3。
  • --format json/table：指定输出格式。

openinsight task_instance restart​

按远端调度实例 code 提交重启请求。使用当前 project 配置的预策认证信息。

openinsight task_instance restart <task_instance_code>

openinsight taskrun list​

按时间范围同步预策调度实例到本地小时分桶，并写入 source/taskruns/。

openinsight taskrun list --from <from> --to <to>

支持 --status <status>、--task-code <code>、--task-name <name> 和 --page-size <size>。

openinsight taskrun log​

查看调度实例执行日志，含重试记录。

openinsight taskrun log

支持 --taskrun-id <id>、--task-code <code>、--task-name <name>、--line <line> 和 --date <date>。

openinsight taskrun diagnose​

查询调度实例对应计算引擎执行计划。

openinsight taskrun diagnose <taskrun-id>

使用 --format json/table 指定输出格式，默认为 json。

仪表盘、站点与图表​

openinsight dashboard list​

实时查询远端仪表盘清单。

openinsight dashboard list

openinsight dashboard get​

实时查询远端仪表盘详情。

openinsight dashboard get <dashboard_id>

openinsight site list​

实时查询远端站点清单。

openinsight site list

支持 --page-size <size>。

openinsight site get​

实时查询远端站点详情，并递归展开站点内仪表盘。

openinsight site get <site_id>

openinsight chart list​

实时查询指定仪表盘下的图表清单。

openinsight chart list --dashboard <dashboard_id>

openinsight chart get​

实时查询远端图表详情。

openinsight chart get <chart_id>

支持 --dashboard <dashboard_id> 指定所属仪表盘。

openinsight chart query​

实时查询远端图表数据。

openinsight chart query <chart_id>

支持 --dashboard <dashboard_id> 指定所属仪表盘，并可用 --format table/json 指定输出格式。

指标中心​

openinsight metric list​

实时查询远端指标清单，固定每页 200 并拉取全部分页。

openinsight metric list

支持 --keyword <keyword> 按指标名称或编码搜索。

openinsight metric get​

实时查询远端指标详情和完整依赖树。

openinsight metric get <metric_id>

openinsight dimension list​

实时查询远端维度清单，固定每页 200 并拉取全部分页。

openinsight dimension list

支持 --keyword <keyword> 按维度名称或字段 ID 搜索。

openinsight subject list​

实时查询远端指标中心-分析主体清单。

openinsight subject list

openinsight subject get​

实时查询远端指标中心-分析主体属性与关系，并输出原始 JSON。

openinsight subject get <object_type_rid>

权限、用户、基线与审计​

openinsight user list​

直接查询预策用户清单。

openinsight user list

支持 --page-size <size>。

openinsight permission get​

直接查询预策权限信息，不写入本地缓存。

openinsight permission get --scope <scope> --user-id <userId>
  • --scope function/data-resource/data/dashboard：指定权限范围。
  • --auth-type <authType>：指定授权类型。

openinsight baseline list​

直接查询预策基线清单。

openinsight baseline list

支持 --page-size <size>。

openinsight baseline-instance list​

按业务日期直接查询预策基线实例。

openinsight baseline-instance list --date <date>

支持 --status <status>、--completed <completed> 和 --page-size <size>。

openinsight audit-log list​

直接查询预策审计日志。

openinsight audit-log list

支持 --from <from>、--to <to>、--resource-type <types>、--object-id <ids>、--operator-id <ids>、--operation-type <types>、--status <status>、--page <page>、--page-size <size> 和 --all。

当 --resource-type chart 且 --operation-type view 时，改查预策点击日志（POST /trace/log/queryLog，operateKey 固定为「接收点击事件」），只保留「仪表盘卡片-加载时间」事件。该接口不支持按图表 ID 查询，--object-id 会在拉取时间段内日志后按 cardId 本地过滤，并自动拉全部分页。此场景时间必填：--from 默认今天 00:00:00，--to 默认当前时刻。排查打开慢的完整路径见 排查卡片打开耗时过久。

示例​

openinsight current
openinsight table find orders
openinsight cluster query "select * from fxxb0507 limit 10"
openinsight task lineage <task_id> --format table
openinsight table lineage <node_id> --format table
openinsight dashboard get <dashboard_id>
openinsight site list
openinsight metric list --keyword 退款
openinsight metric get <metric_id>
openinsight dimension list --keyword 日期
openinsight subject list
openinsight subject get <object_type_rid>
openinsight permission get --scope dashboard --user-id <user_id>
openinsight audit-log list --resource-type chart --operation-type view

更多初始化步骤见 快速开始，更多使用路径见 使用案例。