aura/cli-kernel

The kernel files for an Aura CLI project.

2.0.4 2015-04-04 14:02 UTC

This package is auto-updated.

Last update: 2024-03-29 02:19:23 UTC


README

This is a kernel for the Aura.Cli_Project package.

Foreword

Requirements

This kernel requires PHP 5.4 or later; we recommend using the latest available version of PHP as a matter of principle.

Unlike Aura library packages, this kernel package has userland dependencies, which themselves may have other dependencies:

Installation

This kernel is installable and autoloadable via Composer with the following require element in your composer.json file:

"require": {
    "aura/cli-kernel": "dev-develop-2"
}

Alternatively, download or clone this repository, then require or include its autoload.php file.

Tests

Scrutinizer Code Quality codecov Continuous Integration

To run the unit tests at the command line, issue composer install and then phpunit at the package root. This requires Composer to be available as composer, and PHPUnit to be available as phpunit.

PSR Compliance

This kernel attempts to comply with PSR-1, PSR-2, and PSR-4. If you notice compliance oversights, please send a patch via pull request.

Community

To ask questions, provide feedback, or otherwise communicate with the Aura community, please join our Google Group, follow @auraphp on Twitter, or chat with us on #auraphp on Freenode.

Services

This kernel defines the following service objects in the Container:

  • aura/cli-kernel:dispatcher: an instance of Aura\Dispatcher\Dispatcher
  • aura/cli-kernel:context: an instance of Aura\Cli\Context
  • aura/cli-kernel:stdio: an instance of Aura\Cli\Stdio
  • aura/cli-kernel:help_service: an instance of Aura\Cli_Kernel\HelpService

Note that service definitions set at the kernel level may be reset at the project level.