Quick Start

Run with Cli and docker locally and offline

Quick Start Model Library Trigger Library Connector Library Changelog

Workspace Flow

Start with onboarding, not ad hoc setup.

The onboarding path prepares the local workspace, copies the example runtime config, installs requirements, and writes notification defaults when those values are present.

pip install hearthlight
hearthlight onboard

Step 1

Run onboarding

Use `hearthlight onboard` for a clean local setup. The runtime docs also provide a shell wrapper at `bash scripts/onboard.sh` if you want a repo-local path.

Step 2

Inspect the inventory

Before launch, check which templates and model registrations are available in the current workspace.

hearthlight list-models

Step 3

Launch the stack

The recommended first launch is the interactive path, which lets the CLI choose the runtime template, source preset, and execution profile explicitly.

hearthlight start --interactive

Step 4

Check service state

Use the CLI to confirm whether the compose services are up before you hand control to the dashboard.

hearthlight status

Step 5

Open the dashboard

Once the UI is available, open it with the dedicated CLI command and finish source, binding, prompt, and alert-rule setup there.

hearthlight dashboard

Important

Use the real CLI surface.

This launch site intentionally avoids made-up marketing commands. The current CLI exposes `start`, `stop`, `reset-db`, `status`, `onboard`, `list-models`, `dashboard`, and `gui`.

Docs

Go deeper when you need operational detail.

The runtime repo remains the source of truth for installation, architecture, container startup, and security notes.

Initialization Guide

Step-by-step onboarding, startup flow, dashboard setup, and common failure modes.

Read the guide

Containers Guide

Container preflight, compose expectations, ports, and troubleshooting details.

Read the guide