README

Project Intelligence Engine for Laravel — Scan, understand, and export clean context for any Laravel project.

Transform static project analysis into actionable AI context. Beacon helps AI assistants (ChatGPT, Claude, Gemini, Cursor, Cline, Copilot) understand a Laravel project almost as if they had been developed together with the original team from day one.

Quick Start

composer require coffesoft/laravel-beacon

# Full project scan (recommended first step)
php artisan beacon:scan

# Generate task-specific AI context
php artisan beacon:task "Create attendance system"

# Code quality review
php artisan beacon:review --min-severity=warning

# AI-powered refactoring plan
php artisan beacon:fix-plan

The service provider auto-discovers via Laravel package discovery.

Compatibility

Commands

Core Commands

# Full project scan — runs all scanners + intelligence engines
php artisan beacon:scan

# Re-export from cached scan data
php artisan beacon:export --format=md
php artisan beacon:export --format=json

AI Working Context

# Generate task-specific context for AI assistants
php artisan beacon:task "Create attendance system"

# Show project changes since last scan
php artisan beacon:diff

# Code quality review with severity ranking
php artisan beacon:review --min-severity=warning

AI Copilot

# Full AI refactoring plan with priorities and execution order
php artisan beacon:fix-plan

# Code fix suggestions from review output
php artisan beacon:suggest-fix

# Route quality analysis (duplicates, orphans, REST violations)
php artisan beacon:route-health

Output Files

All outputs are stored in storage/app/beacon/.

Analysis Outputs

AI Working Context

AI Copilot

Architecture

Scanners → Raw Data → Intelligence Engines → Output Files

Scanners (25)

Models, Controllers, Routes, Migrations, Database, Config, Services, Repositories, FormRequests, Middleware, Policies, Events, Jobs, Notifications, Mail, Traits, Enums, Helpers, Livewire, Blade, API, Queue, Storage, Packages, Commands

Intelligence Engines

Architecture Detection, Security Analysis, Performance Analysis, Business Rules, Relationship Graph, AI Summaries, Database Intelligence, Route Intelligence, Folder Tree, Module Detection, Workflow Detection, Dependency Graph, Feature Map, Impact Map, AI Context Compression, Entry Points, Developer Onboarding, AI Prompt Pack, Task Context, Diff Engine, Review Engine, Route Health, Code Fix Engine, AI Refactor Planner, Auto Controller Splitter

Safety

• Read-only — Never executes or modifies application code
• AST-first — Uses PHP tokenization for safe analysis
• Zero application boot — No database queries, no service registration
• Confidence scores — Every finding includes 0–100 reliability rating
• Evidence field — Every suggestion includes the data that triggered it

What It Scans

Requirements

• PHP 8.1+
• Laravel 9.x, 10.x, 11.x, 12.x, or 13.x
• ext-json (included with PHP by default)
• ext-mbstring (included with PHP by default)

License

MIT