Package: excludarr
ExcludarrExcludarr is a CLI that interacts with Radarr and Sonarr instances. It completely manages you library in Sonarr and Radarr to only consist out of movies and series that are not present on any of the configured streaming providers. Excludarr can also re monitor movies and series if it is not available anymore on any of the configured streaming providers. You can also configure to delete the already downloaded files of the excluded entry to keep your storage happy! 🎉PrerequisitesPython 3.6 or DockerIf you have Sonarr: Sonarr V3 (version 2 is not working!)If you have Radarr: Radarr V3InstallationInstallation of excludarr can be done using pip.pipinstallexcludarrConfigurationTo configure the application make sure that one of the following files exists:/etc/excludarr/excludarr.yml
~/.config/excludarr/excludarr.yml
~/.excludarr/config/excludarr.yml
~/.excludarr.yml
./.excludarr.ymlThe application will read those configuration files in that order. So./.excludarr.ymlwill overwrite/etc/excludarr/excludarr.yml. For a full list of options and their description seeexcludarr-example.ymlin this repository.NOTE: To get a full list of available providers in your country, executeexcludarr providers listand copy the full name of the provider in your configuration.RadarrTheradarrsubcommands manages the library in your configured Radarr instance. Checkexcludarr radarr --helpfor a full list of options.ExcludeTo delete or disable monitoring of the movies in Radarr you can execute theexcludarr radarr excludecommand. You can determine to either delete the movie or change the status to not monitored. You can alo configure if you want to delete the associated files and to add an import exclusion to prevent future importing of the movie.By default no files are being deleted, you have to set the-dflag. To make the command non-interactive you can pass the-yflag to auto accept the confirmation question. To show the progress of the process you can pass the--progressflag to get a nice progress bar! Read the help page of the command carefully to adjust the command to your needs.$excludarrradarrexclude-adelete-d-e╷╷╷ReleaseDate│Title│UsedDiskspace│StreamingProviders
╶─────────────┼────────────────────────────────────────────┼────────────────┼─────────────────────────────────╴2021-11-04│RedNotice│0.00GB│Netflix2021-10-13│TheLastDuel│0.00GB│AppleiTunes2021-11-04│Amina│0.00GB│Netflix2021-11-25│Apex│12.00GB│AppleiTunes2021-11-25│ABoyCalledChristmas│0.00GB│Netflix2012-06-27│TheAmazingSpider-Man│0.00GB│Netflix,AppleiTunes2017-07-05│Spider-Man:Homecoming│7.50GB│AppleiTunes2021-10-22│TheHarderTheyFall│0.00GB│Netflix2021-12-02│SingleAlltheWay│0.00GB│Netflix2021-05-19│F9│0.00GB│AppleiTunes2021-07-28│TheSuicideSquad│10.00GB│AppleiTunes2021-10-29│ArmyofThieves│0.00GB│Netflix2021-08-09│PAWPatrol:TheMovie│0.00GB│AppleiTunes2018-12-06│Spider-Man:IntotheSpider-Verse│20.00GB│AppleiTunes2002-05-01│Spider-Man│0.00GB│Netflix,AppleiTunes
╶─────────────┼────────────────────────────────────────────┼────────────────┼─────────────────────────────────╴│TotalUsedDiskspace│49.50GB│╵╵╵
Areyousureyouwanttodeletethelistedmovies?[y/n](n):y
SuccesfullydeletedthemoviesfromRadarr!NOTE: If you want to exclude any of the movies listed in the table, just copy the title and paste it in your configuration file underradarr -> excludes.Re-addTo re enable monitoring of not-monitored movies in Radarr that are not present anymore on any of the streaming providers, you can executeexcludarr radarr re-add. This will lookup all movies that are not monitored anymore in Radarr and check if they are still available on the configured streaming providers. If there is no match, the status of the movie will change to monitored. This is handy if you remove a streaming provider from the configuration, or if the movie is being deleted from a streaming provider.$excludarrradarrre-add╷ReleaseDate│Title
╶─────────────┼───────────────────────────────────────────╴2021-08-27│VacationFriends2021-10-13│TheLastDuel2021-09-01│Shang-ChiandtheLegendoftheTenRings2021-06-17│Luca2019-06-28│Spider-Man:FarFromHome2021-11-12│HomeSweetHomeAlone2021-07-07│BlackWidow2021-07-22│SnakeEyes:G.I.JoeOrigins2021-07-28│JungleCruise2020-08-04│Deathstroke:Knights&Dragons-TheMovie2021-05-19│F92021-07-28│TheSuicideSquad2021-08-09│PAWPatrol:TheMovie2021-09-03│Zone4142021-05-26│Cruella2021-07-15│SpaceJam:ANewLegacy2021-03-24│Godzillavs.Kong╵
Areyousureyouwanttoremonitorthelistedmovies?[y/n](n):y
SuccesfullychangedthestatusofthemovieslistedinRadarrtomonitored!NOTE: If you want to exclude any of the movies listed in the table, just copy the title and paste it in your configuration file underradarr -> excludes.SonarrThesonarrsubcommands manages the library in your configured Sonarr instance. Checkexcludarr sonarr --helpfor a full list of options.ExcludeTo delete or disable monitoring of the series in Sonarr you can execute theexcludarr sonarr excludecommand. You can determine to either delete the serie or change the status to not monitored. You can alo configure if you want to delete the associated files. Excludarr will exclude the whole serie, the season(s) or individually episodes.If you use the delete action (excludarr sonarr exclude -a delete) it will only delete the serie if the serie is ended and all seasons are streaming on a configured streaming service. A few examples with Netflix as a streaming provider.Serie Ahas a total of 5 seasons and has ended. If all 5 seasons are found on Netflix it will delete the serie from Sonarr.Serie Bhas a total of 4 seasons and it still continueing (season 5 will be released next year). If all 4 seasons are found on Netflix it will disable the monitoring of all 4 seasons, but it willnotdelete the whole serie from Sonarr.Serie Chas a total of 6 seasons and has ended. If only 5 seasons are found on Netflix, Excludarr will disable monitoring of the 5 seasons and willnotdelete the serie from Sonarr.By default no files are being deleted, you have to set the-dflag. To make the command non-interactive you can pass the-yflag to auto accept the confirmation question. To show the progress of the process you can pass the--progressflag to get a nice progress bar! Read the help page of the command carefully to adjust the command to your needs.excludarrsonarrexclude-adelete-d╷╷╷╷╷╷ReleaseYear│Title│UsedDiskspace│Seasons│Episodes│Providers│Ended
╶─────────────┼─────────────────────────────────────────────┼────────────────┼─────────────────────────────────────────────┼─────────────────────────────────────────────┼────────────────────┼──────╴2008│BreakingBad│454.00GB│Season1,Season2,Season3,Season4,││Netflix│Yes│││Season5│││2010│TheWalkingDead│0.00GB│Season1,Season2,Season3,Season4,││Netflix│No│││Season5,Season6,Season7,Season8,││││││Season9,Season10│││2016│StrangerThings│0.00GB│Season1,Season2,Season3││Netflix│No2012│Arrow│0.00GB│Season1,Season2,Season3,Season4,││Netflix│Yes│││Season5,Season6,Season7,Season8│││2004│Lost│0.00GB│Season1,Season2,Season3,Season4,││Videoland│Yes│││Season5,Season6│││2013│HouseofCards(US)│0.00GB│Season1,Season2,Season3,Season4,││Netflix│Yes│││Season5,Season6│││2011│Suits│30.00GB│Season1,Season2,Season3,Season4,││Netflix│Yes│││Season5,Season6,Season7,Season8,││││││Season9│││2013│Vikings│100.00GB│Season1,Season2,Season3,Season4,││Netflix│Yes│││Season5,Season6│││2014│TheFlash(2014)│0.00GB│Season1,Season2,Season3,Season4,│S08E01,S08E02,S08E03,S08E04,S08E05│Netflix│No│││Season5,Season6,Season7│││2013│OrangeIstheNewBlack│0.00GB│Season1,Season2,Season3,Season4,││Netflix│Yes│││Season5,Season6,Season7│││2011│BlackMirror│0.00GB│Season1,Season2,Season3,Season4,││Netflix│Yes│││Season5│││2013│RickandMorty│0.00GB│Season1,Season2,Season3,Season4,││Netflix│No│││Season5│││2005│TheOffice(US)│15.00GB│Season1,Season2,Season3,Season4,││Netflix,Videoland│Yes│││Season5,Season6,Season7,Season8,││││││Season9│││2010│Spartacus│30.00GB│Season1,Season3│S02E01,S02E02,S02E03,S02E04,S02E05,│Netflix│Yes││││S02E06││2017│Dark│0.00GB│Season1,Season2,Season3││Netflix│Yes
╶─────────────┼─────────────────────────────────────────────┼────────────────┼─────────────────────────────────────────────┼─────────────────────────────────────────────┼────────────────────┼──────╴│TotalUsedDiskspace│629.00GB││││╵╵╵╵╵╵
Areyousureyouwanttodeletethelistedseries?[y/n](n):y
Succesfullydeletedtheseriesand/orchangedthestatusofserveralseasonsandepisodeslistedinSonarrtonotmonitored!NOTE: If you want to exclude any of the series listed in the table, just copy the title and paste it in your configuration file undersonarr -> excludes.Re-addTo re enable monitoring of not-monitored series in Sonarr that are not present anymore on any of the streaming providers, you can executeexcludarr sonarr re-add. This will lookup all series/seasons/episodes that are not monitored anymore in Sonarr and check if they are still available on the configured streaming providers. If there is no match, the status of the serie will change to monitored. This is handy if you remove a streaming provider from the configuration, or if the movie is being deleted from a streaming provider.excludarrsonarrre-add╷╷╷╷ReleaseYear│Title│Seasons│Episodes│Ended
╶─────────────┼──────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────┼──────╴2010│TheWalkingDead│Season1,Season2,Season3,Season4,Season5,Season6,││No││Season7,Season8,Season9,Season10││2016│StrangerThings│Season1,Season2,Season3││No││Season7,Season8││2004│Lost│Season1,Season2,Season3,Season4,Season5,Season6││Yes2011│Suits│Season1,Season2,Season3,Season4,Season5,Season6,││Yes││Season7,Season8,Season9││2014│TheFlash(2014)│Season1,Season2,Season3,Season4,Season5,Season6,│S08E01,S08E02,S08E03,S08E04,S08E05│No││Season7││2013│OrangeIstheNewBlack│Season1,Season2,Season3,Season4,Season5,Season6,││Yes││Season7││2013│RickandMorty│Season1,Season2,Season3,Season4,Season5││No2005│TheOffice(US)│Season1,Season2,Season3,Season4,Season5,Season6,││Yes││Season7,Season8,Season9││1997│SouthPark│Season1,Season2,Season18,Season19,Season20,Season││No││21││2013│TheBlacklist│Season1,Season2,Season3,Season4,Season5,Season6,│S09E01,S09E02,S09E03│No││Season7,Season8││2015│BetterCallSaul│Season1,Season2,Season3,Season4,Season5││No2014│Gotham│Season1,Season2,Season4,Season5│S03E01,S03E02,S03E03,S03E04,S03E05,S03E06,S03E07,│Yes│││S03E08,S03E09,S03E10,S03E11,S03E12,S03E13,S03E14,││││S03E15,S03E16,S03E17,S03E18,S03E19,S03E20,S03E21│2005│Avatar:TheLastAirbender│Season1,Season2,Season3││Yes2014│Fargo│Season1,Season2,Season3,Season4││No╵╵╵╵
Areyousureyouwanttoremonitorthelistedseries?[y/n](n):y
SuccesfullychangedthestatusoftheserieslistedinSonarrtomonitored!NOTE: If you want to exclude any of the series listed in the table, just copy the title and paste it in your configuration file undersonarr -> excludes.DockerTo use this setup using Docker, you can use thehaijeploeg/excludarrcontainer. You can use the following environment variables:VariableDefaultDescriptionGENERAL_FAST_SEARCHtrueEnable or disable fast search, can betrueorfalse.GENERAL_LOCALEen_USThe locale to use, can also be a two letter country code.GENERAL_PROVIDERSNetflixComma seperated list of providers. e.g.GENERAL_PROVIDERS=netflix, amazon prime video.TMDB_API_KEY-Your TMDB API key. This setting is optional and only used in fallback scenario's.RADARR_URLhttp://localhost:7878The Radarr URL.RADARR_API_KEYsecretYour Radarr API Key.RADARR_VERIFY_SSLfalseTo enable SSL verify, can betrueorfalse.RADARR_EXCLUDE-Comma seperated list of movies to exclude in the process of Excludarr, e.g.RADARR_EXCLUDE=The Matrix, F9.SONARR_URLhttp://localhost:8989The Sonarr URL.SONARR_API_KEYsecretYour Sonarr API Key.SONARR_VERIFY_SSLfalseTo enable SSL verify, can betrueorfalse.SONARR_EXCLUDE-Comma seperated list of series to exclude in Excludarr, e.g.SONARR_EXCLUDE=Breaking Bad, Game of Thrones.CRON_MODEfalseWether to run the docker container using cron. This is useful for docker-compose.You can put those variables in a env file (e.g.excludarr.env) and use it in a command (recommended way). Look thedocker_example.envfor an example. If you have set your variables properly, you can execute excludarr in docker by just adding the command and paramaters at the end of the docker command. Example:dockerrun-it--rm--env-fileexcludarr.envhaijeploeg/excludarr:latestradarrexclude-adelete-d-e--progress
dockerrun-it--rm--env-fileexcludarr.envhaijeploeg/excludarr:latestsonarrexclude-anot-monitoredDocker composeExcludarr can run in cron mode using docker-compose. Using this method the container keeps running and wakes up when you want to run a scheduled command. To use this method you can create acrontabfile and mount it to/etc/excludarr/crontabin the container. Make sure you run the command unattended (with the-yflag!)$catcrontab# minute    hour    day   month   weekday   command01***excludarrsonarrexclude-adelete-d-e-y02***excludarrradarrexclude-adelete-d-e-yYour docker-compose file can look likethis. Make sure you set theCRON_MODEenvironment setting!$catdocker-compose.yml

