### Configure Git and Local Resource Providers

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/configuration.mdx

Example showing how to configure both a Git-based resource provider for TRaSH Guides and a local directory provider for custom formats.

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

  # Local directory provider (custom-formats)
  - name: my-language-cfs
    type: custom-formats
    path: /home/user/custom-formats/radarr
    service: radarr
    replace_default: false
```

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

### Trash Guides Repository Directory Layout

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/trash-guides-structure.mdx

Example directory structure for a `trash-guides` compatible repository. Shows the placement of `metadata.json` and various resource JSON files.

```txt
my-guides-repo/
├── metadata.json                    # Required: defines resource locations
├── docs/
│   ├── json/
│   │   └── radarr/
│   │       ├── cf/                  # Custom formats
│   │       │   ├── my-format-1.json
│   │       │   └── my-format-2.json
│   │       ├── cf-groups/           # Custom format groups
│   │       │   └── my-group.json
│   │       ├── quality-size/        # Quality sizes
│   │       │   └── movie.json
│   │       ├── quality-profiles/    # Quality profiles
│   │       │   └── my-profile.json
│   │       ├── quality-profile-groups/
│   │       │   └── my-qp-group.json
│   │       └── naming/              # Media naming
│   │           └── radarr-naming.json
│   └── Radarr/
│       └── Radarr-collection-of-custom-formats.md  # Optional: categories
└── ...
```

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

### Directory Structure Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/config-examples.mdx

A typical Recyclarr setup using Docker, illustrating the placement of configuration files, secrets, and other managed directories.

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

```

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

### Directory Layout Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/config-templates-structure.mdx

This is an example of the required directory structure for a config-templates compatible repository.

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

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

### Example settings.yml File Location

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/index.mdx

This is an example of where the `settings.yml` file should be located when using Docker.

```txt
/config/settings.yml
```

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

### Install Git using Winget CLI

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/installation/tips/git-install.mdx

Use Winget CLI to quickly install Git on Windows. Ensure you have Winget installed and configured.

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

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

### Start Local Development Server

Source: https://github.com/recyclarr/wiki/blob/master/CONTRIBUTING.md

Starts a local development server for live previewing changes. Changes are reflected live without a server restart.

```bash
yarn start
```

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

### Install Project Dependencies with Yarn

Source: https://github.com/recyclarr/wiki/blob/master/CONTRIBUTING.md

After installing tools with mise, run this command to install the project's specific dependencies.

```bash
yarn
```

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

### Verify Git Installation

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/installation/tips/git-install.mdx

After installing Git, open a new terminal window and run this command to verify the installation and check the version.

```cmd
git --version
```

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

### Example YAML Configuration for Sonarr

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-naming.mdx

An example demonstrating how to use a 'default' key obtained from listing Sonarr naming formats within your YAML configuration.

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

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

### Add Supplemental Git Repository for Trash Guides

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/index.mdx

Include a custom Git repository for TRaSH-style guides alongside official sources. The content from this repository will be combined with the default Trash Guides.

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

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

### Basic Service Configuration

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/basic.mdx

This is a basic example of how to configure a service instance. Ensure you replace placeholders with your actual instance details.

```yaml
service_type:
  instance_name:
    base_url: http://localhost:1234
    api_key: f7e74ba6c80046e39e076a27af5a8444
```

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

### Example Custom Format Configuration with Scores

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/custom-formats.mdx

This example demonstrates how to configure custom formats, assign them Trash IDs, set a default score, and override scores for specific quality profiles.

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

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

### Install Git using Chocolatey

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/installation/tips/git-install.mdx

Use Chocolatey, a popular package manager for Windows, to install Git. Ensure Chocolatey is installed.

```cmd
choco install git
```

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

### Sync Progress Table Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/sync-behavior.mdx

This example shows the output of a sync operation, illustrating the status of each pipeline for different instances. It uses symbols and colors to indicate success, failure, or skipped states.

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

           Custom  Quality Quality  Media
          Formats Profiles   Sizes Naming
✓ sonarr        ✓        ✓       ✓     --
✓ shows         ✓        ✓       ✓      2
✗ radarr        ✗       --       ✓     --

