tjm/shell-runner

Run shell commands over ssh or locally from PHP.

v0.0.14 2023-10-03 20:44 UTC

Requires

• php: >=5.3.3
• symfony/process: >=2.4 <7.0

BSD-3-Clause

• Toby Mackenzie

README

Shell Runner

Run shell commands locally or via SSH. Primarily for simplifying running commands on remote machines, either interactively or capturing the output.

Usage

Install via composer. Example usage:

<?php
use TJM\ShellRunner\ShellRunner;

$shell = new ShellRunner();

//--run `ls` locally, capturing output
$output = $shell->run(Array(
	'command'=> 'ls'
));

//--run `ls` remotely, capturing output
$output = $shell->run(Array(
	'command'=> 'ls'
	,'host'=> 'tobymackenzie.com'
));

//--SSH into remote machine interactively.  Will not capture output.  Interaction will require running PHP on command line, not in browser.
$shell->run(Array(
	'host'=> 'tobymackenzie.com'
	,'interactive'=> true
));

Other Options

• PHP built-ins:
  • shell_exec()
  • passthru()
  • exec()
  • system()
  • popen()
  • procopen()
• Symfony Process Component (which this project uses in some cases)
• PHP Secure Communications Library
• PHP Secure Shell2 extension