Step 1Install the CLI

Install the pixeleagle CLI with a single command:

curl -fsSL https://pixel-eagle.com/install.sh | sh

This downloads the binary and makes it executable. Set INSTALL_DIR to control where it's placed (defaults to the current directory, or /usr/local/bin when run as root).

Prefer a specific version, a prebuilt release, or building from source? The CLI is open source at github.com/vleue/PixelEagle-cli — grab a release binary, install with cargo install, or use the packaged GitHub Action (see the CI Integration section).

Set the token as an environment variable or pass it with --token:

export PIXEL_EAGLE_TOKEN=your_token_here

Step 2Create a Run

Create a new run with optional metadata. The command prints the run ID to stdout.

run_id=$(pixeleagle new-run --metadata '{"gitref": "1f6642d", "platform": "macOS"}')

Step 3Upload Screenshots

Upload a single screenshot:

pixeleagle upload-screenshot $run_id path/to/screenshot.png --name "home-page"

Or upload multiple screenshots at once:

pixeleagle upload-screenshots $run_id screenshots/*.png

Step 4Compare Runs

Compare against a specific run:

pixeleagle compare-run $run_id --with-run $other_run_id --wait --print-details

Or let Pixel Eagle automatically find a matching run to compare against:

# Compare against the latest run on the "main" branch
pixeleagle compare-run $run_id --filter branch:main --wait --print-details

# Compare against a run with the same platform
pixeleagle compare-run $run_id --same platform --wait --print-details