### Example include YAML (hd-bluray.yml)

Source: https://recyclarr.dev/reference/settings/resource-providers/config-templates-structure

A partial configuration file that gets merged into the main config. Defines a quality profile named 'HD Bluray' with reset_unmatched_scores, upgrade settings, and quality list.

```yaml
# radarr/includes/quality-profiles/hd-bluray.yml  

quality_profiles:  

  - name: HD Bluray  

    reset_unmatched_scores:  

      enabled: true  

    upgrade:  

      allowed: true  

      until_quality: Bluray-1080p  

      until_score: 10000  

    min_format_score: 0  

    quality_sort: top  

    qualities:  

      - name: Bluray-1080p  

      - name: Bluray-720p  
```

--------------------------------

### recyclarr sync config examples

Source: https://recyclarr.dev/cli/sync

Examples for using the -c/--config option to specify default, single, or multiple configuration files.

```bash
# Sync using default configs (recyclarr.yml or files in the 'configs' directory)

recyclarr sync

# Use a single config

recyclarr sync --config ../myconfig.yml

# Use multiple configs

recyclarr sync -c ../myconfig1.yml -c "files/my config 2.yml"
```

--------------------------------

### Instance name configuration example

Source: https://recyclarr.dev/cli/delete/custom-formats

Example configuration showing the instance name 'fubar' under the 'radarr' service, with base_url and api_key fields.

```yaml
radarr:  

  fubar:  

    base_url: http://localhost:7878  

    api_key: f7e74ba6c80046e39e076a27af5a8444  
```

--------------------------------

### recyclarr sync instance examples

Source: https://recyclarr.dev/cli/sync

Examples for using the -i/--instance option to sync named instances across services or within a specific service.

```bash
# Sync instances named `movies` and `series` across both Radarr and Sonarr

recyclarr sync -i movies -i series

# Sync an instance named 'series' only if they are in Sonarr

recyclarr sync sonarr --instance series
```

--------------------------------

### Docker Exec Examples

Source: https://recyclarr.dev/guide/installation/docker

Examples of using docker exec and docker compose exec to create a config, sync Sonarr with debug logs, and preview a Radarr sync.

```bash
# Create a default `recyclarr.yml` in the `/config` volume (without compose)  

docker exec recyclarr recyclarr config create  

# Sync Sonarr with debug logs (with compose)  

docker compose exec recyclarr recyclarr sync sonarr --log debug  

# Do a preview (dry run) sync for Radarr (without compose)  

docker exec recyclarr recyclarr sync radarr --preview --log debug  
```

--------------------------------

### Install Git with Winget CLI

Source: https://recyclarr.dev/guide/installation/tips/git-install

Installs Git on Windows using the Winget CLI package manager. This is a quick installation method for users familiar with package managers.

```bash
winget install --id Git.Git -e --source winget
```

--------------------------------

### List score sets for Radarr and Sonarr

Source: https://recyclarr.dev/cli/list/score-sets

Example commands to list score sets for Radarr and Sonarr. The output is a formatted table of available score sets from the TRaSH Guides.

```bash
# List all score sets for Radarr  

recyclarr list score-sets radarr  

  

# List all score sets for Sonarr  

recyclarr list score-sets sonarr  
```

--------------------------------

### Sync output example

Source: https://recyclarr.dev/guide/getting-started

Example output from the sync command showing the processing of the Radarr server and the number of custom formats, profiles, and quality definitions synced.

```text
===========================================
Processing Radarr Server: [hd-bluray-web]
===========================================

[INF] Created 34 New Custom Formats
[INF] Total of 34 custom formats were synced
[INF] Created 1 Profiles: ["HD Bluray + WEB"]
[INF] A total of 1 profiles were synced. 1 contain quality changes and 1 contain updated scores
[INF] Total of 14 sizes were synced for quality definition movie
[INF] Completed at 12/16/2025 10:55:42
```

--------------------------------

### recyclarr.yml instance example

Source: https://recyclarr.dev/cli/sync

Shows example YAML configuration defining instances 'movies' and 'series' under Radarr and Sonarr services.

```yaml
radarr:
  movies:
    base_url: http://localhost:7878
    api_key: abc123
sonarr:
  series:
    base_url: http://localhost:8989
    api_key: def456
```

--------------------------------

### Includes directory structure for include example

Source: https://recyclarr.dev/guide/file-structure

Visualizes the expected file structure of the `includes` directory for the include directive example, showing `configs/foo.yml` and `includes/bar/reusable.yml`.

```text
.

├── configs/

│   └── foo.yml

└── includes/

    └── bar/

        └── reusable.yml

```

--------------------------------

### Install Git with Chocolatey

Source: https://recyclarr.dev/guide/installation/tips/git-install

Installs Git on Windows using the Chocolatey package manager. This is an alternative quick installation method for users who prefer Chocolatey.

```bash
choco install git
```

--------------------------------

### Verify Git Installation

Source: https://recyclarr.dev/guide/installation/tips/git-install

Verifies that Git is correctly installed by displaying the installed version. Run this command in a new terminal window after installation.

```bash
git --version
```

--------------------------------

### Basic service configuration YAML

Source: https://recyclarr.dev/reference/configuration/basic

