Search by

southan / wp-cli

southan

Extension pack for developing with WP-CLI & remote WordPress

Package info

github.com/southan/wp-cli

Type:wp-cli-package

pkg:composer/southan/wp-cli

Statistics

Installs: 1

Dependents: 0

Suggesters: 0

Stars: 1

Open Issues: 0

dev-main 2026-11-13 17:03 UTC

This package is auto-updated.

Last update: 2026-11-13 17:03:24 UTC


README

Extension pack for developing with WP-CLI & remote WordPress.

Fluent shell API

Compose and handle system commands.

$zip = new WP_CLI\Shell( 'zip' );

$zip->add( [ 'recurse-paths' => true, '-q' => true ], 'archive.zip', '.' );

// ...or one-liner
$zip = WP_CLI\Shell::create( 'zip', [
    [ 'recurse-paths' => true, '-q' => true ],
    'archive.zip',
    '.',
] );

echo $zip; // zip --recurse-paths -q 'archive.zip' '.'

// Set working directory
$zip->cwd( __DIR__ . '/src' );

// Set environment variables
$zip->env([
    'ZIPOPT' => '-D',
]);

// Chainable
$zip->add( [ 'recurse-paths' => true, '-q' => true ], 'archive.zip', '.' )
    ->cwd( __DIR__ . '/src' )
    ->env([
        'ZIPOPT' => '-FS'
    ]);

// Get command output (throws exception on error outside allow)
$out = $zip->allow( 12 )->get();

// Get command output (ignore error)
$out = $zip->get( check: false );

// Get command error output
$error = $zip->get_error();

// Non-capturing, stdout/stderr will be null (throws exception on error outside allow)
$zip->allow( 12 )->stream();

// Command exit code was zero
$success = $zip->success();

// Command exit code > zero
$failed = $zip->failed();

// Check command exit code
if ( $zip->is( 12 ) ) {
    WP_CLI::warning( 'Nothing to ZIP.' );
}

// Support debugging in WP-CLI with --debug or --debug=my-group
$zip = WP_CLI\Shell::create( 'zip', debug: 'my-group' );

// Parse JSON
$data = WP_CLI\Shell::create( 'curl', 'https://example/data.json' )->parse_json();

// Parse list
$contents = WP_CLI\Shell::create( 'ls', '.' )->parse_list( "\t" );

Commander

Universal API for both system and WP-CLI commands.

$commander = new WP_CLI\Commander(
    // Set debug group for all commands
    debug: 'my_debug',

    // Set WP-CLI runtime config (default is current runtime)
    wp: [
        'path' => '/path/to/another/wordpress',
    ],
);

// System shell
$home = $commander->sh( 'echo $HOME' )->get();

// WP-CLI shell
$table_prefix = $commander->wp( 'config get table_prefix' )->get();

Remote

Run system & WP-CLI commands on remote WordPress installations.

// Get remote control for WordPress on filesystem
$remote = WP_CLI\Remote::create( '/path/to/wordpress' );

// Get remote control for WordPress over SSH
$remote = WP_CLI\Remote::create( 'user@host' );

// Get remote control for WP-CLI alias
$remote = WP_CLI\Remote::create( '@staging' );

// Get remote controls for all WP-CLI aliases
$remotes = WP_CLI\Remote::resolve( '@all' );

// Get remote controls for WP-CLI alias group "@both"
$remotes = WP_CLI\Remote::resolve( '@both' );

A remote (control) is an extended Commander instance but with some additional methods specific to WordPress.

// Get WordPress absolute path
$path = $remote->get_path();

// Get WordPress URL
$url = $remote->get_url();

// Get remote WordPress constant
$cookie_domain = $remote->get_const( 'COOKIE_DOMAIN' );

// Get remote WordPress option
$page_for_posts = $remote->get_option( 'page_for_posts' );

// Eval PHP on remote WordPress
$remote->eval( 'wp_mail( "john@example.com", "Test", "Test" );' )->run();

// Filesystem API
$remote->is_file( 'foo.txt' );
$remote->is_dir( 'foo/' );
$remote->mkdir( 'foo' );
$remote->unlink( 'foo.txt' );
$remote->file_put_contents( 'foo.txt', 'Foo' );
$remote->copy( 'foo.txt', 'bar.txt' );

// Copy from current filesystem to remote
$remote->copy_from( 'foo.txt' );

// Copy from remote to current filesystem
$remote->copy_to( 'foo.txt', 'foo.txt' );

// ... or more logically
$remote->locate( 'foo.txt' )->copy_to( 'foo.txt' );

// Same API for move e.g.
$remote->move_from( 'foo/' );

MU Plugin

Install (& uninstall) persistent scripts.

$mu_plugin = new WP_CLI\MU_Plugin(
    name: 'Welcome Notice',
    description: 'Set a welcome notice in the WordPress admin.'
);

$code = <<<PHP
add_action( 'admin_notices', function () {
    wp_admin_notice( 'Welcome to WordPress!' );
});
PHP;

$mu_plugin->install( $code );

// ... or delete
$mu_plugin->delete();

// ... or install on a remote WordPress
$mu_plugin->install( $code, $remote ) ;

// ... or delete on a remote WordPress
$mu_plugin->delete( $remote );

Troubleshooting

Running commands non-interactively via SSH executes in a non-login, non-interactive shell, typically bypassing your profile startup scripts and shell paths managed by tools like phpenv or nvm.

Most commonly this means php might resolve to a different version than the one expected.

Use the environment variable WP_CLI_SSH_BINARY to explicitly set which PHP binary and WP-CLI source is used.

For permanence create a CLI alias and define the extra arguments in your WP-CLI config:

@dev:
  ssh: dev@wordpress.org
  env:
    WP_CLI_SSH_BINARY: '/usr/bin/php8.0 /usr/local/bin/wp'

Contributing

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policy and guidelines.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally.