The documentation here is for an unreleased version of Recyclarr.
Visit the documentation site for the Current Version instead.Features
Compatibility
Recyclarr is compatible with the following services and versions.
| Service | Minimum Version |
|---|---|
| Sonarr | v4.0.0 |
| Radarr | v3.0.0 |
info
Sonarr v3 is no longer supported by Recyclarr starting with version v7.0!
Supported Features
A comprehensive list of features in Recyclarr.
Custom Formats
- Sync individual custom formats by trash ID from the TRaSH Guides.
- Sync custom format groups to adopt curated bundles of related custom formats.
- Assign scores from the guides to quality profiles of your choosing.
- Override guide scores with user-specified values.
- Option to enable automatic deletion of custom formats when removed from config or the guide.
Quality Profiles
- Create and modify quality profiles.
- Sync guide-backed quality profiles by trash ID for simplified configuration.
- Sync upgrade settings, qualities, and quality groups.
- Option to choose multiple sort algorithms for qualities.
Quality Definitions
- Guide-provided quality definitions, such as Anime, Series (Non-Anime), and Movies.
Media Naming
- Sync media naming formats from the guides, such as file and folder naming.
- Ability to exclude sync for specific naming formats to manage them manually.
- Preview functionality to show what will be synced before doing it.
Command Line Operations
- A
listcommand for showing available custom formats, media naming formats, and quality definitions available in the TRaSH Guides. - A
deletecommand providing ways to delete stuff from Radarr & Sonarr, such as custom formats. - A
configcommand for managing configuration YAML files, including creating new configuration files from pre-made templates.
YAML Features
- Use environment variables in your configuration via
!env_var. - Specify and store secret values (such as API keys) using
!secret. - Decompose YAML into multiple, reusable files via a YAML include feature.