CLI & AI toolsCommand reference
helix screenshot
Capture headless screenshots of a built world via its in-page screenshot helper (Playwright)
CLI version 0.1.27-helix3.551. Run
helix screenshot --help for the text your installed build prints.helix screenshot
Capture headless screenshots of a built world via its in-page screenshot helper (Playwright)
helix screenshot [options] [directory]| Argument | Required | Description |
|---|---|---|
directory | no | the world's built bundle directory (same dir helix publish takes) |
| Option | Description |
|---|---|
--shot <names...> | capture only these declared shots (default: every declared shot) |
--camera <x,y,z> | override pose: camera position — bypasses declared shots, writes custom.png |
--look-at <x,y,z> | override pose: look-at point (only with --camera) |
--fov <n> | override pose: field of view in degrees (only with --camera) |
--out <dir> | output directory (default "./screenshots") |
--size <WxH> | capture size (default "1280x720") |
--preview | also capture each shot at 2560x1440 to <shot>.preview.png |
--timeout <ms> | readiness timeout in ms (default "60000") |
--blind <ms> | worlds WITHOUT the helper: skip the readiness wait, delay <ms>, then screenshot the canvas element (non-deterministic) |
--install | download the pinned headless Chromium build, then exit (no capture) — only needed when no system Chrome/Edge is available |
--browser <name> | diagnostic override: force one launch candidate (bundled|chrome|msedge), no fallback |