```

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

### Replace Default Trash Guides with a Fork

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/index.mdx

Configure to use a specific Git repository as the sole source for Trash Guides, replacing the default ones. Ensure the fork contains all necessary content.

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

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

### Example Include Directive

Source: https://github.com/recyclarr/wiki/blob/master/src/partials/_include-templates-dir.mdx

Demonstrates how to reference a local include template using a relative path within a configuration file.

```yaml
include:
  - config: bar/reusable.yml
```

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

### Install Project Dependencies with Mise

Source: https://github.com/recyclarr/wiki/blob/master/CONTRIBUTING.md

Use this command to install all project dependencies, including Node.js and Yarn, managed by mise.

```bash
mise install
```

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

### Example File Structure for Includes

Source: https://github.com/recyclarr/wiki/blob/master/src/partials/_include-templates-dir.mdx

Visualizes the expected directory structure for placing local include templates relative to the main configuration files.

```txt
.
├── configs/
│   └── foo.yml
└── includes/
    └── bar/
        └── reusable.yml
```

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

### Example Custom Format Configuration with Comments

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/custom-formats.mdx

Illustrates how to add comments to Trash IDs in the configuration for better readability and identification.

```yaml
trash_ids:
- 5d96ce331b98e077abb8ceb60553aa16 # dovi
- a570d4a0e56a2874b64e5bfa55202a1b # flac
```

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

### Configuration Example with Trash ID

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-quality-profiles.mdx

An example of how to use the `trash_id` obtained from the `list quality-profiles` command within the recyclarr configuration file.

```yaml
radarr:
  main:
    base_url: http://127.0.0.1:7878
    api_key: 2424b3643507485ea2e06382d3f0b8a3
    quality_profiles:
      - trash_id: d1d67249d3890e49bc12e275d989a7e9 # HD Bluray + WEB
```

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

### Example Configuration Snippet

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-qualities.mdx

An example of how a quality definition type is used in the configuration YAML. The `type` value must correspond to an output from the `recyclarr list qualities` command.

```yaml
quality_definition:
  type: series
```

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

### Custom Formats Merge Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/include.mdx

Demonstrates how custom formats are merged using a 'Join' operation, with overrides applied based on trash_id or name. This example shows the initial state of `include.yml` and `config.yml`, and the resulting merged `custom_formats` list.

```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
custom_formats:
  - trash_ids:
      - xyz
    assign_scores_to:
      - name: profile1
      - name: profile2

  - trash_ids:
      - abc
    assign_scores_to:
      - name: profile2

  - trash_ids:
      - abc
    assign_scores_to:
      - name: profile1
        score: 50

```

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

### YAML Sequence Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/include.mdx

Illustrates a YAML sequence, which is an ordered list of zero or more nodes.

```yaml
- one
- two
- three
```

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

### Example Include YAML

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/config-templates-structure.mdx

This YAML file represents a partial configuration for a quality profile that can be included in a main Recyclarr configuration.

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

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

### YAML Mapping Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/include.mdx

Demonstrates a YAML mapping, which is a collection of key/value pairs.

```yaml
one: "one value"
two: 2
three: "3"
```

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

### Install Recyclarr with Homebrew

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/installation/package-managers.mdx

Use these commands to tap the Homebrew repository and install Recyclarr on macOS and Linux.

```bash
brew tap recyclarr/recyclarr
brew install recyclarr
```

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

### Example recyclarr.yml Location

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/file-structure.mdx

Shows the expected path for the main recyclarr.yml configuration file, particularly in a Docker environment.

```txt
/config/recyclarr.yml
```

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

### Sync Diagnostics Error Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/sync-behavior.mdx

This example displays sync diagnostics, specifically detailing an error encountered during the Custom Formats pipeline. It explains the cause of the failure and provides a clear action to resolve the issue.

```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.                                           │
╰──────────────────────────────────────────────────────────────────────────────╯

```

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

### Media Management Configuration

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/include.mdx

Example of media management settings, where 'propers_and_repacks' uses a 'Replace' merge operation.

```yaml
media_management:
  propers_and_repacks: true
