@workflow/web

@workflow/web

A Next.js-based web interface for inspecting workflow runs, steps, streams, and events. This package is designed to be launched from the @workflow/cli package with the --web flag, e.g. workflow inspect runs --web. It can also be self-hosted to provide a standalone observability UI.

Installation

For End Users

When published to npm, install globally:

npm install -g @workflow/cli
# or
pnpm install -g @workflow/cli

Usage

Via CLI

The primary way to start using the web UI is through the CLI:

# Basic usage - view local runs in web UI
wf inspect runs --web

# Viewing remote production data
wf inspect events --web \
  --backend=vercel \
  --env=production \
  --project=my-project \
  --team=my-team

Once the web UI is started, you can use it to navigate and inspect all available workflow-related data.

Contributing

Development Workflow

In the packages/web directory, run the server live:

pnpm dev

Then use the web config to point to your local or remote workflow data.