Download Conveyor¶

After downloading:

On macOS, open the app and click "Add to shell path" so you can use the conveyor command from the terminal. You'll need to re-open terminal tabs to apply the $PATH change.
On Windows, make sure you are using Windows Terminal. The legacy default Windows console has some rendering bugs. Conveyor will appear in your %PATH% automatically so you don't need to restart any terminals.

Now run conveyor --help to check it's ready to go and move on to the next section.

Automatic updates

Conveyor is packaged with itself, but automatic updates are switched off for Windows and macOS to give you full control. To update Conveyor, run it from the GUI and then click "Check for updates". On Debian you can control updates in the usual manner and for other distros, the tarball never updates itself so you'll need to re-download it.

Downloading in build scripts¶

You can download specific versions of Conveyor by simply putting the URLs you find on the download page into your build scripts. Please observe the following:

Ensure your CI system is caching the download. If we observe IP addresses redownloading over and over they'll be throttled or blocked. Consider mirroring the download on your own servers if you aren't sure how to set up caching.
If you want to use the Windows version you can just grab the MSIX file and unzip it.
You can use command line flags or environment variables to agree to the license. You'll be given instructions on what to do the first time you manually agree.

Next steps¶

Please read the release notes and known issues list!
Learn what Conveyor produces.
Take the tutorial.
Learn more about how to run the tool.
Learn how to customize the results.