Installation guide

Download and extract precompiled binary for your OS and platform from the releases page on GitHub

Alternatively, you can compile Receptor from source code (Golang 1.20+ required)

make receptor

Test the installation with the following commands:

receptor --help
receptor --version

The preferred way to interact with Receptor nodes is to use the receptorctl command line tool

pip install receptorctl

receptorctl will be used in various places throughout this documentation.