Run artisan and shell commands in the background from your Filament admin panel.
filament-command-runner is a Filament plugin that allows users to run artisan and shell commands directly from the Filament admin panel. All commands are executed in the background so users don't have to wait for them to finish. They can return later to view the output or optionally terminate a running command midway.
The plugin also keeps a detailed history of past runs including:
- Command executed
- User who initiated the run
- Start time
- Duration
- Exit code
- Command output
You can install the plugin via composer:
composer require binarybuilds/filament-command-runnerRegister the plugin in your Filament panel service provider:
use BinaryBuilds\CommandRunner\CommandRunnerPlugin;
$panel->plugin(CommandRunnerPlugin::make());- Command Validation
You can define custom validation logic using the validateCommand() method. This is useful for restricting which commands can be run:
use Illuminate\Support\Str;
$panel->plugin(
CommandRunnerPlugin::make()->validateCommand(function (string $attribute, string $value, \Closure $fail) {
if (!Str::startsWith($value, 'php artisan')) {
$fail("You can only run artisan commands");
}
})
);- Delete Command History
Control who can delete command history entries using a boolean or closure with canDeleteCommandHistory():
$panel->plugin(
CommandRunnerPlugin::make()->canDeleteCommandHistory(fn ($user) => $user->isAdmin())
);- Purge Old Command History
Schedule the following artisan command to purge command history entries daily:
php artisan command-runner:purge-historyBy default, it removes command runs older than 30 days. You can specify a custom duration like this:
php artisan command-runner:purge-history 7This example will purge command runs older than 7 days.
composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.