Skip to main content

The documentation here is for an unreleased version of Recyclarr.

Visit the documentation site for the Current Version instead.

recyclarr serve

Usage​

recyclarr serve [OPTIONS]

Description​

Runs the Recyclarr server in the foreground until you stop it with Ctrl+C. The server syncs on its built-in schedule and accepts commands from the CLI and the HTTP API. The command exits with the server's exit code.

The server reads its address, port, and schedule from the server settings. It writes log messages to the console and to log files in logs/server/.

serve starts the recyclarr-server executable, which must be in the same directory as recyclarr. The release archives include both.

To have other CLI commands use this server instead of starting their own, set server.base_url in cli.yml. See Client and Server for details.

info

The Docker image already runs the server. You do not need serve in a container.

Command Line Examples​

# Start the server
recyclarr serve