Skip to content

Latest commit

 

History

History
214 lines (153 loc) · 5.54 KB

README.md

File metadata and controls

214 lines (153 loc) · 5.54 KB
Raw

tvst Build Status

TV Shows Tracker (TVST) on command line

TVST command line

Table of contents

👊 More awesome features are in development 👊

Install

Install with npm:

npm install -g tvst

Upgrade 

npm update -g tvst

Usage 


  Usage: tvst [options] [command]


  Commands:

    schedule <date>  Show list of TV shows of a specific date
    ne <show-name>   Date & Air time of next episode of a show
    pe <show-name>   Date & Air time of previous episode of a show
    fav-add          Add TV shows in your favorite list
    fav-list         Show list of your favorite shows
    fav-remove       Remove show(s) from your favorite shows
    help [cmd]       display help for [cmd]

  TV Shows Tracker (TVST) On Command Line - For Developers

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Schedule - schedule 

tvst schedule <date>

Usage of schedule

$ tvst schedule --help

  Usage: tvst-schedule [options]

  Options:

    -h, --help              output usage information
    -c --country <country>  ISO Country Code - eg. US or GB etc.
    -f --filter <filter>    Filter By Show Name

Examples:

  • See all shows of today: 
tvst schedule today
  • See all shows of tomorrow: 
tvst schedule tomorrow
  • See all shows of yesterday: 
tvst schedule yesterday
  • See all shows of a particular date: 
tvst schedule '2016-06-14'
  • See if tomorrow has a episode of a particular tv show: 
tvst schedule tomorrow -f 'game of thrones'
  • See today's schedule of a particular country: 
tvst schedule today -c GB

Next Episode - ne 

tvst ne <show-name>

Examples

  • See next episode's details of a particular show: 
tvst ne 'game of thrones'

📔 If you're not sure about spelling of a specific show name, just guess, it will return list of possible shows

📔 If any show has no update of next episode then it returns details of previous episode

Previous episode - pe 

tvst pe <show-name>

Examples

  • See previous episode's details of a particular show: 
tvst pe 'game of thrones'

📔 If you're not sure about spelling of a specific show name, just guess, it will return list of possible shows

Favorite shows - fav-add fav-remove fav-list 

tvst fav-add
tvst fav-remove
tvst fav-list

Examples

  • Add show(s) to your favorite: 
tvst fav-add

📔 It is an interactive command - just follow the instruction.

  • Remove show(s) from your favorite: 
tvst fav-remove

📔 It is an interactive command - just follow the instruction.

  • See schedules of all of your favorite shows: 
tvst fav-list

📔 If you're not sure about spelling of a specific show name, just guess, it will return list of possible shows

Help 

tvst help

Version 

tvst --version

Credits

TVMaze API

License

The MIT @ Shahriar Mahmood