PHPackages                             x-team/wp-cli-ssh - 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. x-team/wp-cli-ssh

AbandonedLibrary

x-team/wp-cli-ssh
=================

Invoke WP-CLI on another server via SSH from local machine

1622.3k13[8 issues](https://github.com/xwp/wp-cli-ssh/issues)1PHP

Since Nov 25Pushed 9y ago74 watchersCompare

[ Source](https://github.com/xwp/wp-cli-ssh)[ Packagist](https://packagist.org/packages/x-team/wp-cli-ssh)[ RSS](/packages/x-team-wp-cli-ssh/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (3)Used By (1)

*DEPRECATED*: This feature is now part of WP-CLI itself as of [v0.24.0](http://wp-cli.org/blog/version-0.24.0.html). See [wp-cli#2754](https://github.com/wp-cli/wp-cli/issues/2754).

WP-CLI SSH
==========

[](#wp-cli-ssh)

*Seamlessly run WP-CLI commands on a remote server via SSH*

[![Running wp plugin status on production](screenshot1.png)](screenshot1.png)

WP-CLI is an extremely useful tool for managing WordPress installs, but it requires you to invoke it on the same server where WordPress is installed. This means you have to SSH into the server, navigate to the install, and then run the command. It would be much more convenient if you could remain on your local shell and invoke WP-CLI remotely; this is especially the case when using Vagrant.

The WP-CLI SSH script is also TTY-aware, so if you try piping the results of a WP-CLI SSH command to another program, it will return the machine-formatted output (e.g. no colors or table cells).

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

[](#configuration)

Assuming you have a clone of your WordPress install on your machine, add an `ssh` section to your `wp-cli.yml` config file. In this section you define the remote servers which host the other environments for your site, e.g. `vagrant`, `staging`, and `production`. Then you just invoke WP-CLI normally, but supply an additional `--host` argument with host you want to connect to:

```
wp ssh plugin status --host=production
```

You can also provide Bash aliases to supply this argument by default:

```
alias wp="wp ssh --host=vagrant"
alias wpprod="wp ssh --host=production"
```

Add an `ssh` section to your `wp-cli.yml`/`wp-cli.local.yml`, as seen in the [sample config](wp-cli.sample.yml). You indicate the `ssh` command templates for each host you want to connect to. The template variable `%cmd%` is replaced with the full command to run on the server; the `%pseudotty%` template variable is replaced with `-t`/`-T` depending on whether you're on a TTY or piping the command output.

For a step-by-step guide, please refer to the [wiki](https://github.com/x-team/wp-cli-ssh/wiki/Configuring-the-plugin).

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

[](#installation)

Note that you do not necessarily need WP-CLI installed on your server to use this. If the `wp` command is not recognized on the server, the script will download the `wp-cli.phar` file and use that at runtime.

Installing WP-CLI-SSH on your machine can be done either by installation as a Composer package, or by adding a `require` config to a `wp-cli.local.yml`.

For global composer installation:

```
composer global require x-team/wp-cli-ssh dev-master
```

Alternatives
------------

[](#alternatives)

- [vassh](https://github.com/x-team/vassh)
- [`wp` Bash function](https://github.com/humanmade/Salty-WordPress/issues/16)
- [WP Remote CLI](https://github.com/humanmade/wp-remote-cli/)

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity33

Limited adoption so far

Community27

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 54.5% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/63b496ec3806485229b4f934b26643dad6e734ca6e6ef7b38c846205b01cd37f?d=identicon)[westonruter](/maintainers/westonruter)

![](https://avatars.githubusercontent.com/u/1933681?v=4)[Jonathan Bardo](/maintainers/jonathanbardo)[@jonathanbardo](https://github.com/jonathanbardo)

---

Top Contributors

[![westonruter](https://avatars.githubusercontent.com/u/134745?v=4)](https://github.com/westonruter "westonruter (30 commits)")[![timweprovide](https://avatars.githubusercontent.com/u/67999201?v=4)](https://github.com/timweprovide "timweprovide (15 commits)")[![jonathanbardo](https://avatars.githubusercontent.com/u/1933681?v=4)](https://github.com/jonathanbardo "jonathanbardo (7 commits)")[![gMagicScott](https://avatars.githubusercontent.com/u/2353518?v=4)](https://github.com/gMagicScott "gMagicScott (2 commits)")[![scribu](https://avatars.githubusercontent.com/u/225715?v=4)](https://github.com/scribu "scribu (1 commits)")

### Embed Badge

![Health badge](/badges/x-team-wp-cli-ssh/health.svg)

```
[![Health](https://phpackages.com/badges/x-team-wp-cli-ssh/health.svg)](https://phpackages.com/packages/x-team-wp-cli-ssh)
```

PHPackages © 2026

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