Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.signalrooms.xyz/llms.txt

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

Control-plane reference

Status: Current reference from source inspection. Warmr exposes a JSON-RPC 2.0 control plane over a Unix Domain Socket. The wire format is line-delimited JSON, one JSON object per newline. Successful responses include schema 1.0.

Current read methods

Current:
MethodPurpose
statusApp info, devices, active threads.
devices.listKnown and connected devices.
templates.listWarmup template summaries.
thread.listThread job summaries.
logs.subscribeSubscribe to log notifications.
logs.unsubscribeEnd a log subscription.

Current action methods

Current:
MethodPurpose
thread.startStart a thread configuration.
thread.stopStop a thread configuration.
evidence.exportExport a minimal evidence bundle.
app.startEnsure Warmr.app is running.
app.stopTerminate Warmr.app if running.
app.restartTerminate and relaunch Warmr.app.
Some action methods require automation to be explicitly enabled. If automation is disabled, the server returns a domain error instead of performing the action.

Error codes

Current: The control plane uses JSON-RPC standard errors plus Warmr-specific server errors in the reserved server range. Current domain errors include template not found, device not found, thread not found, configuration not found, orchestrator unavailable, upload folder unavailable, duplicate run rejected, port allocation exhausted, evidence export failed, lifecycle not supported, and automation disabled.

Agent contract

Current:
  • Parse schema 1.0 responses.
  • Treat new optional fields as compatible within v1.x.
  • Do not depend on human table output when JSON is available.
  • Keep one request per JSON line.