Example YAML configuration for a service instance, showing the required properties: service_type, instance_name, base_url, and api_key. The service_type must be 'sonarr' or 'radarr', instance_name must be unique and contain only numbers, letters, and underscores, base_url must start with http or https, and api_key is obtained from the service's Settings > General page.

```yaml
service_type:  

  instance_name:  

    base_url: http://localhost:1234  

    api_key: f7e74ba6c80046e39e076a27af5a8444  

```

--------------------------------

### Include directive example

Source: https://recyclarr.dev/guide/file-structure

Example include directive in a configuration file named `foo.yml` that references a relative include template path.

```yaml
include:

  - config: bar/reusable.yml

```

--------------------------------

### Global settings example

Source: https://recyclarr.dev/reference/settings

Global settings example. `enable_ssl_certificate_validation` defaults to true; set to false to disable SSL validation (security risk). `git_path` provides an explicit path to the git executable, overriding PATH search.

```yaml
enable_ssl_certificate_validation: true

git_path: /usr/local/bin/git
```

--------------------------------

### Replace Official Trash Guides with Fork

Source: https://recyclarr.dev/reference/settings/resource-providers

Replaces the official Trash Guides with a custom fork. When replace_default is true, the official repository is not used.

```yaml
resource_providers:  
  - name: my-fork  
    type: trash-guides  
    clone_url: https://github.com/yourname/trash-guides-fork.git  
    reference: main  
    replace_default: true  

```

--------------------------------

### Examples: list custom formats for Radarr, Sonarr, and raw TSV

Source: https://recyclarr.dev/cli/list/custom-formats

Three example commands: listing all custom formats for Radarr, for Sonarr, and outputting in TSV format using --raw for scripting. The --raw option suppresses table formatting and colors.

```bash
# 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  
```

--------------------------------

### recyclarr sync service examples

Source: https://recyclarr.dev/cli/sync

Shows how to sync all services, only Radarr, or only Sonarr using the positional argument.

```bash
# Sync both Radarr and Sonarr

recyclarr sync

# Sync just Radarr

recyclarr sync radarr

# Sync just Sonarr

recyclarr sync sonarr
```

--------------------------------

### Create config from template and overwrite existing file

Source: https://recyclarr.dev/cli/config/create

Example showing how to create a config from a template and overwrite an existing file using --force.

```bash
# Create config from template and overwrite existing file  

recyclarr config create --template uhd-bluray-web --force  
```

--------------------------------

### Create config from single and multiple templates

Source: https://recyclarr.dev/cli/config/create

Two examples: one creates configuration from a single template using --template, the other creates from multiple templates using -t.

```bash
# Create configuration from a single template  

recyclarr config create --template uhd-bluray-web  

  

# Create from multiple templates  

recyclarr config create -t uhd-bluray-web -t remux-web-1080p  
```

--------------------------------

### Examples: list custom-format-groups commands

Source: https://recyclarr.dev/cli/list/custom-format-groups

Five example invocations of the command: one for Radarr, one for Sonarr, one with --details, one with --filter, and one with --raw.

```bash
# 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  
```

--------------------------------

### Create starter config with default file and custom path

Source: https://recyclarr.dev/cli/config/create

Two examples: one creates a starter config using the default file recyclarr.yml, the other creates a starter config in a specific location using --path.

```bash
# Create a starter config using the default file, `recyclarr.yml`  

recyclarr config create  

  

# Create a starter config in a specific location  

recyclarr config create --path ~/myconfig.yml  
```

--------------------------------

### Example: List only local config files

Source: https://recyclarr.dev/cli/config/local

Lists only local configuration files using the recyclarr config list local command.

```bash
# List only local config files  

recyclarr config list local  
```

--------------------------------

### Examples: recyclarr list quality-profiles commands

Source: https://recyclarr.dev/cli/list/quality-profiles

Shows various command examples for listing quality profiles, including filtering and raw output. The `--details` option adds qualities and custom formats, `--filter` filters by name, and `--raw` outputs TSV.

```bash
# List all quality profiles in the guide for Radarr  
recyclarr list quality-profiles radarr  
  
# List all quality profiles in the guide for Sonarr  
recyclarr list quality-profiles sonarr  
  
# Show qualities and custom formats for each profile  
recyclarr list quality-profiles radarr --details  
  
# Filter profiles by name (case-insensitive)  
recyclarr list quality-profiles sonarr --filter bluray  
  
# Output in TSV format for scripting  
recyclarr list quality-profiles radarr --raw  
```

--------------------------------

### Configure media_naming for Radarr

Source: https://recyclarr.dev/guide/getting-started

Adds a media_naming section to the Recyclarr config to sync TRaSH Guide naming formats. The example uses the plex-tmdb folder and movie naming templates, with a quality profile for HD Bluray + WEB.

```yaml
radarr:

  main:

    base_url: http://radarr:7878

    api_key: your_api_key_here



    quality_definition:

      type: movie



    quality_profiles:

      - trash_id: d1d67249d3890e49bc12e275d989a7e9  # HD Bluray + WEB

        reset_unmatched_scores:

          enabled: true



    # Results visible in: Radarr → Settings → Media Management

    media_naming:

      folder: plex-tmdb

      movie:

        rename: true

        standard: plex-tmdb
```

