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

masteringlaravel logo
Laravel Code Review

Get expert guidance in a few days with a Laravel code review

Visit Laravel Code Review

The latest

View all →
Laravel AI SDK and Laravel MCP Security Fixes: Update Now image

Laravel AI SDK and Laravel MCP Security Fixes: Update Now

Read article
Mailbox for Laravel: Preview and Test Rendered Email image

Mailbox for Laravel: Preview and Test Rendered Email

Read article
Count Worker Crashes as Job Exceptions in Laravel 13.34 image

Count Worker Crashes as Job Exceptions in Laravel 13.34

Read article
Elastic Bridge: Eloquent-Style Queries for Elasticsearch and OpenSearch image

Elastic Bridge: Eloquent-Style Queries for Elasticsearch and OpenSearch

Read article
Laravel Release Cycle: Versions, Support Policy, and Dates image

Laravel Release Cycle: Versions, Support Policy, and Dates

Read article
Unlearn.dev goes free for a weekend, October 10 and 11 image

Unlearn.dev goes free for a weekend, October 10 and 11

Read article