-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
287 lines (277 loc) · 13.3 KB
/
index.html
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<title>Git quick statistics is a simple and efficient way to access various statistics in git repository.</title>
<meta name="description"
content="▁▅▆▃▅ Any git repository may contain tons of information about commits, contributors, and files. Extracting this information is not always trivial, mostly because there are a gadzillion options to a gadzillion git commands – I don’t think there is a single person alive who knows them all. Probably not even Linus Torvalds himself :).">
<meta name="keywords" content="git, repository, github, statistics, linux, docker, windows">
<link href="assets/base.css" rel="stylesheet" type="text/css">
<link href="assets/style.css" rel="stylesheet" type="text/css">
<meta name="viewport" content="width=device-width,initial-scale=1,minimum-scale=1">
<link rel="shortcut icon" href="assets/icon.svg" type="image/x-icon">
<script defer data-domain="git-quick-stats.sh" src="https://beacon.static-data.com/js/script.js"></script>
</head>
<body>
<div id="wrap" class="container">
<header class="header">
<div class="row">
<div class="logo six columns">
<a href="https://git-quick-stats.sh/"><img width="40%" src="assets/logo.svg"
alt="git-quick-stats logo"></a>
</div>
<nav class="six columns">
<a href="#getting-started" class="github">Getting started</a>
<a href="#docs" class="github">Docs</a>
<a href="https://github.com/arzzen/git-quick-stats" class="github">GitHub
<img alt="github" src="assets/GitHub-Mark.png"></a>
</nav>
</div>
</header>
<section class="splash center">
<h1>
<span><u>Simple way</u> to access various <br>statistics in <u>git</u> repository. </span>
</h1>
<br>
<div class="center">
<p class="download">
<strong>Installation</strong>
<a href="https://github.com/arzzen/git-quick-stats#windows">Windows</a>
<a href="https://github.com/arzzen/git-quick-stats#unix-and-linux">Linux</a>
<a href="https://github.com/arzzen/git-quick-stats#macos-homebrew">macOS</a>
<a href="https://github.com/arzzen/git-quick-stats#docker">Docker</a>
</p>
<p>
<em>or you can install directly:</em>
<br>
<code>
bash <(curl -s https://git-quick-stats.sh/install)
</code>
</p>
</div>
<div class="center">
<img src="https://user-images.githubusercontent.com/8818630/154823670-f42a111b-45f4-47fc-aea7-80059827c8e6.png"
alt="git quick stats">
</div>
</section>
<section class="features">
<h2 class="center">
<span>Features</span>
</h2>
<div class="row">
<div class="four columns">
<h3>Multiplatform</h3>
Works on Windows, Linux and macOS (or you can use the Docker image).
</div>
<div class="four columns">
<h3>Contribution stats</h3>
List of everyone who contributed to the repository.
</div>
<div class="four columns">
<h3>Code reviewers</h3>
Find the best people to contact to review code.
</div>
</div>
<div class="row">
<div class="four columns">
<h3>Git changelogs</h3>
Easy to fetch git changelogs.
</div>
<div class="four columns">
<h3>Dependency</h3>
You can run on every OS with a Bash shell.
</div>
<div class="four columns">
<h3>Open source</h3>
Git-quick-stats is free, open source software licensed under MIT.
</div>
</div>
</section>
<section>
<h2 class="center">
<span>More screenshots</span>
</h2>
<div class="row">
<div class="">
<img src="https://user-images.githubusercontent.com/8818630/154823677-e34ca867-ae61-4755-bf89-c877f809c591.png"
alt="git commits by weekday">
</div>
<div class="">
<img src="https://user-images.githubusercontent.com/8818630/154823679-bdadc26c-c644-4a01-b625-85e330f85d41.png"
alt="git commits by hour">
</div>
</div>
</section>
<section>
<h2 class="center" id="getting-started">Getting started</h2>
<ul>
<li>
<strong>Installation</strong>
<ul>
<li>
<a href="https://github.com/arzzen/git-quick-stats#windows">Windows</a>
</li>
<li>
<a href="https://github.com/arzzen/git-quick-stats#unix-and-linux">Linux</a>
</li>
<li>
<a href="https://github.com/arzzen/git-quick-stats#macos-homebrew">macOS</a>
</li>
<li>
<a href="https://github.com/arzzen/git-quick-stats#docker">Docker</a>
</li>
</ul>
<br>
</li>
<li><strong>Interactive usage</strong>
<ul>
<li>
git-quick-stats has a built-in interactive menu that can be executed as such:
<br>
<code>git-quick-stats</code>
<br>
Or
<br>
<code>git quick-stats</code>
</li>
</ul>
</li><br>
<li><strong>Non-interactive usage</strong>
<ul>
<li>
For those who prefer to utilize command-line options, git-quick-stats also has a
non-interactive mode supporting both short and long options:
<br>
<code>git-quick-stats [optional-command-to-execute-directly]</code>
<br>
Or
<br>
<code>git quick-stats [optional-command-to-execute-directly]</code>
</li>
<li>
Command-line arguments:
<br>
<code>-r, --suggest-reviewers</code>
show the best people to contact to review code<br>
<code>-T, --detailed-git-stats</code>
- give a detailed list of git stats<br>
<code>-R, --git-stats-by-branch</code>
see detailed list of git stats by branch<br>
<code>-d, --commits-per-day</code>
displays a list of commits per day<br>
<code>-m, --commits-by-month</code>
displays a list of commits per month<br>
<code>-w, --commits-by-weekday</code>
displays a list of commits per weekday<br>
<code>-o, --commits-by-hour</code>
displays a list of commits per hour<br>
<code>-A, --commits-by-author-by-hour</code>
displays a list of commits per hour by author<br>
<code>-a, --commits-per-author</code>
displays a list of commits per author<br>
<code>-S, --my-daily-stats</code>
see your current daily stats<br>
<code>-C, --contributors</code>
see a list of everyone who contributed to the repo<br>
<code>-b, --branch-tree</code>
show an ASCII graph of the git repo branch history<br>
<code>-D, --branches-by-date</code>
show branches by date<br>
<code>-c, --changelogs</code>
see changelogs<br>
<code>-L, --changelogs-by-author</code>
see changelogs by author<br>
<code>-j, --json-output</code>
save git log as a JSON formatted file to a specified area<br>
<code>-h, -?, --help</code>
display this help text in the terminal<br>
</li>
</ul>
</li>
</ul>
</section>
<section>
<h2 class="center" id="docs">
<span>Documentation</span>
</h2>
<div>
<ul>
<li><strong>Git log since and until</strong>
<p>
You can set the variables _GIT_SINCE and/or _GIT_UNTIL before running git-quick-stats to
limit the git log. <br>
These work similar to git's built-in --since and --until log options.
</p>
<code>
export _GIT_SINCE="2017-01-20"<br>
export _GIT_UNTIL="2017-01-22"
</code>
<p>
Once set, run git quick-stats as normal. Note that this affects all stats that parse the git
log history until unset.
</p>
</li>
<li><strong>Git log limit</strong>
<p>
You can set variable _GIT_LIMIT for limited output. It will affect the "changelogs" and
"branch tree" options.
</p>
<p>
<code>
export _GIT_LIMIT=20
</code>
</p>
</li>
<li><strong>Git pathspec</strong>
<p>
You can exclude a directory from the stats by using pathspec
</p>
<code>
export _GIT_PATHSPEC=':!directory'
</code>
<p>
You can also exclude files from the stats. Note that it works with any alphanumeric, glob,
or regex that git respects.
</p>
<p>
<code>
export _GIT_PATHSPEC=':!package-lock.json'
</code>
</p>
</li>
<li>
<strong>Git merge view strategy</strong>
<p>
You can set the variable _GIT_MERGE_VIEW to enable merge commits to be part of the stats by
setting _GIT_MERGE_VIEW to enable. You can also choose to only show merge commits by setting
_GIT_MERGE_VIEW to exclusive. Default is to not show merge commits. These work similar to
git's built-in --merges and --no-merges log options.
</p>
<p>
<code>
export _GIT_MERGE_VIEW="enable"<br>
export _GIT_MERGE_VIEW="exclusive"
</code>
</p>
</li>
<li><strong>Color themes</strong>
<p>
You can change to the legacy color scheme by toggling the variable _MENU_THEME between
default and legacy
</p>
<p>
<code>
export _MENU_THEME=legacy
</code>
</p>
</li>
</ul>
</div>
</section>
<footer class="footer">
© 2017-2024. All rights reserved
</footer>
</div>
</body>
</html>