finebi-cli

finebi-cli is the publishable CLI package in this monorepo. It provides command-line access to FineBI data analysis, exports, and dashboard workflows.

Quick Start

npm install -g finebi-cli
finebi-cli init
finebi-cli search-public-dataset -k "Sales"

Package contents

• CLI executable: finebi-cli
• Published files: dist, README.md, .env.example

Configuration

The CLI reads these environment variables:

• FINEBI_BASE_URL
• FINE_ACCESS_TOKEN

You can create them with finebi-cli init or by writing a .env file manually.

By default:

• finebi-cli init writes to ~/.finebi-cli/.env
• the CLI reads .env in this order:
  • current working directory
  • ~/.finebi-cli/.env
  • package-local development fallbacks

This means:

• user-level config works from any directory
• a project-local .env can still override it when needed

There are two common setup patterns:

1. Standalone CLI usage

finebi-cli init

This writes config to ~/.finebi-cli/.env, and the CLI can then be used from any directory.

2. Running inside a host such as OpenClaw

• the user can configure FINEBI_BASE_URL and FINE_ACCESS_TOKEN in the host tool's .env
• if the host injects those variables into the finebi-cli process, the CLI will use them automatically
• in that case, finebi-cli init is optional rather than required

Release checks

Before publishing this package, run:

pnpm test
pnpm typecheck
pnpm build
pnpm pack

Release note

• finebi-cli consumes finebi-querydata-sdk as a normal npm dependency at publish time.
• In this workspace the dependency is declared as workspace:*, but pnpm pack and pnpm publish rewrite it to the current published SDK version range.
• If the CLI depends on a new SDK release, publish finebi-querydata-sdk first and then publish finebi-cli.

Available CLI commands

• init
• get-entry-tree
• get-published-subject-resources
• search-my-datasets
• search-my-dashboards
• get-publick-datasets-list
• search-public-dataset
• preview-dataset-data
• get-widget-data
• resolve-dashboard-widgets
• export-dashboard-excel
• export-dashboard-pdf
• export-dashboard-image
• get-dashboard-user-info
• get-dashboards-by-subject
• get-dashboard-design-configure

Run finebi-cli <command> --help for command-specific options.

resolve-dashboard-widgets

List all data widgets in a dashboard with their widgetId and display name:

finebi-cli resolve-dashboard-widgets -d <dashboardId>

Use the returned widgetId with get-widget-data.

get-widget-data

Basic usage:

finebi-cli get-widget-data -r <dashboardId> -w <widgetId>

Optional dashboard-state inputs in the same SDK lifecycle:

finebi-cli get-widget-data \
  -r <dashboardId> \
  -w <widgetId> \
  --filter '{"widgetId":"filterWidget","value":{"type":1,"value":["华东"]}}' \
  --linkage '{"widgetId":"sourceWidget","payload":{"dId":"area","fieldId":"field1","text":"华东","value":[{"dId":"area","fieldId":"field1","text":"华东"}]}}'

• --filter applies one filter payload before querying the target widget
• --linkage applies one linkage payload before querying the target widget