Cloud CLI

The signaldiff executable crawls a sitemap locally (HTML report) or talks to the paid Agent API from a terminal, script, or CI job—no MCP host required.

On this page

Local vs cloud

With no subcommand, the CLI crawls from this machine and writes an HTML report (same as before). Subcommands (sites, runs, diff, findings, scan) call Signal Diff in the cloud.

signaldiff --sitemap https://example.com/sitemap.xml --output seo-report.html

Authentication

Cloud commands need a paid key from Developers → API keys.

export SIGNALDIFF_API_KEY=sck_…
export SIGNALDIFF_API_BASE_URL=https://signaldiff.dev/api

Staging: https://staging.signaldiff.dev/api. Flags --api-key and --base-url override the environment; prefer the variable in CI.

Commands

signaldiff sites list
signaldiff runs list --site example.com
signaldiff runs get <runId>
signaldiff runs summary <runId>
signaldiff diff get <runId>
signaldiff findings list <runId> --severity Error --limit 50
signaldiff scan start --sitemap https://example.com/sitemap.xml
signaldiff scan wait <scanId> --json
signaldiff scan cancel <scanId>

Add --json for scripting (tables and key-value text are the default). scan wait exits 0 when the scan completes and 1 when it fails; --interval (seconds, default 2) and optional --timeout control polling.

Customer-hosted crawls: scan start --execution-mode Agent --agent-pool-id <pool> (see Customer agent setup).

Install

Self-contained binaries — no .NET SDK and no repository clone. The installer verifies SHA256 and puts signaldiff on your PATH.

Windows

irm 'https://signaldiff.dev/install/cli.ps1' -OutFile "$env:TEMP\signaldiff-install-cli.ps1"
& "$env:TEMP\signaldiff-install-cli.ps1"

Linux / macOS

curl -fsSL 'https://signaldiff.dev/install/cli.sh' | bash

Manual zips and checksums: downloads/cli. Contributors can still dotnet run --project SignalDiff from a clone.