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-format-groups

Usage​

recyclarr list custom-format-groups <service> [OPTIONS]

Description​

For a specific service, this command prints a list of all available custom format groups from the TRaSH Guides in a compact table. Each group shows its name and trash ID. Use the trash ID with the custom_format_groups 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_format_groups:
      add:
        - trash_id: 9d5acd8f1da78dfbae788182f7605200 # [Audio] Audio Formats
        - trash_id: ef20e67b95a381fb3bc6d1f06ea24f46 # [HDR Formats] HDR
tip

When using guide-backed quality profiles, default CF groups sync automatically. You only need custom_format_groups to opt-out of defaults (skip) or add non-default groups (add).

Examples​

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

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

# Show member custom formats and associated quality profiles for each group
recyclarr list custom-format-groups radarr --details

# Filter groups by name (case-insensitive)
recyclarr list custom-format-groups radarr --filter audio

# Output in TSV format for scripting
recyclarr list custom-format-groups radarr --raw

Arguments​

<service>​

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

  • radarr: List Radarr custom format groups
  • sonarr: List Sonarr custom format groups

Options​

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

--details​

Show additional information for each custom format group. Adds a "Custom Formats" section listing member custom formats with their inclusion semantics (required, default, or optional) and a "Quality Profiles" section listing associated quality profiles with their status (default or optional). This option only affects table output and is ignored when --raw is used.

--filter​

Filter groups by name using a case-insensitive substring match. Only groups whose name contains the filter string are shown.

--raw​

Output in TSV format for scripting. Suppresses table formatting, colors, and instructional text. Outputs one line per custom format (not per group).

Columns (tab-separated):

  1. Group Trash ID - The group identifier to use in custom_format_groups
  2. Group Name - The group name
  3. CF Trash ID - The custom format's trash ID
  4. CF Name - The custom format name
  5. Required - Whether the CF is required (true/false)
  6. Default - Whether the CF is a default (true/false)
info

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