Laravel Console Summary Laravel Package

Getting Started

1. Install the package: Run composer require nunomaduro/laravel-console-summary. No service provider registration is needed—Laravel’s auto-discovery handles it.
2. Publish config (optional): Run php artisan vendor:publish to generate config/laravel-console-summary.php. This lets you customize which commands to hide or override the binary name.
3. Use immediately: Just run any Artisan command (e.g., php artisan) and the summary output will appear by default. No code changes required in your commands.

Implementation Patterns

• Zero-configuration: Works out of the box for all existing commands—no need to modify command classes. The summary is rendered after command execution or when listing commands (php artisan list).
• Customize visibility: In config/laravel-console-summary.php, use glob patterns like 'make:*' or exact names like 'list' to hide commands from the summary UI while keeping them functional.
• Laravel Zero integration: Works seamlessly with Laravel Zero apps (used for CLI tooling), giving polished output for internal CLI tools without extra setup.
• Override binary name: Set 'binary' => 'myapp' in config to replace php artisan with myapp in usage examples (e.g., myapp help).
• Combine with other tools: Works alongside custom console formatters or output decorators since it hooks into Laravel’s command summary rendering phase.

Gotchas and Tips

• Hidden ≠ disabled: Commands hidden in the summary (via config) remain fully functional—this is purely cosmetic for CLI output clarity.
• Case sensitivity: Hide patterns are case-insensitive, but glob patterns like make:* only match command names, not aliases.
• PHP 8.2+ required: Versions ≥1.9.0 require PHP 8.2+, so verify compatibility with your environment before upgrading.
• Debugging missing output: If the summary doesn’t appear, ensure no custom Output or Symfony\Component\Console\Output\ConsoleOutput override is interfering—this package leverages Laravel’s default console output handling.
• Extension point: While not designed for deep customization, the package uses Laravel’s built-in ListCommand replacement pattern—advanced users could theoretically extend NunoMaduro\Summary\Commands\ListCommand to override formatting logic (but this is unsupported and version-sensitive).
• Keep dependencies light: Since it’s a small, focused package, avoid over-integrating it with unrelated tools—it’s designed to be a drop-in visual enhancement, not a logging or analytics layer.