Welcome to the complete documentation for GitFlow Analytics - a powerful tool for analyzing Git repositories to generate comprehensive developer productivity insights.
Non-technical guides for understanding team insights:
- Manager's Quick Start - Get insights in 5 minutes (no installation required)
- Understanding Reports - How to read GitFlow Analytics reports
- Metrics Reference - Plain-language metric definitions
- Dashboard Guide - Create Excel/Google Sheets dashboards
- Manager FAQ - Common questions answered
- All Manager Docs - Complete manager documentation
Start here to get up and running quickly:
- Installation Guide - Set up GitFlow Analytics
- Quick Start Tutorial - 5-minute walkthrough
- Your First Analysis - Analyze your first repository
Comprehensive guides for common tasks:
- LLM Classification Guide - AI-powered commit categorization
- ML Categorization - Machine learning features setup
- Interactive Launcher - Streamlined analysis workflow
- Identity Resolution - Enhanced developer identity detection
- Managing Aliases - Developer identity management
- PM Platform Setup - Project management integration
- ChatGPT Setup - AI-powered qualitative analysis
- Troubleshooting - Common issues and solutions
Real-world scenarios and templates:
- Interactive Launcher Examples - Complete launcher workflows
- Story Points Configuration - JIRA integration setup
- More Examples - Browse all available examples and use cases
Technical specifications and API details:
- CLI Commands - Complete command-line reference
- Configuration Schema - YAML structure specification
- JSON Export Format - Data export documentation
- Caching System - Performance and caching details
For contributors and developers:
- Contributing Guide - How to contribute to the project
- Development Setup - Local development environment
- Refactoring Guide - Code quality improvement tracking
- Training Guide - ML training and development
- Project Organization - Project structure standards
- All Developer Docs - Complete developer documentation
System design and technical decisions:
- ML Pipeline - Machine learning architecture
- Branch Analysis Optimization - Performance optimization
- Caching Strategy - Incremental processing design
- LLM Classifier Refactoring - AI integration architecture
- Design Documents - Detailed design decisions
Production deployment and scaling:
- Deployment Guide - Production deployment documentation
- Security Policy - Security best practices and vulnerability reporting
Understand team productivity (Manager) → Manager Quick Start → Report Interpretation → Dashboard Guide
Analyze a single repository → Installation → Quick Start → Interactive Launcher
Set up organization-wide analysis → PM Platform Setup → Identity Resolution → Managing Aliases
Integrate with CI/CD pipelines → CLI Reference → Interactive Launcher
Contribute to the project → Contributing Guide → Development Setup
Understand the architecture → ML Pipeline → Design Documents
Deploy in production → Deployment Guide → Security Policy
- Use your browser's search (Ctrl/Cmd+F) to find specific topics
- Check the Configuration Schema for YAML options
- Review Troubleshooting for common issues
- Browse Examples for similar use cases
This documentation follows our Documentation Standards and Structure Guidelines:
- Progressive disclosure - Start simple, dive deeper as needed
- Task-oriented - Organized around what you want to accomplish
- Tested examples - All code samples are validated and working
- Cross-referenced - Related topics are linked together
- Audience-focused - Clear paths for users, developers, and contributors
- Issues & Bugs: GitHub Issues
- Feature Requests: GitHub Discussions
- Contributing: See our Contributing Guide
GitFlow Analytics extracts insights from Git repositories including:
- Developer productivity metrics with identity resolution
- ML-powered commit categorization (85-95% accuracy)
- Project activity analysis across multiple repositories
- DORA metrics and development velocity tracking
- Beautiful reporting in CSV, JSON, and Markdown formats
All without requiring external project management tools like JIRA or Linear.
Need help? Start with the Quick Start Tutorial or check Troubleshooting.
Contributing? See the Contributing Guide and Development Setup.
Last Updated: January 2025