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>

Description

For a specific service, this command prints a list of all available custom format groups from the TRaSH Guides in a formatted table. Use the Trash ID values 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:
- trash_id: 9d5acd8f1da78dfbae788182f7605200 # [Audio] Audio Formats (12 CFs)
- trash_id: ef20e67b95a381fb3bc6d1f06ea24f46 # [HDR Formats] HDR (1 CFs)

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

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.

--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 custom_format_groups
  2. Name - The group name
  3. CF Count - Number of custom formats in the group
info

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