GITINSPECTOR(1)

📦
version 0.4.4 · 5 versions
, in ubuntu resolute, ubuntu stonking

💖 NAME 💖

okay bestie, welcome to gitinspector(1) — it's the statistical analysis tool for git repositories, and it's literally about to count everything for you ✨

🦋 SYNOPSIS 🦋

gitinspector [OPTION]... [REPOSITORY]

🎀 DESCRIPTION 🎀

So here's the vibe: gitinspector analyzes a git repository and gathers up all the statistics about it. The default analysis shows you general stats per author (the classic), and you can level it up with a timeline analysis that shows the workload and activity of each author. Slay. 📊

Under normal operation, gitinspector filters the results down so it only shows statistics for a number of given extensions, and by default it only includes source files in the statistical analysis. It's picky like that, but in a cute way. 💅

Several output formats are supported, including plain text, HTML and XML. Choose your fighter. 🌈

✨ OPTIONS ✨

List information about the repository in REPOSITORY. If no repository is specified, the current directory is used. And heads up bestie: if you give multiple repositories, the information will be fetched from the last repository you specified. Last one wins, no cap. 🫶

Mandatory arguments to long options are mandatory for short options too. Boolean arguments can only be given to long options. (Yes, that's the rule. Write it down. 📝)
  • -f, --file-types=EXTENSIONS — a comma separated list of file extensions to include when computing statistics. The default extensions used are: java,c,cc,cpp,h,hh,hpp,py,glsl,rb,js,sql. If you specify a single * asterisk character, that includes files with no extension. If you specify two consecutive ** asterisk characters, that includes all files regardless of extension. 🍓
  • -F, --format=FORMAT — defines in which format output should be generated; the default format is text and the available formats are: html,htmlembedded,text,xml (peep OUTPUT FORMATS below for the full tea ☕)
  • --grading[=BOOL] — show statistics and information in a way that is formatted for grading of student projects; this is the same as supplying the options -HlmrTw. Iconic bundle deal. 👑
  • -H, --hard[=BOOL] — track rows and look for duplicates harder; this can be quite slow with big repositories 😭 (worth it though, sometimes)
  • -l, --list-file-types[=BOOL] — list all the file extensions available in the current branch of the repository
  • -L, --localize-output[=BOOL] — localize the generated output to the selected system language, if a translation is available 🌍
  • -m, --metrics[=BOOL] — include checks for certain metrics during the analysis of commits
  • -r, --responsibilities[=BOOL] — show which files the different authors seem most responsible for (the blame game, but make it statistics 🫣)
  • --since=DATE — only show statistics for commits more recent than a specific date
  • -T, --timeline[=BOOL] — show commit timeline, including author names ⏳
  • --until=DATE — only show statistics for commits older than a specific date
  • -w, --weeks[=BOOL] — show all statistical information in weeks instead of in months
  • -x, --exclude=PATTERN — an exclusion pattern describing the file paths, revisions, author names or author emails that should be excluded from the statistics; can be specified multiple times (see FILTERING)
  • -h, --help — display help and exit
  • --version — output version information and exit

🌈 OUTPUT FORMATS 🌈

There are support for multiple output formats in gitinspector. You pick one using the -F/--format flags when running the main gitinspector script. Here's the lineup:

text (plain text) 💬

Plain text with some very simple ANSI formatting, suitable for console output. This is the format chosen by default by gitinspector. The ol' reliable.

html 🌐

HTML with external links. The generated HTML page links to some external resources; such as the JavaScript library JQuery. It requires an active internet connection to properly function. This output format will most likely also link to additional external resources in the future. (Future-proofing, we love to see it.)

htmlembedded 📦

HTML with no external links. Similar to the HTML output format, but requires no active internet connection. As a consequence; the generated pages are bigger (as certain scripts have to be embedded into the generated output). Trade-off city, but it works offline bestie 🫶

xml 🤖

XML suitable for machine consumption. If you want to parse the output generated by gitinspector in a script or application of your own; this is the format you should choose. Robots eat this one up.

💅 FILTERING 💅

gitinspector offers several different ways of filtering out unwanted information from the generated statistics:

  • gitinspector -x myfile, filter out and exclude statistics from all files (or paths) with the string "myfile"
  • gitinspector -x file:myfile, filter out and exclude statistics from all files (or paths) with the string "myfile"
  • gitinspector -x author:John, filter out and exclude statistics from all authors containing the string "John"
  • gitinspector -x email:@gmail.com, filter out and exclude statistics from all authors with a gmail account
  • gitinspector -x revision:8755fb33, filter out and exclude statistics from all revisions containing the hash "8755fb33"
  • gitinspector -x message:BUGFIX, filter out and exclude statistics from all revisions containing "BUGFIX" in the commit message.

The gitinspector command also lets you add multiple filtering rules by simply specifying the -x options several times or by separating each filtering rule with a comma;

  • gitinspector -x author:John -x email:@gmail.com
  • gitinspector -x author:John,email:@gmail.com

Sometimes, sub-string matching (as described above) is simply not enough. Therefore, gitinspector let's you specify regular expressions as filtering rules. This makes filtering much more flexible:

  • gitinspector -x "author:\^(?!(John Smith))", only show statistics from author "John Smith"
  • gitinspector -x "author:\^(?!([A-C]))", only show statistics from authors starting with the letters A/B/C
  • gitinspector -x "email:.com$", filter out statistics from all email addresses ending with ".com"

🧚 USING GIT TO CONFIGURE GITINSPECTOR 🧚

Options in gitinspector can be set using git config. Consequently, it is possible to configure gitinspector behavior globally (in all git repositories) or locally (in a specific git repository). It also means that settings will be permanently stored. All the long options that can be given to gitinspector can also be configured via git config (and take the same arguments). Set it and forget it, bestie 💜

To configure how gitinspector should behave in all git repositories, execute the following git command:

git config --global inspector.option setting

To configure how gitinspector should behave in a specific git repository, execute the following git command (with the current directory standing inside the repository in question):

git config inspector.option setting

👑 AUTHOR 👑

Originally written by Adam Waldenberg. Respect the founder. 🫡

😭 REPORTING BUGS 😭

Report gitinspector bugs to gitinspector@ejwa.se

The gitinspector project page: https://github.com/ejwa/gitinspector

If you encounter problems, be sure to read the FAQ first: https://github.com/ejwa/gitinspector/wiki/FAQ

There is also an issue tracker at: https://github.com/ejwa/gitinspector/issues

fr fr, read the FAQ first before you file that issue. Future you says thank you 🫶

Copyright © 2012-2016 Ejwa Software. All rights reserved. License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

🌸 SEE ALSO 🌸

git(1)

and that's the whole page bestie, you ate that 💅✨ this is gitinspector 0.4.4, dated 01/20/2026, and it came straight out of The gitinspector Manual — go forth and count some commits, mwah 🎀🦋

📦 where this page comes from