version:"3"services:excludarr:image:haijeploeg/excludarrcontainer_name:excludarrenvironment:-GENERAL_FAST_SEARCH=true-GENERAL_LOCALE=en_NL-GENERAL_PROVIDERS=netflix,amazonprimevideo-RADARR_URL=http://radarr.example.com:7878-RADARR_API_KEY=secret-RADARR_VERIFY_SSL=false-SONARR_URL=http://sonarr.example.com:8989-SONARR_API_KEY=secret-SONARR_VERIFY_SSL=false-SONARR_EXCLUDE="Queen of the South, Breaking Bad"-CRON_MODE=truevolumes:-./crontab:/etc/excludarr/crontabrestart:unless-stoppedWith the above configuration the container will executeexcludarr sonarr exclude -a delete -d -e -yevery day at 01:00 andexcludarr radarr exclude -a delete -d -e -yevery day at 02:00.FAQBelow are some frequently asked questions. Please look if your question is listed below before you submit an issue.Q:I used the--legacyflag before, where can I find it in excludarr v1.0.0?A:Excludarr will now automatically fall back to the legacy delete option if a bulk delete is not possible.Q:Where is thecheckcommand?A:The check command has been replaced byre-add.Q:When excluding series there are no seasons or episodes displayed, what will excludarr do?A:When there are no seasons and episodes displayed this means that excludarr will disable monitoring of the serie if the serie is not ended yet. When a serie is ended and the action was delete, Excludarr will delete the whole serie. When a serie is ended and the action is not-monitored, Excludarr will disable monitoring of the whole serie.Q:Can I also exclude movies and series from being processed by Excludarr?A:Yes, by using theexcludesetting in the configuration file. You can set theexcludesetting under theradarrandsonarrconfiguration section. You can see the exampleexcludarr-example.ymlfile in this repo.Q:How can I know what providers I can use in the configuration file?A:You can list all the available providers for your specific locale using theexcludarr providers listcommand. This should give you a list of all the available providers. Simply copy the full name and insert it in the configuration file.Q:Does excludarr still support Sonarr V2?A:No, Sonarr V2 is EOL (End Of Life) and therefor not supported by Excludarr. Please upgrade to Sonarr V3 by reading theupgrade guide