CLI Command Reference

Complete reference for all tsarr commands.

Global Options

These flags are available on all service resource actions:

Flag	Description
--json	Output as JSON
--table	Output as formatted table with colors and status indicators
--plain	Output as TSV (tab-separated, no colors, stable for piping)
--quiet / -q	Output only IDs
--no-header	Hide the table header row
--select	Cherry-pick fields in JSON mode (comma-separated, e.g. --select=title,year)
--yes / -y	Skip confirmation prompts
--dry-run	Show what would happen without executing
--instance / -i	Target a specific named instance (for multi-instance services)

Radarr (Movies)

tsarr radarr <resource> <action> [args]
Copy

Resource	Action	Args	Description
movie	list		List all movies
movie	get	<id>	Get movie by ID
movie	search	<term>	Search TMDB for movies
movie	add	[term] [--tmdb-id <id>] [--quality-profile-id <id>] [--root-folder <path>]	Add a movie interactively or by TMDB ID
movie	edit	<id> [--monitored] [--quality-profile-id] [--tags]	Edit a movie
movie	refresh	<id>	Refresh movie metadata
movie	manual-search	<id>	Trigger a manual release search
movie	delete	<id> [--delete-files] [--add-import-exclusion]	Delete a movie
moviefile	list	--movie-id <id>	List files for a movie
moviefile	get	<id>	Get movie file by ID
moviefile	delete	<id>	Delete a movie file from disk
profile	list		List quality profiles
profile	get	<id>	Get quality profile by ID
tag	create	<label>	Create a tag
tag	delete	<id>	Delete a tag
tag	list		List all tags
queue	list		Show download queue
queue	status		Queue overview
queue	delete	<id> [--blocklist] [--remove-from-client]	Remove from queue
queue	grab	<id>	Force download a queue item
rootfolder	list		List root folders
rootfolder	add	<path>	Add a root folder
rootfolder	delete	<id>	Delete a root folder
system	status		System information
system	health		Health check issues
history	list	[--since <date>] [--until <date>]	Recent activity (ISO 8601 date filtering)
calendar	list	[--start <date>] [--end <date>] [--unmonitored]	Upcoming movie releases
notification	list		List notification providers
notification	get	<id>	Get notification by ID
notification	add	<file>	Add notification from JSON file or stdin
notification	edit	<id> <file>	Edit notification (merges JSON)
notification	delete	<id>	Delete a notification
notification	test		Test all notifications
downloadclient	list		List download clients
downloadclient	get	<id>	Get download client by ID
downloadclient	add	<file>	Add download client from JSON file or stdin
downloadclient	edit	<id> <file>	Edit download client (merges JSON)
downloadclient	delete	<id>	Delete a download client
downloadclient	test		Test all download clients
blocklist	list		List blocked releases
blocklist	delete	<id>	Remove from blocklist
wanted	missing		Movies with missing files
wanted	cutoff		Movies below quality cutoff
importlist	list		List import lists
importlist	get	<id>	Get import list by ID
importlist	add	<file>	Add import list from JSON file or stdin
importlist	edit	<id> <file>	Edit import list (merges JSON)
importlist	delete	<id>	Delete an import list
customformat	list		List custom formats

Sonarr (TV Shows)

tsarr sonarr <resource> <action> [args]
Copy

