Skip to main content

The documentation here is for an unreleased version of Recyclarr.

Visit the documentation site for the Current Version instead.

CLI Settings

# yaml-language-server: $schema=https://schemas.recyclarr.dev/latest/cli-schema.json
server:
  base_url: http://localhost:7982
  api_key: your-key-here

CLI settings are specified in an optional file named cli.yml in your configuration directory. Only the recyclarr CLI reads this file; the server reads settings.yml instead.

Without this file, each CLI command starts a temporary server of its own. See Client and Server for how the CLI and server work together.

server.base_url​

Optional. Default: Each command starts a temporary server

The address of a running Recyclarr server, such as one started with recyclarr serve. When set, CLI commands send their work to this server instead of starting their own. The value must be an absolute URL that starts with http:// or https://.

The RECYCLARR_SERVER_URL environment variable overrides this setting when it is set to a non-empty value. The Docker image sets that variable, so the CLI in the container always uses the container's server.

server.api_key​

Conditionally Required. Default: No key is sent

The server API key that CLI commands send to the server at server.base_url. It must match the API key of that server. Required when server.base_url is set, unless an environment variable provides the key.

The CLI ignores this setting when server.base_url is not set, because it gives each temporary server a one-time key of its own.

The RECYCLARR_API_KEY and RECYCLARR_API_KEY_FILE environment variables override this setting when either is set to a non-empty value. The Docker image's server reads those same variables, so the CLI in the container uses the container's key.