gitallica

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 8, 2025 License: MIT Imports: 1 Imported by: 0

README

Gitallica

Go Version Build Status

Gitallica performs temporal diff analysis of distributed version control logs to help you understand code evolution, identify risks, and optimize team workflows. Analyze churn patterns, code survival rates, and other engineering metrics to make data-driven decisions about your codebase health.

Features

  • 14 Research-Backed Metrics: Based on industry studies from Microsoft Research, DORA, and Clean Code principles
  • DORA Compliance: Elite/High/Medium/Low performance classification using Accelerate benchmarks
  • Real Git Analysis: Authentic repository analysis using go-git (no external dependencies)
  • Comprehensive Coverage: From code survival to change lead time, bus factor to commit cadence
  • CLI-First Design: Simple commands with powerful filtering and time-window analysis

Quick Start

# Analyze code churn patterns
gitallica churn --last 30d

# Check code survival rates
gitallica survival --last 6m

# Measure DORA performance
gitallica change-lead-time --limit 10

Installation

Coming soon: Homebrew installation will be available after project stabilization.

For now, build from source:

git clone https://github.com/bgricker/gitallica.git
cd gitallica
go build -o gitallica .

Available Commands

Command Description Research Basis
churn Additions vs. deletions ratio Microsoft Research
survival Code survival rate analysis MSR, CodeScene
churn-files High-churn files identification Martin Fowler
component-creation New component creation rate Industry benchmarks
directory-entropy Directory structure entropy Edsger Dijkstra
dead-zones Untouched code identification Robert C. Martin
bus-factor Knowledge concentration analysis Martin Fowler
ownership-clarity Code ownership patterns Industry research
onboarding-footprint New contributor analysis Robert C. Martin
test-ratio Test-to-code ratio Robert C. Martin
high-risk-commits Large commit identification Kent Beck, Martin Fowler
commit-cadence Commit frequency trends Kent Beck
long-lived-branches Branch lifecycle analysis DORA research
change-lead-time DORA lead time metrics Accelerate research

Note: Review Bottlenecks (#13) requires GitHub API integration and is planned for future implementation.

Usage Examples

Basic Analysis
# Analyze entire repository
gitallica churn

# Time-scoped analysis
gitallica survival --last 3m

# Path-specific analysis
gitallica bus-factor --path src/
Advanced Filtering
# Combined filters
gitallica churn --last 90d --path lib/

# Detailed output
gitallica change-lead-time --limit 20 --method tag

Documentation

Research Foundation

Gitallica implements 14 metrics based on authoritative sources:

  • DORA Metrics: Elite/High/Medium/Low performance classification
  • Clean Code Principles: Robert C. Martin's guidelines
  • Microsoft Research: Code survival and churn analysis
  • Accelerate Research: Lead time and deployment frequency
  • Industry Benchmarks: Bus factor, ownership patterns, and more

Each metric includes:

  • Research-backed thresholds
  • Industry-standard classifications
  • Actionable recommendations
  • Performance benchmarking

Contributing

We welcome contributions! Please see our Contributing Guide for details.

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests for new functionality
  5. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • DORA Research: DevOps Research and Assessment team
  • Microsoft Research: Code survival and churn studies
  • Clean Code: Robert C. Martin's principles
  • Accelerate: Nicole Forsgren, Jez Humble, Gene Kim
  • go-git: Git implementation for Go

Gitallica - Shred your git history. Rock your repo insights. 🎸

Documentation

Overview

Copyright © 2025 Ben Ricker

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL