https://github.com/progfay/github-streaks
Check streak on GitHub from CLI
https://github.com/progfay/github-streaks
cli github nodejs streak typescript
Last synced: 3 months ago
JSON representation
Check streak on GitHub from CLI
- Host: GitHub
- URL: https://github.com/progfay/github-streaks
- Owner: progfay
- Created: 2020-04-10T13:28:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-05T23:29:27.000Z (4 months ago)
- Last Synced: 2025-06-06T00:29:03.678Z (4 months ago)
- Topics: cli, github, nodejs, streak, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@progfay/github-streaks
- Size: 2.05 MB
- Stars: 14
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```
❯ npx @progfay/github-streaks @progfay
+-------------------+-------------------------+-----------+------+-----+-----+------+---------+
| Category | From ~ To | Day Count | Sum | Max | Min | Mean | Std dev |
+-------------------+-------------------------+-----------+------+-----+-----+------+---------+
| All Contributions | 2016-01-01 ~ 2020-12-31 | 1827 days | 4970 | 56 | 0 | 2.72 | 5.51 |
+-------------------+-------------------------+-----------+------+-----+-----+------+---------+
| Current Streak | 2019-06-10 ~ 2020-09-20 | 469 days | 3202 | 36 | 1 | 6.83 | 6.91 |
+-------------------+-------------------------+-----------+------+-----+-----+------+---------+
| Longest Streak | 2019-06-10 ~ 2020-09-20 | 469 days | 3202 | 36 | 1 | 6.83 | 6.91 |
+-------------------+-------------------------+-----------+------+-----+-----+------+---------+
```
[](https://codeclimate.com/github/progfay/github-streaks/maintainability)
### Requirements
- Node.js v12.16.3 or later
### Usage
#### Use instantly
```sh
npx @progfay/github-streaks [username]
# or
npm exec @progfay/github-streaks [username]
```
#### Use frequently
```sh
# global install
npm install -g @progfay/github-streaks
# then, call command
ghs [username]
```
### Development
#### Initialization
```sh
git clone git@github.com:progfay/github-streaks.git
cd github-streaks
npm install
```
#### Build
```sh
npm run build
```
#### Lint
```sh
npm run lint
# or
npm run lint:fix
```
#### Test
```sh
npm test
```
#### Debug
- Use [`npm link`](https://docs.npmjs.com/cli/link.html) .