ktm dashboards add-widget

Add a widget to a dashboard from a JSON file or stdin

Usage

ktm dashboards add-widget <uid> [flags]

Examples

# Add widget from a file (auto-positioned)
ktm dashboards add-widget abc123 --json widget.json

# Pipe from template
ktm dashboards widget-template title | ktm dashboards add-widget abc123 --json -

# With explicit position and size
ktm dashboards add-widget abc123 --json widget.json --x 0 --y 0 --w 24 --h 1

# Full-width chart
ktm dashboards add-widget abc123 --json chart.json --w 24 --h 8

Arguments

Flags

Details

Validate a widget definition and append it to the dashboard layout.

The widget JSON is the data section (same format as widget-template output, without _metadata). Use --json to specify a file or "-" to read from stdin.

GRID LAYOUT: 24 columns, 30px row height, vertical compaction.

• Full width: --w 24. Half: --w 12. Quarter: --w 6.
• x + w must be <= 24. Widgets cannot overlap.
• Omit --x and --y for auto-positioning (fills gaps left-to-right, top-to-bottom).
• Default sizes per type: charts/tables/custom 6x8, counter 6x3, title 6x2.

LAYOUT PATTERNS:

• KPI row: 2-4 counters. --w 12 for 2, --w 8 for 3, --w 6 for 4.
• Chart pair: 2 charts side by side, --w 12 each.
• Section divider: title --w 24 --h 2, then content below.

customDisplay: requires IIFE script, uses queries[] not series[], max 20KB script. Scripts can compute (ratios, stats, correlation) but lack the platform's statistical engine (EWMA, anomaly detection, SLO) — use InfluxQL or MCP/CLI tools for those. Do not hardcode pre-computed values — widgets are live and re-query on time range changes. Run validate-widget or check widget-template _metadata.notes for script API docs.

Related

• ktm dashboards

What's next?