Data & Execution Commands

This page covers data onboarding, modeling, metrics, execution, and AI-related capabilities. It aligns most closely with hbi-data, hbi-data-modeling, hbi-pipeline, hbi-notebook, hbi-data-alert, and hbi-data-agent.

connection

Purpose: manage data connections, browse schemas/tables, and test connectivity.

Common subcommands:

• connection lifecycle: types list show test create delete update
• internal auth rules: auth-rules auth-rule-get auth-rule-create auth-rule-update auth-rule-delete
• inheritance control: auth-inherit-get auth-inherit-update
• browsing and query: browse query

dataset

Purpose: manage datasets, fields, granularities, previews, imports, and exports.

Common subcommands:

• lifecycle: list show update replace delete duplicate import
• preview and state: preview status schedule lineage export
• knowledge enhancement: knowledge example
• creation paths: create create-from-file upload create-custom-sql create-api create-reference
• transformation flows: create-union create-fusion create-aggregate create-pivot create-unpivot
• fields and expressions: fields expression-rewrite column-create column-update column-delete
• field supplements: column-values column-geo column-geo-role column-geo-role-reset
• granularities: granularity-list granularity-create granularity-update granularity-delete

data-model

Purpose: manage data models and joins.

Common subcommands:

• list show preview query
• lineage tree
• suggest-joins
• join-add join-list join-delete

metric

Purpose: manage atomic metrics.

Common subcommands:

• create delete update
• list show
• query

measure

Purpose: manage business measures.

Common subcommands:

• create delete update
• list show
• query

pipeline

Purpose: manage pipeline flows and nodes.

Common subcommands:

• pipeline lifecycle: list show create update delete duplicate
• runtime state: status errors schedule
• node read/write entrypoints: node edit

edit is the most common deeper entrypoint, with:

• add
• remove
• connect

notebook

Purpose: manage notebooks, paragraphs, and execution-related resources.

Common subcommands:

• notebook lifecycle: list show create update delete
• paragraphs: paragraphs add-paragraph update-paragraph execute delete-paragraph
• connections: connections add-connection authorize-connection revoke-connection remove-connection
• other: schedule languages

data-alert

Purpose: manage data alerts.

Common subcommands:

• list show
• create update delete
• enable disable
• validate

data-agent

Purpose: manage Data Agent / ChatBI backend configuration.

Common subcommands:

• config
• prompt
• vector

Where to drill down next

Scenario	Start with
data connections, schema browsing, and connectivity checks	connection
dataset lifecycle, preview, fields, and granularities	dataset
joins and model queries	data-model
pipeline resources	pipeline
node add/remove/connect operations	pipeline edit
notebooks, paragraphs, and connections	notebook
alert definitions and enable/disable actions	data-alert
Data Agent config, prompts, and vector state	data-agent

When you need exact flags and examples, use that command tree's --help in the terminal.