```

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

### Create Quality Profile Variants from TRaSH Guide

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/quality-profiles.mdx

Use the same `trash_id` multiple times to create variants of a guide-backed quality profile. Each variant inherits the guide's qualities and scores but can have independent overrides for settings like `upgrade` or `min_format_score`.

```yaml
quality_profiles:
  - trash_id: ca39fe2fec28ae7a6e8779404b614f80
    name: Any
    upgrade:
      allowed: true

  - trash_id: ca39fe2fec28ae7a6e8779404b614f80
    name: Arabic
    upgrade:
      allowed: false
    min_format_score: 100
```

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

### Combine Multiple Resource Providers

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/index.mdx

A comprehensive configuration example demonstrating the combination of official sources (implicit), a supplemental Git repository, local custom formats for Radarr and Sonarr, and custom config templates.

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

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

### List Quality Profiles for Sonarr

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-quality-profiles.mdx

Lists all available quality profiles for Sonarr from the TRaSH Guides. This is the basic usage of the command.

```bash
recyclarr list quality-profiles sonarr
```

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

### Configure Radarr Media Management

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/media-management.mdx

Example configuration for Radarr to manage media, including API key, base URL, and media management settings for Propers and Repacks.

```yaml
radarr:
  movies:
    base_url: http://localhost:7878
    api_key: !secret radarr_api_key

    media_management:
      propers_and_repacks: do_not_prefer
```

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

### List Quality Profiles for Radarr

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-quality-profiles.mdx

Lists all available quality profiles for Radarr from the TRaSH Guides. This is the basic usage of the command.

```bash
recyclarr list quality-profiles radarr
```

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

### Use Local Directory as Trash Guides Source

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/trash-guides-structure.mdx

Configure Recyclarr to use a local directory as a source for trash-guides metadata.

```yaml
resource_providers:
  - name: my-local-guides
    type: trash-guides
    path: /home/user/my-guides
```

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

### Add Supplemental Trash Guides Repository

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/trash-guides-structure.mdx

Configure Recyclarr to use a custom trash-guides repository as an additional source of metadata.

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

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

### Add Multiple Quality Profiles

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/config-examples.mdx

Configure multiple TRaSH Guide profiles on a single Radarr or Sonarr instance using guide-backed quality profiles. This is the recommended approach for most users.

```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 Custom Formats Configuration

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-custom-formats.mdx

Demonstrates how to use custom format Trash IDs within the `custom_formats` section of your Recyclarr configuration YAML file.

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

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

### Download and Install Recyclarr

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/installation/manual-install.mdx

Downloads the Recyclarr binary from the URL stored in RECYCLARR_URL, extracts it, and places it in /usr/local/bin. The --overwrite flag is used for upgrades.

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

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

### List Custom Formats for Sonarr

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-custom-formats.mdx

Lists all available custom formats from the TRaSH Guides for Sonarr. This output is suitable for human readability.

```bash
recyclarr list custom-formats sonarr
```

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

### List Available Recyclarr Templates

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/getting-started.mdx

Use this command to see the quality profile templates provided by Recyclarr that match TRaSH Guide profiles.

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

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

### includes.json Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/config-templates-structure.mdx

This JSON file maps include IDs to their corresponding YAML file paths within the repository. Use this to define reusable configuration snippets.

```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
  }
]
```

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

### Replace Default Trash Guides Repository

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/trash-guides-structure.mdx

Configure Recyclarr to use a custom trash-guides repository, replacing the default official source.

```yaml
resource_providers:
  # 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
```

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

### Join Merge Operation Example (by trash_id)

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/include.mdx

Shows the 'Join' merge operation for guide-backed quality profiles, using 'trash_id' as the key. Matching profiles are combined, and unmatched ones are added.

