Readme: Updated.

pull/78/head
desimaniac 6 years ago
parent a65cf11c9b
commit 2c40093ace

@ -934,13 +934,13 @@ Usage: traktarr movie [OPTIONS]
Add a single movie to Radarr. Add a single movie to Radarr.
Options: Options:
-id, --movie_id TEXT Trakt movie_id. [required] -id, --movie-id TEXT Trakt Movie ID. [required]
-f, --folder TEXT Add movie with this root folder to Radarr. -f, --folder TEXT Add movie with this root folder to Radarr.
--no-search Disable search when adding movie to Radarr. --no-search Disable search when adding movie to Radarr.
--help Show this message and exit. --help Show this message and exit.
``` ```
_Note: This command only works with `-id` or `--show_id` specified (i.e. not with lists), and supports both Trakt IDs and IMDB IDs._ _Note: This command only works with `-id` or `--show-id` specified (i.e. not with lists), and supports both Trakt and IMDB IDs._
### Movies (Multiple Movies) ### Movies (Multiple Movies)
@ -955,27 +955,24 @@ Usage: traktarr movies [OPTIONS]
Add multiple movies to Radarr. Add multiple movies to Radarr.
Options: Options:
-t, --list-type TEXT Trakt list to process. For example, -t, --list-type TEXT Trakt list to process. For example, anticipated, trending,
anticipated, trending, popular, boxoffice, popular, boxoffice, person, watched, recommended, played,
watched, played, watchlist or any URL to a watchlist or any URL to a list [required]
list [required] -l, --add-limit INTEGER Limit number of movies added to Radarr. [default: 0]
-l, --add-limit INTEGER Limit number of movies added to Radarr. -d, --add-delay FLOAT Seconds between each add request to Radarr. [default: 2.5]
[default: 0] -s, --sort [rating|release|votes]
-d, --add-delay FLOAT Seconds between each add request to Radarr. Sort list to process. [default: votes]
[default: 2.5] -r, --rating INTEGER Set a minimum rating threshold (according to Rotten Tomatoes)
-s, --sort [votes|rating|release]
Sort list to process.
-r, --rating INTEGER Only add movies above this rating according to Rotten Tomatoes Score
[default: 0]
-g, --genre TEXT Only add movies from this genre to Radarr. -g, --genre TEXT Only add movies from this genre to Radarr.
-f, --folder TEXT Add movies with this root folder to Radarr. -f, --folder TEXT Add movies with this root folder to Radarr.
-a, --actor TEXT Only add movies from this actor to Radarr.
--no-search Disable search when adding movies to Radarr. --no-search Disable search when adding movies to Radarr.
--notifications Send notifications. --notifications Send notifications.
--authenticate-user TEXT Specify which user to authenticate with to --authenticate-user TEXT Specify which user to authenticate with to retrieve Trakt lists.
retrieve Trakt lists. Default: first user in Default: first user in the config.
the config. --ignore-blacklist Ignores the blacklist when running the command.
--ignore-blacklist Ignores the blacklist when running the --remove-rejected-from-recommended
command. Removes rejected/existing movies from recommended.
--help Show this message and exit. --help Show this message and exit.
``` ```
@ -1023,12 +1020,18 @@ Options:
- Example: `-f /mnt/unionfs/Media/Movies/Movies-Kids/` - Example: `-f /mnt/unionfs/Media/Movies/Movies-Kids/`
`-a`, `--actor` - Only add movies with a specific actor to Radarr.
`--no-search` - Tells Radarr to not automatically search for added movies. `--no-search` - Tells Radarr to not automatically search for added movies.
`--notifications` - To enable notifications. Default is `disabled`. `--notifications` - To enable notifications. Default is `disabled`.
`--authenticate-user` - Specify which authenticated user to retrieve Trakt lists as. Default is the first user in the config.
`--ignore-blacklist` - Ignores blacklist filtering. Equivalent of `disabled_for` in `config.json`. `--ignore-blacklist` - Ignores blacklist filtering. Equivalent of `disabled_for` in `config.json`.
`--remove-rejected-from-recommended` - Removes rejected/existing shows from the recommended list, so that it will be removed from further recommendations.
### Show (Single Show) ### Show (Single Show)
@ -1043,13 +1046,13 @@ Usage: traktarr show [OPTIONS]
Add a single show to Sonarr. Add a single show to Sonarr.
Options: Options:
-id, --show_id TEXT Trakt show_id. [required] -id, --show-id TEXT Trakt Show ID. [required]
-f, --folder TEXT Add show with this root folder to Sonarr. -f, --folder TEXT Add show with this root folder to Sonarr.
--no-search Disable search when adding show to Sonarr. --no-search Disable search when adding show to Sonarr.
--help Show this message and exit. --help Show this message and exit.
``` ```
_Note: This command only works with `-id` or `--show_id` specified (i.e. not with lists), and supports both Trakt IDs and IMDB IDs._ _Note: This command only works with `-id` or `--show-id` specified (i.e. not with lists), and supports both Trakt and IMDB IDs._
### Shows (Multiple Shows) ### Shows (Multiple Shows)
@ -1065,25 +1068,23 @@ Usage: traktarr shows [OPTIONS]
Add multiple shows to Sonarr. Add multiple shows to Sonarr.
Options: Options:
-t, --list-type TEXT Trakt list to process. For example, -t, --list-type TEXT Trakt list to process. For example, anticipated, trending,
anticipated, trending, popular, watched, popular, person, watched, played, recommended, watchlist or any
played, watchlist or any URL to a list URL to a list [required]
[required] -l, --add-limit INTEGER Limit number of shows added to Sonarr. [default: 0]
-l, --add-limit INTEGER Limit number of shows added to Sonarr. -d, --add-delay FLOAT Seconds between each add request to Sonarr. [default: 2.5]
[default: 0] -s, --sort [rating|release|votes]
-d, --add-delay FLOAT Seconds between each add request to Sonarr. Sort list to process. [default: votes]
[default: 2.5]
-s, --sort [votes|rating|release]
Sort list to process.
-g, --genre TEXT Only add shows from this genre to Sonarr. -g, --genre TEXT Only add shows from this genre to Sonarr.
-f, --folder TEXT Add shows with this root folder to Sonarr. -f, --folder TEXT Add shows with this root folder to Sonarr.
-a, --actor TEXT Only add movies from this actor to Radarr.
--no-search Disable search when adding shows to Sonarr. --no-search Disable search when adding shows to Sonarr.
--notifications Send notifications. --notifications Send notifications.
--authenticate-user TEXT Specify which user to authenticate with to --authenticate-user TEXT Specify which user to authenticate with to retrieve Trakt lists.
retrieve Trakt lists. Default: first user in Default: first user in the config
the config --ignore-blacklist Ignores the blacklist when running the command.
--ignore-blacklist Ignores the blacklist when running the --remove-rejected-from-recommended
command. Removes rejected/existing shows from recommended.
--help Show this message and exit. --help Show this message and exit.
``` ```
@ -1128,12 +1129,18 @@ Options:
- Example: `-f /mnt/unionfs/Media/Shows/Shows-Kids/` - Example: `-f /mnt/unionfs/Media/Shows/Shows-Kids/`
`-a`, `--actor` - Only add shows with a specific actor to Sonarr.
`--no-search` - Tells Sonarr to not automatically search for added shows. `--no-search` - Tells Sonarr to not automatically search for added shows.
`--notifications` - To enable notifications. Default is `disabled`. `--notifications` - To enable notifications. Default is `disabled`.
`--authenticate-user` - Specify which authenticated user to retrieve Trakt lists as. Default is the first user in the config.
`--ignore-blacklist` - Ignores blacklist filtering. Equivalent of `disabled_for` in `config.json`. `--ignore-blacklist` - Ignores blacklist filtering. Equivalent of `disabled_for` in `config.json`.
`--remove-rejected-from-recommended` - Removes rejected/existing shows from the recommended list, so that it will be removed from further recommendations.
## Examples (CLI) ## Examples (CLI)

Loading…
Cancel
Save