Skip to content

Commands reference

The protocol has 42 commands organised into eleven groups.

Protocol (4)

CommandPurpose
handshakeNegotiate protocol version + auth - mandatory first message
pingHealth check, returns {"pong": true}
versionServer version, protocol version, Qt version
echoReturns {"text": <input>} - diagnostic only

Object discovery (6)

CommandPurpose
list_objectsFind objects by class_name / object_name
find_objectResolve a single object by path
get_propertiesRead N properties of an object
get_childrenDirect children of an object
get_parentThe parent of an object
get_object_treeRecursive subtree from a root

Interaction (7)

CommandPurpose
mouse_clickClick at object centre (button, count configurable)
type_textType into a focusable widget
key_pressPress a single key (or chord like Ctrl+C)
dragDrag source → target
scrollWheel scroll on a widget
screenshotPNG of a widget or whole window
highlight_objectOverlay a coloured frame for debugging

Touch & gestures (5)

CommandPurpose
touch_tapSingle-finger tap
touch_long_pressLong press with configurable duration
swipeDirectional swipe
pinchTwo-finger pinch with scale + optional rotation
multi_touchArbitrary multi-finger sequence

Model / view data (2)

CommandPurpose
get_model_infoRow/column count + role names of a model
get_model_dataCell values by index + role

Visual verification (1)

CommandPurpose
screenshot_compareDiff a widget against a baseline PNG

Extended automation (4)

CommandPurpose
set_propertyWrite a property (triggers NOTIFY)
invoke_methodCall a Q_INVOKABLE method or slot
wait_for_propertyBlock until a property reaches a value
wait_for_signalBlock until a signal fires once

Push subscriptions (5)

CommandPurpose
subscribe_signalPush signal_emitted events for a signal
subscribe_propertyPush property_changed events for a property
subscribe_destroyedPush one object_destroyed when the QObject is destroyed
unsubscribeCancel a subscription
list_subscriptionsList active subscriptions on this connection

See Push events for full payload details.

Performance (3)

CommandPurpose
frame_timeFPS + min/avg/max frame duration over a window
paint_countCount paint events on a widget over a window
memory_snapshotProcess RSS / VSize / threads / heap

Mocking + multi-window (3)

CommandPurpose
emit_signalProgrammatically emit a signal (test stub)
clipboardRead or write the system clipboard
list_windowsEnumerate all top-level windows

Recording (2)

CommandPurpose
start_recordingBegin recording user interactions
stop_recordingEnd recording, return the script

Released under a commercial licence. Privacy · Terms