```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 Custom Formats for Radarr

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-custom-formats.mdx

Lists all available custom formats from the TRaSH Guides for Radarr. This output is suitable for human readability.

```bash
recyclarr list custom-formats radarr
```

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

### Create Starter Config with Custom Path

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/config/config-create.mdx

Specify a custom file path for the starter configuration file. The contents will be identical to the default, only the output location differs.

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

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

### Start Docker Compose in Background

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/installation/docker.mdx

Use this command to start the Docker Compose setup in detached mode, enabling cron mode for Recyclarr.

```bash
docker compose up -d
```

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

### Use a Specific Version of Trash Guides

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/index.mdx

Pin the resource provider to a specific commit hash or tag from a Git repository for stable and reproducible builds. This is useful for ensuring consistency across deployments.

```yaml
resource_providers:
  - name: stable-guides
    type: trash-guides
    clone_url: https://github.com/TRaSH-Guides/Guides.git
    reference: c611e9df00bf9261bddfc749219295fe189ae552
    replace_default: true
```

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

### Join Merge Operation Example (by name)

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/include.mdx

Illustrates the 'Join' merge operation for sequences of mappings, using 'name' as the key. Matches are combined, and non-matches are appended.

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

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

### Usage of recyclarr list

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/index.mdx

This is the base command for listing information. Use it with a specific command to get details about custom formats, quality profiles, and more.

```bash
recyclarr list <COMMAND>
```

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

### Example Configuration for Custom Format Groups

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-custom-format-groups.mdx

Demonstrates how to use custom format group trash IDs in your recyclarr configuration YAML file to add specific 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
```

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

### Custom Format Configuration Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/custom-formats.mdx

This YAML snippet demonstrates how to configure custom formats, including trash IDs and score assignments. It shows how to opt-out of or add custom format groups.

```yaml
service_type:
  instance_name:
    # Custom Format Configuration
    delete_old_custom_formats: false
    custom_formats:
      - trash_ids:
          - ed38b889b31be83fda192888e2286d83 # BR-DISK
          - 90cedc1fea7ea5d11298bebd3d1d3223 # EVO (no WEBDL)
          - 90a6f9a284dff5103f6346090e6280c8 # LQ
          - dc98083864ea246d05a42df0d05f81cc # x265 (720/1080p)
        assign_scores_to:
          - name: HD-1080p
          - trash_id: 64fb5f9858489bdac2af690e27c8f42f # UHD Bluray + WEB
            score: -1000
      - trash_ids:
          - 496f355514737f7d83bf7aa4d24f8169 # TrueHD ATMOS
          - 2f22d89048b01681dde8afe203bf2e95 # DTS X
        assign_scores_to:
          - name: SD

    # Custom Format Groups
    # Default groups auto-sync when using guide-backed quality profiles.
    # Use `skip` to opt-out, `add` to include non-default groups.
    custom_format_groups:
      skip:
        - 9d5acd8f1da78dfbae788182f7605200 # Opt-out of Audio Formats
      add:
        - trash_id: f737e18b5824d6ebb2d57b957ae2fd6c # Streaming Services (UK)
          assign_scores_to:
            - trash_id: 64fb5f9858489bdac2af690e27c8f42f # UHD Bluray + WEB
            - name: HD-1080p
        - trash_id: 9d5acd8f1da78dfbae788182f7605200 # Customize Audio Formats
          select:
            - 7357cf5161efbf8c4d5d0c30b4815ee2 # Add non-default CFs
          exclude:
            - dc98083864ea246d05a42df0d05f81cc # Remove unwanted defaults
        - trash_id: f4a0410a1df109a66d6e47dcadcce014 # [Optional] Miscellaneous
          select_all: true
          exclude:
            - c9eafd50846d299b862ca9bb6ea91950 # x265

```

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

### templates.json Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/config-templates-structure.mdx

This JSON file maps template IDs to their YAML file paths. These templates are used to scaffold complete configurations with the `recyclarr config create` command.

```json
[
  {
    "id": "radarr-movies-hd",
    "template": "radarr/templates/movies-hd.yml",
    "hidden": false
  },
  {
    "id": "sonarr-tv-hd",
    "template": "sonarr/templates/tv-shows.yml",
    "hidden": false
  }
]
```

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

### Consolidated Radarr Instances Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/config-examples.mdx

