The documentation here is for an unreleased version of Recyclarr.
Visit the documentation site for the Current Version instead.Manual Installation
Prerequisites
The following dependencies are required on all platforms.
- Git v2.0 or greater (Instructions for Windows Users)
Download
Simply download the latest release for your platform using the table below. The download itself is
just an archive (ZIP on Windows and tarball on mac/linux) with two executables in it: recyclarr
(the CLI) and recyclarr-server. You may put them anywhere you want, but keep both in the same
directory. The CLI starts recyclarr-server from its own directory.
| Platform | Binary |
|---|---|
| Windows | x64, arm64 |
| Linux | x64, arm64, arm |
| macOS | x64, arm64 |
The above links are from the latest release on the releases page. Feel free to visit there for release notes, additional architectures and platforms, and older releases.
Linux & macOS Installation
If you follow these instructions, the following tools are required.
tar, xz, wget
Copy the URL to the specific download you want in the table above. Use this URL in the following
command. You can even put this URL in your ~/.bashrc or similar to set it every time you log in.
export RECYCLARR_URL="Paste_URL_Here"
With the above variable set, run the command below to download & install/upgrade. The --overwrite
option is necessary for upgrades so that the command may replace the existing binaries.
wget "$RECYCLARR_URL" -O - | sudo tar xJ --overwrite -C /usr/local/bin
It is recommended to install Recyclarr to /usr/local/bin because, on most platforms, this path is
already in $PATH by default. This allows you to use the recyclarr command without much fuss. You
are, of course, welcome to install Recyclarr anywhere you want.
You can run the server as a service that starts at boot and syncs on a schedule. See Linux or Windows. On macOS, install with Homebrew to run it as a service.