effemmeffe

flexget cli options

Jan 28th, 2016
417
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 15.87 KB | None | 0 0
  1. usage: flexget [-h] [-V] [--test] [-c CONFIG] [--logfile LOGFILE]
  2. [--loglevel LEVEL] [--bugreport] [--profile [OUTFILE]] [--cron]
  3. [--debug-warnings] [--debug-db-sessions]
  4. <command> ...
  5.  
  6. optional arguments:
  7. -h, --help show this help message and exit
  8. -V, --version Print FlexGet version and exit.
  9. --test Verbose what would happen on normal execution.
  10. -c CONFIG Specify configuration file. Default: config.yml
  11. --logfile LOGFILE, -l LOGFILE
  12. Specify a custom logfile name/location. Default:
  13. flexget.log in the config directory.
  14. --loglevel LEVEL, -L LEVEL
  15. Set the verbosity of the logger. Levels: none,
  16. critical, error, warning, info, verbose, debug, trace
  17. --bugreport Use this option to create a detailed bug report, note
  18. that the output might contain PRIVATE data, so edit
  19. that out
  20. --profile [OUTFILE] Use the python profiler for this run to debug
  21. performance issues.
  22. --cron use when executing FlexGet non-interactively: allows
  23. background maintenance to run, disables stdout and
  24. stderr output, reduces logging level
  25. --debug-warnings elevate warnings to errors for debugging purposes, so
  26. a traceback is shown
  27. --debug-db-sessions debug session starts and ends, for finding problems
  28. with db locks
  29.  
  30. commands:
  31. <command>
  32. execute execute tasks now
  33. daemon run continuously, executing tasks according to
  34. schedules defined in config
  35. trakt view and manage trakt authentication.Please visit
  36. http://trakt.tv/pin/346 to retrieve your pin code.
  37. archive search and manipulate the archive database
  38. doc display plugin documentation
  39. database utilities to manage the FlexGet database
  40. backlog view or clear entries from backlog plugin
  41. movie-queue view and manage the movie queue
  42. plugins print registered plugin summaries
  43. check validate configuration file and print errors
  44. series view and manipulate the series plugin database
  45. users Manage users providing access to the web server
  46. history view the history of entries that FlexGet has accepted
  47. send_telegram send_telegram cli
  48. seen view or forget entries remembered by the seen plugin
  49. failed list or clear remembered failures
  50. rejected list or clear remembered rejections
  51. inject inject an entry from command line into tasks
  52.  
  53.  
  54.  
  55. ==============
  56. usage: flexget execute [-h] [--tasks TASK [TASK ...]] [--learn] [--no-cache]
  57. [--template NAME] [--now] [--stop-waiting NAME]
  58. [--disable-tracking]
  59. [--cli-config VARIABLE=VALUE [VARIABLE=VALUE ...]]
  60. [--dl-path PATH] [--dump-config]
  61. [--dump [{eval,trace,accepted,rejected,undecided,title} [{eval,trace,accepted,rejected,undecided,title} ...]]]
  62. [--try-regexp] [--tail-reset FILE|TASK]
  63. [--discover-now] [-v] [-s]
  64.  
  65. optional arguments:
  66. -h, --help show this help message and exit
  67. --tasks TASK [TASK ...]
  68. run only specified task(s), optionally using glob
  69. patterns ("tv-*"). matching is case-insensitive
  70. --learn matches are not downloaded but will be skipped in the
  71. future
  72. --no-cache disable caches. works only in plugins that have
  73. explicit support
  74. --template NAME execute tasks using given template
  75. --now run task(s) even if the interval plugin would normally
  76. prevent it
  77. --stop-waiting NAME stop timeframe for a given series
  78. --disable-tracking disable episode advancement for this run
  79. --cli-config VARIABLE=VALUE [VARIABLE=VALUE ...]
  80. configuration parameters through commandline
  81. --dl-path PATH override path for download plugin, applies to all
  82. executed tasks
  83. --dump-config display the config of each feed after template
  84. merging/config generation occurs
  85. --dump [{eval,trace,accepted,rejected,undecided,title} [{eval,trace,accepted,rejected,undecided,title} ...]]
  86. display all entries in task with fields they contain,
  87. use `--dump eval` to evaluate all lazy fields. Specify
  88. an entry state/states to only dump matching entries.
  89. --try-regexp try regular expressions interactively
  90. --tail-reset FILE|TASK
  91. reset tail position for a file
  92. --discover-now immediately try to discover everything
  93. -v, --verbose verbose undecided entries
  94. -s, --silent don't verbose any actions (accept, reject, fail)
  95.  
  96.  
  97.  
  98. ==============
  99. usage: flexget archive [-h] <action> ...
  100.  
  101. optional arguments:
  102. -h, --help show this help message and exit
  103.  
  104. Actions:
  105. <action>
  106. search search from the archive
  107. inject inject entries from the archive back into tasks
  108. tag-source
  109. tag all archived entries within a given source
  110. consolidate
  111. migrate old archive data to new model, may take a long time
  112.  
  113.  
  114.  
  115. ==============
  116. usage: flexget archive search [-h] <keyword> [<keyword> ...] [optional arguments]
  117.  
  118. positional arguments:
  119. <keyword> keyword(s) to search for
  120.  
  121. optional arguments:
  122. -h, --help show this help message and exit
  123. --tags TAG [TAG ...] tag(s) to search within
  124. --sources SOURCE [SOURCE ...]
  125. source(s) to search within
  126.  
  127.  
  128.  
  129. ==============
  130. usage: flexget archive inject [-h] [--immortal] ID [ID ...] ...
  131.  
  132. positional arguments:
  133. ID archive ID of an item to inject
  134.  
  135. optional arguments:
  136. -h, --help show this help message and exit
  137. --immortal injected entries will not be able to be rejected by
  138. any plugins
  139.  
  140. execute arguments:
  141. <flexget execute arguments>
  142. arguments for the `flexget execute` command are
  143. allowed here
  144.  
  145.  
  146.  
  147. ==============
  148. usage: flexget archive tag-source [-h] <source> <tag> [<tag> ...]
  149.  
  150. positional arguments:
  151. <source> the source whose entries you would like to tag
  152. <tag> the tag(s) you would like to apply to the entries
  153.  
  154. optional arguments:
  155. -h, --help show this help message and exit
  156.  
  157.  
  158.  
  159. ==============
  160. usage: flexget database [-h] <action> ...
  161.  
  162. optional arguments:
  163. -h, --help show this help message and exit
  164.  
  165. Actions:
  166. <action>
  167. cleanup make all plugins clean un-needed data from the database
  168. vacuum running vacuum can increase performance and decrease database
  169. size
  170. reset reset the entire database (DANGEROUS!)
  171. reset-plugin
  172. reset the database for a specific plugin
  173.  
  174.  
  175.  
  176. ==============
  177. usage: flexget backlog [-h] [--porcelain] {list,clear} [task]
  178.  
  179. positional arguments:
  180. {list,clear} choose to show items in backlog, or clear them
  181. task limit to specific task (if supplied)
  182.  
  183. optional arguments:
  184. -h, --help show this help message and exit
  185. --porcelain make the output parseable
  186.  
  187.  
  188.  
  189. ==============
  190. usage: flexget movie-queue [-h] <action> ...
  191.  
  192. optional arguments:
  193. -h, --help show this help message and exit
  194.  
  195. actions:
  196. <action>
  197. list list movies from the queue
  198. add add a movie to the queue
  199. del remove a movie from the queue
  200. forget remove the downloaded flag from a movie
  201. clear remove all un-downloaded movies from the queue
  202.  
  203.  
  204.  
  205. ==============
  206. usage: flexget movie-queue list [-h] [--porcelain] [{waiting,downloaded,all}]
  207.  
  208. positional arguments:
  209. {waiting,downloaded,all}
  210. choose to show waiting or already downloaded movies
  211.  
  212. optional arguments:
  213. -h, --help show this help message and exit
  214. --porcelain make the output parseable
  215.  
  216.  
  217.  
  218. ==============
  219. usage: flexget movie-queue add [-h] <movie> [<quality>]
  220.  
  221. positional arguments:
  222. <movie> the movie (can be movie title, imdb id, or in the form
  223. `tmdb_id=XXXX`
  224. <quality> the quality requirements for getting this movie (default: ANY)
  225.  
  226. optional arguments:
  227. -h, --help show this help message and exit
  228.  
  229.  
  230.  
  231. ==============
  232. usage: flexget movie-queue del [-h] <movie>
  233.  
  234. positional arguments:
  235. <movie> the movie (can be movie title, imdb id, or in the form
  236. `tmdb_id=XXXX`
  237.  
  238. optional arguments:
  239. -h, --help show this help message and exit
  240.  
  241.  
  242.  
  243. ==============
  244. usage: flexget movie-queue forget [-h] <movie>
  245.  
  246. positional arguments:
  247. <movie> the movie (can be movie title, imdb id, or in the form
  248. `tmdb_id=XXXX`
  249.  
  250. optional arguments:
  251. -h, --help show this help message and exit
  252.  
  253.  
  254.  
  255. ==============
  256. usage: flexget plugins [-h] [--group GROUP] [--phase PHASE] [--porcelain]
  257.  
  258. optional arguments:
  259. -h, --help show this help message and exit
  260. --group GROUP show plugins belonging to this group
  261. --phase PHASE show plugins that act on this phase
  262. --porcelain make the output parseable
  263.  
  264.  
  265.  
  266. ==============
  267. usage: flexget check [-h]
  268.  
  269. optional arguments:
  270. -h, --help show this help message and exit
  271.  
  272.  
  273.  
  274. ==============
  275. usage: flexget series [-h] <action> ...
  276.  
  277. optional arguments:
  278. -h, --help show this help message and exit
  279.  
  280. actions:
  281. <action>
  282. list list a summary of the different series being tracked
  283. show show the releases FlexGet has seen for a given series
  284. begin set the episode to start getting a series from
  285. forget removes episodes or whole series from the series database
  286.  
  287.  
  288.  
  289. ==============
  290. usage: flexget series list [-h] [--premieres] [--new [DAYS]] [--stale [DAYS]]
  291. [--porcelain]
  292. [{configured,unconfigured,all}]
  293.  
  294. positional arguments:
  295. {configured,unconfigured,all}
  296. limit list to series that are currently in the config
  297. or not (default: configured)
  298.  
  299. optional arguments:
  300. -h, --help show this help message and exit
  301. --premieres limit list to series which only have episode 1 (and
  302. maybe also 2) downloaded
  303. --new [DAYS] limit list to series with a release seen in last 7
  304. days. number of days can be overridden with DAYS
  305. --stale [DAYS] limit list to series which have not seen a release in
  306. 365 days. number of days can be overridden with DAYS
  307. --porcelain make the output parseable
  308.  
  309.  
  310.  
  311. ==============
  312. usage: flexget series show [-h] <series name>
  313.  
  314. positional arguments:
  315. <series name> the name of the series
  316.  
  317. optional arguments:
  318. -h, --help show this help message and exit
  319.  
  320.  
  321.  
  322. ==============
  323. usage: flexget series begin [-h] <series name> <episode ID>
  324.  
  325. positional arguments:
  326. <series name> the name of the series
  327. <episode ID> episode ID to start getting the series from (e.g. S02E01,
  328. 2013-12-11, or 9, depending on how the series is numbered)
  329.  
  330. optional arguments:
  331. -h, --help show this help message and exit
  332.  
  333.  
  334.  
  335. ==============
  336. usage: flexget series forget [-h] <series name> [episode_id]
  337.  
  338. positional arguments:
  339. <series name> the name of the series
  340. episode_id episode ID to forget (optional)
  341.  
  342. optional arguments:
  343. -h, --help show this help message and exit
  344.  
  345.  
  346.  
  347. ==============
  348. usage: flexget users [-h] <action> ...
  349.  
  350. positional arguments:
  351. <action>
  352. list List users
  353. add add a new user
  354. delete delete a new user
  355. passwd change password for user
  356. gentoken Generate a new api token for a user
  357.  
  358. optional arguments:
  359. -h, --help show this help message and exit
  360.  
  361.  
  362.  
  363. ==============
  364. usage: flexget history [-h] [--limit NUM] [--search TERM] [--task TASK]
  365.  
  366. optional arguments:
  367. -h, --help show this help message and exit
  368. --limit NUM limit to NUM results
  369. --search TERM limit to results that contain TERM
  370. --task TASK limit to results in specified TASK
  371.  
  372.  
  373.  
  374. ==============
  375. usage: flexget seen [-h] <action> ...
  376.  
  377. positional arguments:
  378. <action>
  379. forget forget entry or entire task from seen plugin database
  380. add add a title or url to the seen database
  381. search search text from the seen database
  382.  
  383. optional arguments:
  384. -h, --help show this help message and exit
  385.  
  386.  
  387.  
  388. ==============
  389. usage: flexget failed [-h] <action> ...
  390.  
  391. positional arguments:
  392. <action>
  393. list list all the entries that have had failures
  394. clear clear all failures from database, so they can be retried
  395.  
  396. optional arguments:
  397. -h, --help show this help message and exit
  398.  
  399.  
  400.  
  401. ==============
  402. usage: flexget rejected [-h] <action> ...
  403.  
  404. positional arguments:
  405. <action>
  406. list list all the entries that have been rejected
  407. clear clear all rejected entries from database, so they can be retried
  408.  
  409. optional arguments:
  410. -h, --help show this help message and exit
  411.  
  412.  
  413.  
  414. ==============
  415. usage: flexget inject title [url] [--accept] [--force] [--fields NAME=VALUE [NAME=VALUE...]] [<execute arguments>]
  416.  
  417. inject arguments:
  418. title title of the entry to inject
  419. url url of the entry to inject
  420. --force prevent any plugins from rejecting this entry
  421. --accept accept this entry immediately upon injection
  422. --fields NAME=VALUE [NAME=VALUE ...]
  423.  
  424. execute arguments:
  425. -h, --help show this help message and exit
  426. --tasks TASK [TASK ...]
  427. run only specified task(s), optionally using glob
  428. patterns ("tv-*"). matching is case-insensitive
  429. --learn matches are not downloaded but will be skipped in the
  430. future
  431. --no-cache disable caches. works only in plugins that have
  432. explicit support
  433. --template NAME execute tasks using given template
  434. --now run task(s) even if the interval plugin would normally
  435. prevent it
  436. --stop-waiting NAME stop timeframe for a given series
  437. --disable-tracking disable episode advancement for this run
  438. --cli-config VARIABLE=VALUE [VARIABLE=VALUE ...]
  439. configuration parameters through commandline
  440. --dl-path PATH override path for download plugin, applies to all
  441. executed tasks
  442. --dump-config display the config of each feed after template
  443. merging/config generation occurs
  444. --dump [{eval,trace,accepted,rejected,undecided,title} [{eval,trace,accepted,rejected,undecided,title} ...]]
  445. display all entries in task with fields they contain,
  446. use `--dump eval` to evaluate all lazy fields. Specify
  447. an entry state/states to only dump matching entries.
  448. --try-regexp try regular expressions interactively
  449. --tail-reset FILE|TASK
  450. reset tail position for a file
  451. --discover-now immediately try to discover everything
  452. -v, --verbose verbose undecided entries
  453. -s, --silent don't verbose any actions (accept, reject, fail)
Advertisement
Add Comment
Please, Sign In to add comment