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

[Copilot]

Documentation Update for SSH + Path Configuration

This PR addresses the issue where users experience problems when using ssh and path as separate top-level options in wp-cli.yml. The path option is not applied correctly in this scenario.

As per maintainer feedback (@danielbachhuber), this PR adds documentation to clarify the limitation and provides clear workarounds rather than changing the existing behavior.

Changes Made:

• Added a new "Using path with SSH" subsection in the Remote (SSH) configuration section
• Documented that path must be specified as suffix in SSH string
• Clearly stated the limitation when using separate top-level options
• Added yaml language marker to code blocks
• Changed wording from "may not be applied correctly" to "will be ignored"
• Simplified to focus on the primary approach (path suffix in SSH string)
• Noted that aliases support separate ssh and path options
• Verified syntax matches existing documentation
• Completed code review
• Ran CodeQL security check (no issues, documentation-only change)

Primary Approach:

Include the path as a suffix in the SSH connection string: ssh: user@host~/path/to/wordpress

The documentation is clear, consistent with existing examples, and directly addresses the issue raised.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>wp-cli.yml with ssh not using path</issue_title>
<issue_description>Strangely enough I can get this to work without problem:

wp --ssh=ssh-config-alias --path=path/to/wp-on-remote-server rewrite flush

but if I create a wp-cli.yml on my project root with the following:

ssh: ssh-config-alias
path: path/to/wp-on-remote-server

I then get:

$ wp rewrite flush
Error: This does not seem to be a WordPress installation.
Pass --path=`path/to/wordpress` or run `wp core download`.

It seems that the config file is only applying the ssh option but not path as If I then run the below, it works.

wp --path=path/to/wp-on-remote-server rewrite flush 

So apparently, I am unable to get wp-cli.yml working with SSH.</issue_description>

Comments on the Issue (you are @copilot in this section)

@danielbachhuber > Honestly, I would expect both to work so there seems to be at least room for improvement here (at least in terms of documentation).

I don't think we should change the existing behavior, but additional documentation seems fine.</comment_new>

• Fixes wp-cli.yml with ssh not using path wp-cli#5324

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[Copilot]

Pull request overview

This pull request documents a known limitation where the path configuration option is ignored when specified alongside ssh as separate top-level options in wp-cli.yml, though it works correctly when used in aliases or via command-line parameters.

Changes:

• Added "Using path with SSH" subsection explaining the limitation and providing three working approaches
• Documented that separate top-level ssh and path options don't work together, but work fine in aliases

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.