README

Run allowlisted Artisan commands from a Livewire UI. Every execution is logged to the database and notifications are sent on completion or failure.

Features

• Three discovery modes - Manual allowlist, auto-discover, or selective discovery
• Livewire 4 UI - Select commands, configure parameters, and view output in real-time
• Async by default - Commands run via queued jobs, never blocking HTTP requests
• Full audit trail - Every execution logged with who, what, when, and result
• Output viewer - Click any execution to expand terminal-style command output
• Notifications - Mail and database notifications on completion or failure
• Dynamic parameters - Arguments and options rendered separately with proper input types

Installation

composer require cleaniquecoders/laravel-artisan-runner

Publish and run migrations:

php artisan artisan-runner:install
php artisan migrate

Quick Start

Add a command to your allowlist in config/artisan-runner.php:

'allowed_commands' => [
    'cache:clear' => [
        'label'       => 'Clear Cache',
        'description' => 'Flush the application cache.',
        'group'       => 'Cache',
        'parameters'  => [],
    ],
],

Include the Livewire component in any Blade view:

<livewire:artisan-runner::command-runner />

Start your queue worker and run commands from the UI.

Documentation

Full documentation is available in the docs directory:

• Getting Started - Installation, quick start, basic usage
• Architecture - Design, contracts, data layer
• Configuration - Config reference, environment variables
• Livewire UI - Component usage and customization
• Testing - Pest test conventions and examples
• Advanced - Log pruning, notifications, extending

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Nasrul Hazim
• All Contributors

License

The MIT License (MIT). Please see License File for more information.