app-skeleton/minion

The official kohana module for running tasks via the CLI

Minion

Minion is a framework for running tasks via the CLI., _(*1)

The system is inspired by ruckusing, which had a nice system for defining tasks but lacked the desired flexibility for kohana integration., _(*2)

Getting Started

First off, download and enable the module in your bootstrap, _(*3)

Then copy the bash script minion alongside your index.php (most likely the webroot). If you'd rather the executable be in a different location to index.php then simply modify the bash script to point to index.php., _(*4)

You can then run minion like so:, _(*5)

./minion {task}

To view a list of minion tasks, run minion without any parameters, or with the --help option, _(*6)

./minion
./minion --help

To view help for a specific minion task run, _(*7)

./minion {task} --help

For security reasons Minion will only run from the cli. Attempting to access it over http will cause a Kohana_Exception to be thrown., _(*8)

If you're unable to use the binary file for whatever reason then simply replace ./minion {task} in the above examples with, _(*9)

php index.php --uri=minion --task={task}

Writing your own tasks

All minion tasks must be located in classes/task/. They can be in any module, thus allowing you to ship custom minion tasks with your own module / product., _(*10)

Each task must extend the abstract class Minion_Task and implement Minion_Task::_execute()., _(*11)

See Minion_Task for more details., _(*12)

Documentation

Code should be commented well enough not to need documentation, and minion can extract a class' doccomment to use as documentation on the cli., _(*13)

Testing

This module is unittested using the unittest module. You can use the minion group to only run minion tests., _(*14)

i.e., _(*15)

phpunit --group minion

Feel free to contribute tests(!), they can be found in the tests/minion directory. :), _(*16)

License

This is licensed under the same license as Kohana., _(*17)