recyclarr/README.md

# Recyclarr

[![GitHub License](https://img.shields.io/github/license/recyclarr/recyclarr)](https://github.com/recyclarr/recyclarr/blob/master/LICENSE)
[![Build Workflow Status](https://img.shields.io/github/actions/workflow/status/recyclarr/recyclarr/build.yml?branch=master&logo=githubactions)](https://github.com/recyclarr/recyclarr/actions/workflows/build.yml?query=branch%3Amaster)
[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/recyclarr_recyclarr?server=https%3A%2F%2Fsonarcloud.io&logo=sonarcloud)](https://sonarcloud.io/summary/new_code?id=recyclarr_recyclarr)
[![GitHub Release](https://img.shields.io/github/v/release/recyclarr/recyclarr?logo=github)](https://github.com/recyclarr/recyclarr/releases/)
[![Discord](https://img.shields.io/discord/492590071455940612?label=TRaSH-Guides&logo=discord)](https://discord.com/invite/Vau8dZ3)

A command-line application that will automatically synchronize recommended settings from the [TRaSH
guides](https://trash-guides.info/) to your Sonarr/Radarr instances.

## Features

Recyclarr supports Radarr and Sonarr (v4 and higher only). The following information can be synced
to these services from the TRaSH Guides. For a more detailed features list, see the [Features] page.

[Features]: https://recyclarr.dev/wiki/features/

- Quality Profiles, including qualities and quality groups
- Custom Formats, including scores (from guide or manual)
- Quality Definitions (file sizes)
- Media Naming Formats

## Read the Documentation

[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://recyclarr.dev/)

Main documentation is located in [the wiki](https://recyclarr.dev/wiki). Links provided below for
some main topics.

- [Installation](https://recyclarr.dev/wiki/installation/)
- [Command Line Reference](https://recyclarr.dev/wiki/cli/)
- [Configuration Reference](https://recyclarr.dev/wiki/yaml/config-reference/)
- [Settings Reference](https://recyclarr.dev/wiki/yaml/settings-reference/)
- [Troubleshooting](https://recyclarr.dev/wiki/troubleshooting/help/)
- [Upgrade Guides](https://recyclarr.dev/wiki/upgrade-guide/)
docs: Fix repo name and links in README.md 3 years ago			`# Recyclarr`
Complete rewrite using C# .NET Core 5 4 years ago
docs: Update README badges 9 months ago			`[![GitHub License](https://img.shields.io/github/license/recyclarr/recyclarr)](https://github.com/recyclarr/recyclarr/blob/master/LICENSE)`
			`[![Build Workflow Status](https://img.shields.io/github/actions/workflow/status/recyclarr/recyclarr/build.yml?branch=master&logo=githubactions)](https://github.com/recyclarr/recyclarr/actions/workflows/build.yml?query=branch%3Amaster)`
			`[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/recyclarr_recyclarr?server=https%3A%2F%2Fsonarcloud.io&logo=sonarcloud)](https://sonarcloud.io/summary/new_code?id=recyclarr_recyclarr)`
			`[![GitHub Release](https://img.shields.io/github/v/release/recyclarr/recyclarr?logo=github)](https://github.com/recyclarr/recyclarr/releases/)`
			`[![Discord](https://img.shields.io/discord/492590071455940612?label=TRaSH-Guides&logo=discord)](https://discord.com/invite/Vau8dZ3)`
docs(readme): add badges license, build status, release, and discord 4 years ago
docs(readme): Add link to trash guides in opening summary 3 years ago			`A command-line application that will automatically synchronize recommended settings from the [TRaSH`
			`guides](https://trash-guides.info/) to your Sonarr/Radarr instances.`
docs: Fix repo name and links in README.md 3 years ago
docs(wiki): Move features list to its own page The goal is to compact the README on the front page a little more. 3 years ago			`## Features`
Complete rewrite using C# .NET Core 5 4 years ago
feat!: Remove Sonarr v3 Support Includes complete removal of Release Profile support. 11 months ago			`Recyclarr supports Radarr and Sonarr (v4 and higher only). The following information can be synced`
			`to these services from the TRaSH Guides. For a more detailed features list, see the [Features] page.`
Complete rewrite using C# .NET Core 5 4 years ago
docs(readme): Add media naming to features list 1 year ago			`[Features]: https://recyclarr.dev/wiki/features/`
Complete rewrite using C# .NET Core 5 4 years ago
docs(readme): Update features list - Trim the list down - Add quality profile syncing 2 years ago			`- Quality Profiles, including qualities and quality groups`
			`- Custom Formats, including scores (from guide or manual)`
			`- Quality Definitions (file sizes)`
docs(readme): Add media naming to features list 1 year ago			`- Media Naming Formats`
docs(wiki): updates for radarr custom formats 4 years ago
docs(readme): New links, formatting adjustments 1 year ago			`## Read the Documentation`
Complete rewrite using C# .NET Core 5 4 years ago
docs: Update README badges 9 months ago			`[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://recyclarr.dev/)`

docs(readme): Delete a lot of docs and link to the new wiki site 2 years ago			`Main documentation is located in [the wiki](https://recyclarr.dev/wiki). Links provided below for`
			`some main topics.`
Complete rewrite using C# .NET Core 5 4 years ago
docs(readme): Delete a lot of docs and link to the new wiki site 2 years ago			`- [Installation](https://recyclarr.dev/wiki/installation/)`
docs: Fix broken wiki links in README 2 years ago			`- [Command Line Reference](https://recyclarr.dev/wiki/cli/)`
docs(readme): Add media naming to features list 1 year ago			`- [Configuration Reference](https://recyclarr.dev/wiki/yaml/config-reference/)`
			`- [Settings Reference](https://recyclarr.dev/wiki/yaml/settings-reference/)`
			`- [Troubleshooting](https://recyclarr.dev/wiki/troubleshooting/help/)`
docs(readme): New links, formatting adjustments 1 year ago			`- [Upgrade Guides](https://recyclarr.dev/wiki/upgrade-guide/)`