clue/shell-react

Run async commands within any interactive shell command

clue/reactphp-shell

, _(*1)

Run async commands within any interactive shell command, built on top of ReactPHP., _(*2)

Note: This project is in beta stage! Feel free to report any issues you encounter., _(*3)

Quickstart example

Once installed, you can use the following code to run an interactive bash shell and issue some commands within:, _(*4)

<?php

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

$launcher = new Clue\React\Shell\ProcessLauncher();

$shell = $launcher->createDeferredShell('bash');

$shell->execute('echo -n $USER')->then(function ($result) {
    var_dump('current user', $result);
}, function (Exception $e) {
    echo 'Error: ' . $e->getMessage() . PHP_EOL;
});

$shell->execute('env | sort | head -n10')->then(function ($env) {
    var_dump('env', $env);
}, function (Exception $e) {
    echo 'Error: ' . $e->getMessage() . PHP_EOL;
});

$shell->end();

See also the examples:, _(*5)

• Run shell commands within a bash shell
• Run PHP code within an interactive PHP shell
• Run shell commands within a docker container

Install

The recommended way to install this library is through Composer. New to Composer?, _(*6)

This will install the latest supported version:, _(*7)

composer require clue/shell-react:^0.2

See also the CHANGELOG for details about version upgrades., _(*8)

This project aims to run on any platform and thus does not require any PHP extensions and supports running on legacy PHP 5.3 through current PHP 8+. It's highly recommended to use the latest supported PHP version for this project., _(*9)

Tests

To run the test suite, you first need to clone this repo and then install all dependencies through Composer:, _(*10)

composer install

To run the test suite, go to the project root and run:, _(*11)

vendor/bin/phpunit

License

MIT, _(*12)