Quick Start Guide

Choose how you want to use the tool

Desktop Application - graphical interface with an already built-in command-line interface
Command-line Interface - for advanced users who prefer to work with the command line

Desktop Application

1. Download the latest version of the installer from releases, or here for most common platforms:
   • Windows x64 - MSI (recommended) / EXE / portable EXE
   • Linux x64 - AppImage (recommended) / DEB / SNAP
   • macOS arm64 (CPU M1/M2/M3) - DMG*, macOS x64 (CPU Intel) - DMG*
     * Note for macOS users: As of 12/12/2023, the macOS app is already signed and officially notarized by Apple. We will also strive to publish the next versions to the Mac App Store for easier installation and updates.
     
2. Install the application and run it. You will find it under the name SiteOne Crawler.
3. Enter the URL of the website you want to crawl and click the Run button.
4. Watch video below, which explains in more detail other useful options.
5. Report a bug or suggest an improvement via one of the channels.
6. Tell colleagues and friends about this tool if you find it useful ;-)
7. Enjoy the tool and build quality websites! 🚀

How to use Desktop Application

Command-line Interface

1. Download and install the crawler to your OS - the easiest way with ready-to-use packages.
2. Run the crawler - look at basic usage, or simply run ./crawler --url=crawler.siteone.io.
3. Study the available features and try advanced usage.
4. Review all command-line options if you are an advanced user.
5. Report a bug or suggest an improvement via one of the communication channels.
6. Enjoy the tool and use it in CI/CD too. 🚀

How to use Command-line Interface