Skip to content
A lightweight package to execute commands over an SSH connection
PHP
Branch: master
Clone or download
Latest commit 037efe2 Feb 14, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github wip Feb 4, 2020
src wip Feb 14, 2020
tests wip Feb 14, 2020
.editorconfig initial commit Feb 3, 2020
.gitattributes initial commit Feb 3, 2020
.gitignore initial commit Feb 3, 2020
.scrutinizer.yml initial commit Feb 3, 2020
.styleci.yml wip Feb 3, 2020
CHANGELOG.md wip Feb 14, 2020
CONTRIBUTING.md initial commit Feb 3, 2020
LICENSE.md initial commit Feb 3, 2020
README.md wip Feb 14, 2020
composer.json Upgrade PHPUnit snapshot assertions to v4 Feb 11, 2020
phpunit.xml.dist wip Feb 13, 2020

README.md

A lightweight package to execute commands over an SSH connection

Latest Version on Packagist GitHub Tests Action Status Quality Score Total Downloads

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 us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/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

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Alternatives

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

Credits

The Ssh class contains code taken from laravel/envoy

License

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

You can’t perform that action at this time.