Resource	Action	Args	Description
series	list		List all series
series	get	<id>	Get series by ID
series	search	<term>	Search for TV series
series	add	[term] [--tvdb-id <id>] [--quality-profile-id <id>] [--root-folder <path>]	Add a series interactively or by TVDB ID
series	edit	<id> [--monitored] [--quality-profile-id] [--tags]	Edit a series
series	refresh	<id>	Refresh series metadata
series	manual-search	<id>	Trigger a manual release search
series	delete	<id> [--delete-files] [--add-import-list-exclusion]	Delete a series
episode	list	[--series-id <id>]	List all episodes or filter by series
episode	get	<id>	Get episode by ID
episode	search	<id>	Trigger search for an episode
episodefile	list	--series-id <id>	List files for a series
episodefile	get	<id>	Get episode file by ID
episodefile	delete	<id>	Delete an episode file from disk
profile	list		List quality profiles
profile	get	<id>	Get quality profile by ID
tag	create	<label>	Create a tag
tag	delete	<id>	Delete a tag
tag	list		List all tags
queue	list	[--series-id <id>]	Show download queue
queue	status		Queue overview
queue	delete	<id> [--blocklist] [--remove-from-client]	Remove from queue
queue	grab	<id>	Force download a queue item
rootfolder	list		List root folders
rootfolder	add	<path>	Add a root folder
rootfolder	delete	<id>	Delete a root folder
system	status		System information
system	health		Health check issues
history	list	[--series-id <id>] [--since <date>] [--until <date>]	Recent activity (date filtering: ISO 8601)
calendar	list	[--start <date>] [--end <date>] [--unmonitored]	Upcoming episode releases
notification	list		List notification providers
notification	get	<id>	Get notification by ID
notification	add	<file>	Add notification from JSON file or stdin
notification	edit	<id> <file>	Edit notification (merges JSON)
notification	delete	<id>	Delete a notification
notification	test		Test all notifications
downloadclient	list		List download clients
downloadclient	get	<id>	Get download client by ID
downloadclient	add	<file>	Add download client from JSON file or stdin
downloadclient	edit	<id> <file>	Edit download client (merges JSON)
downloadclient	delete	<id>	Delete a download client
downloadclient	test		Test all download clients
blocklist	list		List blocked releases
blocklist	delete	<id>	Remove from blocklist
wanted	missing		Episodes with missing files
wanted	cutoff		Episodes below quality cutoff
importlist	list		List import lists
importlist	get	<id>	Get import list by ID
importlist	add	<file>	Add import list from JSON file or stdin
importlist	edit	<id> <file>	Edit import list (merges JSON)
importlist	delete	<id>	Delete an import list

Lidarr (Music)

tsarr lidarr <resource> <action> [args]
Copy

Resource	Action	Args	Description
artist	list		List all artists
artist	get	<id>	Get artist by ID
artist	search	<term>	Search for artists
artist	add	--term <term> [--foreign-artist-id <id>] [--quality-profile-id <id>] [--metadata-profile-id <id|name>] [--root-folder <path>] [--monitored <true|false>] [--no-search]	Search and add an artist
artist	edit	<id> [--monitored] [--quality-profile-id] [--tags]	Edit an artist
artist	refresh	<id>	Refresh artist metadata
artist	manual-search	<id>	Trigger a manual release search
artist	delete	<id>	Delete an artist
album	list	[--artist-id <id>]	List albums, optionally for one artist
album	get	<id>	Get album by ID
album	search	<term>	Search for albums
album	add	<file>	Add album from JSON file or stdin
album	edit	<id> <file>	Edit album (merges JSON)
album	delete	<id>	Delete an album
trackfile	list	--artist-id <id>	List files for an artist
trackfile	get	<id>	Get track file by ID
trackfile	delete	<id>	Delete a track file from disk
profile	list		List quality profiles
profile	get	<id>	Get quality profile by ID
metadataprofile	list		List metadata profiles
metadataprofile	get	--id <id>	Get metadata profile by ID
release	list	--album-id <id> | --artist-id <id>	List full release candidates
release	grab	--file <path|-> [--yes]	Grab a complete candidate from JSON
tag	create	<label>	Create a tag
tag	delete	<id>	Delete a tag
tag	list		List all tags
queue	list		Show download queue
queue	status		Queue overview
queue	delete	<id> [--blocklist] [--remove-from-client]	Remove from queue
queue	grab	<id>	Force download a queue item
rootfolder	list		List root folders
rootfolder	add	<path>	Add a root folder
rootfolder	delete	<id>	Delete a root folder
system	status		System information
system	health		Health check issues
history	list	[--since <date>] [--until <date>]	Recent activity (ISO 8601 date filtering)
calendar	list	[--start <date>] [--end <date>] [--unmonitored]	Upcoming album releases
notification	list		List notification providers
notification	get	<id>	Get notification by ID
notification	add	<file>	Add notification from JSON file or stdin
notification	edit	<id> <file>	Edit notification (merges JSON)
notification	delete	<id>	Delete a notification
notification	test		Test all notifications
downloadclient	list		List download clients
downloadclient	get	<id>	Get download client by ID
downloadclient	add	<file>	Add download client from JSON file or stdin
downloadclient	edit	<id> <file>	Edit download client (merges JSON)
downloadclient	delete	<id>	Delete a download client
downloadclient	test		Test all download clients
blocklist	list		List blocked releases
blocklist	delete	<id>	Remove from blocklist
wanted	missing		Albums with missing tracks
wanted	cutoff		Albums below quality cutoff
importlist	list		List import lists
importlist	get	<id>	Get import list by ID
importlist	delete	<id>	Delete an import list

