Plugins

Plugins provide most of the functionality in FlexGet. Plugins usually create, manipulate or download entries but they can also change how FlexGet operates.

Most plugins are enabled by placing a keyword and required settings in a configuration file. All these plugins are included in the FlexGet package with the exception of ones in 3rd party plugins section.

Indentation in examples

All configuration examples are assumed to be placed under a task. So if documentation has example:

series:
  - name

In full configuration this goes into:

tasks:
  task_name:
    rss: http://example.com
    series:
      - name

This makes examples more compact and reduces unnecessary boilerplate.

Inputs

Produce entries from external source.
Most requests are cached so there is no penalty for example using same RSS URL multiple times in the configuration.

Keyword	Description
apple_trailers	Get movie trailers from Apple.com
csv	Parse any CSV-file
discover	Produce entries from search results.
emit_movie_queue	NEW Emit your movie_queue, useful for example with discover.
find	NEW Search through a local directory looking for files as a input.
from_deluge	NEW Use torrents loaded in a Deluge daemon as input.
from_transmission?	NEW Use torrents loaded in Transmission as input.
html	Parse any HTML-page.
imdb_list	Use movies in your IMDb list as an input (eg. watchlist, rating history).
inputs	Configure the same input plugin multiple times in one task.
listdir	Use any local directory listing as a input.
plex	NEW Produce entries for shows present in a ​Plex Media Server section.
pogcal	NEW Produce entries for shows marked on your ​pogdesign calendar.
rlslog	Parse ​http://rlslog.net category.
rottentomatoes_list	Use movies from ​Rotten Tomatoes lists.
rss	Parse RSS-feed.
scenereleases	Parse ​http://scenereleases.info.
tail	Tail a log file (eg. irc logs)
text	Parse any text data
thetvdb_favorites	Produce an entry for all shows you have marked as favorites at ​http://thetvdb.com.
trakt_list	NEW Create entries from one of your trakt.tv lists.
tvt	BROKEN Parse ​http://tvtorrents.com.
regexp_parse	Use regular expressions to parse text from a web resource or file

Filters

Reject or Accept entries based on given rules. A single task may have any number of filters.
If you plan to use multiple filters per task, you should look at filtering operations to understand how they work.

Keyword	Description
accept_all	Accept all entries.
all_series	Accepts any entry that appears to be an episode of a series.
content_filter	Reject based on filenames within torrents.
content_size	Reject torrents and nzb's that do not meet size requirements.
crossmatch	Accept/reject based on other inputs (eg. imdb_list watchlist, ratings history).
exists	Reject entries based on existing files in filesystem.
exists_series	Reject entries based on existing series in filesystem.
exists_movie	Reject entries based on existing movies in filesystem.
if	Filter based on simple python statements.
imdb	Accept movie entries based on imdb details.
imdb_required	Reject imdb incompatible entries.
limit_new	Allow only given number of entries to pass per execution.
movie_queue	Accept movies from movie queue.
magnets	Rejects entries with only magnet links.
only_new	Causes all entries that were in the task on the previous run to be rejected at the input phase.
private_torrents	Reject private or public torrents.
proper_movies	Keep track of downloaded movies and force re-download proper versions.
quality	Reject entries not of the specified quality.
regexp	Reject, Accept entries by using regular expression.
reject_failed	Reject entries that have failed too many times in the past. Builtin
require_field	Reject entries that do not have the specified fields.
rottentomatoes	Accept movie entries based on Rotten Tomatoes details.
seen_movies	Rejects already downloaded movies (detected by imdb-link).
seen_info_hash	Rejects already downloaded torrents (detected by torrent info hash). Builtin
seen	Reject already downloaded entries. Builtin
series	Accept TV-series episodes. Quality and episode number aware.
series_premiere	Accept any entry that appears to be the first episode of a series.
torrent_alive	Reject any torrents that do not have an active tracker with seeds.

Site integration & Auto configuration

Keyword	Description
imdb_lookup	Enable imdb parsing for imdb fields on-demand.
myepisodes	NEW Mark accepted episodes as acquired on MyEpisodes.
rottentomatoes_lookup	Enable Rotten Tomatoes parsing for Rotten Tomatoes fields on-demand.
thetvdb_lookup	Fetch series information from thetvdb.
tmdb_lookup	Enable ​http://www.themoviedb.org/ parsing for imdb fields on-demand.
trakt_acquired	NEW Mark accepted episodes/movies as acquired on trakt.tv.
pogcal_acquired	NEW Mark accepted episodes on ​pogdesign TV calendar

