Skip to main content

The documentation here is for an unreleased version of Recyclarr.

Visit the documentation site for the Current Version instead.

recyclarr list custom-formats

Usage​

recyclarr list custom-formats <service> [OPTIONS]

Description​

For a specific service, this command prints a list of all available Custom Formats from the TRaSH Guides in YAML format, ready to be copied & pasted directly into your configuration YAML file (e.g. recyclarr.yml). Here is an example of the output you will see:

List of Custom Formats in the TRaSH Guides:

          - b124be9b146540f8e62f98fe32e49a2a # 1.0 Mono
          - 820b09bb9acbfde9c35c71e0e565dad8 # 1080p
          - 89dac1be53d5268a7e10a19d3c896826 # 2.0 Stereo
          - fb392fb0d61a010ae38e49ceaa24a1ef # 2160p
          - 205125755c411c3b8622ca3175d27b37 # 3.0 Sound

The above Custom Formats are in YAML format and ready to be copied & pasted under the `trash_ids:` property.

You can copy & paste these directly into your config YAML, like this:

radarr:
  main:
    base_url: http://127.0.0.1:7878
    api_key: 2424b3643507485ea2e06382d3f0b8a3
    custom_formats:
      - trash_ids:
          - b124be9b146540f8e62f98fe32e49a2a # 1.0 Mono
          - 820b09bb9acbfde9c35c71e0e565dad8 # 1080p

Examples​

# List all custom formats in the guide for Radarr
recyclarr list custom-formats radarr

# List all custom formats in the guide for Sonarr
recyclarr list custom-formats sonarr

# List all score sets in custom formats for Radarr
recyclarr list custom-formats radarr --score-sets

# List all custom formats without any formatting (e.g. for scripts)
recyclarr list custom-formats radarr --raw

Arguments​

<service>​

A required positional argument that indicates the specific service type to list custom formats for. Valid values for this argument are:

Options​

Visit Common Options to read about options usable by all commands.

--score-sets​

Instead of listing custom format names, output a list of score sets that can be used with the score_set YAML property.

--raw​

Omit boilerplate text in the output. This excludes superfluous instructional text, formatting, and colors. This option is useful to use in scripting scenarios, such as taking the CF output list and automatically building a YAML configuration file from it.