--------------------------------

### Sync progress table example

Source: https://recyclarr.dev/guide/sync-behavior

Example output from a sync where Custom Formats failed for the radarr instance. Shows the progress table with symbols for success, failure, and skipped, and the row prefix indicating overall instance status.

```text
Legend: ✓ ok · ✗ failed · -- skipped  

  

           Custom  Quality Quality  Media  

          Formats Profiles   Sizes Naming  

✓ sonarr        ✓        ✓       ✓     --  

✓ shows         ✓        ✓       ✓      2  

✗ radarr        ✗       --       ✓     --  

```

--------------------------------

### Docker Compose Run Examples

Source: https://recyclarr.dev/guide/installation/docker

Examples of using docker compose run to create a config, sync Sonarr with debug logs, and preview a Radarr sync. The --rm flag deletes the container after each run.

```bash
# Create a default `recyclarr.yml` in the `/config` volume  

docker compose run --rm recyclarr config create  

# Sync Sonarr with debug logs  

docker compose run --rm recyclarr sync sonarr --log debug  

# Do a preview (dry run) sync for Radarr  

docker compose run --rm recyclarr sync radarr --preview --log debug  
```

--------------------------------

### recyclarr config list templates examples

Source: https://recyclarr.dev/cli/config/templates

Examples of listing configuration templates and include templates. The --includes flag lists include template IDs, but only works with custom resource providers since the official repo no longer provides include templates as of v8.

```bash
# List available configuration templates  
recyclarr config list templates  

# List available include templates (only useful with custom resource providers)  
recyclarr config list templates --includes  
```

--------------------------------

### Install Recyclarr via Homebrew

Source: https://recyclarr.dev/guide/installation/package-managers

Adds the Recyclarr Homebrew tap and installs the recyclarr package. Available for macOS and Linux.

```bash
brew tap recyclarr/recyclarr  

brew install recyclarr  

```

--------------------------------

### Multiple Resource Providers Combined

Source: https://recyclarr.dev/reference/settings/resource-providers

Realistic setup combining official sources (implicit), a supplemental git repository, local custom formats, and config templates. Precedence: official lowest, community extras next, local custom formats highest.

```yaml
resource_providers:  
  # Supplemental guides from a community repository  
  - name: community-extras  
    type: trash-guides  
    clone_url: https://github.com/community/extra-guides.git  
    reference: main  

  # Local custom formats for Radarr  
  - name: my-radarr-cfs  
    type: custom-formats  
    path: /home/user/custom-formats/radarr  
    service: radarr  

  # Local custom formats for Sonarr  
  - name: my-sonarr-cfs  
    type: custom-formats  
    path: /home/user/custom-formats/sonarr  
    service: sonarr  

  # Custom config templates  
  - name: my-templates  
    type: config-templates  
    clone_url: https://github.com/yourname/my-templates.git  
    reference: main  

```

--------------------------------

### Configuration example using trash_id

Source: https://recyclarr.dev/cli/list/quality-profiles

Example YAML configuration showing how to use the trash ID from the quality profile list in the `quality_profiles` section. The `trash_id` value is used to reference a specific profile.

```yaml
radarr:  

  main:  

    base_url: http://127.0.0.1:7878  

    api_key: 2424b3643507485ea2e06382d3f0b8a3  

    quality_profiles:  

      - trash_id: d1d67249d3890e49bc12e275d989a7e9 # HD Bluray + WEB  
```

--------------------------------

### Download and install Recyclarr with wget and tar

Source: https://recyclarr.dev/guide/installation/manual-install

Downloads and installs or upgrades Recyclarr to /usr/local/bin. The --overwrite option is necessary for upgrades to replace any existing recyclarr binary.

```bash
wget "$RECYCLARR_URL" -O - | sudo tar xJ --overwrite -C /usr/local/bin  
```

--------------------------------

### Before consolidation: uhd-bluray-web.yml

Source: https://recyclarr.dev/reference/config-examples

Example config file created from a template for a UHD Bluray + WEB quality profile, targeting a Radarr instance named radarr-uhd.

```yaml
radarr:  
  radarr-uhd:  
    base_url: !secret radarr_uhd_url  
    api_key: !secret radarr_uhd_apikey  

    quality_definition:  
      type: movie  

    quality_profiles:  
      - trash_id: 64fb5f9858489bdac2af690e27c8f42f  # UHD Bluray + WEB  
        reset_unmatched_scores:  
          enabled: true  

```

--------------------------------

### Config example: using trash_ids in YAML

Source: https://recyclarr.dev/cli/list/custom-formats

Example configuration YAML for Radarr showing how to use the Trash IDs from the custom formats list in the 'trash_ids' property. The IDs are commented with their format names.

```yaml
radarr:  

  main:  

    base_url: http://127.0.0.1:7878  

    api_key: 2424b3643507485ea2e06382d3f0b8a3  

    custom_formats:  

      - trash_ids:  

          - b124be9b146540f8e62f98fe32e49a2a # 1.0 Mono  

          - 820b09bb9acbfde9c35c71e0e565dad8 # 1080p  
```

