https://github.com/bbougon/git-stats
Retrieve Gitlab/GitHub statistics usage
https://github.com/bbougon/git-stats
github gitlab merge-request pull-request
Last synced: about 2 months ago
JSON representation
Retrieve Gitlab/GitHub statistics usage
- Host: GitHub
- URL: https://github.com/bbougon/git-stats
- Owner: bbougon
- License: mit
- Created: 2023-03-23T13:03:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-23T22:47:56.000Z (almost 3 years ago)
- Last Synced: 2025-09-29T05:20:32.386Z (9 months ago)
- Topics: github, gitlab, merge-request, pull-request
- Language: CSS
- Homepage:
- Size: 5.47 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Git stats
Provide MR/PR statistics for your Gitlab/GitHub projects
## Install
Run `npm install -g gitflows-stats`
### Prerequisite
**Generate a token to use the API:**
- [Gitlab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)
- Have a token with enough privilege (`read_api`)
- [GitHub](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-personal-access-token-classic)
- Generate a personal access token
## Usage
- `gitflows-stats --help` will print:
```shell
Usage: index [options] [command]
Options:
-h, --help display help for command
Commands:
gitlab [options] Provide merge requests statistics on a Gitlab project for a given period
github [options] Provide pull requests statistics on a GitHub project for a given period
help [command] display help for command
```
- the `` parameter has an optional end and may be in the following format:
- `2023-01-01,2023-01-31` will retrieve all the merged events between these 2 dates
- `2023-01-01` will retrieve all the merged events between the given date and now
- `gitflows-stats gitlab ` ( in the following format `2023-01-01,2023-01-31`) will print:
```json
{
"average": {
"months": 0,
"days": 4,
"hours": 22,
"minutes": 48,
"seconds": 0
},
"total": {
"merged": 15,
"closed": 2,
"opened": 3,
"all": 20
},
"data": [
[
2023,
[
{
"Week 9": 1
},
{
"Week 10": 5
},
{
"Week 11": 3
},
{
"Week 12": 2
},
{
"Week 13": 2
},
{
"Week 14": 2
}
]
]
]
}
```
- `gitflows-stats gitlab --format html` ( in the following format `2023-01-01,2023-01-31`) will generate a `report` folder with an `index.html` where the command has been executed.
**The report will automatically open after generation.**
**example:**
### Available output format
- **Console (Default):** print a lightweight statistics in JSON into the console
- **HTML:** generates a `HTML` file, opening automatically in your browser
- **CSV:** generates a `CSV` file with all raws data