Combine configurations for multiple Radarr quality profiles targeting the same instance into a single instance definition. This is done by listing multiple quality profiles under one instance.

```yaml
radarr:
  movies:
    base_url: !secret radarr_url
    api_key: !secret radarr_apikey

    quality_definition:
      type: movie

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

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

```

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

### Override TRaSH Guide Profile Settings

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/quality-profiles.mdx

You can override specific properties inherited from a TRaSH Guide profile. Any explicitly defined property, such as `name` or `min_format_score`, takes precedence over the guide's values.

```yaml
quality_profiles:
  - trash_id: 9a0e43cb7a892e3e9c4f2f5c5e0dcf8e
    name: My Custom Profile Name   # Override guide's name
    min_format_score: 100          # Override guide's value
```

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

### Basic Include Directive

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/include.mdx

Demonstrates the basic structure for including configuration files. Ensure `service_type` and `instance_name` are correctly set up.

```yaml
service_type:
  instance_name:
    # Include Configuration
    include:
      - config: my-config.yml
```

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

### Define a Quality Profile with TRaSH Guide ID

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/quality-profiles.mdx

Use `trash_id` to sync quality profiles from a TRaSH Guide. This automatically imports qualities, score sets, custom formats, and languages. The profile name is derived from the guide if not explicitly set.

```yaml
quality_profiles:
  - trash_id: 9a0e43cb7a892e3e9c4f2f5c5e0dcf8e
```

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

### List Configuration Templates

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/config/config-list-templates.mdx

Use this command to list all available configuration templates. These templates are used with the `config create` command.

```bash
recyclarr config list templates
```

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

### Verbose Notification Example: Per-Item Details

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/notifications.mdx

Example of how per-item change details are displayed under the 'verbose' notification level for Custom Formats.

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

Information:

- Custom Formats Synced: 3
  - Created: Obfuscated
  - Updated: Bad Dual Groups
  - Deleted: HDR10Plus Boost
```

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

### Create Starter Config

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/config/config-create.mdx

Use this command to generate a default `recyclarr.yml` configuration file in the application's default config directory.

```bash
recyclarr config create
```

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

### Radarr Movie HD Template Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/config-templates-structure.mdx

This is an example of a Radarr configuration template for HD movies. It defines quality definitions, profiles, and custom formats.

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

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

### Verbose Notification Example: Truncated Item List

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/notifications.mdx

Example showing how the per-item change details are truncated when the list exceeds the 20-item cap, indicating the number of additional items.

```text
- Custom Formats Synced: 25
  - Updated: CF01, CF02, CF03, CF04, CF05, CF06, CF07, CF08, CF09, CF10, CF11, CF12, CF13, CF14, CF15, CF16, CF17, CF18, CF19, CF20 (and 5 more)
```

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

### Configuration Directory Structure

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/file-structure.mdx

This outlines the typical files and subdirectories found within the configuration directory.

```txt
<config directory>/
├── recyclarr.yml
├── configs/
├── includes/
├── settings.yml
└── state/
```

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

### List Available Naming Formats for Radarr

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/getting-started.mdx

Use this command to list all available media naming formats that can be synced for Radarr. This helps in choosing the correct format for your `media_naming` configuration.

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

```

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

### Create Config from Template and Overwrite

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/config/config-create.mdx

Use this command to create a configuration file from a template and forcefully overwrite any existing file with the same name. Exercise caution as this is a destructive operation.

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

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

### Sync with Custom Configuration

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/sync.mdx

Use this command to sync services using a specific YAML configuration file. If multiple files are needed, repeat the `-c` option for each file.

```bash
recyclarr sync --config ../myconfig.yml
```

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

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

### Markdown Admonition Example

Source: https://github.com/recyclarr/wiki/blob/master/CONTRIBUTING.md

Illustrates the correct spacing for markdown admonitions to prevent formatting issues.

```markdown
:::tip

This is a tip

:::
```

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

### YAML Scalar Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/include.mdx

Shows a YAML scalar, which is a single value node like a string, number, or boolean.

```yaml
delete_old_custom_formats: true
```

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

### Basic Sync Command

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/sync.mdx