--------------------------------

### List available templates with recyclarr config list templates

Source: https://recyclarr.dev/guide/getting-started

Run this command to list the ready-to-use templates that match TRaSH Guide quality profiles. The output shows available Sonarr and Radarr templates.

```bash
docker compose run --rm recyclarr config list templates  

```

```text
┌───────────────────┬───────────────────┐  
│ Sonarr            │ Radarr            │  
├───────────────────┼───────────────────┤  
│ web-1080p         │ hd-bluray-web     │  
│ web-2160p         │ uhd-bluray-web    │  
│ anime-remux-1080p │ remux-web-1080p   │  
│ ...               │ remux-web-2160p   │  
│                   │ anime-remux-1080p │  
│                   │ ...               │  
└───────────────────┴───────────────────┘  

```

--------------------------------

### Before consolidation: hd-bluray-web.yml

Source: https://recyclarr.dev/reference/config-examples

Example config file created from a template for an HD Bluray + WEB quality profile, targeting a Radarr instance named radarr-hd.

```yaml
radarr:  
  radarr-hd:  
    base_url: !secret radarr_hd_url  
    api_key: !secret radarr_hd_apikey  

    quality_definition:  
      type: movie  

    quality_profiles:  
      - trash_id: d1d67249d3890e49bc12e275d989a7e9  # HD Bluray + WEB  
        reset_unmatched_scores:  
          enabled: true  

```

--------------------------------

### Directory layout example for config-templates repository

Source: https://recyclarr.dev/reference/settings/resource-providers/config-templates-structure

Shows the required directory structure for a config-templates repository, with includes.json and templates.json at the root, and subdirectories for radarr and sonarr includes and templates.

```text
my-templates-repo/  

├── includes.json              # Maps include IDs to YAML files  

├── templates.json             # Maps template IDs to YAML files  

├── radarr/  

│   ├── includes/  

│   │   └── quality-profiles/  

│   │       ├── hd-bluray.yml  

│   │       └── uhd-bluray.yml  

│   └── templates/  

│       └── movies-hd.yml  

└── sonarr/  

    ├── includes/  

    │   └── quality-profiles/  

    │       └── tv-hd.yml  

    └── templates/  

        └── tv-shows.yml  
```

--------------------------------

### Config example: custom_format_groups add

Source: https://recyclarr.dev/cli/list/custom-format-groups

Example configuration for adding custom format groups to Radarr. Use trash IDs from the command output with the 'add' key under custom_format_groups.

```yaml
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  
```

--------------------------------

### Resource provider configuration example

Source: https://recyclarr.dev/reference/settings/resource-providers/configuration

Example configuration for defining resource providers in Recyclarr. Shows a git-based provider using trash-guides type with clone_url, reference, and cache_limit, and a local directory provider using custom-formats type with path and service. Both set replace_default to false.

```yaml
resource_providers:  

  # Git-based provider (trash-guides or config-templates)  

  - name: my-custom-guides  

    type: trash-guides  

    clone_url: https://github.com/yourname/custom-guides.git  

    reference: main  

    replace_default: false  

    cache_limit: 100MB  

  

  # Local directory provider (custom-formats)  

  - name: my-language-cfs  

    type: custom-formats  

    path: /home/user/custom-formats/radarr  

    service: radarr  

    replace_default: false  

  
```

--------------------------------

### secrets.yml example with Sonarr and Radarr credentials

Source: https://recyclarr.dev/reference/config-examples

Example secrets.yml file storing API keys and URLs for Sonarr and Radarr. These values are referenced elsewhere using the !secret tag.

```yaml
# secrets.yml  
sonarr_url: http://sonarr:8989  
sonarr_apikey: abc123  

radarr_url: http://radarr:7878  
radarr_apikey: def456  

```

--------------------------------

### Quality Profiles Configuration Example

Source: https://recyclarr.dev/reference/configuration/quality-profiles

Example YAML configuration for defining quality profiles in Recyclarr. Shows both a guide-backed profile using a trash_id and a manual profile with properties like reset_unmatched_scores, upgrade, min_format_score, and qualities. Omitted properties are not modified by Recyclarr.

```yaml
service_type:

  instance_name:

    # Quality Profile Configuration

    quality_profiles:

      # Guide-backed profile (name derived from guide)

      - trash_id: 9a0e43cb7a892e3e9c4f2f5c5e0dcf8e


      # Manual configuration

      - name: SD

        reset_unmatched_scores:

          enabled: true

          except:

            - My First CF

            - My Second CF

          except_patterns:

            - "^\\[My\\]"

        upgrade:

          allowed: true

          until_quality: Remux-1080p

          until_score: 456

        min_format_score: 123

        min_upgrade_format_score: 100

        score_set: sqp-1-1080p

        quality_sort: bottom

        qualities:

          - name: Remux-1080p

          - name: Bluray-1080p

            enabled: false

          - name: Bluray-720p

          - name: WEB 720p

            qualities:

              - WEBRip-720p

              - WEBDL-720p

          - name: DVD
```

--------------------------------

### recyclarr config list templates usage

Source: https://recyclarr.dev/cli/config/templates

