git-insights 0.0.2

A CLI tool to generate Git repo stats and insights.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# git-insights

A cli tool to generate Git repo stats and insights.

## Features

- [x] Overall repository statistics
  - [x] Total commit count
  - [x] Total file count
  - [x] Total lines of code (LOC)
  - [x] Per-author breakdown (LOC/commits/files) with % distribution
- [ ] Individual user insights
  - [x] Get file "ownership" list
  - [x] Ownership table flags: `--top N`, `--sort loc|pct` and `--by-email` (default matches by name)
  - [ ] Total locs, inserts, updates, deletes
  - [ ] Past PRs/issues count
  - [x] Tags/releases count
- [ ] Data export
  - [x] Export to JSON
  - [ ] Export to CSV
- [ ] Visualizations
  - [ ] Commit heatmap
  - [ ] Hotspot analysis
  - [ ] Timeline charts
- [x] CLI/UX
  - [x] Fast, no-deps
  - [x] Helpful global and per-command help
  - [x] Version command
  - [x] Clean progress spinner while processing files
  - [x] Group by author name by default, or use --by-email for `"Name <email>"`
  - [x] Clean git calls (no pager)

## Installation

### Installing from crates.io

```bash
cargo install git-insights
```

### Installing via cargo + git

```bash
cargo install --git https://github.com/Magnus167/git-insights.git
```

### Building from source

```bash
git clone https://github.com/Magnus167/git-insights.git
cd git-insights
cargo install --path .
```

## Usage

`git-insights` provides several commands to analyze your repository.
To see the available commands and options, run:

```bash
git-insights --help
```

## License

MIT License. See [`LICENSE`](./LICENSE) file for details.