PHPackages                             yasuslik/codeception-secureshell - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing &amp; Quality](/categories/testing)
4. /
5. yasuslik/codeception-secureshell

ActiveLibrary[Testing &amp; Quality](/categories/testing)

yasuslik/codeception-secureshell
================================

Codeception extension providing SSH capabilitie: SSH command, SSH file transfer, SSH tunneling

0.1.1(5y ago)03MITPHPPHP ^5.6 || ^7.0

Since Jul 3Pushed 5y agoCompare

[ Source](https://github.com/Yasuslik/codeception-secureshell)[ Packagist](https://packagist.org/packages/yasuslik/codeception-secureshell)[ Docs](https://github.com/edno/codeception-secureshell)[ RSS](/packages/yasuslik-codeception-secureshell/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (1)Dependencies (3)Versions (3)Used By (0)

Codeception Secure Shell
========================

[](#codeception-secure-shell)

[![Latest Version](https://camo.githubusercontent.com/3bd944c860755afac6cdfb84e160a2f00a74164c0cf11000751c91653b23099a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f65646e6f2f636f646563657074696f6e2d7365637572657368656c6c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/edno/codeception-secureshell)[![Dependency Status](https://camo.githubusercontent.com/f4f4b268c80a61267566c974d5bd968fb2a712414bef5d49d358e389b361f4d3/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f757365722f70726f6a656374732f3537363332343063303733353430303033356239346539662f62616467652e7376673f7374796c653d666c61742d737175617265)](https://www.versioneye.com/user/projects/5763240c0735400035b94e9f)[![Build Status](https://camo.githubusercontent.com/b1d239f47023cc537952d23ca19d3071e81cb51499b9ad1097771de96db24468/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f65646e6f2f636f646563657074696f6e2d7365637572657368656c6c2e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/edno/codeception-secureshell)[![SensioLabs Insight](https://camo.githubusercontent.com/e63b8e27845fb5312742b83811ef3938083aeb278c992dc0b7932cc937f03194/68747470733a2f2f696d672e736869656c64732e696f2f73656e73696f6c6162732f692f66663165386237632d333662652d343439662d396365352d3039323936386232636461352e7376673f7374796c653d666c61742d737175617265)](https://insight.sensiolabs.com/projects/ff1e8b7c-36be-449f-9ce5-092968b2cda5)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/4d4bd61c6dee041a4b049ecee0fa9bc6f1bbdd627660c1b1a1121fad7016ade3/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f65646e6f2f636f646563657074696f6e2d7365637572657368656c6c2e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/edno/codeception-secureshell/?branch=master)[![Coverage Status](https://camo.githubusercontent.com/6bfdc7646406eadc933bd59034caf92f766d937a25029a8320ab4fdf1d0687ab/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c732f65646e6f2f636f646563657074696f6e2d7365637572657368656c6c2e7376673f7374796c653d666c61742d737175617265)](https://coveralls.io/github/edno/codeception-secureshell?branch=master)[![GitHub license](https://camo.githubusercontent.com/942e017bf0672002dd32a857c95d66f28c5900ab541838c6c664442516309c8a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265)](https://raw.githubusercontent.com/edno/codeception-secureshell/master/LICENSE)

The [Codeception](http://codeception.com/) module for **SSH commands**, **SFTP access** and **SSH tunnels**

If you just need a **SFTP** connection, please consider the in-built Codeception [FTP module](http://codeception.com/docs/modules/FTP).

Roadmap
-------

[](#roadmap)

- **0.1**: Basic commands for testing remote file system and commands
- 0.2: Tunnel commands
- 0.3: Services and advanced commands

Minimum Requirements
--------------------

[](#minimum-requirements)

- Codeception 2.2
- PHP 5.6
- Extension [SecureShell2](http://www.php.net/ssh2)

Installation
------------

[](#installation)

The module can be installed using [Composer](https://getcomposer.org)

```
$ composer require edno/codeception-secureshell
```

Be sure to enable the module as shown in [configuration](#configuration) below.

Configuration
-------------

[](#configuration)

Enabling **Secure Shell** is done in your configuration file `.yml`.

```
module:
    enabled:
        - Codeception\Extension\SecureShell
```

### Parameters

[](#parameters)

By default the module always [accepts the host public key fingerprint](https://en.wikibooks.org/wiki/Guide_to_Unix/Explanations/Connecting_to_Remote_Unix#Accepting_the_Key_Fingerprint).

You can enable a strict mode where only known hosts will be accepted by setting the configuration parameter `StrictHostKeyChecking` to `true`.
Once enabled, the module will verify the host fingerprint against a `known_hosts` file located at the root directory of your Codeception project.

```
modules:
    config:
        Codeception\Extension\SecureShell:
            StrictHostKeyChecking: true
```

If you want to reuse an existing `known_hosts` file, you can use the parameter `KnownHostsFile` for specifying the location of the file.

```
modules:
    config:
        Codeception\Extension\SecureShell:
            StrictHostKeyChecking: true
            KnownHostsFile: '/etc/ssh/known_hosts'
```

The file must respect the [OpenSSH **~/.ssh/known\_hosts** format](https://en.wikibooks.org/wiki/OpenSSH/Client_Configuration_Files#.7E.2F.ssh.2Fknown_hosts).

Documentation
-------------

[](#documentation)

Documentation is available in the wiki [List of commands and methods](https://github.com/edno/codeception-secureshell/wiki/List-of-commands-and-methods).

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 71.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1547 days

Total

2

Last Release

2058d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/37928986?v=4)[yasuslik](/maintainers/yasuslik)[@Yasuslik](https://github.com/Yasuslik)

---

Top Contributors

[![edno](https://avatars.githubusercontent.com/u/324670?v=4)](https://github.com/edno "edno (5 commits)")[![dependabot-support](https://avatars.githubusercontent.com/u/112581971?v=4)](https://github.com/dependabot-support "dependabot-support (1 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (1 commits)")

---

Tags

codeceptionsshextensionscp

### Embed Badge

![Health badge](/badges/yasuslik-codeception-secureshell/health.svg)

```
[![Health](https://phpackages.com/badges/yasuslik-codeception-secureshell/health.svg)](https://phpackages.com/packages/yasuslik-codeception-secureshell)
```

###  Alternatives

[site5/phantoman

The Codeception extension for automatically starting and stopping PhantomJS when running tests.

481.1M17](/packages/site5-phantoman)[mcustiel/phiremock-codeception-extension

Codeception extension for Phiremock. Allows to stub remote services for HTTP requests.

311.0M5](/packages/mcustiel-phiremock-codeception-extension)[codeception/module-webdriver

WebDriver module for Codeception

3831.4M245](/packages/codeception-module-webdriver)[mcustiel/codeception-http-mock

Extension for HTTP Mock.

1424.3k1](/packages/mcustiel-codeception-http-mock)[docler-labs/codeception-slim-module

Codeception Module for Slim framework.

13178.0k1](/packages/docler-labs-codeception-slim-module)[kolyunya/codeception-markup-validator

Markup validator module for Codeception.

1413.8k3](/packages/kolyunya-codeception-markup-validator)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
