Live: arm socket
live_arm_socketEnable a programmatic Inkscape launch to access the full live command set by automatically installing and invoking the socket helper, preparing for a socket bridge connection.
Instructions
Auto-arm the extension-socket helper so a programmatic launch gets the FULL live surface.
When to use: bringing up the FULL perceive/compose live command set without a human
Extensions-menu click — a programmatic launch otherwise yields only DBus's reduced
action set. After this returns armed, call live_connect (the socket bridge is then the best
transport). To install the helper files first use live_install_helper; to probe readiness use
check_live_support.
Key params: none. Installs the helper if absent, then LAUNCHES a headful Inkscape with the
helper effect auto-invoked so it binds its loopback socket and advertises a rendezvous — no menu
click. The socket bridge is the cross-platform primary (NOT bound to one OS). Requires the
master live gate. GUI-ONLY: the headful launch needs a display; on a HEADLESS host (CI / box,
no DISPLAY/WAYLAND_DISPLAY) it fails with a clear, stable message (this leg is documented as
deferred there) rather than spawning a doomed process. An already-armed session is reused.
Return shape: SocketArmResult — armed, launched (whether THIS call started Inkscape),
helper_installed, transport, and notes. No host path is carried (sec.12).
Example: live_arm_socket() then live_connect()
Risk class: restricted (launches a headful Inkscape process and writes a server-bundled helper).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| armed | Yes | ||
| notes | No | ||
| launched | Yes | ||
| transport | No | extension-socket | |
| helper_installed | Yes |