Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kkeeth/check-stats-modules

cli-app download npm-package stats

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/kkeeth/check-stats-modules
Owner: kkeeth
License: mit
Created: 2018-08-23T00:59:44.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-10-30T00:21:57.000Z (about 2 months ago)
Last Synced: 2024-10-30T02:50:02.832Z (about 2 months ago)
Topics: cli-app, download, npm-package, stats
Language: JavaScript
Size: 856 KB
Stars: 3
Watchers: 3
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

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

[![npm version](https://badge.fury.io/js/check-stats-modules.svg)](https://badge.fury.io/js/check-stats-modules)
[![Build Status](https://travis-ci.org/kkeeth/check-stats-modules.svg?branch=master)](https://travis-ci.org/kkeeth/check-stats-modules)
[![Code Climate](https://codeclimate.com/github/kkeeth/check-stats-modules/badges/gpa.svg)](https://codeclimate.com/github/kkeeth/check-stats-modules)
![node](https://img.shields.io/badge/node-%3E%3D%2018.18.0-brightgreen.svg?style=social)
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](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

```cmd
$ 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

```cmd
$ csm check-stats-modules

- check the stats of two modules from 2020-06-01

```cmd
$ 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

```cmd
$ 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.

```cmd
$ 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](https://github.com/kkeeth/check-stats-modules/LICENSE)

# Others

Please write a new [issues](https://github.com/kkeeth/check-stats-modules/issues)! Please send me [PRs](https://github.com/kkeeth/check-stats-modules/pulls)!