Use this command to initiate a sync operation. By default, it syncs all configured services. You can optionally specify a service like 'radarr' or 'sonarr' to sync only that service.

```bash
recyclarr sync [service] [OPTIONS]
```

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

### Build Static Content

Source: https://github.com/recyclarr/wiki/blob/master/CONTRIBUTING.md

Generates static content for deployment. The output is placed in the 'build' directory.

```bash
yarn build
```

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

### Create Config from Single Template

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/config/config-create.mdx

Generate a configuration file based on a specified template. This is useful for creating configurations tailored to specific needs, such as 'uhd-bluray-web'.

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

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

### List Local Config Files

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/config/config-list-local.mdx

Use this command to display all configuration files found in the default YAML locations.

```bash
recyclarr config list local
```

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

### List Custom Format Groups for Sonarr

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-custom-format-groups.mdx

Use this command to list all available custom format groups for Sonarr from the TRaSH Guides.

```bash
recyclarr list custom-format-groups sonarr
```

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

### WEB-2160p Combined Configuration

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/guide-configs.mdx

Use this configuration for a combined WEB-2160p profile. Copy this configuration into your own configuration file.

```yaml
https://github.com/recyclarr/config-templates/blob/v8/sonarr/templates/web-2160p-combined.yml
```

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

### List Custom Format Groups for Radarr

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/list/list-custom-format-groups.mdx

Use this command to list all available custom format groups for Radarr from the TRaSH Guides.

```bash
recyclarr list custom-format-groups radarr
```

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

### Preview Sync for Radarr with Docker Compose

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/installation/docker.mdx

Perform a preview (dry run) synchronization for Radarr using `docker compose run`, along with debug logging. This allows you to see what changes would be made without actually applying them.

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

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

### Install Recyclarr Docker Service

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/getting-started.mdx

Add this service definition to your docker-compose.yml to run Recyclarr. Ensure volumes and user IDs are correctly mapped.

```yaml
services:
  recyclarr:
    image: ghcr.io/recyclarr/recyclarr:8
    container_name: recyclarr
    user: 1000:1000
    restart: unless-stopped
    environment:
      - TZ=America/New_York
    volumes:
      - ./config:/config
```

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

### WEB-2160p Alternative Configuration

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/guide-configs.mdx

Use this configuration for WEB-2160p content when an alternative profile is desired. Copy this configuration into your own configuration file.

```yaml
https://github.com/recyclarr/config-templates/blob/v8/sonarr/templates/web-2160p-alternative.yml
```

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

### List Include Templates

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/config/config-list-templates.mdx

Use this command with the `--includes` flag to list only the include templates. These are typically used with custom resource providers and the `include` property in configurations.

```bash
recyclarr config list templates --includes
```

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

### Replace Operation Example

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/configuration/include.mdx

Demonstrates a 'Replace' merge operation where value B completely overwrites value A. This is typically used for scalar values.

```yaml
delete_old_custom_formats: true
```

```yaml
delete_old_custom_formats: false
```

```yaml
delete_old_custom_formats: false
```

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

### Create Config from Template CLI

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/config-templates-structure.mdx

Use this command to create a new configuration file based on an existing template ID.

```bash
recyclarr config create -t radarr-movies-hd
```

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

### Sync All Services

Source: https://github.com/recyclarr/wiki/blob/master/docs/cli/sync.mdx

Execute this command to synchronize all configured services, including Radarr and Sonarr, if they are set up.

```bash
recyclarr sync
```

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

### Set Recyclarr Download URL

Source: https://github.com/recyclarr/wiki/blob/master/docs/guide/installation/manual-install.mdx

Set the RECYCLARR_URL environment variable to the download link of the desired release. This variable is used in the subsequent installation command.

```bash
export RECYCLARR_URL="Paste_URL_Here"
```

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

### Add Supplemental Custom Formats for Multiple Services

Source: https://github.com/recyclarr/wiki/blob/master/docs/reference/settings/resource-providers/index.mdx

Configure local custom formats for both Radarr and Sonarr, allowing them to be used alongside official guides.

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