This document discusses using the command line interface (CLI) with WordPress. It provides an overview of basic WP-CLI commands for core functions like installing plugins and themes. More advanced commands cover content management, tools, and custom commands that can be built. The CLI allows for automated migrations and efficient development practices.

1. WordPress &
the command line
Kelly Dwan
@ryelle
NERD Summit • Sept 2014

2. About Me
WordPress Developer
Core Contributor
Boston WordPress Organizer

3. “Why should I use the command line, when
WordPress already has such a fantastic UI?”

4. • Already included in VVV, VIP Quickstart
https://github.com/Varying-Vagrant-Vagrants/VVV/
https://github.com/Automattic/vip-quickstart
• Most major hosts include it: DreamHost, Media
Temple, BlueHost, SiteGround, 1&1…
• Installation:
http://wp-cli.org/#install

5. Basic Commands

6. wp command subcommand <argument> —flag

7. • wp core version
• wp core update
• wp plugin list
• wp plugin install <name> [--activate]
• wp theme list
• wp theme activate <name>

8. • wp core download
• wp core config
• wp core install / multisite-install
• wp core multisite-convert

9. wp help
wp help <command>
wp help <command> <subcommand>

10. Content
Management

11. • wp post create
• wp post delete
• wp post url
• wp post meta list
• wp post meta update

12. • wp comment approve
• wp comment delete $(wp comment list --
status=spam --format=ids)

13. • wp media import

14. • wp term create
• wp term generate
• wp term list

15. Tools

16. • wp export [—skip_comments]
• wp import
• wp media regenerate

17. Advanced
Management

18. • wp user create
• wp user import-csv
• wp user remove-cap
• wp role list
• wp cap list

19. • wp cron test
• wp cron schedule list
• wp cron event list
• wp cron event run

20. • wp rewrite list
• wp rewrite flush
• wp rewrite structure

21. Custom
Commands

22. “Adding commands to your plugin is great for
encouraging good API design, collaborating
amidst a changing data structure, efficiency, and
better debugging.”
–Matt Wiebe, Why You Should Develop Plugins With wp-cli

23. • Jetpack module control
• wp jetpack module list
• wp jetpack module activate
• BackUpWordPress
• wp backup [lots of options]

24. how to write your own

25. if ( defined('WP_CLI') && WP_CLI ) {
include __DIR__ . '/my-command.php';
}

26. class Example_Command extends WP_CLI_Command {
/**
* Prints a greeting.
* @synopsis <name>
*/
function hello( $args, $assoc_args ) {
list( $name ) = $args;
!
// Print a success message
WP_CLI::success( "Hello, $name!" );
}
}
!
WP_CLI::add_command( 'example', 'Example_Command' );

27. class Example_Command extends WP_CLI_Command {
/**
* Prints a greeting.
* @synopsis <name> [<last-name>]
*/
function hello( $args, $assoc_args ) {
list( $name ) = $args;
!
// Print a success message
WP_CLI::success( "Hello, $name!" );
}
}
!
WP_CLI::add_command( 'example', 'Example_Command' );

28. • WP CLI Commands Cookbook walks through this
in more detail.

29. Automated
Migrations

30. From WordPress

31. • wp export [on source site]
• wp import [on destination]
• wp search-replace <old> <new>
—skip-columns=guid —dry-run

32. From Other CMSs

33. • Importing (any!) Content with WP-CLI

34. • https://github.com/wp-cli/wp-cli/wiki/External-
Resources
• http://redradar.net/nerds-wp-cli