These plugins configure other plugins from external sources like 3rd party sites.

Keyword	Description
import_series	Configures the series plugin with all the shows given by any input plugin (eg. listdir, rss).

Outputs

Execute operation(s) on accepted entries.

Keyword	Description
deluge	Pass torrents directly to deluge bittorrent client.
download	Download passed entries into given path.
email	UPDATED Send email when new content is passed.
exec	Executes commands on entries.
notifymyandroid	NEW Send notifications to android.
make_html	Generate HTML file from passed entries.
make_rss	Generate RSS-feed file from passed entries.
move	NEW Move local files.
nzbget	NEW Download nzbs with nzbget.
prowl	Send prowl notifications (iPhone).
pushover	NEW Send Pushover notifications (iPhone and Android).
rapidpush	NEW An easy-to-use push notification service. (Android).
pyload	NEW ​http://pyload.org/.
rtorrent_magnet	NEW Handles magnet URI's and produces rTorrent compatible torrent files (0.8.9+)
sabnzbd	Download nzbs with SABnzbd.
transmission	Pass entries' url to transmission, supporting magnet links.
queue_movies	NEW Add to movie queue.
notify_osd	NEW Send notifications to notify-osd.(linux only. Ubuntu tested)

Modify / Other

Keyword	Description
add_trackers	Add trackers to torrents.
archive	UPGRADED Archive all seen entries for searchable database for later retrieval.
cookies	UPGRADED Use FireFox3 cookies.
delay	Adds artificial delay into a task.
disable_builtins	Disable builtin plugin(s) from a task.
disable_plugin	Disable plugins from presets.
domain_delay	NEW Sets a minimum interval between requests to specific domains.
extension	Force a file extension.
formlogin	Log in to web site via login form.
free_space	Abort task when drive space is low.
headers	Modify HTTP headers.
include	Include configuration from another yaml file.
interval	Maintain minimum poll interval for the task.
manipulate	Allows regexp manipulation for entries.
manual	NEW Only run the task when explicitly specified.
pathscrub	NEW Cleans invalid characters from generated path/file names. (Used by other plugins that generate files.)
path_by_ext	Change (download) path based on file-type (extension).
priority	Change task execution order.
proxy	NEW Use a proxy to access resources.
plugin_priority	Change plugin priorities.
remove_trackers	Remove trackers from a torrent.
preset	Provides global configuration and named presets.
set	Set 'path' or other info per task. Can be dynamic per entry.
sleep	Causes a pause to occur before execution of a task.
sort_by	Sort entries in a task.
torrent_scrub	Removes non-standard keys like libtorrent resume information from downloads (which prevents the torrent from properly starting in Rtorrent).
urlrewrite	User regexp for URL Rewriting.
urlrewrite_search	Search for download URL from supported sites.
verify_ssl_certificates	Can turn off SSL certificate verification on a task.

Metainfo

These are usually automatic (Builtin) plugins which provide metainfo (fields) to Entry.

metainfo_quality?	Parses quality from the entry.
metainfo_task?	Populates task field for entries.
metainfo_series?1	Populates series related fields for entries, even without series plugin.
metainfo_imdb?	Detects imdb urls from description.

^{1. Not a builtin, configuration required to enable.}

Search

search_rss?

Search with parametrized rss feed.

Command line plugins

--cli-config	Allow using values from commandline in YML-configuration file.
--dump?	Display all entries after task execution.
--task	Executes only the specified task(s)
--inject	Injects custom entry into task(s).
--try-regexp	Test how regexps work on task(s) interactively.

3rd party plugins

Plugins can be installed by simply placing them in ~/.flexget/plugins/

rtorrent	NEW Scan (parts of) your rtorrent session.
​my_movie_filter	An extremely specific custom movie filter by atlanta800.
​flexget-twitter	NEW Twitter output plugin, allowing posting to twitter when entries are accepted.
jdownloader	jDownloader output - perhaps included in the core package sooner or later.