Readarr (Books)

tsarr readarr <resource> <action> [args]
Copy

Resource	Action	Args	Description
author	list		List all authors
author	get	<id>	Get author by ID
author	search	<term>	Search for authors
author	add	<term>	Search and add an author interactively
author	edit	<id> [--monitored] [--quality-profile-id] [--tags]	Edit an author
author	refresh	<id>	Refresh author metadata
author	manual-search	<id>	Trigger a manual release search
author	delete	<id>	Delete an author
book	list		List all books
book	get	<id>	Get book by ID
book	search	<term>	Search for books
book	add	<file>	Add book from JSON file or stdin
book	edit	<id> <file>	Edit book (merges JSON)
book	delete	<id>	Delete a book
bookfile	list	--author-id <id>	List files for an author
bookfile	get	<id>	Get book file by ID
bookfile	delete	<id>	Delete a book file from disk
profile	list		List quality profiles
profile	get	<id>	Get quality profile by ID
tag	create	<label>	Create a tag
tag	delete	<id>	Delete a tag
tag	list		List all tags
queue	list		Show download queue
queue	status		Queue overview
queue	delete	<id> [--blocklist] [--remove-from-client]	Remove from queue
queue	grab	<id>	Force download a queue item
rootfolder	list		List root folders
rootfolder	add	<path>	Add a root folder
rootfolder	delete	<id>	Delete a root folder
system	status		System information
system	health		Health check issues
history	list	[--since <date>] [--until <date>]	Recent activity (ISO 8601 date filtering)
calendar	list	[--start <date>] [--end <date>] [--unmonitored]	Upcoming book releases
notification	list		List notification providers
notification	get	<id>	Get notification by ID
notification	add	<file>	Add notification from JSON file or stdin
notification	edit	<id> <file>	Edit notification (merges JSON)
notification	delete	<id>	Delete a notification
notification	test		Test all notifications
downloadclient	list		List download clients
downloadclient	get	<id>	Get download client by ID
downloadclient	add	<file>	Add download client from JSON file or stdin
downloadclient	edit	<id> <file>	Edit download client (merges JSON)
downloadclient	delete	<id>	Delete a download client
downloadclient	test		Test all download clients
blocklist	list		List blocked releases
blocklist	delete	<id>	Remove from blocklist
wanted	missing		Books with missing files
wanted	cutoff		Books below quality cutoff
importlist	list		List import lists
importlist	get	<id>	Get import list by ID
importlist	delete	<id>	Delete an import list

Prowlarr (Indexers)

tsarr prowlarr <resource> <action> [args]
Copy

