dossier

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 80 Open GitHub ↗

Generate statistics from any repository that adheres to the conventional changelog standard

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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 <n>   Number of commits to analyze
    -p, --prefixes <l>  Conventional changelog prefixes used
```

![Dossier Demo](https://raw.githubusercontent.com/captainsafia/dossier/master/dossier-demo.gif)

dossier

Today's picks

Was this content helpful?

Recent Feedback

dossier

Today's picks

Was this content helpful?

Recent Feedback

Download README