CLI Reference
The pixeleagle CLI simplifies uploading screenshots and triggering comparisons from CI pipelines. Source code and additional documentation are available on GitHub .
Global Options
| Option | Env Variable | Description |
|---|---|---|
--token <TOKEN> | PIXEL_EAGLE_TOKEN | Project API token (required) |
Commands
pixeleagle new-run
Create a new run. Prints the run ID to stdout.
| Option | Description |
|---|---|
--metadata <JSON> | JSON metadata (e.g. '{"branch": "main"}') |
pixeleagle upload-screenshot
Upload a single screenshot to a run.
pixeleagle upload-screenshot <RUN_ID> <PATH> [--name <NAME>]
If --name is not provided, the file name is used.
pixeleagle upload-screenshots
Upload multiple screenshots to a run.
pixeleagle upload-screenshots <RUN_ID> <PATH>...
pixeleagle compare-run
Trigger a comparison for a run.
| Option | Description |
|---|---|
--with-run <ID> | Compare with a specific run |
--filter <key:value> | Find a matching run by metadata (repeatable) |
--same <key> | Find a run with the same metadata value (repeatable) |
--wait | Wait for the comparison to finish |
--wait_timeout <SECS> | Timeout when waiting (default: 300s) |
--print-details | Print detailed comparison results |
pixeleagle get-comparison
Retrieve an existing comparison result.
pixeleagle get-comparison <RUN_ID> --with_run <OTHER_RUN_ID> [--wait] [--print-details]