Skip to content

kkeeth/check-stats-modules

Repository files navigation

           __                   __                    __            __                                          __            __
  _____   / /_   ___   _____   / /__          _____  / /_  ____ _  / /_   _____          ____ ___   ____   ____/ /  __  __   / /  ___    _____
 / ___/  / __ \ / _ \ / ___/  / //_/ ______  / ___/ / __/ / __ `/ / __/  / ___/ ______  / __ `__ \ / __ \ / __  /  / / / /  / /  / _ \  / ___/
/ /__   / / / //  __// /__   / ,<   /_____/ (__  ) / /_  / /_/ / / /_   (__  ) /_____/ / / / / / // /_/ // /_/ /  / /_/ /  / /  /  __/ (__  )
\___/  /_/ /_/ \___/ \___/  /_/|_|         /____/  \__/  \__,_/  \__/  /____/         /_/ /_/ /_/ \____/ \__,_/   \__,_/  /_/   \___/ /____/

npm version Build Status Code Climate node MIT License

check-stats-modules

check-stats-modules (csm) is a CLI application that obtains the specified npm module's stats. After specifying the module name and period, the number of downloads during that period is acquired and displayed on the terminal.

Installation

$ npm install -g check-stats-modules

Usage (example)

note: If the -e option(end date) is not specified, today's date is automatically specified.

  • check the stats of one module from yesterday
$ csm check-stats-modules

╔═════════════════════╤════════════╤════════════╤═══════════╗
║ package             ║ start      ║ end        ║ downloads ║
╟─────────────────────┼────────────┼────────────┼───────────╢
║ check-stats-modules ║ 2023-11-03 ║ 2023-11-04 ║ 0         ║
╚═════════════════════╧════════════╧════════════╧═══════════╝
  • check the stats of two modules from 2020-06-01
$ csm cmd-ranking check-stats-modules -s 2020-06-01

╔═════════════════════╤════════════╤════════════╤═══════════╗
║ package             ║ start      ║ end        ║ downloads ║
╟─────────────────────┼────────────┼────────────┼───────────╢
║ check-stats-modules ║ 2020-06-01 ║ 2023-11-04 ║ 1249      ║
╟─────────────────────┼────────────┼────────────┼───────────╢
║ cmd-ranking         ║ 2020-06-01 ║ 2023-11-04 ║ 1140      ║
╚═════════════════════╧════════════╧════════════╧═══════════╝
  • check the stats of two modules from last month
$ csm cmd-ranking check-stats-modules -m

╔═════════════════════╤════════════╤════════════╤═══════════╗
║ package             ║ start      ║ end        ║ downloads ║
╟─────────────────────┼────────────┼────────────┼───────────╢
║ check-stats-modules ║ 2023-10-04 ║ 2023-11-04 ║ 223       ║
╟─────────────────────┼────────────┼────────────┼───────────╢
║ cmd-ranking         ║ 2023-10-04 ║ 2023-11-04 ║ 115       ║
╚═════════════════════╧════════════╧════════════╧═══════════╝

If you need total count of specified modules, you can use -T or --total option.

$ csm cmd-ranking check-stats-modules -m -T

╔═════════════════════╤════════════╤════════════╤═══════════╗
║ package             ║ start      ║ end        ║ downloads ║
╟─────────────────────┼────────────┼────────────┼───────────╢
║ check-stats-modules ║ 2023-10-23 ║ 2023-11-23 ║ 201       ║
╟─────────────────────┼────────────┼────────────┼───────────╢
║ cmd-ranking         ║ 2023-10-23 ║ 2023-11-23 ║ 18        ║
╟─────────────────────┼────────────┼────────────┼───────────╢
║ Total               ║ 2023-10-23 ║ 2023-11-23 ║ 219       ║
╚═════════════════════╧════════════╧════════════╧═══════════╝

Options

    --version    Show version number                                 [boolean]
-s, --start      Specify the start of the period to be counted
-e, --end        Specify the end of the period to be counted
-y, --year       Set "from" 1 year                                   [boolean]
-t, --this-year  Set "from" January 1 of this year                   [boolean]
-m, --month      Set "from" 1 month                                  [boolean]
-w, --week       Set "from" 1 week                                   [boolean]
-T, --total      Show the total count of specified modules           [boolean]
-h, --help       Show help                                           [boolean]

License

MIT

Others

Please write a new issues! Please send me PRs!