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, ports, logging, and schedule from the
server settings. It writes log messages to the console and to log files in
logs/server/. In a terminal the console shows readable text; when you redirect the output, it is
JSON lines instead (see server.logging.format). It also opens a
management port (7983 by default) for health probes and metrics.
serve starts the recyclarr-server executable, which must be in the same directory as
recyclarr. The release archives include both.
The server runs with the environment of the shell you start serve from, and it does not start
unless the RECYCLARR_API_KEY or RECYCLARR_API_KEY_FILE
environment variable provides its API key.
To have other CLI commands use this server instead of starting their own, set
server.base_url and server.api_key in cli.yml. See
Client and Server for details.
The Docker image already runs the server. You do not need serve in a container.
Command Line Examples
# Start the server with an API key
export RECYCLARR_API_KEY="$(openssl rand -hex 32)"
recyclarr serve