Documentation

github-insights collects comprehensive activity insights from GitHub. It tracks your contributions (pull requests, code reviews, issues, mentions, and releases) across a date range and outputs structured data for reporting, analysis, or documentation.

Example visualization of collected insights in the Steam-themed viewer

Features

Pull Request Tracking: capture all PRs you authored and reviewed
Issue Analytics: track issues created and commented on
Mention Detection: find all mentions of your username across repositories
Release & Tag Monitoring: track releases and tags in repositories you maintain
Flexible Configuration: use a YAML config file, command-line flags, or environment variables
Structured Output: JSON files organized by repository for easy analysis
Rate Limit Aware: efficient GitHub API usage with automatic rate limit handling

Where to go next

Installation

go install, release binaries, container image, or build from source.

Usage

Command-line flags and common examples.

Configuration

Config file, environment variables, and how they combine.

Output

The report files and what they contain.

Viewer

Browse the reports in a static web page.

Troubleshooting

Common errors and how to fix them.