---
url: /v6.2/cli-reference.md
---
# CLI 命令参考

这组页面按 **顶层命令域** 组织，并在高频命令域里补充了**最小可用示例、典型输出片段和下一步常见动作**。它的作用是帮你快速：

* 找到最小可用命令
* 看见典型输出长什么样
* 知道下一步常接什么命令

如果你已经知道自己要操作的是应用、仪表盘、数据集、数据集成或权限，这组 reference 会比从工作流页里反复跳转更直接。

## 如何使用这组 reference

推荐顺序：

1. 先在本页找到对应命令域
2. 再进入子页面照着**最小可用示例**跑第一条命令
3. 看**典型输出**判断结果是否正常
4. 参考**下一步常见动作**了解后续命令
5. 需要精确参数时，用 CLI 的 `--help` 查看完整选项

## 全局参数

下面这些参数会在大多数命令里重复出现：

| 参数 | 作用 | 常见场景 |
| --- | --- | --- |
| `-o, --output` | 指定输出格式 | 人工查看用 `table`；脚本、Agent、CI 更常用 `json` / `yaml` |
| `-c, --config` | 指定配置文件路径 | 在多套配置间切换，或显式使用某个本地配置文件 |
| `--api-url` | 指定目标实例 API 地址 | 临时覆盖 `HBI_HOST` / 本机默认 host；可直接写裸 host 或带子路径的 host，省略 scheme 时会先探测 `https://` 再试 `http://`；`HBI_API_URL` 仅兼容 |
| `--token` | 指定访问令牌 | 临时覆盖当前缓存凭据；不承诺 durable / refresh |
| `--dry-run` | 只预演，不真正执行写动作 | 授权、配置更新、删除前先确认 |
| `--yes` | 自动确认副作用操作 | 非交互式运行或批处理 |
| `--lang` | 指定 CLI 语言 | 当前支持 `zh-CN`、`en-US` |

> \[!TIP] HQL 表达式
> `data-model`、`metric`、`measure`、`element chart` 等命令的参数广泛支持 [HQL (Hengshi Query Language)](https://api.hengshi.com/function_reference.html) 表达式，包括聚合函数（SUM、AVG、COUNT 等）、时间函数（YEAR、MONTH、MOY、DOM 等）和条件逻辑（IF、CASE WHEN）。完整函数列表请参考 [HQL 函数参考](https://api.hengshi.com/function_reference.html)。

## 命令域总览

| 命令域 | 主要覆盖范围 | 继续阅读 |
| --- | --- | --- |
| `auth` `search` `config` `preferences` `scheduler` `logs` | 认证、搜索、CLI 本地配置、系统设置、调度与日志 | [核心与运行时命令](cli-reference-core.md) |
| `app` `folder` `dashboard` `element` | 应用、文件夹、仪表盘和页面控件 | [应用与仪表盘命令](cli-reference-app.md) |
| `connection` `dataset` `data-model` `metric` `measure` `pipeline` `notebook` `data-alert` `data-agent` | 数据接入、建模、指标、执行和智能能力 | [数据与执行命令](cli-reference-data.md) |
| `user` `user-group` `org` `user-attr` `tenant` `subject` `kanban` `permission` `authorize` | 用户、组织、租户、权限、主题域与分析看板 | [用户、租户与权限命令](cli-reference-governance.md) |

## 多层命令怎么继续往下看

这组 reference 主要帮你定位“先进入哪条命令树”，不逐条展开每一级 `--help`。继续下钻时，按下面的路径理解就够了：

| 你要做什么 | 先进入哪层命令树 |
| --- | --- |
| 应用参数、公共维度、规则、订阅、门户 | `app` -> `app param` / `app dimension` / `app rule` / `app subscribe` / `app portal` |
| 仪表盘 plan 与主题 | `dashboard` -> `dashboard plan` / `dashboard theme` |
| 图表与页面控件 | `element` -> `element chart` / `element filter` / `element container` / `element text` |
| 数据集成节点编辑 | `pipeline` -> `pipeline edit` |

当你已经定位到具体命令树，再在终端查看对应层级的 `--help`，获取精确参数和示例。

## 中文命令别名

CLI 仍支持一级命令的中文输入别名，例如：

```bash
hbi 应用 list
hbi 数据集 preview
hbi 仪表盘 show
```

如果你的团队里既有人类用户也有 Agent，仍然建议以英文命令树作为主写法，这样更利于脚本、skills 和帮助信息保持一致。