PHPackages                             app-skeleton/minion - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. app-skeleton/minion

ActiveKohana-module[Framework](/categories/framework)

app-skeleton/minion
===================

The official kohana module for running tasks via the CLI

v3.3.1(12y ago)022BSD-3-ClausePHPPHP >=5.3.3

Since Aug 26Pushed 12y ago1 watchersCompare

[ Source](https://github.com/app-skeleton/minion)[ Packagist](https://packagist.org/packages/app-skeleton/minion)[ Docs](http://kohanaframework.org)[ RSS](/packages/app-skeleton-minion/feed)WikiDiscussions 3.3/master Synced 2mo ago

READMEChangelogDependencies (2)Versions (3)Used By (0)

Minion
======

[](#minion)

Minion is a framework for running tasks via the CLI.

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

Getting Started
---------------

[](#getting-started)

First off, download and enable the module in your bootstrap

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.

You can then run minion like so:

```
./minion {task}

```

To view a list of minion tasks, run minion without any parameters, or with the `--help` option

```
./minion
./minion --help

```

To view help for a specific minion task run

```
./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.

If you're unable to use the binary file for whatever reason then simply replace `./minion {task}` in the above examples with

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

```

Writing your own tasks
----------------------

[](#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.

Each task must extend the abstract class `Minion_Task` and implement `Minion_Task::_execute()`.

See `Minion_Task` for more details.

Documentation
-------------

[](#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.

Testing
-------

[](#testing)

This module is unittested using the [unittest module](http://github.com/kohana/unittest). You can use the `minion` group to only run minion tests.

i.e.

```
phpunit --group minion

```

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

License
-------

[](#license)

This is licensed under the [same license as Kohana](http://kohanaframework.org/license).

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 51% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

4640d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/16ee23968209089931c6439441b750be90767059c48cff0da75b631224283b66?d=identicon)[app-skeleton](/maintainers/app-skeleton)

---

Top Contributors

[![BRMatt](https://avatars.githubusercontent.com/u/20394?v=4)](https://github.com/BRMatt "BRMatt (98 commits)")[![zeelot](https://avatars.githubusercontent.com/u/40011?v=4)](https://github.com/zeelot "zeelot (46 commits)")[![zombor](https://avatars.githubusercontent.com/u/170538?v=4)](https://github.com/zombor "zombor (16 commits)")[![kiall](https://avatars.githubusercontent.com/u/52713?v=4)](https://github.com/kiall "kiall (16 commits)")[![biakaveron](https://avatars.githubusercontent.com/u/95280?v=4)](https://github.com/biakaveron "biakaveron (4 commits)")[![ahutchings](https://avatars.githubusercontent.com/u/35026?v=4)](https://github.com/ahutchings "ahutchings (3 commits)")[![tamaspap](https://avatars.githubusercontent.com/u/1059643?v=4)](https://github.com/tamaspap "tamaspap (2 commits)")[![bobeagan](https://avatars.githubusercontent.com/u/100226?v=4)](https://github.com/bobeagan "bobeagan (2 commits)")[![alexeyco](https://avatars.githubusercontent.com/u/496179?v=4)](https://github.com/alexeyco "alexeyco (2 commits)")[![acoulton](https://avatars.githubusercontent.com/u/416566?v=4)](https://github.com/acoulton "acoulton (1 commits)")[![kemo](https://avatars.githubusercontent.com/u/100160?v=4)](https://github.com/kemo "kemo (1 commits)")[![bluehawk](https://avatars.githubusercontent.com/u/139870?v=4)](https://github.com/bluehawk "bluehawk (1 commits)")

---

Tags

frameworkkohanatask

### Embed Badge

![Health badge](/badges/app-skeleton-minion/health.svg)

```
[![Health](https://phpackages.com/badges/app-skeleton-minion/health.svg)](https://phpackages.com/packages/app-skeleton-minion)
```

###  Alternatives

[kohana/minion

The official kohana module for running tasks via the CLI

114117.1k10](/packages/kohana-minion)[kohana/database

The official Kohana module for database interactions, building queries, and prepared statements

158486.0k19](/packages/kohana-database)[kohana/image

The official Kohana module for manipulating images

103461.3k8](/packages/kohana-image)[kohana/auth

The official Kohana auth module

101227.2k9](/packages/kohana-auth)[kohana/cache

The official Kohana cache management module

76318.3k8](/packages/kohana-cache)[kohana/orm

The official Kohana ORM module

15772.1k8](/packages/kohana-orm)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)