Skip to content

Document ssh+path configuration limitation in wp-cli.yml #622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 3 commits into
base: main
Choose a base branch
from
+19 −0
Draft

Document ssh+path configuration limitation in wp-cli.yml #622

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b8ce19
Initial plan
Copilot Feb 2, 2026
6db8de1
Document ssh+path configuration limitation and workarounds
Copilot Feb 2, 2026
b68e973
Address PR review feedback: simplify documentation and fix formatting
Copilot Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions references/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,25 @@ Supported types are:

All connection types support an optional `path` suffix to specify a directory to `cd` to before running WP-CLI; `path` is a full system path starting with either `/` or `~`. (If `WP_CLI_SSH_PRE_CMD` is specified, `cd` is run after this pre-command.)

### Using path with SSH

When using SSH connections, you must specify the remote WordPress path as a suffix in the SSH connection string:

```yaml
# Using the path suffix directly in the ssh parameter
ssh: user@host~/path/to/wordpress
```

**Important:** When using `ssh` and `path` as separate top-level options in `wp-cli.yml`, the `path` option will be ignored. Always include the path as a suffix in the SSH connection string (e.g., `ssh: user@host~/path/to/wordpress`).

Note: Within an alias definition, you can specify `ssh` and `path` as separate options:

```yaml
@staging:
ssh: user@host
path: /path/to/wordpress
```

The SSH connection type also supports two advanced connection configuration options, which must be specified via an alias in the YAML configuration:

* `proxyjump` - Specifies a jumpbox connection string, which is passed to `ssh -J`
Expand Down