> ## Documentation Index
> Fetch the complete documentation index at: https://ahvn.top/llms.txt
> Use this file to discover all available pages before exploring further.

# 仪表板 (Dashboard)

> 运行本地 HeavenBase 配置与工作区操作台。

<Note>
  Dashboard 给现有状态开一扇窗；它不会在幕布后面另盖一栋房子。
</Note>

<br />

## 1. 动机

若没有可视化操作台，配置与工作区检查只能在 CLI 调用和短 Python 脚本之间来回跳转。
Dashboard 在一个本地操作台中公开相同的公共表面：

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
hb dashboard
```

它不会添加 planner、配置存储、Registry 或行持久化路径。

<br />

## 2. 启动操作台

服务器默认绑定 `127.0.0.1:42777` 并打开浏览器。
首次运行时，HeavenBase 会确保默认工作区存在。

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
hb dashboard --no-open
hb dashboard --app
hb dashboard --host 127.0.0.1 --port 42777
```

`--app` 会在可用时打开无浏览器边框的 Chromium 系窗口，否则回退到普通浏览器标签页。

<Warning>
  非 loopback 绑定需要 `--allow-network`。这会向所选网络暴露未经认证的配置 API，因此请先评估风险。
</Warning>

<br />

## 3. 检查配置

配置操作台通过 `CM_HVNB` 读取和写入。
它会显示每个键来自内置值、覆盖值还是自定义值，并支持 scope 选择、历史记录、版本比较、重置与搜索。

内置键保持锁定。
环境变量插值按原样显示，类似密钥的值会被遮罩。

<br />

## 4. 浏览工作区状态

数据浏览器会列出已注册的 `WorkspaceSpec` 值，并一次打开一个工作区。
对于每个 Entity，它提供可排序、可过滤、分页表格、行检查、Data 与 Schema 视图、放置元数据、查询能力以及工作区健康信息。

命令面板会通过 `ws.search(...)` 搜索 Catalog 与 MetaSchema 卡片。

<Info>
  `0.1.2.1` Dashboard 中的工作区行是只读的。它不会注册 Entity、修改 schema、upsert 行或删除行。
</Info>

<br />

## 5. 使用可选助手

助手使用 `heavenbase.dashboard.assistant` 下配置的模型。
它的工具可以列出 Entity、检查 schema、抽样行、计算列统计、搜索工作区并读取经过遮罩的配置。

默认情况下凭据始终被遮罩。
启用 `heavenbase.dashboard.assistant.share_credentials` 可能把原始值发送给已配置的外部模型 Provider，并要求显式确认披露。

<br />

## 6. 嵌入适配器

当另一个本地主机拥有进程生命周期时，请使用公共适配器：

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
from heavenbase.dashboard import DashboardAPI, build_app, resolve_bind, serve

api = DashboardAPI()
app = build_app(api)
host, port = resolve_bind()
serve(host=host, port=port, api=api)
```

Dashboard 是公共配置、Registry、工作区、Catalog 与 MetaSchema 表面之上的适配器。
核心领域不会导入它。

<br />

## 总结

* Dashboard 可视化现有 HeavenBase 权威。
* Loopback 是安全默认值；网络暴露必须显式开启。
* 工作区浏览保持只读。
* 助手只会在显式选择后共享凭据。

<br />

## 进一步探索

<Tip>
  **相关资源：**

  * [配置 (Configuration)](/zh/features/configuration) — Scope 值与保留历史
  * [工作区 (Workspace)](/zh/features/workspace) — Dashboard 展示的应用边界
  * [目录 (Catalog)](/zh/features/catalog) — 对象与结构发现
  * [CLI 参考](/zh/reference/cli/overview) — Dashboard 标志与其他 `hb` 命令
</Tip>

<br />