Skip to main content
Version: Next

lhc dashboards

Manage Lakehousecat analytics dashboards. Dashboards collect charts into curated views and support approval workflows and fine-grained sharing.

Commands​

dashboards list​

lhc dashboards list [--model <model-id>]
FlagDescription
--modelFilter dashboards by custom model ID

dashboards get <id>​

lhc dashboards get <dashboard-id>

dashboards metadata <id>​

lhc dashboards metadata <dashboard-id>

dashboards create​

lhc dashboards create --name <name> --model <custom-model-id>
FlagRequiredDescription
--nameyesDashboard name
--modelyesCustom model ID this dashboard belongs to

dashboards update <id>​

lhc dashboards update <dashboard-id> --name <new-name>

dashboards delete <id>​

lhc dashboards delete <dashboard-id>

dashboards clone <id>​

lhc dashboards clone <dashboard-id>

dashboards search [query]​

Search matches a substring of the dashboard title or its model ID — not the dashboard's content, which is encrypted at rest.

lhc dashboards search "sales"
lhc dashboards search --tag RED # every red dashboard, across all pages

--tag restricts results to dashboards tagged with that color (repeatable, OR-combined; valid colors: RED, YELLOW, GREEN, BLUE, PURPLE). Tags are per user and assigned in the UI — the CLI only filters by them. The query is optional when --tag is given, but at least one of the two is required.


dashboards statistics​

lhc dashboards statistics

dashboards count​

lhc dashboards count

Export / Import​

Export a dashboard — including its charts, datasets, and database reference — as a portable .lhc.json package, and import it into another custom model or environment. Requires admin access, since the underlying export contains database connection metadata (the connection password itself is masked).

dashboards export <id>​

lhc dashboards export <dashboard-id>
lhc dashboards export <dashboard-id> -f dashboard.lhc.json
FlagDescription
-f, --output-fileWrite the export to this file instead of stdout

Use lhc dashboards list (optionally with --model <custom-model-id>) to look up the numeric dashboard ID — it is not shown in the UI, but is always present in the API/CLI response.

dashboards import <file>​

lhc dashboards import dashboard.lhc.json --model <custom-model-id>
FlagRequiredDescription
--modelyesTarget custom model ID the dashboard is imported into

On import, the package's database reference is repointed to the destination environment's own ClickHouse connection — the exporting environment's connection string is never reused.

dashboards export-model-map <superset-dashboard-id>​

Export a Custom Model's Model Map dashboard by its raw Superset dashboard ID (custom_model_map_dashboard_id):

lhc dashboards export-model-map 42
lhc dashboards export-model-map 42 -f model_map.lhc.json
FlagDescription
-f, --output-fileWrite the export to this file instead of stdout

dashboards import-model-map <file>​

Import a Model Map dashboard package:

lhc dashboards import-model-map model_map.lhc.json

Prints the new chart_id/dashboard_id/embedding_uuid on success — these are not patched onto the target model automatically. Update the model's custom_model_map_* meta fields yourself with the printed values (e.g. via lhc models update).


Approval Workflow​

dashboards lock <id>​

Lock a dashboard to prevent further edits:

lhc dashboards lock <dashboard-id>

dashboards unlock <id>​

lhc dashboards unlock <dashboard-id>

dashboards approve <id>​

Mark a dashboard as officially approved:

lhc dashboards approve <dashboard-id>

dashboards revoke-approval <id>​

Remove the approval from a dashboard:

lhc dashboards revoke-approval <dashboard-id>

Sharing​

dashboards share <id>​

Share with a user or group:

lhc dashboards share <dashboard-id> --user <user-id>
lhc dashboards share <dashboard-id> --group <group-id>

dashboards unshare <id>​

Remove a specific share:

lhc dashboards unshare <dashboard-id> --user <user-id>
lhc dashboards unshare <dashboard-id> --group <group-id>

dashboards sharing <id>​

View the sharing summary for a dashboard:

lhc dashboards sharing <dashboard-id>

dashboards shared-by-me​

lhc dashboards shared-by-me

dashboards shared-with-me​

lhc dashboards shared-with-me