Shows the command syntax for listing available template configuration files in the Trash Guides repo.

```bash
recyclarr config list templates [OPTIONS]  
```

--------------------------------

### Docker Compose configuration for Recyclarr

Source: https://recyclarr.dev/guide/installation/docker

A docker-compose.yml example using the GHCR image `ghcr.io/recyclarr/recyclarr:8`. It defines a shared external network, mounts `./config` to `/config`, sets the user to `1000:1000`, and sets the timezone. The example should not be used verbatim; adjust for your environment.

```yaml
networks:  

  recyclarr:  

    name: recyclarr  

    external: true  

  

services:  

  recyclarr:  

    image: ghcr.io/recyclarr/recyclarr:8  

    container_name: recyclarr  

    user: 1000:1000  

    networks: [recyclarr]  

    volumes:  

      - ./config:/config  

    environment:  

      - TZ=America/Santiago  
```

--------------------------------

### recyclarr delete custom-formats examples

Source: https://recyclarr.dev/cli/delete/custom-formats

Examples of deleting custom formats: all with confirmation, specific names, all with --force to skip the prompt, and all with --preview to only show what would be deleted.

```bash
# Delete all custom formats from an instance named "my-radarr" with a confirmation prompt  

recyclarr delete custom-formats my-radarr --all  

  

# Delete two specific custom formats from an instance named "my-radarr"  with a confirmation prompt  

recyclarr delete custom-formats my-radarr "DTS-HD HRA" AMZN  

  

# Delete all custom formats without a confirmation prompt  

recyclarr delete custom-formats my-radarr --all --force  

  

# Preview the deletion of all custom formats from an instance named "my-sonarr-v4"  

recyclarr delete custom-formats my-sonarr-v4 --all --preview  
```

--------------------------------

### Sync Diagnostics error example

Source: https://recyclarr.dev/guide/sync-behavior

Example of Sync Diagnostics output showing an error for the radarr instance: a custom format with duplicate names. Provides the error message and suggested action.

```text
╭─Sync Diagnostics─────────────────────────────────────────────────────────────╮  
│ Errors                                                                       │  
│ ──────                                                                       │  
│   • [radarr] — Custom Format 'HDR10+' could not be synced because 2 CFs      │  
│     with that name exist in the service. Delete or rename the duplicates in  │  
│     Radarr so each name is unique.                                           │  
╰──────────────────────────────────────────────────────────────────────────────╯  

```

--------------------------------

### quality_definition type configuration example

Source: https://recyclarr.dev/cli/list/qualities

Example YAML configuration showing how the quality definition type is used. The type value must match one of the types listed by the 'recyclarr list qualities' command for the corresponding service.

```yaml
quality_definition:

  type: series
```

--------------------------------

### Join merge operation example

Source: https://recyclarr.dev/reference/configuration/include

Shows how the Join operation combines two sequences of mappings under quality_profiles based on a key (name or trash_id). Side A and B each contain a profile, and the result A + B merges matching profiles by combining their properties. The example also includes a second variant joining by trash_id.

```yaml
# A  
quality_profiles:  
  - name: Bluray|WEB-1080p  
    score_set: sqp-1-1080p  

# B  
quality_profiles:  
  - name: Bluray|WEB-1080p  
    min_format_score: 1000  
  - name: Remux + WEB 1080p  
    min_format_score: 0  

# A + B  
quality_profiles:  
  - name: Bluray|WEB-1080p  
    min_format_score: 1000  
    score_set: sqp-1-1080p  
  - name: Remux + WEB 1080p  
    min_format_score: 0  

```

```yaml
# A  
quality_profiles:  
  - trash_id: 64fb5f9858489bdac2af690e27c8f42f  
    min_format_score: 1000  

# B  
quality_profiles:  
  - trash_id: 64fb5f9858489bdac2af690e27c8f42f  
    upgrade:  
      until_score: 10000  

# A + B  
quality_profiles:  
  - trash_id: 64fb5f9858489bdac2af690e27c8f42f  
    min_format_score: 1000  
    upgrade:  
      until_score: 10000  

```

--------------------------------

### List available naming formats

Source: https://recyclarr.dev/guide/getting-started

Lists available naming formats for Radarr from the TRaSH Guides. Run this before adding a media_naming section to your config.

```bash
docker compose run --rm recyclarr list naming radarr
```

--------------------------------

### Create config from template hd-bluray-web

Source: https://recyclarr.dev/guide/getting-started

Generates a configuration file from the HD Bluray + WEB template. Run this command in the directory containing your docker-compose setup. It creates config/configs/hd-bluray-web.yml with pre-configured settings.

```bash
docker compose run --rm recyclarr config create --template hd-bluray-web
```

--------------------------------

### Before (v7.x): List command output

Source: https://recyclarr.dev/guide/upgrade-guide/v8.0

Before the v8.0 upgrade, list commands output plain text. This example shows the old format.

```text
List of Custom Formats in the TRaSH Guides:  

          - b124be9b146540f8e62f98fe32e49a2a # 1.0 Mono  
          - 820b09bb9acbfde9c35c71e0e565dad8 # 1080p  
```

--------------------------------

### quality_sort: top example

Source: https://recyclarr.dev/reference/configuration/quality-profiles