Resource	Action	Args	Description
indexer	list		List all indexers
indexer	get	<id>	Get indexer by ID
indexer	add	<file>	Add indexer from JSON file or stdin
indexer	edit	<id> <file>	Edit indexer (merges JSON)
indexer	delete	<id>	Delete an indexer
indexer	test	[--id <id>]	Test one or all indexers
search	run	<term> or <query>	Search across all indexers
app	list		List connected applications
app	get	<id>	Get application by ID
app	add	<file>	Add application from JSON file or stdin
app	edit	<id> <file>	Edit application (merges JSON)
app	delete	<id>	Delete an application
app	sync		Trigger app indexer sync
indexerstats	list		Get indexer performance statistics
tag	create	<label>	Create a tag
tag	delete	<id>	Delete a tag
tag	list		List all tags
notification	list		List notification providers
notification	get	<id>	Get notification by ID
notification	add	<file>	Add notification from JSON file or stdin
notification	edit	<id> <file>	Edit notification (merges JSON)
notification	delete	<id>	Delete a notification
notification	test		Test all notifications
downloadclient	list		List download clients
downloadclient	get	<id>	Get download client by ID
downloadclient	add	<file>	Add download client from JSON file or stdin
downloadclient	edit	<id> <file>	Edit download client (merges JSON)
downloadclient	delete	<id>	Delete a download client
downloadclient	test		Test all download clients
system	status		System information
system	health		Health check issues

Bazarr (Subtitles)

tsarr bazarr <resource> <action> [args]
Copy

Resource	Action	Args	Description
series	list		List series with subtitle info
movie	list		List movies with subtitle info
episode	wanted		Episodes needing subtitles
provider	list		List subtitle providers
language	list		List available languages
language	profiles		List language profiles
system	status		System information
system	health		Health check issues
system	badges		Notification badges

qBittorrent (Torrent Client)

tsarr qbit <resource> <action> [args]
Copy

Resource	Action	Args	Description
torrents	list	[--filter <state>]	List torrents (filters: all, downloading, seeding, completed, paused, active, inactive, resumed, stalled, stalled_uploading, stalled_downloading, errored)
torrents	pause	<hashes>	Pause torrents (comma-separated hashes or "all")
torrents	resume	<hashes>	Resume torrents (comma-separated hashes or "all")
torrents	delete	<hashes> [--delete-files]	Delete torrents (comma-separated hashes or "all")
status	show		Transfer info (speed, connections, DHT nodes)

Seerr (Media Requests)

tsarr seerr <resource> <action> [args]
Copy

Resource	Action	Args	Description
requests	list	[--filter <status>]	List media requests (filters: all, approved, available, pending, processing, unavailable, failed, deleted, completed)
requests	count		Get request count summary
requests	approve	<id>	Approve a request
requests	decline	<id>	Decline a request
search	query	<query>	Search for movies and TV shows
users	list		List all users
status	show		Server status and version

Jellyfin (Media Server)

tsarr jellyfin <resource> <action> [args]
Copy

