Vm

wscript API object

A VM handle obtained from lab.vm(name): the entry point to lifecycle, snapshots, input, screen matching and the guest agent.

A Vm handle is returned by lab.vm(name) (or lab.vms()). Its methods fall into five groups, each documented as its own reference:

• Lifecycle & state — start/stop/restart, state, readiness, IPs.
• Snapshots — take, restore, list and delete snapshots.
• Keyboard & mouse — send keys, type text, move/click/drag the mouse.
• Screen, image matching & OCR — screenshot, wait-for-image, OCR and text matching.
• Guest agent — exec commands and copy files in and out.

Fallible calls return Result[..., string]; the matched screen hits return a Match and exec returns an ExecResult.