Skip to content

Quickstart

This guide gets you from zero to your first analysis in under 2 minutes.

  1. Install the package

    Terminal window
    composer require codemetry/laravel --dev
  2. Run your first analysis

    Terminal window
    php artisan codemetry:analyze --days=7
  3. View the results

    You’ll see a table showing the mood proxy for each day:

    DateMoodScoreConfidenceTop Reasons
    2024-01-15good780.80Low churn; stable patterns
    2024-01-14medium550.70Elevated scatter

That’s it! Codemetry analyzed your Git history and produced quality metrics for the last 7 days.

What Just Happened?

Codemetry:

  1. Read your Git log for the specified time range
  2. Collected signals: churn, file scatter, follow-up fixes, commit patterns
  3. Compared signals against a 56-day baseline (your repo’s normal patterns)
  4. Computed a score (0-100) and label (bad/medium/good) for each day
  5. Identified the top reasons contributing to each day’s score

Next Steps