https://github.com/captainsafia/dossier
Generate statistics from any repository that adheres to the conventional changelog standard
https://github.com/captainsafia/dossier
command-line-tool git open-source
Last synced: about 1 year ago
JSON representation
Generate statistics from any repository that adheres to the conventional changelog standard
- Host: GitHub
- URL: https://github.com/captainsafia/dossier
- Owner: captainsafia
- License: mit
- Created: 2017-03-06T08:44:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-12T13:47:55.000Z (over 9 years ago)
- Last Synced: 2025-04-30T07:34:44.304Z (about 1 year ago)
- Topics: command-line-tool, git, open-source
- Language: JavaScript
- Size: 146 KB
- Stars: 80
- Watchers: 3
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# dossier
dossier is a command line utility that generates a report from any git repository
that utilizes the [Conventional Changelog Standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md). Technically, this tool can be used on any commit message convention that denotes
commit type with a prefix. Currently, dossier generates the following statistics:
- Commit counts by prefix
- Top contributor by prefix
- Most frequent commit day by prefix
If you're interested in seeing more statistics reflected in dossier, you can
submit an issue.
dossier aims to provide an output that can be easily piped and parsed
by other utilities in your workflow.
### Installation
```
npm install --global @captainsafia/dossier
```
### Usage
```
Usage: dossier [options]
Options:
-h, --help output usage information
-V, --version output the version number
-c, --commits Number of commits to analyze
-p, --prefixes Conventional changelog prefixes used
```
