northern-lights/command

Command is small library providing execution of system commands in OOP way

Command

, _(*1)

Command is small library providing execution of system commands in OOP way, _(*2)

Deprecation

I have decided to deprecate this project. If you want to take over and continue maintaining it, welcome contact me.
This repository is archived and there will be no further updates.
The reason is that symfony/process is everything this project is, and was intended to be, but so much better, actively maintained and fully mature, so there is really no reason for this project to exist., _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require northern-lights/command, <sub>(*5)</sub>

It really is that easy!

## Usage
``` php
<?php

namespace NorthernLights\Command\Example;

use NorthernLights\Command\Result\CommandResultInterface;
use function NorthernLights\Command\Run as command;

require __DIR__ . '/vendor/autoload.php';

/** @var CommandResultInterface $result */
$result = command('ls -all');

if ($result->isOk()) {
    // Note: $result->getOutput() will return an instance of OutputInterface which implements __toString()
    echo $result->getOutput() . PHP_EOL;
} else {
    echo "Command failed with status code " . $result->getExitCode() . PHP_EOL;
}

See Example, <sub>(*6)</sub>

Please pay attention to line "use function NorthernLights\Command\Run as command" which is crucial as it assigns function NorthernLights\Command\Run to commmand alias., <sub>(*7)</sub>

If you don't want to use this way, see Run function declaration, <sub>(*8)</sub>

PSR-2 Standard

Library strives to comply with PSR-2 coding standards, therefore we included following commands: ``` bash $ composer check-style $ composer fix-style, <sub>(*9)</sub>

Note: Second command will actually modify files

## PSR-4 Standard
Library complies with PSR-4 autoloading standard

## Testing

``` bash
$ composer php-lint
$ composer test

License

The MIT License (MIT). Please see License File for more information., <sub>(*10)</sub>