Installation

Requirements

• PHP 8.2 or higher
• Git installed and accessible from command line
• Laravel: Laravel 11.x or 12.x
• WordPress: WP-CLI 2.8+

Installation

Codemetry is a development/analysis tool—it analyzes your Git history but isn’t needed in production. Install it as a dev dependency.

Laravel

1. Install via Composer

   composer require codemetry/laravel --dev

   The service provider is auto-discovered—no manual registration needed.

2. Publish the configuration (optional)

   php artisan vendor:publish --tag=codemetry-config

   This creates config/codemetry.php where you can customize:

   • Baseline days (default: 56)
   • Follow-up horizon (default: 3 days)
   • Keyword patterns for fix/revert/wip detection
   • AI engine settings

3. Verify installation

   php artisan codemetry:analyze --days=1

   If you see a table with mood results, you’re all set!

WordPress (WP-CLI)

1. Install via WP-CLI or Composer

   # Option 1: WP-CLI package manager
   wp package install codemetry/wordpress
   
   # Option 2: Composer
   composer require codemetry/wordpress --dev

2. Configure via wp-cli.yml (optional)

   Create wp-cli.yml in your project root:

   codemetry:
     baseline_days: 56
     ai:
       enabled: false
       engine: openai
       api_key: ${CODEMETRY_AI_API_KEY}

3. Verify installation

   wp codemetry analyze --days=1

   If you see a table with mood results, you’re all set!

Configuration File

After publishing, you’ll have config/codemetry.php:

return [
    // Days of history for baseline distribution
    'baseline_days' => 56,

    // Days after a window to scan for follow-up fixes
    'follow_up_horizon_days' => 3,

    // Commit message patterns
    'keywords' => [
        'fix_pattern' => '/\b(fix|bug|hotfix|patch|typo|oops)\b/i',
        'revert_pattern' => '/\b(revert)\b/i',
        'wip_pattern' => '/\b(wip|tmp|debug|hack)\b/i',
    ],

    // AI configuration (optional)
    'ai' => [
        'enabled' => false,
        'engine' => env('CODEMETRY_AI_ENGINE', 'openai'),
        'api_key' => env('CODEMETRY_AI_API_KEY'),
        'model' => env('CODEMETRY_AI_MODEL'),
        'base_url' => env('CODEMETRY_AI_BASE_URL'),  // Custom API endpoint
        'timeout' => env('CODEMETRY_AI_TIMEOUT', 30),  // Request timeout
    ],
];

Tip

You don’t need to publish the config to use Codemetry. The defaults work well for most projects.

Upgrading

Both codemetry/laravel and codemetry/core must be updated together to ensure compatibility. Use one of these commands:

# Update all Codemetry packages
composer update "codemetry/*"

# Or explicitly
composer update codemetry/laravel codemetry/core

Caution

Running composer update codemetry/laravel alone may not work because both packages are versioned together and require matching versions.

Installing from GitHub (Pre-Release)

If the package isn’t on Packagist yet, install directly from GitHub:

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/albertoarena/codemetry"
        }
    ],
    "minimum-stability": "dev",
    "prefer-stable": true,
    "require-dev": {
        "codemetry/laravel": "dev-master"
    }
}

Then run:

composer update

Troubleshooting

Command not found

If php artisan codemetry:analyze returns “Command not found”, the service provider may not be loaded. Try:

php artisan package:discover --ansi

Git errors

Codemetry requires Git access. Ensure:

• You’re running the command from a Git repository
• The git command is available in your PATH
• The repository has commit history (not a fresh init)

Memory issues on large repos

For repositories with extensive history, the baseline calculation may use significant memory. Try:

• Reducing baseline_days in config
• Running with increased PHP memory: php -d memory_limit=512M artisan codemetry:analyze