Use the radarr.py CLI to query and administer Radarr
Radarr is managed through radarr.py, a CLI for Radarr's v3 API.
Run commands as:
radarr.py <command> <subcommand> [options]
In this repo, the script lives at scripts/radarr.py.
Set these before running commands:
RADARR_API_KEY (required): API key from RadarrRADARR_URL (optional): Base URL, defaults to http://localhost:7878--url <url> : Override Radarr URL--api-key <key> : Override API key--timeout <seconds> : HTTP timeout (default 30)--json : Output raw JSON instead of table/text outputsystem status : Show Radarr version and instance infomovie list|get|lookup|add|update|delete : Full movie managementcalendar list : Calendar entries for release windowsqueue list|status|get|remove : Download queue operationswanted missing : Wanted/missing movie viewcommand list|get|run : Inspect and trigger Radarr commandsresource list|get|create|update|delete : Generic CRUD for any resourcerequest <METHOD> <PATH> : Arbitrary API request escape hatchMutating commands require explicit confirmation:
movie update/delete require --yesqueue remove requires --yesresource update/delete require --yesrequest with PUT/PATCH/DELETE requires --yesShow server status:
radarr.py system status
List tracked movies:
radarr.py movie list
Find a movie by name:
radarr.py movie lookup "Dune"
Add a movie from lookup result index 0 and search immediately:
radarr.py movie add "Blade Runner" --select 0 --search
Trigger RSS sync:
radarr.py command run RssSync
Show queue in JSON:
radarr.py --json queue list --page-size 20
Generic request against any endpoint:
radarr.py request GET /system/status
Update resource with payload file:
radarr.py resource update qualityprofile 1 --data-file ./profile.json --yes
request can be either /foo (auto-prefixed to /api/v3/foo) or full /api/v3/foo../scripts/radarr.py unless you have radarr.py in your PATH.