Quick BI CLI installation and usage-Quick BI(Quick BI)-阿里云帮助中心

Limitations

The Quick BI CLI is available only in the Professional Edition.

Overview

The Quick BI CLI is a command-line tool for Quick BI that helps you quickly manage Quick BI resources on AI-native platforms such as Claude Code, OpenClaw, Qoderwork, QClaw, and Wukong. By wrapping the OpenAPI capabilities of the Quick BI Open Platform, the CLI lets you efficiently manage organization and permission configurations, data resources, embedded analytics, and the audit log.

Use cases:

Type	Scenario	Features	Subcommands	Scope
Organization management	Unified management of members, user groups, tags, and roles.	Supports bulk import, hierarchical user groups, and multi-dimensional role permissions.	47	workspace CRUD, user CRUD, user groups, tag system, and role management
Permission management	Control of report sharing, portal menus, and row- and column-level data permissions.	Fine-grained authorization (view/edit/manage), approval workflow callbacks, and allowlist mechanism.	35	row-level permission, sharing authorization, portal menu permissions, and approval workflows
Resource management	Lifecycle management for workspaces, reports, datasets, and data sources.	Lineage analysis, performance monitoring, Quick Engine acceleration, and subscription push.	27	workspace query/lineage/performance, dataset/acceleration/cache, data sources, favorites, and homepage aggregation
Data services	Publish datasets as APIs for external calls.	Supports conditional queries and returns structured data.	5	Data service API management
Embedded analytics	Embed reports into third-party systems without sign-in.	Dynamic ticket management (adjustable validity period and usage count) and embedded state control.	16	Full lifecycle management for embedded analytics
Statistical analysis	Query the operation audit log.	Multi-dimensional filtering (by time, user, resource, or operation type) and end-to-end tracing.	4	Audit log and statistical data
Total	134

For a complete list of CLI commands, see the Quick BI CLI Command Reference.

Installation

The installation process varies depending on how you obtain the skill package. Choose the installation method that matches your scenario. The following example uses Wukong for installation.

Step 1: Install via conversation

Open your AI agent workbench. In the chat box, enter and send the following command:
As an Agent assistant, install Quick BI CLI by following this guide: https://quickbi-prod.oss-cn-beijing.aliyuncs.com/quickbi-cli/AI_INSTALLATION_GUIDE.md
When you see the message "Quick BI CLI installed successfully", the installation is complete.

Step 2: Configure credentials

After installation, the AI assistant will prompt you for your credentials. You must provide them to complete the configuration.
How to obtain your credentials: Log on to the Quick BI console → Move the pointer over your avatar in the upper-right corner → Click Access Key → Copy the required information.

Examples

This section introduces several typical use cases for real-world business scenarios. You can use natural language to quickly complete tasks such as embedding reports, auditing data, and managing members.

Example 1: Embed a report

Scenario overview

In daily operations, organizations often need to share data reports with external partners or leadership. Traditional embedding requires engineers to manually call APIs, which involves a lengthy enablement process and requires scheduled tasks for ticket renewals.

With the Quick BI CLI, you can simply describe your needs in natural language to configure login-free report embedding in a single step and send the link directly to specified individuals.

Example

Scenario description: Enable embedded access for a report in a specified workspace, set an access validity period, and generate a shareable link.

Use cases

Show business data reports to clients
Report operational data to management
Share data and collaborate across departments

What this does

The CLI automatically performs the following actions:

Generates an embedding ticket for the report
Sets an access validity period (customizable in days)
Returns an accessible embedding link
Sends the link to a recipient through a specified channel (optional)

Example prompts:

Basic usage: "Use the Quick BI CLI to enable embedded access for the <report_name> report in the <workspace_name> workspace. Set the access period to 30 days, then return the link to me."
Advanced usage: "Use the Quick BI CLI to enable embedded access for the <report_name> report in the <workspace_name> workspace. Set the access period to 30 days. After setup, send it to <recipient_name> with the message: 'Hello, here is our company's sales data. Please review.'"

Example output:

Example 2: Data inventory and audit

Scenario overview

Managing enterprise data assets requires regular audits and performance analysis to understand resource usage and identify optimization opportunities. Traditional audit log and performance analysis tools are available only through a UI or OpenAPI. The UI provides limited information, and OpenAPI requires a high level of technical expertise.

The Quick BI CLI offers interactive data auditing through natural language, helping you quickly gain insights into data asset usage and performance.

Use cases

Regular data asset inventory
Report usage heat analysis
Performance bottleneck investigation and optimization
Data governance and compliance audit

Features

The CLI provides you with:

Resource audit: Displays statistics, such as visit rankings and trends, in a table.
Performance analysis: Analyzes metrics, such as query performance and response time, for the dataset associated with a specified report or dashboard.

Examples

Scenario: View the reports with the highest recent access volume and analyze their performance.

Example command: "Use the Quick BI command-line tool to display the top 10 reports by visits in the last 7 days in a table, and perform a performance analysis for the last seven days on the top-ranked dashboard based on the associated dataset."

The following is an example:

You can also view a detailed performance analysis report that includes a detailed component list, business metric mapping, and optimization recommendations.

Example 3: Organization member management

Scenario overview

Manually managing members in the console is a tedious process. Quick BI CLI lets you quickly manage members using natural language commands. Companies frequently manage members in the following scenarios:

Create Quick BI accounts and assign permissions for new employees.
Import users in bulk from an old system during a system migration.
Change member roles or workspaces after an organizational restructuring.

Applicable scenarios

Onboard new employees by creating accounts.
Import user data in bulk.
Adjust permissions for workspace members.
Synchronize permissions after organizational changes.

Feature description

The CLI supports the following member management features:

Add organization members.
Add members to a specified workspace.
Update workspace member roles in bulk.

Usage example

Scenario description: Create an account for a new employee and add them to a specified workspace.

Example command: "Use Quick BI CLI to add the new colleague xxx, who started today, to the organization and to the xx workspace as an analyst."

The result is shown below.

Example 4: Data Q&A dataset permission management + Data Q&A Skill

Scenario overview

The Quick BI Data Q&A Skill relies on the configuration of Data Q&A datasets. You can use the CLI to quickly configure permissions for these datasets. When combined with the Data Q&A Skill, this achieves an effect where 1 + 1 > 2: