命令清单

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

CLI 管理

命令	功能
openinsight man	输出 OpenInsight Domain / Knowledge / Utils 子命令树，供 Agent 了解 CLI 能力。
openinsight man --all	输出全部 CLI 分组，包括 CLI 管理命令。
openinsight skills	将内置 Agent skills 安装到 Cursor / Claude Code / Codex / 生意高手。
openinsight skills --tool <tool> --scope <scope>	指定目标工具和安装范围；tool 支持 cursor / claude / codex / shengyigaoshou，scope 支持 global / project。
openinsight update	检查并安装最新版本的 OpenInsight CLI。
openinsight update --base-url <url>	使用指定更新源检查并升级 CLI。
openinsight setup [path]	引导完成数据分析库初始化。

setup 支持用参数跳过交互：

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 location <url>	从数据产品 URL 中解析 provider、领域对象和远端业务对象 ID；调度实例 URL 会同时返回关联 task。
openinsight feedback <session-id>	根据 SessionId 查找本地 Agent 会话日志，并将对话、thinking、tool 调用上报到 Sentry。
openinsight provider list	列出当前 project 已配置的 provider。
openinsight provider add <provider_code> --endpoint <endpoint> --token <token>	新增 provider。
openinsight provider update <provider_code>	修改 provider 连接配置。
openinsight provider update-auth <provider_code> <access_token>	直接更新 provider 的本地 Personal Access Token。
openinsight provider update-auth <access_token>	当前 project 只有一个 provider 时，可省略 provider code。
openinsight provider delete <provider_code>	删除 provider，并清理它同步到本地的缓存。

provider add 支持 --provider <provider> 指定 provider 类型，目前支持 yuce。provider update 支持更新 --endpoint 和 --token。provider update-auth 只修改本地 .open-insight.json 中的 token；如果当前 project 配置了多个 provider，必须显式传入 provider code。

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

数据查询与语义数据集

命令	功能
openinsight cluster query [sql...]	在计算集群上执行 SQL 并输出结果。
openinsight cluster query --sql <sql>	执行包含引号或换行的复杂 SQL。
openinsight dataset list	列出当前 project 下的数据集清单，只读本地 datasets/*.md。
openinsight dataset get <id>	查看单个数据集定义。
openinsight dataset create <id> --title <title>	创建本地数据集定义。
openinsight dataset delete <id>	删除本地数据集定义。
openinsight table find <pattern>	优先按表名和 table.yaml 内容查找本地表；未命中或缓存过期时自动查询远端。
openinsight table get <remote_id>	查看当前 project 下的本地 table.yaml。
openinsight table lineage <node_id>	查询表或数据节点的上游数据血缘。

常用选项：

命令	选项
cluster query	--format auto/table/records/json。
dataset create	--owner <owner>、--source <source>。
table find	--force-pull，忽略缓存时间，先同步远端 table 元信息。
table get	--name 按 table name 匹配；--force-pull 强制同步远端 table 元信息。
table lineage	--max-level <level>（默认 3）、--format json/table。

调度任务与产出排查

命令	功能
openinsight task list	列出当前 project 下的调度任务清单。
openinsight task get <task_id> --task-type <task_type>	实时查看远端任务详情；task_type 当前支持 etl / sql。
openinsight task instances --task-code <code>	按时间范围分页查询指定任务的远端调度实例，输出完整 JSON。
openinsight task lineage <task_id>	查询调度任务的上下游任务血缘。
openinsight taskrun list --from <from> --to <to>	按时间范围同步预策调度实例到本地小时分桶。
openinsight taskrun log	查看调度实例执行日志，含重试记录。
openinsight taskrun diagnose <taskrun-id>	查询调度实例对应计算引擎执行计划。

常用选项：

命令	选项
task list	--page-size <size>。
task get	--version <version>、--force-pull。
task instances	--task-code <code>（必填）、--page-index <page>（默认 1）、--page-size <size>（默认 100）、--start-time <time>（默认今天 00:00）、--end-time <time>（默认今天 23:59）。
task lineage	--max-level <level>（默认 3）、--format json/table。
taskrun list	--status <status>、--task-code <code>、--task-name <name>、--page-size <size>。
taskrun log	--taskrun-id <id>、--task-code <code>、--task-name <name>、--line <line>、--date <date>。
taskrun diagnose	--format json/table（默认 json）。

task instances 只查询指定分页且不写本地文件；taskrun list 会按时间范围同步实例并写入 source/taskruns/ 小时分桶。

仪表盘、站点与图表

命令	功能
openinsight dashboard list	实时查询远端仪表盘清单。
openinsight dashboard get <dashboard_id>	实时查询远端仪表盘详情。
openinsight site get <site_id>	实时查询远端站点详情，并递归展开站点内仪表盘。
openinsight chart list --dashboard <dashboard_id>	实时查询指定仪表盘下的图表清单。
openinsight chart get <chart_id>	实时查询远端图表详情。
openinsight chart query <chart_id>	实时查询远端图表数据。

chart get 和 chart query 支持 --dashboard <dashboard_id> 指定所属仪表盘；chart query 支持 --format table/json。

指标中心

命令	功能
openinsight metric list	实时查询远端指标清单，固定每页 200 并拉取全部分页。
openinsight metric get <metric_id>	实时查询远端指标详情和完整依赖树。
openinsight dimension list	实时查询远端维度清单，固定每页 200 并拉取全部分页。
openinsight subject list	实时查询远端指标中心-分析主体清单。
openinsight subject get <object_type_rid>	实时查询远端指标中心-分析主体属性与关系。

metric list 支持 --keyword <keyword> 按指标名称或编码搜索；dimension list 支持 --keyword <keyword> 按维度名称或字段 ID 搜索。subject get 输出属性和关系的原始 JSON。

权限、用户、基线与审计

命令	功能
openinsight user list	直接查询预策用户清单。
openinsight permission get --scope <scope> --user-id <userId>	直接查询预策权限信息，不写入本地缓存。
openinsight baseline list	直接查询预策基线清单。
openinsight baseline-instance list --date <date>	按业务日期直接查询预策基线实例。
openinsight audit-log list	直接查询预策审计日志。

常用选项：

命令	选项
user list	--page-size <size>。
permission get	--scope function/data-resource/data/dashboard、--auth-type <authType>。
baseline list	--page-size <size>。
baseline-instance list	--status <status>、--completed <completed>、--page-size <size>。
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。

示例

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 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>

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