FIELD MANUALSECTION 03 / CONTROLS

SECTION 03 / CONTROLS

CLI & configuration

A small command surface for serving, registering, inspecting, and scripting the switchboard.

Commands

CommandEffectStatus
serveRun the agent listener in the foreground. Current source requires --upstream PATH.Available
register PATHAdd or refresh an upstream agent socket.Available
unregister PATHRemove an explicit registration.Available
status [--json]Report candidates, reachability, source, and routing priority.Available
socket [--control]Print the stable agent or control socket path for shell scripts.Available

Configuration

Start the daemon with a durable local fallback using serve --upstream PATH. Runtime registrations are intentionally ephemeral and can be managed through the control commands above. The agent and control sockets live in the private Lanyard directory beneath $XDG_RUNTIME_DIR.

SCRIPTING CONTRACTUse status --json for automation. Human output may gain explanatory fields; JSON field meanings remain versioned.