Skip to main content

The documentation here is for an unreleased version of Recyclarr.

Visit the documentation site for the Current Version instead.

Common Options

Options​

These are options shared by all commands.

-h|--help​

Print help output. Help is also context-aware, so you can get help output specific to any command. For example, recyclarr sync -h will print help specific to the sync command.

--log [LEVEL]​

Enable log output mode. When used, Recyclarr switches from interactive UI output to log output. This is useful for scripts, automation, or debugging.

Valid levels:

  • verbose - Everything in debug, plus the body of each request to and response from the server
  • debug - Show debug, info, warning, and error messages, including each request to the server
  • info - Show info, warning, and error messages (default)
  • warn - Show only warning and error messages

When used without a level argument (--log), defaults to info.

The CLI does not write log files. To keep its log output, redirect it to a file. The server writes its own log files; see Obtaining Debug Logs.

Output Modes

Recyclarr has two mutually exclusive output modes:

  • Interactive mode (default): Shows progress bars, tables, and formatted output. No logs are printed.
  • Log mode (--log): Shows log output. Interactive UI elements are disabled. Recyclarr also uses this mode, at the info level, when its output is redirected to a file or a pipe (except for list commands with --raw).