series.md

title	description	published	date	tags	editor	dateCreated
series		true	2022-09-18 05:12:42 UTC		markdown	2022-09-18 04:54:29 UTC

CLI > series

View and manage the series plugin database.

Sub-commands

Sub-command	Option	Description/Example
list*		List a summary of the different series being tracked
	`(configured	unconfigured
	--premieres^†^	Limit list to series which only have episode 1 (and maybe also 2) downloaded
	--new <days>^†^	Limit list to series with a release seen in last 7 days. number of days can be overridden with DAYS
	--stale <days>^†^	Limit list to series which have not seen a release in 365 days. number of days can be overridden with DAYS
	`--sort-by (name	age)`^†^
	--descending^†^	Sort in descending order
	--ascending^†^	Sort in ascending order
show*		Show the releases FlexGet has seen for a given series
	<series name>	Name of the series
	`--sort-by (age	identifier)`^†^
	--descending^†^	Sort in descending order
	--ascending^†^	Sort in ascending order
begin		Set the episode to start getting a series from (use forget to remove it)
	<series name>	Name of the series
	<episode_id>	Episode or season ID to start getting the series from (e.g. S02E01, 2013-12-11, or 9, depending on how the series is numbered, or S02 for season)
forget		Removes episodes, seasons, or a whole series from the entire database (including seen plugin)
	<series name>	Name of the series
	<episode_id> [<episode_id> ...] <season_id> [<season_id> ...]	Episode or season ID(s) to forget (optional)
remove		Removes episodes, seasons, or a whole series from the series database only
	<series name>	Name of the series
	<episode_id> [<episode_id> ...] <season_id> [<season_id> ...]	Episode or season ID(s) to forget (optional)
add
	<series name>	Name of the series
	<episode_id> [<episode_id> ...] <season_id> [<season_id> ...]	Episode or season ID(s) to add
	--quality <quality_string>^†^	Quality string that is attached to each entity added
Includes/TableStylesDiv{.include}
Includes/EnvDiv{.include}

Environment Variables

Environment variables set option defaults for the subcommand noted, and are overridden by the corresponding flag(s) listed.

Subcommand	Variable	Possible Values	Description	Corresponding Argument(s)
show↑
	FLEXGET_SERIES_SHOW_SORTBY_FIELD	age, identifier	Sort option for releases.	--sort-by
list↑
	FLEXGET_SERIES_SHOW_SORTBY_ORDER	desc	Reverses the sort order.	--descending --ascending
	FLEXGET_SERIES_LIST_CONFIGURED	configured, unconfigured, all	Limit series displayed to those in the config or not.	positional: configured unconfigured all
	FLEXGET_SERIES_LIST_PREMIERES	yes	Limit series displayed to those with a maximum of two episodes downloaded.	--premieres
	FLEXGET_SERIES_LIST_STATUS	new, stale	Limit series displayed those with a release in the last 7 days (new) or without a release in the last 365 days (stale). The number of days can be customized with FLEXGET_SERIES_LIST_NUMDAYS.	--new --stale
	FLEXGET_SERIES_LIST_NUMDAYS	integer	The number of days used in the calculation for new or stale status.	<days> after --new or --stale
	FLEXGET_SERIES_LIST_SORTBY_FIELD	name, age	Sort option for series.	--sort-by
	FLEXGET_SERIES_LIST_SORTBY_ORDER	desc	Reverses the sort order.	--descending --ascending
add↑
	FLEXGET_SERIES_ADD_QUALITY	quality string	The quality that is attached to each entity added	--quality <quality_string>

Examples

#lists a summary of the different series being tracked
$ flexget series list

#sets the series "FooSeries" to start with episode one of season 6
$ flexget series begin FooSeries S06E01

#shows all releases for the show FooSeries
$ flexget series show FooSeries

#deletes the whole show FooSeries even from seen plugin
$ flexget series forget FooSeries