Improve documentation: where to add customizations?

[guaka]

I'm ready to start building my custom wp-cli stuff, but I'm not sure where I should put my code. I found https://make.wordpress.org/cli/handbook/internal-api/wp-cli-add-command/ which is good, but not good enough.

It'll be very useful to point readers of this page of to a place where they learn more about where to actually add this example code. This could also be on the page itself.

I'll be happy to do a pull request for this if/when I figure it out on my own.

[wojsmol]

@guaka See https://make.wordpress.org/cli/handbook/commands-cookbook/

[guaka]

Thanks @wojsmol

It looks like that page can also use some more information.

I want to create some commands that I can apply to several different wordpress sites, without creating a plugin that needs to be installed on those sites. I tried wp scaffold package but that gives me:

Warning: No WordPress installation found. If the command 'scaffold package' is in a plugin or theme, pass --path=`path/to/wordpress`. Error: 'package' is not a registered subcommand of 'scaffold'. See 'wp help scaffold' for available subcommands.

But I don't want to build my commands inside an installation.

Context: I have more experience with drush, where it's possible to put some custom commands inside ~/.drush/, e.g. I have this:

.drush/sar/sar.info
.drush/sar/README.txt
.drush/sar/LICENSE.txt
.drush/sar/sar.drush.inc

Can I (ab)use ~/.wp-cli/packages for this?

(Related: is there something like ~/.drush/aliases.drushrc.php? A place to put code, not just yaml, this makes it much easier to control many different sites on different servers without keeping track of the configuration for this. And to combine multiple different config files e.g. from different repositories.)

[schlessera]

@guaka If you want to have a single PHP file somewhere to just add arbitrary commands to, you can do the following:

Edit your global config file (usually found in ~/.wp-cli/config.yml) to require a PHP file in that same folder:

require:
  some-file.php

Then add said file (~/.wp-cli/some-file.php in this case) and add whatever commands you want to have globally added. Here's an example to get you started:

<?php

WP_CLI::add_command( 'hello-world', function () { echo "Hello World!\n"; } );

Any command you will add to that file will be globally available from now on.

[schlessera]

Note: I'll accept PRs for adding the above to the documentation if it can be written in a clear and understandable way.

[guaka]

Great!

Got round to trying this. It works, will play a bit more.

What do you think of wp-cli/wp-cli@master...guaka:patch-1 as a start?

Happy to improve this and other docs while learning more about this.

[guaka]

The 1st thing I wanted to code was drush style $aliases, so I can generate them programmatically. That seems a bit harder than I thought though. How could I approach this?

Programmatic $aliases would be nice for the docs as well, especially for others coming with knowledge of drush. What could be a good place for this?