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 a formatted table grouped by category. Use the Trash ID values with the trash_ids property in your configuration YAML file.

Example usage in your config:

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

# Output in TSV format for scripting
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.

--raw​

Output in TSV format for scripting. Suppresses table formatting, colors, and instructional text.

Columns (tab-separated):

  1. Trash ID - The unique identifier to use in trash_ids
  2. Name - The custom format name
  3. Category - The category grouping (may be empty)
info

The --raw and --log options are mutually exclusive. Use --raw for machine-readable output or --log for diagnostics.