CLI reference

soundor driver runs Soundor Driver from the CLI: each command connects to the session, does one thing, prints its result and disconnects, releasing anything it held. There is no background process.

soundor driver targets
soundor driver tree --json
soundor driver inspect reset

soundor driver <command> --help describes a command and its options.

CommandsCopy Anchor Link

Commands that act on a node find it by a debugId, or instead by --role <role> (with --name <name>) or --text <text>, as the locators do, and wait until it is actionable for up to --timeout. key and type take --debug-id <id> to focus a node first.

Input commands work beside DevTools tabs and other clients, with a pointer and keys of their own, and release what they held before they exit, as the Driver does.

OptionsCopy Anchor Link

Every command takes these:

The browser key is never an argument (arguments show in process lists and shell history): it comes from the descriptor, or from the environment.

OutputCopy Anchor Link

Results go to stdout, and nothing else does: no banners, no colors. With --json, stdout is exactly one JSON document:

• targets: an array of targets (id, name, runtime, generation, capabilities);
• tree: the tree snapshot (generation, revision, roots, nodes, truncated);
• inspect: the node with its details;
• click, hover, drag, scroll, move, key: what the input reached, { "handled": true, "node": { "generation": 1, "id": "12" } }; focus: { "focused": true }; type: { "typed": <characters> };
• screenshot: where it saved the PNG, and its width, height, scale, format and bytes. The image itself goes only to the file, never to stdout.

Their shapes are those of inspection.

Errors go to stderr: soundor driver: <message> (<CODE>), or with --json

{
  "error": {
    "code": "ELEMENT_NOT_FOUND",
    "message": "getByDebugId(\"reset\") matches no node"
  }
}

with a Driver error code.

Exit codesCopy Anchor Link