CLI reference
Every command and flag: xray, the capture pipeline, the Playwright engine and the factory.
xray
The one-command entry point. Runs capture, refine and wire in order.
xray <url> --site <slug> [options]| Flag | Effect |
|---|---|
--site <slug> | Names the clone. Becomes the tenant key and the deploy name. |
--out <dir> | Output root. Defaults to a durable directory under your home, not a temp folder. |
--max-pages <n> | Cap on routes crawled. |
--recapture | Ignore an existing capture and fetch again. Without it, re-runs reuse what is on disk. |
--shared | Register as a tenant on the shared database rather than creating a new project. |
--ref <ref> | Target an existing database by reference. |
--create | Create a dedicated database for this clone. |
--domain <fqdn> | Custom domain for the deploy. |
--modules a,b | Turn specific modules on. --no-<id> turns one off. |
--no-interactions | Skip interaction recording. |
--reseed | Re-seed content slots. Overwrites values edited in the admin. |
--skip-deploy | Stop after wiring. |
Capture pipeline
The capture stage on its own, with per-step opt-outs.
xray capture <url> [out-dir] [--max-pages n] [--engine static|playwright|auto]Steps run in order and each can be skipped with --no-<step>: clone, interactions, pwa, optimize, dedupe, minify, validate, score.
Browser engine
Flags that only apply when the browser engine is running.
| Flag | Effect |
|---|---|
--all | Follow the sitemap and crawl deeply, rather than just linked pages. |
--login <email:pass> | Sign in before capturing. |
--save-auth | Persist the session so later runs reuse it. |
--bake-session | Clear a bot challenge once and reuse the cookies. |
--passcode /route:CODE | Unlock a password-gated route. |
--interactive | Record clicks and the DOM changes they cause. |
--responsive | Capture at several viewports. |
--concurrency <n> | Parallel page workers. |
--headed | Show the browser. Useful when a capture behaves differently than expected. |
Factory
Manage every clone you have built.
xray factory list
xray factory status <site>
xray factory redeploy <site>
xray factory open <site>