Example YAML configuration for the `quality_sort` property set to `top`. Explicitly specified qualities are sorted to the top of the list, while unspecified qualities appear at the bottom. Note that if qualities are removed instead of disabled, this can cause unwanted downgrades of movie files.

```yaml
quality_sort: top  

qualities:  

  - name: Remux-1080p  

  - name: Bluray-1080p  

    enabled: false  

  - name: Bluray-720p  

  - name: WEB 720p  

    qualities:  

      - WEBRip-720p  

      - WEBDL-720p  

  - name: DVD  

```

--------------------------------

### Config include examples with absolute and relative paths

Source: https://recyclarr.dev/reference/configuration/include

Shows two `config` include directives: one with an absolute path and one with a relative path. Relative paths are resolved relative to the app data directory, e.g., on Linux `/home/john/.config/recyclarr/includes/`.

```yaml
include:

  # An absolute include path

  - config: /home/john/my-include.yml



  # A relative include path

  # Equivalent absolute path is (on Linux):

  #   /home/john/.config/recyclarr/includes/my-include.yml

  - config: my-include.yml

```

--------------------------------

### Example: include.yml and config.yml before merge

Source: https://recyclarr.dev/reference/configuration/include

Two YAML files used to demonstrate the Join merge operation for custom_formats. The include.yml defines custom formats with trash_ids and assign_scores_to, while config.yml includes that file and overrides one custom format's score.

```yaml
# include.yml  

custom_formats:  

  - trash_ids:  

      - abc  

      - xyz  

    assign_scores_to:  

      - name: profile1  

      - name: profile2  

  

# config.yml  

include:  

  - config: include.yml  

  

custom_formats:  

  - trash_ids:  

      - abc  

    assign_scores_to:  

      - name: profile1  

        score: 50  
```

--------------------------------

### YAML Sequence Example

Source: https://recyclarr.dev/reference/configuration/include

Illustrates a YAML sequence, an ordered list of nodes. Used to understand Recyclarr's include merge behavior.

```yaml
- one  

- two  

- three  

```

--------------------------------

### YAML Mapping Example

Source: https://recyclarr.dev/reference/configuration/include

Illustrates a YAML mapping, a collection of key/value pairs. Both keys and values can be any node type.

```yaml
one: "one value"  

two: 2  

three: "3"  

```

--------------------------------

### Default recyclarr.yml path (Docker)

Source: https://recyclarr.dev/guide/file-structure

Example path for the default YAML configuration file `recyclarr.yml` when using the Docker configuration directory.

```text
/config/recyclarr.yml

```

--------------------------------

### Configure media_management with propers_and_repacks

Source: https://recyclarr.dev/reference/configuration/media-management

Example YAML configuration for the media_management section under radarr.movies. Sets propers_and_repacks to do_not_prefer, which disables built-in handling so Custom Format scores control upgrade behavior. Unspecified settings are not synced.

```yaml
radarr:

  movies:

    base_url: http://localhost:7878

    api_key: !secret radarr_api_key



    media_management:

      propers_and_repacks: do_not_prefer

```

--------------------------------

### Template Include Example

Source: https://recyclarr.dev/reference/configuration/include

Shows how to include YAML templates by ID from a resource provider's includes.json. The template IDs must match the service type (e.g., Sonarr templates cannot be used in Radarr configs).

```yaml
include:  

  # Includes YAML templates by ID from a resource provider's includes.json  

  - template: my-custom-quality-profile  

  - template: my-custom-formats  

```

--------------------------------

### Typical Recyclarr Docker directory structure

Source: https://recyclarr.dev/reference/config-examples

Shows the recommended directory layout for a Docker-based Recyclarr setup. recyclarr.yml and files in configs/ are auto-loaded; includes/ files are only loaded when referenced; state/, resources/, and logs/ are managed by Recyclarr.

```text
config/  

├── recyclarr.yml          # Main config (auto-loaded)  

├── secrets.yml            # API keys and URLs  

├── configs/               # Additional configs (auto-loaded)  

│   ├── sonarr.yml  

│   └── radarr.yml  

├── includes/              # Local include files (referenced, not auto-loaded)  

│   └── my-custom-cfs.yml  

├── state/                 # Sync state (managed by Recyclarr)  

├── resources/             # Git repos (managed by Recyclarr)  

└── logs/                  # Application logs  


```

--------------------------------

### YAML media_naming configuration for Sonarr

Source: https://recyclarr.dev/cli/list/naming

Example YAML configuration using the 'default' key from the 'Series Folder Format' table for Sonarr. The key is placed under the 'media_naming' property.

```yaml
# For Sonarr  
media_naming:  
  series: default  
```

--------------------------------

### Custom Format JSON Example (German-Language.json)

Source: https://recyclarr.dev/reference/settings/resource-providers

Minimal custom format JSON file defining a German language specification. The trash_id is used to reference the format in config.

```json
{  
  "trash_id": "my-german-language",  
  "name": "German Language",  
  "specifications": [  
    {  
      "name": "German",  
      "implementation": "LanguageSpecification",  
      "negate": false,  
      "required": true,  
      "fields": {  
        "value": 4  
      }  
    }  
  ]  
}  

```

