A lightweight package to execute commands over an SSH connection, based on `spatie/ssh`, with php 5.6 compatibility.

This package is a fork of the original spatie/ssh package to be compatible with php5.6. Please use it with caution.

You can execute an SSH command like this:

Ssh::create('user', 'host')->execute('your favorite command');

It will return an instance of Symfony's Process.

Support Spatie

As Spatie is the original creator of this package, please consider supporting them or checkout another of their great open source packages.

Installation

You can install this package via composer:

composer require chris-doehring/ssh

Usage

You can execute an SSH command like this:

$process = Ssh::create('user', 'example.com')->execute('your favorite command');

It will return an instance of Symfony's Process.

Getting the result of a command

To check if your command ran ok

$process->isSuccessful();

This is how you can get the output

$process->getOutput();

Running multiple commands

To run multiple commands pass an array to the execute method.

$process = Ssh::create('user', 'example.com')->execute([
   'first command',
   'second command',
]);

Choosing a port

You can choose a port by passing it to the constructor.

$port = 123;

Ssh::create('user', 'host', $port);

Alternatively you can use the usePort function:

Ssh::create('user', 'host')->usePort($port);

Specifying the private key to use

You can use usePrivateKey to specify a path to a private SSH key to use.

Ssh::create('user', 'host')->usePrivateKey('/home/user/.ssh/id_rsa');

Disable Strict host key checking

By default, strict host key checking is enabled. You can disable strict host key checking using disableStrictHostKeyChecking.

Ssh::create('user', 'host')->disableStrictHostKeyChecking();

Uploading & downloading files and directories

You can upload files & directories to a host using:

Ssh::create('user', 'host')->upload('path/to/local/file', 'path/to/host/file');

Or download them:

Ssh::create('user', 'host')->download('path/to/host/file', 'path/to/local/file');

Under the hood the process will use scp.

Modifying the Symfony process

Behind the scenes all commands will be performed using Symfonys Process.

You can configure to the Process by using the configureProcess method. Here's and example where we disable the timeout.

Ssh::create('user', 'host')->configureProcess(fn (Process $process) => $process->setTimeout(null));

Immediately responding to output

You can get notified whenever you command produces output by setting by passing a closure to onOuput.

Ssh::create('user', 'host')->onOutput(fn($type, $line) => echo $line)->execute('whoami');

Whenever there is output that close will get called with two parameters:

type: this can be Symfony\Component\Process\Process::OUT for regular output and Symfony\Component\Process\Process::ERR for error output
line: the output itself

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

This package has been forked to be compatible with the deprecated php version 5.6. Please consider using php 7.4 and the most recent original package from spatie/ssh. If you have to use it anyway, be sure to run it on the security backport version of Microsoft. Neither I nor any other contributors give any warranty when running this fork under php 5.6.

Alternatives

If you need some more features, take a look at DivineOmega/php-ssh-connection.

Credits

This package is completely based on spatie/ssh. If you like it, please consider supporting them.

The Ssh class contains code taken from laravel/envoy

License

The MIT License (MIT). Please see License File for more information.

chris-doehring / ssh Goto Github PK

ssh's Introduction

A lightweight package to execute commands over an SSH connection, based on spatie/ssh, with php 5.6 compatibility.