panlatent / schedule
Schedule plugin for CraftCMS
Fund package maintenance!
panlatent
paypal.me/panlatent
afdian.net/a/panlatent
Installs: 28 029
Dependents: 1
Suggesters: 0
Security: 0
Stars: 10
Watchers: 2
Forks: 9
Open Issues: 1
Type:craft-plugin
Requires
- php: ^8.0.2
- craftcms/cms: ^4.0|^5.0
- dragonmantank/cron-expression: ^3.3
- guzzlehttp/guzzle: ^7.2
- nesbot/carbon: ^1.22 || ^2.10 || ^3.0
- panlatent/cron-expression-descriptor: ^1.1
- symfony/process: ^4.2 || ^5.0 || ^6.0 || ^7.0
Requires (Dev)
- codeception/codeception: ^4.1
- craftcms/phpstan: dev-main
- craftcms/rector: dev-main
Suggests
- ext-intl: Help translate cron express description
README
Manage your CraftCMS application schedules in Cp. Run a command, trigger an event, push a queue task, or send HTTP requests at a specified time. You can flexibly customize the trigger time and even design your schedule type.
Requirements
This plugin requires Craft CMS 3.1 or later.
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project
-
Then tell Composer to load the plugin:
composer require panlatent/schedule
-
In the Control Panel, go to Settings → Plugins and click the “Install” button for Schedule.
-
Add a record to system crontab:
* * * * * php /path/to/craft schedules/run 1>> /dev/null 2>&1
Or use built-in
schedules/listen
command:$ ./craft schedules/listen
If you use DDEV:
$ ddev craft schedules/listen
Usage
For the command line we support some actions and options:
Delete logs
craft schedules/clear-logs [interval]
Delete all logs
craft schedules/clear-logs --all
Run schedules asynchronously:
craft schedules/run --async craft schedules/listen --async
Listen all active timer events with clear log:
craft schedules/listen --with-clear-log
Documentation
Read more about it, including install instructions, in the official documentation.
License
The Schedule is open-sourced software licensed under the MIT license.