Quick BI CLI 安装与使用指南

更新时间:
复制为 MD 格式

概述

Quick BI CLI 是 Quick BI 产品的命令行工具,帮助您在 AI 原生平台(如 Claude Code、OpenClaw、Qoderwork、QClaw、悟空等)即可快速管理 Quick BI 资源。通过封装 Quick BI 开放平台的 OpenAPI 能力,帮助用户高效管理组织与权限配置、数据资源、嵌入分析及审计日志。

适用场景

类型

场景

特点

子命令数

覆盖范围

组织管理

成员、用户组、标签、角色的统一管理

支持批量导入、层级用户组、多维度角色权限

47

工作空间 CRUD、用户 CRUD、用户组、标签体系、角色管理

权限管理

报表分享、门户菜单、行列级数据权限控制

细粒度授权(查看/编辑/管理)、审批流回调、白名单机制

35

行级权限、分享授权、门户菜单权限、审批流

资源管理

工作空间、报表、数据集、数据源的生命周期管理

血缘分析、性能监控、Quick 引擎加速、订阅推送

27

作品查询/血缘/性能、数据集/加速/缓存、数据源、收藏、首页聚合

数据服务

数据集发布为API供外部调用

支持条件查询、返回结构化数据

5

数据服务API管理

嵌入分析

报表免登嵌入第三方系统

Ticket 动态管理(有效期/次数可调)、嵌入状态控制

16

嵌入分析全生命周期管理

统计分析

操作审计日志查询

多维度筛选(时间/用户/资源/操作类型)、全链路追溯

4

审计日志、统计数据

合计

134

具体CLI命令的清单您可以查看Quick BI CLI 命令参考手册

安装指南

根据您获取技能包的方式不同,安装流程有所差异,请按具体场景选择对应的安装方法。下面以悟空安装为例:

第一步:通过对话安装

第二步:配置凭证

  • 安装完成后,AI 助理将主动向您要求提供您的身份凭证。您需将个人的身份凭证发送给您的 AI 助理完成配置设置。

    image.png

  • 如何获取身份凭证:登录 Quick BI 控制台 → 挪动光标至右上角头像 → 个人识别码 → 复制对应信息。

    image

使用场景示例

本章节介绍在实际业务中的三大典型应用场景。通过自然语言交互,您可以快速完成报表嵌入、数据审计和成员管理等更多工作。

示例一:报表快速外嵌

场景概述

在企业日常运营中,经常需要将数据报表分享给外部合作伙伴、管理层查看。传统的报表嵌入方式需要技术人员手动调用 API 接口,开通流程长且需要定时任务维护票据续期。

通过 Quick BI CLI,您只需用自然语言描述需求,即可一键完成报表的免密嵌入配置,并直接发送给指定人员。

image.png

使用示例

场景描述:将指定工作空间下的报表开通嵌入访问权限,设置访问有效期,并生成分享链接。

适用场景

  • 向客户展示业务数据报表

  • 向管理层汇报经营数据

  • 跨部门数据共享与协作

功能说明

CLI 将自动完成以下操作:

  • 生成报表嵌入 Ticket

  • 设置访问有效期(支持自定义天数)

  • 返回可访问的嵌入链接

  • 通过指定渠道发送给接收人(可选)

操作指令示例

  • 基础用法:“使用 Quick BI CLI,将 xx 工作空间下的 xx 报表开通嵌入访问,访问时间限制为 30 天,设置完成后返回链接给我。”

  • 进阶用法:“使用 Quick BI CLI,将 xx 工作空间下的 xx 报表开通嵌入访问,访问时间限制为 30 天,设置好后发送给 xx 人员查看,内容为:您好,这是我们公司的销售数据,请查收。”

效果示例如下:

image

image

示例二:数据资产盘点与审计分析

场景概述

企业数据资产的管理需要定期审计和性能分析,以了解资源使用情况和优化方向。传统的审计日志和性能分析仅提供界面展示或 OpenAPI 接口,前者信息展示有限,后者技术门槛较高。

Quick BI CLI 提供了自然语言交互式的数据审计能力,帮助您快速获取数据资产的使用情况和性能表现。

适用场景

  • 定期数据资产盘点

  • 报表使用热度分析

  • 性能瓶颈排查与优化

  • 数据治理与合规审计

功能说明

CLI 将为您提供:

  • 资源审计:以表格形式展示访问量排名、访问趋势等统计信息

  • 性能分析:针对指定报表或仪表板,分析其关联数据集的查询性能、响应时间等指标

使用示例

场景描述:查看近期访问量最高的报表,并对热门报表进行性能分析。

操作指令示例:“使用 Quick BI 命令行工具,用表格展示近 7 天访问量前 10 的报表,并对排名第一的仪表板根据关联数据集做近七天的性能分析。”

效果示例如下:

image

image

同时,可查看详细的性能分析报告,包括详细的组件清单、业务指标映射与优化建议。

image

示例三:组织成员管理

场景概述

传统方式依赖人工在控制台操作,流程繁琐。Quick BI CLI 支持通过自然语言指令快速完成成员管理任务。企业在以下场景需要频繁进行成员管理操作:

  • 新员工入职,需要创建 Quick BI 账号并分配权限

  • 系统迁移,需要将用户从旧系统批量导入

  • 组织架构调整,需要变更成员角色或所属工作空间

适用场景

  • 新员工入职账号开通

  • 批量导入用户数据

  • 工作空间成员权限调整

  • 组织架构变更后的权限同步

功能说明

CLI 支持以下组织成员管理能力:

  • 添加组织成员

  • 将成员添加到指定工作空间

  • 批量更新工作空间成员角色

使用示例

场景描述:为新入职员工创建账号并添加到指定工作空间。

操作指令示例:“使用 Quick BI CLI,将今天入职的新同事 xxx 加入组织,并添加到 xx 的工作空间作为分析师。”

效果示例如下:

image

image

示例四:问数数据集权限管理 + 问数 Skill 搭配使用

场景概述

Quick BI 问数 Skill 需要依赖问数数据集的配置,利用 CLI 您可以快速完成问数数据集权限配置,和问数 Skill 结合,达到 1+1 > 2 的效果:

  • 新员工入职,需要批量赋予问数数据集的权限

  • 快速完成多个问数数据集的权限管理

适用场景

  • 快速问数数据集权限开通

  • 和问数Skill搭配形成工作流

功能说明

CLI 支持以下组织成员管理能力:

  • 列出当前用户可用的问数数据集

  • 批量管理问数授权(新增/撤销)

使用示例

场景描述:查看有哪些智能问数数据集可用。

操作指令示例:“查看我有哪些智能问数数据集可用”+“给我申请xx的智能问数数据集权限”+“销售额排名情况如何”

效果示例如下:

  • 使用Quick BI CLI查看有哪些智能问数数据集可用。image.png

  • 使用Quick BI CLI对指定智能问数数据集添加权限。image

  • 使用Quick BI Skill对开始问数。image查看结果:image