Laravel Packages

Write Shell Scripts like Blade Components With Task Runner

Published
Write Shell Scripts like Blade Components With Task Runner image

Task Runner for Laravel is a package by Pascal Baljet that lets you write Shell scripts like Blade Components and run them locally or on a remote server:

{{-- resources/views/tasks/deploy-app.blade.php --}}
cd /var/www/html
git pull origin {{ $branch }}
php artisan migrate --database={{ $databaseConnection() }}

Given the conventions in this package, the above template would have an accompanying Task class:

use ProtoneMedia\LaravelTaskRunner\Task;
 
class DeployApp extends Task
{
public function __construct(public string $branch) { }
 
public function databaseConnection()
{
return 'mysql';
}
}

You might have noticed that the databaseConnection() public method is available as callable in the template. All public methods are available in task blade templates.

If you want to trigger the above task, you can use the package's dispatch() method, which will run it locally. You can also dispatch tasks in the background and also run them on a remote server:

$output = DeployApp::dispatch();
 
$output = DeployApp::inBackgronud()
->onConnection('web')
->dispatch();
 
// API of the task result
$output->getBuffer();
$output->getExitCode();
$output->isSuccessful();
$output->isTimeout();
// returns the buffer as an array
$output->getLines();

This package also has excellent testing helpers, which you can read about in the Documentation. You can learn more about this package, get full installation instructions, and view the source code on GitHub.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
Critical PHP Security Release Coming Tomorrow (October 21) image

Critical PHP Security Release Coming Tomorrow (October 21)

Read article
Critical Token Guard Auth Bypass Fixed in Laravel 13.29 and 12.68 image

Critical Token Guard Auth Bypass Fixed in Laravel 13.29 and 12.68

Read article
Run Large PlanetScale Queries in Laravel With DB::olap() image

Run Large PlanetScale Queries in Laravel With DB::olap()

Read article
Fluent Rule Builders for All Laravel Validation Rules image

Fluent Rule Builders for All Laravel Validation Rules

Read article
Laravel URL AI Transformer: Extract Structured Data From URLs image

Laravel URL AI Transformer: Extract Structured Data From URLs

Read article
Rule Builders for Every Validation Rule in Laravel 13.36 image

Rule Builders for Every Validation Rule in Laravel 13.36

Read article