Quick Start

Go from zero to your first website audit in a couple of minutes: install SiteOne Crawler, run one command, and open the HTML report with its 0–10 quality score.

Run your first audit in 30 seconds

Homebrew

# macOS / Linux (Homebrew)
brew install janreges/tap/siteone-crawler

# Audit any site — full HTML report + 0-10 quality score in one command
siteone-crawler --url=https://your-site.com

Linux (apt)

# Debian / Ubuntu (apt)
curl -1sLf 'https://dl.cloudsmith.io/public/janreges/siteone-crawler/setup.deb.sh' | sudo -E bash
sudo apt-get install siteone-crawler

siteone-crawler --url=https://your-site.com

Other / Windows

# Download a single dependency-free binary for Windows / macOS / Linux
# from https://github.com/janreges/siteone-crawler/releases

# Linux / macOS — extract, then run from the folder:
tar -xzf siteone-crawler-*.tar.gz
./siteone-crawler --url=https://your-site.com

# Windows — unzip the *-win-x64.zip, then in cmd/PowerShell:
# siteone-crawler.exe --url=https://your-site.com

No account, no dependencies — one native binary. The HTML report path is printed at the end of the run; add --upload to share it via a private link. Not sure where to start? Run siteone-crawler with no arguments for an interactive wizard.

Two ways to use the tool

Command-line interface — for developers, DevOps, QA and CI/CD (recommended).
Desktop application — a graphical interface with the same engine built in.

Command-line Interface

1. Install the crawler. The quickest way is Homebrew — brew install janreges/tap/siteone-crawler — or use your Linux package manager (apt/dnf/zypper/apk) or a direct binary download. See ready-to-use packages for every option.
2. Run your first crawl on your own site:

   siteone-crawler --url=https://your-site.com

   Not sure where to start? Run siteone-crawler with no arguments for an interactive wizard with 10 preset modes.
3. Open the report. The HTML report path is printed at the end of the run — open it in any browser and start with the “Fix first” panel, which lists the highest-impact issues in priority order. Want to share it? Add --upload. What’s in the report →
4. Go further — explore basic usage, advanced usage, real-world examples, and the full command-line options.

Watch: command-line interface

Desktop Application

1. Download & install the desktop application (Windows, macOS, Linux):
   ⬇️ Download the desktop app (latest release)

   Installers for Windows (MSI / EXE), macOS (DMG, signed & notarized by Apple) and Linux (AppImage / DEB / SNAP) — pick your platform on the release page. Prefer the command line? See the CLI packages.

2. Run it — you’ll find it as SiteOne Crawler. Enter the URL of the website you want to crawl and click Run.
3. Open the report with the button when the crawl finishes, and start with the “Fix first” panel. What’s in the report →
4. Watch the video below for the other options.

Watch: desktop application

You’re done 🚀

You now have an interactive HTML report with a 0–10 quality score for your whole site, and a prioritized list of what to fix first.

• Found it useful? Star it on GitHub (command-line and desktop app) and tell a colleague.
• Hit a bug or have an idea? Reach us through any of the communication channels.