Add global --ssh-args argument for SSH/Docker/Vagrant execution by Copilot · Pull Request #6206 · wp-cli/wp-cli

Copilot · 2026-01-25T16:49:24Z

WP-CLI's --ssh flag only accepts connection strings, preventing users from passing tool-specific arguments like SSH options (-o ConnectTimeout=5), Docker flags (--env), or Vagrant parameters.

Changes

Core Implementation

Added ssh-args to global config spec with multiple: true support
Modified generate_ssh_command() to inject escaped args into all scheme commands (SSH, Docker, Docker Compose, Docker Compose Run, Vagrant)
Filter --ssh-args from arguments passed to remote WP-CLI to prevent double-processing

Supporting Changes

Added ssh-args to alias specification for alias support
Updated PHPStan GlobalConfig type definition

Usage

# SSH timeout
wp --ssh=server --ssh-args="-o ConnectTimeout=5" core version

# Multiple args
wp --ssh=server --ssh-args="-o ConnectTimeout=5" --ssh-args="-o ServerAliveInterval=10" core version

# Docker environment
wp --ssh=docker:wordpress --ssh-args="--env MY_VAR=value" core version

# In aliases
@prod:
  ssh: user@prod.example.com
  ssh-args:
    - "-o ConnectTimeout=10"
    - "-o ProxyJump=bastion"

All arguments are shell-escaped via escapeshellarg() before execution.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

example.com
- Triggering command: /usr/bin/php php vendor/bin/phpunit --color=always --bootstrap ./vendor/wp-cli/wp-cli-tests/tests/bootstrap.php '-d short_open_tag=Off' '-d error_reporting=E_ALL' '-n' '-l' './bundle/rmccue/requests/src/Excepgit features/config.feature /usr/bin/grep quests/src/Auth./home/REDACTED/work/wp-cli/wp-cli/vendor/wp-cli/wp-cli-tests/bin/run-phpstan-tests--no-color r.php cal/bin/grep grep -l ssh features/http-logging.feature p/bin/grep php/class-wp-cliphp hp .php grep (dns block)
nosuchhost_asdf_asdf_asdf.com
- Triggering command: /usr/bin/php php vendor/bin/phpunit --color=always --bootstrap ./vendor/wp-cli/wp-cli-tests/tests/bootstrap.php '-d short_open_tag=Off' '-d error_reporting=E_ALL' '-n' '-l' './bundle/rmccue/requests/src/Excepgit features/config.feature /usr/bin/grep quests/src/Auth./home/REDACTED/work/wp-cli/wp-cli/vendor/wp-cli/wp-cli-tests/bin/run-phpstan-tests--no-color r.php cal/bin/grep grep -l ssh features/http-logging.feature p/bin/grep php/class-wp-cliphp hp .php grep (dns block)
wordpress
- Triggering command: /usr/bin/ssh ssh -o ConnectTimeout=5 -T -vvv wordpress wp '--debug' '--ssh-args=-o ConnectTimeout=5' '--version' k/wp-cli/wp-cli/features/validation.feature mposer/vendor/bin/grep tests/SchemaValiwhich 416.php rgo/bin/grep grep -l ssh k/wp-cli/wp-cli/features/cli-info.feature grep ssh 414.php mposer/vendor/bin/grep grep (dns block)
- Triggering command: /usr/bin/ssh ssh -o ConnectTimeout=5 -o ServerAliveInterval=10 -T -vvv wordpress wp '--debug' '--ssh-args=-o ConnectTimeout=5' '--ssh-args=-o ServerAliveInterval=10' '--version' /home/REDACTED/.composer/vendor/bin/grep tests/UtilsTest.sh 402.php ep grep hpcs�� ssh k/wp-cli/wp-cli/features/formatter.feature tnet/tools/git ssh 429.php /home/REDACTED/.co-a grep (dns block)
- Triggering command: /usr/bin/ssh ssh -o ConnectTimeout=5 -T -vvv wordpress wp '--debug' '--version' -d short_open_tag=Off (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

This section details on the original issue you should resolve

<issue_title>Add global --ssh-args argument</issue_title>
<issue_description>Some SSH functionality can currently not be used (or only through workarounds) because we cannot directly pass arguments to SSH, we only have the connection string to communicate with it.

One of these limitations can be seen here: #5100

Adding a new global argument to pass arguments to SSH would make this more flexible and open up access to the full functionality of SSH.

As we are using the --ssh flag for access to docker & vagrant as well, this would also allow the user to pass arguments to these as well.</issue_description>

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

Fixes Add global --ssh-args argument ideas#123

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

codecov · 2026-01-25T17:14:19Z

Codecov Report

❌ Patch coverage is 76.19048% with 5 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
php/WP_CLI/Runner.php	64.28%	5 Missing ⚠️

📢 Thoughts on this report? Let us know!

Initial plan

c0804d3

Copilot AI assigned Copilot and swissspidy Jan 25, 2026

Copilot started work on behalf of swissspidy January 25, 2026 16:49 View session

github-actions bot added command:cli Related to 'cli' command command:cli-utils labels Jan 25, 2026

Copilot AI and others added 4 commits January 25, 2026 16:55

Add --ssh-args global argument implementation

d562bd1

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Fix vagrant command format to make spacing explicit

4ba4735

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Filter ssh-args from remote command and improve vagrant spacing clarity

79ad079

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Simplify vagrant command construction (keep is_array check for PHPStan)

a6d20ce

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add global --ssh-args argument for SSH functionality~~ Add global --ssh-args argument for SSH/Docker/Vagrant execution Jan 25, 2026

Copilot AI requested a review from swissspidy January 25, 2026 17:05

Copilot finished work on behalf of swissspidy January 25, 2026 17:05

Update test

c1ae34f

swissspidy requested a review from Copilot January 25, 2026 17:21

Copilot started reviewing on behalf of swissspidy January 25, 2026 17:24 View session

This comment was marked as resolved.

Sign in to view

Copilot AI mentioned this pull request Feb 3, 2026

Add global --ssh-args argument for SSH/Docker/Vagrant execution #6225

Closed

swissspidy marked this pull request as ready for review February 3, 2026 14:19

swissspidy requested a review from a team as a code owner February 3, 2026 14:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add global --ssh-args argument for SSH/Docker/Vagrant execution#6206

Add global --ssh-args argument for SSH/Docker/Vagrant execution#6206
Copilot wants to merge 6 commits intomainfrom
copilot/add-global-ssh-args

Copilot AI commented Jan 25, 2026 •

edited

Loading

Uh oh!

codecov bot commented Jan 25, 2026 •

edited

Loading

Uh oh!

This comment was marked as resolved.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Copilot AI commented Jan 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Usage

I tried to connect to the following addresses, but was blocked by firewall rules:

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

Uh oh!

codecov bot commented Jan 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This comment was marked as resolved.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Jan 25, 2026 •

edited

Loading

codecov bot commented Jan 25, 2026 •

edited

Loading