Plugins
0.9.x users should look here.
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.
Indentation in examples
All configuration examples are assumed to be placed under a feed. So if documentation has example:
series: - name
In full configuration this goes into:
feeds:
feed_name:
rss: http://example.com
series:
- name
This makes examples more compact and reduces unnecessary boilerplate.
Inputs
Produce entries from external source.
| Keyword | Description |
| csv | Parse any CSV-file |
| html | Parse any HTML-page. |
| listdir | NEW Use any local directory listing as a input. |
| rlslog | Parse http://rlslog.net category. |
| rss | Parse RSS-feed. |
| scenereleases | Parse http://scenereleases.info. |
| text | Parse any text data |
| tvt | BROKEN Parse http://tvtorrents.com. |
Filters
Reject or Accept entries based on given rules. Single feed may have any number of filters.
If you plan to use multiple filters per feed, you should look filtering operations to understand how they work.
| Keyword | Description |
| accept_all | Accept all entries. |
| content_size | NEW Reject torrents and nzb's that do not meet size requirements. |
| exists | Reject entries based on existing files in filesystem. |
| exists_series | Reject entries based on existing series in filesystem. |
| imdb | Accept movie entries based on imdb details. |
| imdb_rated | Reject movies you've already voted on imdb. |
| imdb_required | Reject imdb incompatible entries. |
| limit_new | Allow only given number of entries to pass per execution. |
| nzb_size | DEPRECATED Reject nzb's that do not meet size requirements. |
| quality | NEW Reject entries not of the specified quality. |
| regexp | Reject, Accept entries by using regular expression. |
| seen_movies | Rejects already downloaded movies (detected by imdb-link). |
| seen | Reject already downloaded entries. Builtin |
| series | Accept TV-serie episodes. Quality and episode number aware. |
| torrent_size | DEPRECATED Reject torrents that do not meet size requirements. |
Outputs
Execute operation(s) to accepted entries.
| Keyword | Description |
| deluge | Pass torrents directly to deluge bittorrent client. |
| download | Download passed entries into given path. |
| Send email when new content is passed. | |
| exec | Execute command for passed entries. |
| make_rss | Generate RSS-feed file from passed entries. |
| prowl | Send prowl notifications (iPhone). |
| sabnzbd | Download nzbs with SABnzbd. |
| subtitles | Download subtitles for movies from opensubtitles.com. |
| transmissionrpc | Pass entries' url to transmission, supporting magnet links. |
Modify / Other
| Keyword | Description |
| archive | NEW Archive all seen entries for searchable database for later retrieval. |
| adv_exec | NEW Highly customizable exec plugin. |
| cookies | UPGRADED Use FireFox3 cookies. |
| delay | Adds artificial delay into a feed. |
| disable_builtins | Disable builtin plugin(s) from a feed. |
| disable_plugin | NEW Disable plugins from presets. |
| extension | Force a file extension. |
| formlogin | Log in via form. |
| headers | Modify HTTP headers. |
| include | Include configuration from another yaml file. |
| imdb_lookup | Tries to perform imdb lookup for all entries. |
| interval | Maintain minimum poll interval for a feed. |
| manipulate | NEW Allows regexp manipulation for entries. |
| path_by_ext | Change (download) path based on file-type (extension). |
| priority | Change feed execution order. |
| plugin_priority | Change plugin priorities. |
| remove_trackers | Remove trackers from a torrent. |
| preset | Provides global configuration and named presets. |
| search | Search for download URL from supported sites. |
| set | Set 'path' or other info per feed. |
| sort_by | Sort entries in a feed. |
| urlrewrite | User regexp for URL Rewriting. |
Command line plugins
| --cli-config | Allow using values from commandline in YML-configuration file. |
| --imdb-queue | NEW Accept movies from a predefined queue. |
| --inject | Injects custom entry into feed(s). |
| --try-regexp | Test how regexps work on feed(s) interactively. |
