Skip to content

DotCraft Dashboard Guide

Dashboard is DotCraft's Web debugging and visual configuration interface. Use it to inspect sessions, traces, tool calls, automation state, and merged configuration. It is the fastest way to answer "what did the Agent do?" and "why did this config apply?"

Quick Start

1. Enable Dashboard

Add this to .craft/config.json:

json
{
  "DashBoard": {
    "Enabled": true,
    "Host": "127.0.0.1",
    "Port": 8080
  }
}

2. Start DotCraft

bash
dotcraft gateway

3. Open Dashboard

Default URL:

text
http://127.0.0.1:8080/dashboard

4. Trigger an Agent Run

Start a conversation from CLI, Desktop, TUI, or another entry point. Dashboard will show sessions, tool calls, errors, and configuration state.

Configuration

FieldDescriptionDefault
DashBoard.EnabledEnables Dashboardfalse
DashBoard.HostListen address127.0.0.1
DashBoard.PortListen port8080

Setting Host to 0.0.0.0 allows external network access. Dashboard can expose prompts, tool arguments, and tool results, so verify the network boundary first.

Usage Examples

ScenarioUse
Confirm the model can be calledTrigger one session and inspect Trace Timeline
Debug a failed tool callOpen session details and filter Tools / Errors
Inspect merged configurationOpen Settings and compare global, workspace, and merged config
Review automation stateUse the Automations panel with Gateway + Automations

Advanced Topics

Runtime Modes

ModeDescription
CLI standalone DashboardDebugs the current local entry point
Gateway DashboardShares a backend with API, AG-UI, Automations, and external channels
Shared portAPI, AG-UI, and Dashboard can be merged into one HTTP service by Gateway

Frontend Pages

PagePurpose
DashboardRuntime summary and entry-point state
SessionsSession list and details
Trace TimelineTimeline view of Agent, tool, and error events
SettingsConfig schema, global config, workspace config, and merged config
AutomationsLocal tasks, Cron, and activity state

API Reference

For Dashboard trace event types and HTTP endpoints, see Dashboard API.

Troubleshooting

Browser cannot open Dashboard

Confirm DashBoard.Enabled = true and use the address printed by the console. The default path is http://127.0.0.1:8080/dashboard.

Automations panel is missing

The Automations panel requires Gateway to load the Automations module. CLI standalone Dashboard is best for the current session and does not display the full automation orchestration state.

Changes in Settings do not appear

Model fields usually affect new sessions. AppServer, port, Gateway, and external channel settings are startup fields and require restarting DotCraft.

Apache License 2.0