Skip to main content

Documentation Index

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

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

Dashboards provide customizable views for monitoring evaluation results. Each dashboard contains widgets that display charts, tables, or text.

List Dashboards

coval dashboards list [OPTIONS]
OptionTypeDefaultDescription
--filterstringFilter expression
--page-sizenumber50Results per page
--order-bystringSort order
Output columns: ID, NAME, CREATED, UPDATED
coval dashboards list

Get Dashboard

coval dashboards get <dashboard_id>
ArgumentTypeRequiredDescription
dashboard_idstringYesThe dashboard ID
coval dashboards get db_abc123

Create Dashboard

coval dashboards create [OPTIONS]
OptionTypeRequiredDescription
--namestringYesDisplay name
coval dashboards create --name "Production Metrics"

Update Dashboard

coval dashboards update <dashboard_id> [OPTIONS]
ArgumentTypeRequiredDescription
dashboard_idstringYesThe dashboard ID to update
OptionTypeDescription
--namestringNew display name
coval dashboards update db_abc123 --name "Staging Metrics"

Delete Dashboard

coval dashboards delete <dashboard_id>
ArgumentTypeRequiredDescription
dashboard_idstringYesThe dashboard ID to delete
coval dashboards delete db_abc123

Widgets

Widgets are visual components that live inside a dashboard. All widget commands are nested under coval dashboards widgets.

List Widgets

coval dashboards widgets list <dashboard_id> [OPTIONS]
ArgumentTypeRequiredDescription
dashboard_idstringYesThe parent dashboard ID
OptionTypeDefaultDescription
--page-sizenumber50Results per page
Output columns: ID, NAME, TYPE, GRID, CREATED
coval dashboards widgets list db_abc123

Get Widget

coval dashboards widgets get <dashboard_id> <widget_id>
ArgumentTypeRequiredDescription
dashboard_idstringYesThe parent dashboard ID
widget_idstringYesThe widget ID
coval dashboards widgets get db_abc123 wgt_xyz789

Create Widget

coval dashboards widgets create <dashboard_id> [OPTIONS]
ArgumentTypeRequiredDescription
dashboard_idstringYesThe parent dashboard ID
OptionTypeRequiredDescription
--namestringYesWidget display name
--typestringYesWidget type (see below)
--configstringNoJSON config string or @filepath to read from file
--grid-wnumberNoGrid width
--grid-hnumberNoGrid height
--grid-xnumberNoGrid X position
--grid-ynumberNoGrid Y position

Widget Types

TypeDescription
chartLine, bar, or area chart visualization
tableTabular data display
textStatic text or markdown content
# Create a chart widget
coval dashboards widgets create db_abc123 \
  --name "Score Trends" \
  --type chart \
  --config '{"metric_id": "met_001"}' \
  --grid-w 6 \
  --grid-h 4

# Create a widget with config from a file
coval dashboards widgets create db_abc123 \
  --name "Detailed Report" \
  --type table \
  --config @widget-config.json

Update Widget

coval dashboards widgets update <dashboard_id> <widget_id> [OPTIONS]
ArgumentTypeRequiredDescription
dashboard_idstringYesThe parent dashboard ID
widget_idstringYesThe widget ID to update
OptionTypeDescription
--namestringNew display name
--typestringNew widget type
--configstringNew JSON config or @filepath
--grid-wnumberNew grid width
--grid-hnumberNew grid height
--grid-xnumberNew grid X position
--grid-ynumberNew grid Y position
coval dashboards widgets update db_abc123 wgt_xyz789 \
  --grid-w 12 --grid-h 6

Delete Widget

coval dashboards widgets delete <dashboard_id> <widget_id>
ArgumentTypeRequiredDescription
dashboard_idstringYesThe parent dashboard ID
widget_idstringYesThe widget ID to delete
coval dashboards widgets delete db_abc123 wgt_xyz789