spatie/laravel-cronless-schedule

Run the Laravel scheduler without relying on cron

1.0.1 2020-09-08 16:59 UTC

This package is auto-updated.

Last update: 2020-11-12 09:23:42 UTC


README

Latest Version on Packagist Tests Psalm Total Downloads

Laravel's native scheduler relies on cron to be executed every minute. It's rock solid and in most cases you should stick to using it.

If you want to simulate the scheduler running every minute in a test environment, using cron can be cumbersome. This package provides a command to run the scheduler every minute, without relying on cron. Instead it uses a ReactPHP loop.

This is how you can start the cronless schedule:

php artisan schedule:run-cronless

This command will never end. Behind the scenes it will execute php artisan schedule every minute.

Support us

68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f6c61726176656c2d63726f6e6c6573732d7363686564756c652e6a70673f743d31

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer. Probably you only want to use this schedule in a development environment.

composer require spatie/laravel-cronless-schedule --dev

Usage

This is how you can start the cronless schedule:

php artisan schedule:run-cronless

By default, it will run every minute.

Manually triggering a run

To perform an extra run of the scheduler, just press enter.

Using an alternative frequency

If you want to run the scheduler at another frequency, you can pass an amount of seconds to the frequency option. Here is an example where the schedule will be run every 5 seconds.

php artisan schedule:run-cronless --frequency=5

Using another command

If you want to run another command instead of the scheduler, just can pass it to the command option. Here is an example where another command will be run every 5 seconds.

php artisan schedule:run-cronless --command=your-favorite-artisan-command

Only run the schedule for a certain period

By default, the command will run forever. You can shorten that period by passing an amount of seconds to the stop-after-seconds option.

In this example we'll stop the command after 5 seconds

php artisan schedule:run-cronless --stop-after-seconds=5

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Credits

License

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