Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openworkflow.dev/llms.txt

Use this file to discover all available pages before exploring further.

OpenWorkflow includes a built-in web dashboard for monitoring and debugging your workflows. It lets you browse workflow runs, see which steps completed or failed, inspect errors, and track the state of long-running workflows.

​
Starting the Dashboard

npx @openworkflow/cli dashboard
The dashboard starts on http://localhost:3000 by default. To use a custom port: 
npx @openworkflow/cli dashboard --port 4000

​
Requirements

The dashboard requires:
  1. A valid openworkflow.config.ts in your project
  2. A running backend (PostgreSQL or SQLite)
The dashboard connects to the same backend as your workers. It shows data for the namespace configured in your config file.

​
Prometheus Metrics

The dashboard serves a Prometheus endpoint at GET /metrics. See the Prometheus guide for setup and alert examples.
The dashboard does not include built-in authentication. For production use, deploy it behind a VPN, private network, or reverse proxy with Basic Auth.