Skip to main content
The dashboard gives existing state a window; it does not build a second house behind the curtains.

1. Motivation

Configuration and workspace inspection otherwise bounce between CLI calls and short Python scripts. The dashboard exposes the same public surfaces in one local workbench:
It adds no planner, configuration store, Registry, or row persistence path.

2. Start the Workbench

The server binds to 127.0.0.1:42777 by default and opens a browser. On first run, HeavenBase ensures a default workspace exists.
--app opens a chromeless Chromium-family window when available and otherwise falls back to a normal browser tab.
Non-loopback binds require --allow-network. That exposes an unauthenticated configuration API to the selected network, so review the risk first.

3. Inspect Configuration

The configuration workbench reads and writes through CM_HVNB. It shows whether each key is built-in, overridden, or custom and supports scope selection, history, version comparison, reset, and search. Built-in keys stay locked. Environment interpolation is shown as written, and secret-like values are masked.

4. Browse Workspace State

The data browser lists registered WorkspaceSpec values and opens one workspace at a time. For each Entity, it offers sortable, filterable, paged tables, row inspection, Data and Schema views, placement metadata, query capabilities, and workspace health. The command palette searches Catalog and MetaSchema cards through ws.search(...).
Workspace rows are read-only in the 0.1.2.1 dashboard. It does not register Entities, alter schemas, upsert rows, or delete rows.

5. Use the Optional Assistant

The assistant uses the model configured under heavenbase.dashboard.assistant. Its tools can list Entities, inspect schemas, sample rows, calculate column statistics, search the workspace, and read masked configuration. Credentials remain masked by default. Enabling heavenbase.dashboard.assistant.share_credentials may send raw values to the configured external model provider and requires explicit disclosure acknowledgement.

6. Embed the Adapter

Use the public adapter when another local host owns process lifecycle:
The dashboard is an adapter over public configuration, Registry, workspace, Catalog, and MetaSchema surfaces. Core domains do not import it.

Summary

  • The dashboard visualizes existing HeavenBase authorities.
  • Loopback is the safe default; network exposure is explicit.
  • Workspace browsing is read-only.
  • The assistant shares credentials only after explicit opt-in.

Further Exploration

Related resources:
  • Configuration — Scoped values and retained history
  • Workspace — The application boundary shown by the dashboard
  • Catalog — Object and structure discovery
  • CLI Reference — Dashboard flags and other hb commands