Theme

Installation ​

System Requirements ​

Minimum Requirements ​

  • PHP: 8.1 or higher
  • Laravel: 9.x, 10.x, 11.x, or 12.x
  • Composer: 2.0 or higher
  • Memory: 512MB minimum (1GB recommended for large projects)
  • Disk Space: 50MB for package + cache
  • PHP: 8.2 or higher
  • Extensions: ext-json, ext-mbstring, ext-tokenizer
  • Memory: 1GB or higher
  • OPcache: Enabled for better performance

Compatibility Matrix ​

Laravel VersionPHP VersionShieldCI Support
Laravel 12.xPHP 8.2+✅ Full Support
Laravel 11.xPHP 8.2+✅ Full Support
Laravel 10.xPHP 8.1+✅ Full Support
Laravel 9.xPHP 8.1+✅ Full Support

Installation Methods ​

Install ShieldCI:

bash
composer require shieldci/laravel

Verify Installation:

bash
php artisan shield:analyze

This will run the analysis and show the ShieldCI version in the output.

Method 2: Global Installation ​

Install ShieldCI globally for use across multiple projects:

bash
composer global require shieldci/laravel

Add to PATH (if not already):

bash
# Add to ~/.bashrc or ~/.zshrc
export PATH="$HOME/.composer/vendor/bin:$PATH"

Run from any Laravel project:

bash
cd /path/to/your/laravel/app
php artisan shield:analyze

Method 3: Docker ​

Use ShieldCI in a Docker container:

bash
# Pull official image
docker pull shieldci/laravel:latest

# Run analysis
docker run --rm -v $(pwd):/app shieldci/laravel:latest php artisan shield:analyze

Docker Compose Integration:

yaml
# docker-compose.yml
services:
  shieldci:
    image: shieldci/laravel:latest
    volumes:
      - .:/app
    command: php artisan shield:analyze

Run analysis:

bash
docker-compose run --rm shieldci

Post-Installation Setup ​

Step 1: Publish Configuration (Optional) ​

Generate a configuration file to customize analyzer behavior:

bash
php artisan vendor:publish --tag=shieldci-config

This creates config/shieldci.php with default settings.

Step 2: Verify Installation ​

Run your first analysis to verify installation:

bash
php artisan shield:analyze

This will run all analyzers and show you the results. If you see the analysis report, ShieldCI is installed correctly.

Step 3: Run First Analysis ​

Perform your first security and quality scan:

bash
php artisan shield:analyze

This will:

  1. Discover your Laravel project structure
  2. Parse PHP files into ASTs
  3. Run all analyzers
  4. Generate a detailed report

Expected duration: 30-60 seconds for typical Laravel apps

See First Analysis for detailed walkthrough.

Installation Troubleshooting ​

Issue: Composer Install Fails ​

Error:

Your requirements could not be resolved to an installable set of packages.

Solutions:

  1. Update Composer dependencies:

    bash
    composer update shieldci/laravel --with-all-dependencies

  2. Check PHP version:

    bash
    php -v  # Must be 8.1+

  3. Clear Composer cache:

    bash
    composer clear-cache
composer install

Issue: Command Not Found ​

Error:

bash
php artisan shield:analyze
# Command "shield:analyze" is not defined.

Solutions:

  1. Clear Laravel cache:

    bash
    php artisan config:clear
php artisan cache:clear
php artisan optimize:clear

  2. Verify package is in composer.json:

    bash
    composer show shieldci/laravel

  3. Reinstall package:

    bash
    composer remove shieldci/laravel
composer require shieldci/laravel

Issue: Memory Limit Exceeded ​

Error:

PHP Fatal error: Allowed memory size of 134217728 bytes exhausted

Solutions:

  1. Increase PHP memory limit (temporary):

    bash
    php -d memory_limit=512M artisan shield:analyze

  2. Update php.ini (permanent):

    ini
    memory_limit = 512M

  3. Exclude large directories:

    php
    // config/shieldci.php
'excluded_paths' => [
    'vendor/*',
    'node_modules/*',
    'storage/*',
    'public/build/*',  // Add large build directories
],

Issue: Parse Errors in Legacy Code ​

Error:

Parse error: syntax error, unexpected token "match" in OldController.php

Solutions:

  1. Exclude problematic files:

    php
    // config/shieldci.php
'excluded_paths' => [
    'vendor/*',
    'app/Legacy/**',  // Exclude legacy code
],

  2. Update PHP version:

    bash
    # ShieldCI requires PHP 8.1+ for modern syntax
php -v

Issue: Slow Analysis Performance ​

Symptoms: Analysis takes 5+ minutes

Solutions:

  1. Enable OPcache:

    ini
    ; php.ini
opcache.enable=1
opcache.enable_cli=1

  2. Reduce analyzed paths:

    php
    // config/shieldci.php
'paths' => [
    'analyze' => [
        'app/Http',      // Only analyze critical paths
        'app/Models',
        'routes',
    ],
],

Upgrading ​

From Previous ShieldCI Versions ​

bash
# Update to latest version
composer update shieldci/laravel

# Clear caches
php artisan config:clear
php artisan cache:clear

# Republish config (if needed)
php artisan vendor:publish --tag=shieldci-config --force

Breaking changes: See CHANGELOG.md

Uninstallation ​

Remove ShieldCI completely:

bash
# 1. Remove package
composer remove shieldci/laravel

# 2. Delete configuration (optional)
rm config/shieldci.php

# 3. Clear caches
php artisan config:clear
php artisan cache:clear

Next Steps ​

Getting Help ​

Copyright © 2026 ShieldCI