Command-line options
This page is the complete reference for every command-line option of siteone-crawler. It mirrors the output of siteone-crawler --help, using the same section groupings and order. For each option you will find its description and, where the crawler defines one, its default value.
Basic settings
Section titled “Basic settings”| Parameter | Description |
|---|---|
--url=<url> | Required URL. It can also be the URL to sitemap.xml. Enclose in quotes if URL contains query parameters. |
--url-list=<val> | Path to a plain-text file with one URL per line (blank lines and # comments ignored). When provided, --url is optional; the first URL in the file is used as the crawl base. All listed URLs are seeded into the crawl queue. |
--single-page | Load only one page to which the URL is given (and its assets), but do not follow other pages. |
--max-depth=<int> | Maximum crawling depth (for pages, not assets). Default is 0 (no limit). 1 means /about or /about/, 2 means /about/contacts etc. |
--device=<val> | Device type for User-Agent selection. Values desktop, tablet, mobile. Ignored with --user-agent. Default value is desktop. |
--user-agent=<val> | Override User-Agent selected by --device. If you add ! at the end, the SiteOne-Crawler/version will not be added as a signature at the end of the final user-agent. |
--timeout=<int> | Request timeout (in sec). Default value is 5. |
--proxy=<host:port> | HTTP proxy in host:port format. |
--http-auth=<val> | Basic HTTP authentication in username:password format. |
--accept-invalid-certs | Accept invalid or incomplete SSL/TLS certificates (e.g. expired, self-signed, or missing intermediate CA). Use with caution. |
--config-file=<file> | Load options from a configuration file (one option per line). Processed before all other arguments; CLI arguments override values from the file. See Configuration file for the format and auto-discovery details. |
--help | Show help and exit. |
--version | Show crawler version and exit. |
Output settings
Section titled “Output settings”Resource filtering
Section titled “Resource filtering”Advanced crawler settings
Section titled “Advanced crawler settings”Expert settings
Section titled “Expert settings”File export settings
Section titled “File export settings”Mailer options
Section titled “Mailer options”Markdown exporter options
Section titled “Markdown exporter options”The markdown export feature is activated by entering the --markdown-export-dir parameter. All others are optional.
Offline exporter options
Section titled “Offline exporter options”The offline export feature is activated by entering the --offline-export-dir parameter. All others are optional.
Sitemap options
Section titled “Sitemap options”Upload options
Section titled “Upload options”See Online HTML report (upload) for more information.
Fastest URL analyzer
Section titled “Fastest URL analyzer”SEO and OpenGraph analyzer
Section titled “SEO and OpenGraph analyzer”| Parameter | Description |
|---|---|
--max-heading-level=<int> | Maximal analyzer heading level from 1 to 6. Default value is 3. |
Slowest URL analyzer
Section titled “Slowest URL analyzer”CI/CD settings
Section titled “CI/CD settings”See CI/CD integration for exit codes, JUnit XML, baseline regression and full pipeline examples.