Skip to content

UI Tour

This tutorial serves the Streamlit application over the demo workspace and walks through every page. Complete Getting started first so examples/demo validates and has ingested aggregates.

For task-oriented instructions, see Running reports.

Start From the Demo Workspace

Validate the demo workspace:

uv run valuestream validate examples/demo

Run ingestion:

uv run valuestream run examples/demo

Serve the UI:

uv run valuestream serve examples/demo --port 8501 --headless

Open the Streamlit URL printed by the command.

UI Pages

Page Purpose
Home Workspace summary, validation state, and quick navigation
Build Choose a sample-first Studio path or catalog-first Builder path
Data Load Source discovery, file upload, source runs, and workspace runs
Reports Dashboard pages, report filters, freshness, charts, and inspect mode
Catalog Sources, processors, metrics, dashboards, and validation status
Configuration Builder Catalog-first object drafts, transactional apply, outcome handoff, and workspace export
AI Configuration Studio Preview-sample drafting with deterministic or model-assisted generation and dependency-closed review
Chat With Data Aggregate-aware questions over selected metrics
Pipelines / Ops Runs, chunks, source health, and operational controls

Verification

After the UI starts:

  1. Confirm the sidebar shows the expected workspace; open Workspace details to check the path and catalog revision.
  2. Open Build. Confirm the two choices explain that apply never runs data.
  3. Choose Start from sample, select the deterministic demo, and confirm a valid draft can be reached without model credentials. Return to Build.
  4. Choose Configure manually. Confirm Back/Continue and the jump outline keep one current task, then open Export current workspace and confirm downloads appear before collapsed YAML previews.
  5. Open Data Load and confirm source chunks are discovered.
  6. Open Reports and select a dashboard page from the selector row; confirm the view, advanced, and filter actions appear on the second toolbar row.
  7. Switch to Inspect mode for one tile and confirm data is returned.
  8. Open Pipelines / Ops and confirm the latest run appears.