lubusin / laravel-decomposer
A Laravel package to decompose your installed packages, their dependencies, your app & server environment
Package info
github.com/lubusIN/laravel-decomposer
Language:Blade
Type:laravel-package
pkg:composer/lubusin/laravel-decomposer
Fund package maintenance!
Requires
- php: ^8.2
- illuminate/support: ^11.0|^12.0|^13.0
Requires (Dev)
- illuminate/http: ^11.0|^12.0|^13.0
- illuminate/routing: ^11.0|^12.0|^13.0
- laravel/pint: ^1.18
- orchestra/testbench: ^9.0|^10.0|^11.0
- pestphp/pest: ^3.0|^4.0
- pestphp/pest-plugin-laravel: ^3.0|^4.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Laravel Decomposer
Laravel Decomposer provides an instant, interactive breakdown of your Laravel application's installed packages, lock versions, and dependencies alongside deep server and framework environment details.
It also generates a standardized Markdown system report ready to copy or download for troubleshooting and GitHub issues, and provides programmatic PHP APIs to access report data as an array or JSON anywhere in your code.
Features
- Installed Packages & Dependencies: View all direct dependencies, required constraints, installed lock versions, and expandable direct sub-dependencies directly in the browser.
- Environment Diagnostics: Inspect Laravel version, timezone, debug mode, directory permissions (
storage,bootstrap/cache), app size, server software, PHP version, and loaded core extensions (OpenSSL, PDO, Mbstring, Tokenizer, XML). - One-Click Markdown Report: Generate, copy, or download a structured system report formatted for GitHub issues, issue trackers, and customer support tickets.
- Programmatic API: Retrieve the system report as a native PHP array or JSON payload anywhere in your application or CLI commands.
- Extensible Stats: Register custom application, Laravel, or server metrics via
Decomposer::addExtraStats(),addLaravelStats(), andaddServerStats(). - Modern Dashboard UI: Built with Tailwind CSS and Alpine.js, featuring real-time package search, hotkey search (
/), dependency filters, pagination, and built-in light & dark mode.
Requirements & Compatibility
- PHP:
^8.2(PHP 8.2, 8.3, 8.4) - Laravel:
11.x,12.x, and13.x
Installation
1. Install via Composer
composer require lubusin/laravel-decomposer
2. Publish Dashboard Assets
Publish the compiled stylesheet and JavaScript bundle to your application's public directory:
php artisan vendor:publish --tag=DecomposerAssets --force
3. Publish Configuration (Optional)
php artisan vendor:publish --tag=DecomposerConfig
This creates config/decomposer.php, where you can configure directories to exclude when calculating total application size:
return [ 'exclude_folders' => [ 'vendor', 'node_modules', 'storage', 'tests', '.git', ], ];
4. Register the Route
Add the Decomposer route to your routes/web.php. We recommend protecting this route with authentication or authorization middleware in production environments:
use Lubusin\Decomposer\Controllers\DecomposerController; // Development / Local: Route::get('decompose', [DecomposerController::class, 'index']); // Recommended for Production: Route::get('decompose', [DecomposerController::class, 'index']) ->middleware(['web', 'auth']);
5. Access the Dashboard
Open https://your-app.test/decompose (or your configured path) in your browser.
Usage
The Docs can be found in the Wiki but to save you one more click, here's the index
- Add your own extra stats for your package or app
- Get Decomposer report as markdown
- Get Decomposer report as an array
- Get Decomposer report as JSON
Local Development & Contributing
Thank you for considering contributing to Laravel Decomposer! Please review the contribution guidelines.
Setup for Local Package Development
-
Clone the repository:
git clone git@github.com:lubusIN/laravel-decomposer.git cd laravel-decomposer -
Install PHP and Node dependencies:
composer install npm install
-
Compile frontend assets:
npm run build # Or for active development: npm run dev -
Run tests and code style checks:
composer test # Runs Pest test suite composer lint # Checks formatting with Laravel Pint composer format # Auto-fixes formatting with Laravel Pint
Security
If you discover a security vulnerability within Laravel Decomposer, please email info@lubus.in. All security issues will be promptly addressed.
Meet Your Artisans
LUBUS is a web design and development agency based in Mumbai, India.
License
Laravel Decomposer is open-sourced software licensed under the MIT license.
