Skip to content

HENGSHI CLI

Overview

HENGSHI CLI is the official command-line tool from HENGSHI and the unified command entrypoint for both humans and AI agents. It turns actions that used to live in UI clicks, ad-hoc scripts, or private API calls into stable, reviewable, and automatable command workflows.

Its current coverage includes:

  • Data connections and dataset onboarding
  • HQL / HE queries and data preview
  • Dashboard, report, and element creation / configuration
  • Permission lookup, grant, and revoke flows
  • System configuration, environment checks, and operational tasks
  • Agent execution workflows powered by official skills

NOTE

Starting with 2.0.0, the public command name is hbi, and this documentation uses hbi plus HBI_* as the primary namespace. Legacy everest / EVEREST_* names are kept only for migration compatibility.

The bridge between HENGSHI SENSE and agents

HENGSHI CLI does not replace the HENGSHI SENSE UI. Its role is to turn core HENGSHI SENSE capabilities into a stable command interface that people and agents can call, review, and reuse. It works for direct terminal users as well as OpenClaw, CI jobs, and automation scripts.

In that chain, the common split looks like this:

LayerRoleTypical responsibility
HumanTask owner and reviewerProvide intent, approve boundaries, review outcomes
Agent / automation flowOrchestration layerBreak work into steps, sequence actions, and decide which command to call next
HENGSHI CLI + skillsBridge and execution layerTranslate HENGSHI SENSE capabilities into structured commands, outputs, and --dry-run previews
HENGSHI SENSE backendCapability layerActually perform connection, query, modeling, authorization, and delivery actions

If you are designing reusable workflows for OpenClaw or other agents, CLI is usually the bridge itself: it connects agent-side orchestration with real HENGSHI SENSE capabilities instead of forcing the agent to guess UI paths or assemble private APIs on its own.

What problems CLI is good at solving

ScenarioWhat CLI brings
Letting an agent perform BI delivery tasksOne command model and one output contract instead of “every agent invents its own API calls”
Putting risky changes into review flows--dry-run lets you inspect changes before execution
Returning results to humans or downstream systemsjson / yaml / table outputs are easier to read, record, and post-process
Building repeatable operational workflowsLocal terminals, CI, background services, and agent runtimes can all reuse the same commands
Surfacing out-of-browser changes back into the UISSE and the Autopilot indicator provide a realtime feedback bridge

Command surface at a glance

HENGSHI CLI is not a single-purpose tool. It is a command tree aligned with the main BI delivery chain.

Command domainWhat it coversExample
appApplications, spaces, portals, shared dimensionshbi app list --area personal-area --root
datasetDataset onboarding and listinghbi dataset list --app retail-ops --output json
data-modelHQL / HE querying and data previewhbi data-model query --app <id> --dataset <id> "SUM({amount})"
dashboardDashboards, reports, and themeshbi dashboard create --app retail-ops "Regional Sales Cockpit"
elementCharts, filters, containers, buttons, iframes, and morehbi element chart create --dashboard dsh_2048 --app retail-ops --dataset sales_daily line
connectionData source connection managementhbi connection list
authorizeUnified authorization APIhbi authorize grant app app_42 --user 123:editor --dry-run
preferencesSystem configuration inspection and previewed updateshbi preferences everest --output json

Official skills and agent execution

CLI is delivered together with official bundled skills. Common layers include:

  • hbi-core: authentication, configuration, output, and terminology rules
  • hbi-data: connections, datasets, metrics, and data workflows
  • hbi-dashboard: dashboard planning, layout, and element configuration
  • hbi-permission: permission lookup, grants, and revocations
  • hbi-workflow: cross-domain orchestration and sequencing

The purpose of these skills is not to replace CLI. They encode execution experience such as which state should be read first, which actions must go through --dry-run, and how results should be returned to people or other systems.

If you are new to HENGSHI CLI, read in this order:

  1. Installation & Upgrade
  2. Authentication & Connection
  3. Agent Integration & Skills
  4. Common Workflows
  5. Command Reference
  6. Realtime Sync & Autopilot
  7. Troubleshooting & FAQ

Recommendation

If your goal is to let an agent execute stable actions instead of typing commands manually, start with Agent Integration & Skills and Common Workflows.

User Manual for Hengshi Analysis Platform