Skip to content

Quick Start

Get up and running with GitInspectorGUI in just a few steps.

Installation

Download the latest release for your platform:

  • GitHub Releases - GUI apps for Windows and macOS
  • No installation required - just download and run

Option 2: Install from PyPI

pip install gitinspectorgui

Basic Usage

Using the GUI

  1. Launch the application
  2. Double-click the downloaded executable, or

  3. Run python -m gigui.gui if installed via PyPI

  4. Select your repository

  5. Click "Browse" next to "Input folder path"
  6. Navigate to your Git repository folder

  7. Click "Select Folder"

  8. Run analysis

  9. Click the "Run" button

  10. Wait for analysis to complete (progress shown in console)

  11. View results

  12. Results automatically open in your default browser (HTML format)
  13. Excel files are saved to the repository's parent directory

Using the CLI

# Analyze current directory
gitinspectorgui .

# Analyze specific repository
gitinspectorgui /path/to/repository

# Generate Excel output
gitinspectorgui /path/to/repository --format excel

What You'll Get

GitInspectorGUI generates comprehensive reports showing:

  • Author Statistics - Lines added/removed per contributor
  • File Analysis - Contribution breakdown by file
  • Blame Information - Line-by-line authorship with color coding
  • Visual Reports - Easy-to-read HTML and Excel formats

Common Options

Filter by Date Range

# Only commits after 2023-01-01
gitinspectorgui . --since 2023-01-01

# Only commits before 2023-12-31
gitinspectorgui . --until 2023-12-31

Include Specific File Types

# Only Python and JavaScript files
gitinspectorgui . --file-types py,js

Exclude Authors

# Exclude bot commits
gitinspectorgui . --exclude-authors "*bot*,*automated*"

Next Steps

Need Help?