Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-cronless-schedule
Run the Laravel scheduler without relying on cron
https://github.com/spatie/laravel-cronless-schedule
artisan cron laravel php scheduler
Last synced: 4 days ago
JSON representation
Run the Laravel scheduler without relying on cron
- Host: GitHub
- URL: https://github.com/spatie/laravel-cronless-schedule
- Owner: spatie
- License: mit
- Created: 2020-06-10T06:35:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-02T05:46:34.000Z (11 months ago)
- Last Synced: 2024-05-09T22:24:04.269Z (9 months ago)
- Topics: artisan, cron, laravel, php, scheduler
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 47.9 KB
- Stars: 337
- Watchers: 9
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Run the Laravel scheduler without relying on cron
[](https://packagist.org/packages/spatie/laravel-cronless-schedule)
[](https://packagist.org/packages/spatie/laravel-cronless-schedule)
[Laravel's native scheduler](https://laravel.com/docs/master/scheduling) 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](https://reactphp.org) loop.
This is how you can start the cronless schedule:
```bash
php artisan schedule:run-cronless
```
This command will never end. Behind the scenes it will execute `php artisan schedule` every minute.
## Support us
[
](https://spatie.be/github-ad-click/laravel-cronless-schedule)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer. Probably you only want to use this schedule in a development environment.
```bash
composer require spatie/laravel-cronless-schedule --dev
```
## Usage
This is how you can start the cronless schedule:
```bash
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.
```bash
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.
```bash
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
```bash
php artisan schedule:run-cronless --stop-after-seconds=5
```
## Testing
``` bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.