--------------------------------

### Radarr YAML configuration with base_url path

Source: https://recyclarr.dev/guide/troubleshooting/errors

Example YAML configuration for Radarr that includes the /radarr path in the base_url to avoid the deserialization error.

```yaml
radarr:  

  my-instance:  

    base_url: http://hostname:7878/radarr  

    api_key: your_api_key  
```

--------------------------------

### Override guide properties

Source: https://recyclarr.dev/reference/configuration/quality-profiles

Overrides the guide's name and min_format_score for a trash_id-based profile. Explicit properties take precedence over guide values.

```yaml
quality_profiles:  

  - trash_id: 9a0e43cb7a892e3e9c4f2f5c5e0dcf8e  

    name: My Custom Profile Name   # Override guide's name  

    min_format_score: 100          # Override guide's value  

```

--------------------------------

### Configure Sonarr instance in recyclarr.yml

Source: https://recyclarr.dev/

Example recyclarr.yml configuration for a Sonarr instance. Defines the instance with base_url and api_key, then includes three pre-built templates for quality definitions, quality profile, and custom formats.

```yaml
sonarr:
  web-1080p-v4:
    base_url: http://localhost:8989
    api_key: !secret SONARR_API_KEY


    include:
      # Use pre-built templates for instant setup
      - template: sonarr-quality-definition-series
      - template: sonarr-v4-quality-profile-web-1080p
      - template: sonarr-v4-custom-formats-web-1080p
```

--------------------------------

### Example template YAML (radarr/templates/movies-hd.yml)

Source: https://recyclarr.dev/reference/settings/resource-providers/config-templates-structure

A complete, working template file for a Radarr movies HD configuration. It defines a radarr instance with base_url, api_key using a secret, quality definition, quality profiles, and custom formats with trash IDs and score assignments.

```yaml
# radarr/templates/movies-hd.yml
radarr:
  movies-hd:
    base_url: http://localhost:7878
    api_key: !secret radarr_api_key

    quality_definition:
      type: movie

    quality_profiles:
      - name: HD Movies
        reset_unmatched_scores:
          enabled: true
        upgrade:
          allowed: true
          until_quality: Bluray-1080p
          until_score: 10000
        min_format_score: 0
        quality_sort: top
        qualities:
          - name: Bluray-1080p
          - name: WEB 1080p
            qualities:
              - WEBDL-1080p
              - WEBRip-1080p

    custom_formats:
      - trash_ids:
          - ed38b889b31be83fda192888e2286d83  # BR-DISK
          - 90cedc1fea7ea5d11298bebd3d1d3223  # EVO (no WEBDL)
        assign_scores_to:
          - name: HD Movies
```

--------------------------------

### includes.json example

Source: https://recyclarr.dev/reference/settings/resource-providers/config-templates-structure

Maps include IDs to YAML file paths. Each entry requires an id and template path; hidden is optional and defaults to false.

```json
[  

  {  

    "id": "radarr-quality-hd",  

    "template": "radarr/includes/quality-profiles/hd-bluray.yml",  

    "hidden": false  

  },  

  {  

    "id": "radarr-quality-uhd",  

    "template": "radarr/includes/quality-profiles/uhd-bluray.yml",  

    "hidden": false  

  },  

  {  

    "id": "sonarr-quality-hd",  

    "template": "sonarr/includes/quality-profiles/tv-hd.yml",  

    "hidden": false  

  }  

]  
```

--------------------------------

### Add Supplemental Custom Formats for Radarr and Sonarr

Source: https://recyclarr.dev/reference/settings/resource-providers

Adds custom formats for both Radarr and Sonarr alongside official Trash Guides. Custom formats with the same Trash ID take precedence.

```yaml
resource_providers:  
  - name: my-language-cfs  
    type: custom-formats  
    path: /home/user/custom-formats/radarr  
    service: radarr  

  - name: my-sonarr-cfs  
    type: custom-formats  
    path: /home/user/custom-formats/sonarr  
    service: sonarr  

```

--------------------------------

### Settings file location (Docker path)

Source: https://recyclarr.dev/reference/settings

Shows the expected location of the settings.yml file in a Docker environment. Recyclarr will create this file if it does not exist, starting with default behavior.

```text
/config/settings.yml
```

--------------------------------

### Entry-level score with per-profile override

Source: https://recyclarr.dev/reference/configuration/custom-formats

Example showing an entry-level default score of 0 with a per-profile override of 100 for the REMUX-MULTi-VF-HD profile. The override takes precedence over the entry-level score.

```yaml
custom_formats:  

  - trash_ids:  

      - dc98083864ea246d05a42df0d05f81cc # x265 (HD)  

    score: 0  

    assign_scores_to:  

      - name: MULTi-VF-HD  

      - name: MULTi-VO-HD  

      - name: REMUX-MULTi-VF-HD  

        score: 100 # overrides the entry-level 0  
```

--------------------------------

### Add multiple quality profiles to one Radarr instance

Source: https://recyclarr.dev/reference/config-examples

Configure multiple TRaSH Guide quality profiles on a single Radarr instance using guide-backed quality profiles. Each profile references a trash_id and enables reset_unmatched_scores. The quality_definition type is set to movie.

