From 1f2fceb92c175293b30d13f64cb92b35e57520cd Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Tue, 10 Feb 2015 20:25:01 +0100 Subject: [PATCH] Readme --- README.md | 261 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 261 insertions(+) diff --git a/README.md b/README.md index 63f7399..866e0ab 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,264 @@ $ curl -sS https://getcomposer.org/installer | php $ ./composer.phar install $ ./console ``` + +## Commands + +### console auth:login + +``` +Usage: + auth:login + +Options: + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question + +Help: + auth:login + + Generate the config to access the API. You must have a valid login/password. + + The login and the password are not saved. + + Usage: auth:login +``` + + +### console categories:tree + +``` +Usage: + categories:tree + +Options: + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question + +Help: + categories:tree + + List all categories and sub-categories with IDs. + + Usage: categories:tree +``` + + +### console torrents:details + +``` +Usage: + torrents:details id + +Arguments: + id Torrent ID + +Options: + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question + +Help: + torrents:details + + Show torrent details. + + Usage: torrents:details TORRENT_ID +``` + + +### console torrents:download + +``` +Usage: + torrents:download id output_file + +Arguments: + id Torrent ID + output_file Output + +Options: + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question + +Help: + torrents:download + + Download a torrent. + + Usage: torrents:download TORRENT_ID OUTPUT + + OUTPUT could be a file or STDIN by using -. +``` + + +### console torrents:search + +``` +Usage: + torrents:search [-o|--offset="..."] [-l|--limit="..."] [-s|--sub-category="..."] [-c|--category="..."] [-t|--terms="..."] query + +Arguments: + query Query + +Options: + --offset (-o) Page number + --limit (-l) Number of results per page + --sub-category (-s) Filter by sub-category ID + --category (-c) Filter by category ID + --terms (-t) Filter by terms IDs (separated by ",") + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question + +Help: + torrents:search + + Search torrents. + + Usage: torrents:search QUERY [OPTIONS] + + --terms does not work (API bug) +``` + + +### console torrents:search:movies + +``` +Usage: + torrents:search:movies [-o|--offset="..."] [-l|--limit="..."] [-t|--terms="..."] query + +Arguments: + query Query + +Options: + --offset (-o) Page number + --limit (-l) Number of results per page + --terms (-t) Filter by terms IDs (separated by ",") + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question + +Help: + torrents:search:movies + + Search movies. + + Usage: torrents:search:movies QUERY [OPTIONS] + + --terms does not work (API bug) +``` + + +### console torrents:search:series + +``` +Usage: + torrents:search:series [-o|--offset="..."] [-l|--limit="..."] [-t|--terms="..."] query + +Arguments: + query Query + +Options: + --offset (-o) Page number + --limit (-l) Number of results per page + --terms (-t) Filter by terms IDs (separated by ",") + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question + +Help: + torrents:search:series + + Search series. + + Usage: torrents:search:series QUERY [OPTIONS] + + --terms does not work (API bug) +``` + + +### console torrents:top + +``` +Usage: + torrents:top [-p|--period="..."] + +Options: + --period (-p) Period + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question + +Help: + torrents:top + + Show top torrents. + + Usage: torrents:search:top [OPTIONS] + + Period values: "100", "day", "week", "month" +``` + + +### console types:tree + +``` +Usage: + types:tree [-t|--terms] [-f|--filter[="..."]] + +Options: + --terms (-t) Show terms + --filter (-f) Filter types by ID or by name + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question + +Help: + types:tree + + List all types of terms and terms. + + Usage: types:tree [OPTIONS] +``` + +