Resource	Action	Args	Description
library	refresh		Trigger a full library scan
library	folders		List libraries (virtual folders)
library	add	--name <v> [--collection-type <v>] [--paths <v>] [--refresh]	Add a library (types: movies, tvshows, music, musicvideos, homevideos, boxsets, books, mixed)
library	remove	--name <v>	Remove a library (confirms)
item	list	[--search <v>] [--type <v>] [--parent <v>] [--user <v>] [--played] [--limit <n>]	List media items
item	get	--id <v> --user <v>	Get a media item by ID
item	refresh	--id <v> [--mode <v>] [--replace-metadata] [--replace-images]	Refresh item metadata (modes: None, ValidationOnly, Default, FullRefresh)
item	delete	--id <v>	Delete a media item — removes it from disk (confirms)
item	counts	[--user <v>]	Show library item counts
item	latest	--user <v> [--limit <n>]	List recently added items
item	nextup	--user <v> [--limit <n>]	List next-up episodes
item	resume	--user <v> [--limit <n>]	List in-progress (resumable) items
image	list	--id <v>	Artwork an item has, with dimensions — use to spot missing or poor covers
image	remote	--id <v> [--type <v>] [--provider <v>] [--all-languages] [--limit <n>]	Artwork candidates from metadata providers
image	providers	--id <v>	Artwork providers available for an item
image	set	--id <v> --type <v> --url <v>	Attach artwork from a URL, replacing the existing image
image	delete	--id <v> --type <v> [--index <n>]	Remove artwork (confirms)
watched	status	--id <v> --user <v>	Show watched state for an item
watched	mark	--id <v> --user <v>	Mark an item as played
watched	unmark	--id <v> --user <v>	Mark an item as unplayed
watched	favorite	--id <v> --user <v>	Mark an item as a favorite
watched	unfavorite	--id <v> --user <v>	Remove an item from favorites
session	list	[--active-within <n>]	List active sessions
session	play	--id <v> --items <a,b> [--mode <v>] [--position <n>]	Start playback (modes: PlayNow, PlayNext, PlayLast, PlayInstantMix, PlayShuffle)
session	pause	--id <v>	Pause playback on a session
session	unpause	--id <v>	Resume playback on a session
session	stop	--id <v>	Stop playback on a session (confirms)
session	seek	--id <v> --position <n>	Seek to a position (--position is in seconds)
session	message	--id <v> --text <v> [--header <v>] [--timeout <n>]	Display a message on a session
session	command	--id <v> --command <v>	Send a general command (volume, navigation, subtitles)
session	system	--id <v> --command <v>	Send a system command to a session
session	display	--id <v> --item <v> --name <v> --type <v>	Show an item's detail page on a session
session	add-user	--id <v> --user <v>	Add a user to a session
session	remove-user	--id <v> --user <v>	Remove a user from a session
playlist	create	--name <v> --user <v> [--items <a,b>] [--type <v>]	Create a playlist
playlist	items	--id <v> --user <v> [--limit <n>]	List the items in a playlist
playlist	add	--id <v> --items <a,b> --user <v>	Add items to a playlist
playlist	remove	--id <v> --entries <a,b>	Remove entries by PlaylistItemId from playlist items (confirms)
collection	create	--name <v> [--items <a,b>] [--parent <v>]	Create a collection
collection	add	--id <v> --items <a,b>	Add items to a collection
collection	remove	--id <v> --items <a,b>	Remove items from a collection (confirms)
user	list		List users
user	get	--id <v>	Get a user by ID
task	list		List scheduled tasks
task	start	--id <v>	Start a scheduled task
task	stop	--id <v>	Stop a running scheduled task
search	query	--query <v> [--type <v>] [--limit <n>]	Search for items
system	status		Show server status
system	activity	[--limit <n>]	Show the activity log

Jellyfin returns PascalCase JSON, so table columns and --select use PascalCase field names (Id, Name, Type) rather than the camelCase used by Servarr services.

Artwork: image set --url accepts any reachable image URL, not just the candidates from image remote. Note that image remote reports Width/Height on Jellyfin 10.11 but not on 12.0, even though the API schema declares them — rank candidates by CommunityRating when dimensions are absent. The image serving endpoints (GET /Items/{id}/Images/..., which return raw bytes) are deliberately not wrapped.

Not available: there is no playlist get or playlist move. Jellyfin's GetPlaylist and MoveItem endpoints require a user-context token and expose no userId parameter, so they return HTTP 400 under the API-key authentication tsarr uses (verified against both 10.11.11 and 12.0). Read a playlist's details with tsarr jellyfin item get --id <playlistId> --user <userId> — a playlist is an item.

--user is required on user-scoped commands. Jellyfin's OpenAPI spec marks userId optional on these endpoints, but the server returns HTTP 400 without it when authenticating with an API key (verified against both 10.11.11 and 12.0). Tsarr requires it so you get a clear prompt instead of a confusing API error. Get IDs from tsarr jellyfin user list.

Utility Commands

Doctor

Test connectivity to all configured services:

tsarr doctor
Copy

Config

Manage CLI configuration:

tsarr config init                    # Interactive setup
tsarr config set <key> <value>       # Set a config value
tsarr config get <key>               # Get a config value
tsarr config show                    # Show full merged config
Copy

See CLI Configuration for details.

Completions

Generate shell completions:

tsarr completions bash
tsarr completions zsh
tsarr completions fish
Copy