Connectivity verbs

Liveness, status, multi-AD targeting.

Part of the Adom Desktop verb reference. Invoke as adom-desktop <verb> '<json>'.

health

Check if the relay server HTTP API is reachable

Returns: Relay server health status

kick_all

Force-disconnect all WebSocket clients (they auto-reconnect in ~5s)

Note: Use when connections are stale or duplicated

ping

Round-trip connectivity test (5s timeout)

Args:

  • message — optional string, echoed back

Returns: echo, roundTripMs, status

Note: Always run this first to verify desktop connection

status

Query connected clients, capabilities, and app installation status

Returns: clients count, appName, hostname, capabilities[], desktop app status (kicad/fusion/browser installed/running)

targets

v1.8.133+: list the Adom Desktops connected to this relay so you can address one by name. Each AD has a name (its --client-name / Settings value, defaulting to the OS hostname). Use this to discover names, then run any verb with the global --target selector, or --target all to fan out to every AD.

Returns: {count, targets:[{name, hostname, version, os, connectedAt}], _hint}

Note: See _targeting_note at the top of this map for how --target works.