Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/niksy/tv-shows-cli
Personal TV shows manager.
https://github.com/niksy/tv-shows-cli
Last synced: about 2 months ago
JSON representation
Personal TV shows manager.
- Host: GitHub
- URL: https://github.com/niksy/tv-shows-cli
- Owner: niksy
- License: mit
- Created: 2016-10-02T17:36:10.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-17T17:23:02.000Z (over 7 years ago)
- Last Synced: 2024-10-18T03:48:44.067Z (2 months ago)
- Language: JavaScript
- Size: 459 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# tv-shows-cli
[![Build Status][ci-img]][ci]
Personal TV shows manager.
## Install
```sh
npm install -g @niksy/tv-shows-cli
```
## Usage
```
tv-shows
Personal TV shows manager.
Usage
$ tv-shows [options]
Options
-d, --date [human date] Display TV shows for given (airing) date or range of dates in human readable format (Default: yesterday)
-s, --choose-show Choose TV show regardless of date
-o, --organize-files Organize subtitle and video files (optionally refreshing Plex Media Server library and removing watched episodes)
```
## Configuration
Configuration is stored in `.tvshowsrc` file and parsed with [cosmiconfig][cosmiconfig].
| Property | Type | Default | Description |
| --- | --- | --- | --- |
| `subtitleLanguage` | `String|Number` | | [Subtitle language][subtitle-language]. |
| `quality` | `String[]` | | [Video/audio quality][quality]. |
| `country` | `String[]` | | [Country schedule][country-schedule]. |
| `excludeTorrentService` | `String[]` | `[]` | [Exclude torrent service][exclude-torrent-service] from checking. |
| `showsDir` | `String` | [OS homedir][os-homedir] | Shows directory location. Used for default subtitle download location. |
| `maxItems` | `Number` | `15` | Maximum number of torrents and subtitles to display. |
| `refreshPlexLibrary` | `Boolean` | `false` | Refresh [Plex][plex] library when organizing files. |
| `removeWatchedEpisodes` | `Boolean` | `false` | Remove watched episodes from Plex library. |
| `shows` | `Object[]` | | [List of shows][shows]. |
### Example
```json
{
"subtitleLanguage": "en_US",
"quality": ["720p"],
"country": ["US", "GB"],
"excludeTorrentService": [],
"showsDir": "~/Movies",
"maxItems": 15,
"refreshPlexLibrary": false,
"removeWatchedEpisodes": false,
"shows": [
{
"title": "Game of Thrones",
"webChannel": false,
"tvmazeId": 123,
"addic7edId": 456,
"searchQuery": [
"game of thrones",
"of thrones"
],
"advancedSearchQuery": [
"game of thrones {{ season }} {{ episode }}"
]
}
]
}
```
## License
MIT © [Ivan Nikolić](http://ivannikolic.com)
[ci]: https://travis-ci.org/niksy/tv-shows-cli
[ci-img]: https://travis-ci.org/niksy/tv-shows-cli.svg?branch=master
[subtitle-language]: https://github.com/niksy/tv-shows#subtitlelanguage
[quality]: https://github.com/niksy/tv-shows#quality
[exclude-torrent-service]: https://github.com/niksy/tv-shows#excludetorrentservice
[shows]: https://github.com/niksy/tv-shows#show-configuration
[cosmiconfig]: https://github.com/davidtheclark/cosmiconfig
[os-homedir]: https://github.com/sindresorhus/os-homedir
[country-schedule]: https://github.com/niksy/tv-shows#country
[plex]: https://www.plex.tv/