```yaml
radarr:  

  movies:  

    base_url: !secret radarr_url  

    api_key: !secret radarr_apikey  

    delete_old_custom_formats: true  

  

    quality_definition:  

      type: movie  

  

    quality_profiles:  

      # HD Bluray + WEB (1080p)  

      - trash_id: d1d67249d3890e49bc12e275d989a7e9  # HD Bluray + WEB  

        reset_unmatched_scores:  

          enabled: true  

  

      # UHD Bluray + WEB (4K)  

      - trash_id: 64fb5f9858489bdac2af690e27c8f42f  # UHD Bluray + WEB  

        reset_unmatched_scores:  

          enabled: true  

  

      # Remux + WEB 1080p  

      - trash_id: 9ca12ea80aa55ef916e3751f4b874151  # Remux + WEB 1080p  

        reset_unmatched_scores:  

          enabled: true  

  

      # Remux + WEB 2160p  

      - trash_id: fd161a61e3ab826d3a22d53f935696dd  # Remux + WEB 2160p  

        reset_unmatched_scores:  

          enabled: true  

  

```

--------------------------------

### Example of verbose per-item change details

Source: https://recyclarr.dev/reference/settings/notifications

Shows the output format for 'verbose' verbosity, with statistics line followed by indented sub-bullets grouped by action (Created, Updated, Deleted). Item names are sorted alphabetically and empty action groups are omitted.

```text
### Instance: `radarr`  

  

Information:  

  

- Custom Formats Synced: 3  

  - Created: Obfuscated  

  - Updated: Bad Dual Groups  

  - Deleted: HDR10Plus Boost  

```

--------------------------------

### Configure custom trash-guides resource provider in settings.yml

Source: https://recyclarr.dev/reference/settings/resource-providers/trash-guides-structure

Configure a custom TRaSH Guides repository in settings.yml. The first block shows both supplemental (adds to official) and replacement (replace_default: true) modes. The second block shows using a local directory via the path key instead of clone_url.

```yaml
resource_providers:  

  # As a supplemental source (adds to official)  

  - name: my-guides  

    type: trash-guides  

    clone_url: https://github.com/yourname/my-guides.git  

    reference: main  

  

  # Or as a replacement (replaces official)  

  - name: my-guides  

    type: trash-guides  

    clone_url: https://github.com/yourname/my-guides.git  

    reference: main  

    replace_default: true  


```

```yaml
resource_providers:  

  - name: my-local-guides  

    type: trash-guides  

    path: /home/user/my-guides  


```

--------------------------------

### Sonarr Naming Override Example

Source: https://recyclarr.dev/reference/settings/resource-providers/override-examples

Defines custom naming schemes for Sonarr using dictionary keys. The 'default' keys override official TRaSH naming, while 'plex-tvdb' overrides the official key and 'my-compact' extends with a new option.

```json
{
  "season": {
    "default": "Season {season:00}"
  },
  "series": {
    "default": "{Series TitleYear}",
    "plex-tvdb": "{Series TitleYear} {tvdb-{TvdbId}}"
  },
  "episodes": {
    "standard": {
      "default": "{Series TitleYear} - S{season:00}E{episode:00} - {Episode CleanTitle}",
      "my-compact": "{Series Title} - {season:00}x{episode:00} - {Episode Title}"
    },
    "daily": {
      "default": "{Series TitleYear} - {Air-Date} - {Episode CleanTitle}"
    },
    "anime": {
      "default": "{Series TitleYear} - S{season:00}E{episode:00} - {absolute:000} - {Episode CleanTitle}"
    }
  }
}
```

--------------------------------

### Basic trash_id profile

Source: https://recyclarr.dev/reference/configuration/quality-profiles

Minimal configuration that uses a trash_id to pull profile settings from the guide. The name is optional and defaults to the guide's recommended name when omitted.

```yaml
quality_profiles:  

  - trash_id: 9a0e43cb7a892e3e9c4f2f5c5e0dcf8e  

```

--------------------------------

### Filesystem structure before recommended change

Source: https://recyclarr.dev/guide/upgrade-guide/v8.0

Shows the directory layout with an intermediate 'include' directory inside the includes directory. This is the before state for the recommended file structure change.

```text
.

├── configs/  
│   ├── config1.yml  
│   └── config2.yml  
└── includes/  
    └── include/  
        ├── my-include1.yml  
        └── my-include2.yml  

```

--------------------------------

### Configure a config-templates repository in settings.yml (supplemental and replacement options)

Source: https://recyclarr.dev/reference/settings/resource-providers/config-templates-structure

Shows two alternative configurations for adding a config-templates repository to resource_providers in settings.yml: one as a supplemental source and one as a replacement (with replace_default: true). Choose the option that fits your needs.

```yaml
resource_providers:  

  # As a supplemental source (adds to official)  

  - name: my-templates  

    type: config-templates  

    clone_url: https://github.com/yourname/my-templates.git  

    reference: main  

  

  # Or as a replacement (replaces official)  

  - name: my-templates  

    type: config-templates  

    clone_url: https://github.com/yourname/my-templates.git  

    reference: main  

    replace_default: true  
```