Difference between revisions of "WP-CLI"

From Things and Stuff Wiki
Jump to navigation Jump to search
m (moved Wp-cli to WP Commandline)
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{techy}}
+
{{menu}}
  
−
Command-line WordPress.
+
Command-line interface WordPress.
  
−
== Basics ==
+
== General ==
−
* [https://github.com/wp-cli/wp-cli wp-cli] - based on drush
+
* [http://wp-cli.org/ wp-cli] - A command line interface for WordPress. Based on Drush.
−
** [https://github.com/wp-cli/wp-cli/tree/master/src/php/wp-cli/commands/internals commands/internals] [https://github.com/wp-cli/wp-cli/wiki/List-of-internal-commands]
+
** https://github.com/wp-cli/wp-cli
−
** [https://github.com/wp-cli/wp-cli/tree/master/src/php/wp-cli/commands/community  commands/community] [https://github.com/wp-cli/wp-cli/wiki/List-of-community-commands]
+
** [https://github.com/wp-cli/wp-cli/wiki/List-of-community-commands List of community commands]
 
** [https://github.com/wp-cli/wp-cli/wiki/Commands-Cookbook Commands Cookbook]
 
** [https://github.com/wp-cli/wp-cli/wiki/Commands-Cookbook Commands Cookbook]
  
Line 12: Line 12:
 
* [http://codeseekah.com/2012/02/23/wordpress-command-line-fun/ WordPress Command Line Fun] - Feb 23, 2012
 
* [http://codeseekah.com/2012/02/23/wordpress-command-line-fun/ WordPress Command Line Fun] - Feb 23, 2012
  
−
== Install ==
+
=== Install ===
−
  git clone --recursive git://github.com/wp-cli/wp-cli.git ~/git/wp-cli
+
  curl https://raw.github.com/wp-cli/wp-cli.github.com/master/installer.sh | bash
−
cd ~/git/wp-cli
 
−
sudo utils/dev-build
 
  
−
For BOA; both php 5.2 and 5.3 could be installed. 5.3 is required, so change script to;
+
//.wp-cli/bin/wp --info
−
  php=/opt/local/bin/php
+
 
 +
  export PATH=//.wp-cli/bin:$PATH
  
−
== Usage ==
+
=== Usage ===
−
Available commands:
+
* https://developer.wordpress.org/cli/commands
−
wp core [download|config|install|install_network|version|update|update_db]
 
−
wp db [create|drop|optimize|repair|connect|cli|query|export|import]
 
−
wp eval-file
 
−
wp eval
 
−
wp export [validate_arguments]
 
−
wp generate [posts|users]
 
−
wp home
 
−
wp option [add|update|delete|get]
 
−
wp plugin [activate|deactivate|toggle|path|update|uninstall|delete|status|install]
 
−
wp post-meta [get|delete|add|update]
 
−
wp post [create|update|delete]
 
−
wp theme [activate|path|delete|status|install|update]
 
−
wp transient [get|set|delete|type]
 
−
wp user-meta [get|delete|add|update]
 
−
wp user [list|delete|create|update]
 
  
 
  wp --blog=myblog.mynetwork.com
 
  wp --blog=myblog.mynetwork.com
Line 51: Line 35:
 
   full version infos
 
   full version infos
  
 +
wp user create username email@example.com --role=administrator
 +
 +
wp user list
 +
 +
wp user update 3 --user_pass=123456
 +
 +
wp db dump
 +
  sql dump
 +
wp db query "SELECT MAX(post_date) from wp_posts WHERE post_type = 'post' AND post_status = 'publish'" 
 +
  last post published
 +
wp db cli
 +
  interactive mysql
  
 
  wp plugin status
 
  wp plugin status
Line 86: Line 82:
 
  wp export --path=./ --user=admin
 
  wp export --path=./ --user=admin
 
   export content to a WXR file
 
   export content to a WXR file
−
   
+
 
−
  wp db dump
+
=== Other ===
−
  sql dump
+
 
−
  wp db query "SELECT MAX(post_date) from wp_posts WHERE post_type = 'post' AND post_status = 'publish'"
+
* https://github.com/billerickson/wp-cli-plugin-install-missing - Install any plugins that are "active" but missing.
−
  last post published
+
 
−
wp db cli
+
 
−
  interactive mysql
+
 
 +
=== Puppet WP-CLI ===
 +
* [https://github.com/rmccue/puppet-wp Puppet WP-CLI] - This module enables the easy use of WP CLI to control your WordPress site through Puppet manifests. It provides an easy abstraction for common WP CLI commands as well as installing the WP CLI binaries as needed.
 +
 
 +
== Other ==
 +
=== WordPress Tools ===
 +
* https://github.com/drrobotnik/wp-tools
 +
 
 +
Run the script from a folder where you'd like your dev site to live. Name the project. Slug is used throughout the build in your theme, function prefixes, etc. Optionally connect it to a private BB repo. Automatically builds local DB based on given inputs. Installs latest version of WP via WP-CLI. Creates a local-config file and modifies wp-config credentials if given for "live credentials". Installs developer plugins. ACF, Developer, WP_Debug, etc. If you fork this project you can easily change the ones I've chosen. Optionally (recommended) installs and activates a custom _s theme. This theme generates Title, description, and prefixes all functions. Saving tons of initial work.
 +
 
 +
=== WXR import/export ===
 +
* [http://wordpress.org/extend/plugins/wordpress-importer/ WordPress Importer]
 +
** https://github.com/tott/WordPress-CLI-Importer
 +
 
 +
wordpress-importer-cli.php goes in wp-content/plugins/wordpress-importer
 +
  --blog:
 +
  Blog ID of the blog you like to import to
 +
  --file: Full Path to WXR import file
 +
--attachments: Import attachments (true/false)
 +
--user: Username/ID the import should run as
 +
  --author_mapping: empty or php file with User mapping array $cli_user_map = array( <old_user> => <new_user_name/email/id> ); defined. if the file does not exist it will be created for you
 +
 
 +
* [https://github.com/tott/WordPress-CLI-Exporter WordPress-CLI-Exporter] - A CLI Wrapper around the WordPress WXR Exporter
 +
 
 +
php cli-exporter.php --blog=blogname --path=/tmp/ --user=admin [--start_date=2011-01-01] [--end_date=2011-12-31] [--post_type=post] [--author=admin] [-- * category=Uncategorized] [--post_status=publish] [--skip_comments=1] [--file_item_count=1000]
 +
 
 +
=== wpshell ===
 +
* source: [http://code.trac.wordpress.org/browser/wpshell wpshell]
 +
** [http://hitchhackerguide.com/2011/11/13/wpshell-a-shell-for-wordpress/ Meet wpshell – the power of WordPress at your prompt] - Nov 13, 2011
 +
 
 +
=== to sort ===
 +
* http://wordshell.net/ - costs? says gpl2, but that is a lie?
 +
** http://wordshell.net/support/cheat-sheet-get-going-quickly/
 +
** http://wordshell.net/support/faqs/competitors/compared-with-wp-cli/
 +
 
 +
* https://github.com/jerodsanto/wordpress-console - adds a "Console" page to the admin menu for WordPress environment cli
 +
 
 +
* https://github.com/webord/wp-migrate - migrate the System from one url to another.
 +
* http://samjlevy.com/2011/12/shell-script-for-cloning-a-wordpress-installation/
 +
* https://github.com/brool/wordpress-shuffle - python, save posts to files
 +
 
 +
* [https://github.com/markjaquith/WordPress-Skeleton skeleton] repo for a WordPress site. not wp-mu compatible.
 +
* https://github.com/vidluther/Autopress - Capistrano install scripts
 +
* https://github.com/shacker/wp-batch-manage - scripts for cPanel based
 +
* https://github.com/dxw/wp-generate - ruby, generate themes and templates
 +
* https://github.com/dxw/cucumber-wordpress - for [http://cukes.info/ cucumber] development, ruby
 +
 
 +
* https://github.com/genesis/wordpress/ [https://news.ycombinator.com/item?id=6531071] - Rapidly create, develop, & deploy WordPress across multiple environments.
 +
 
 +
== Vim ==
 +
* http://www.vim.org/scripts/script.php?script_id=3510 - post from vim
 +
 
 +
* http://www.kloppmagic.ca/blog/2011/05/wordpress-vim-syntax-highlighting/

Latest revision as of 01:16, 11 August 2018

Command-line interface WordPress.

General

Install

curl https://raw.github.com/wp-cli/wp-cli.github.com/master/installer.sh | bash

//.wp-cli/bin/wp --info
 
export PATH=//.wp-cli/bin:$PATH

Usage

wp --blog=myblog.mynetwork.com
  set scope to multisite blog

wp core download
  download latest release

wp core install --url=url --title=site-title [--admin_name=username] --admin_email=email --admin_password=password
  db install
wp core update
  upgrade to latest release
wp core version --extra
  full version infos

wp user create username email@example.com --role=administrator

wp user list

wp user update 3 --user_pass=123456

wp db dump
  sql dump
wp db query "SELECT MAX(post_date) from wp_posts WHERE post_type = 'post' AND post_status = 'publish'"  
  last post published
wp db cli
  interactive mysql

wp plugin status
  display installed plugins
wp plugin install hello-dolly
  install hello-dolly
wp plugin install google-sitemap-generator --activate
  install and activate google-sitemap-generator
wp plugin install google-sitemap-generator --activate --dev  
  install and activate google-sitemap-generator development branch
wp plugin update akismet 
  update akismet
wp plugin update --all
  update all

wp plugin toggle [plugin]
  turn on/off google-sitemap-generator
wp plugin uninstall [plugin]
  remove plugin from the system
wp plugin delete [plugin] 
  delete plugin files 

wp theme status
  main site theme status
wp theme status --blog=test.example.com
  multisite theme status
wp theme activate my-new-theme --blog=fooblog.example.com
  multisite theme activate installed theme
cd $(wp theme path twentyeleven)
  change to theme directory

wp generate posts --count=1000
  for testing

wp export --path=./ --user=admin
  export content to a WXR file

Other


Puppet WP-CLI

  • Puppet WP-CLI - This module enables the easy use of WP CLI to control your WordPress site through Puppet manifests. It provides an easy abstraction for common WP CLI commands as well as installing the WP CLI binaries as needed.

Other

WordPress Tools

Run the script from a folder where you'd like your dev site to live. Name the project. Slug is used throughout the build in your theme, function prefixes, etc. Optionally connect it to a private BB repo. Automatically builds local DB based on given inputs. Installs latest version of WP via WP-CLI. Creates a local-config file and modifies wp-config credentials if given for "live credentials". Installs developer plugins. ACF, Developer, WP_Debug, etc. If you fork this project you can easily change the ones I've chosen. Optionally (recommended) installs and activates a custom _s theme. This theme generates Title, description, and prefixes all functions. Saving tons of initial work.

WXR import/export

wordpress-importer-cli.php goes in wp-content/plugins/wordpress-importer 

--blog:
  Blog ID of the blog you like to import to
--file: Full Path to WXR import file
--attachments: Import attachments (true/false)
--user: Username/ID the import should run as
--author_mapping: empty or php file with User mapping array $cli_user_map = array( <old_user> => <new_user_name/email/id> ); defined. if the file does not exist it will be created for you

php cli-exporter.php --blog=blogname --path=/tmp/ --user=admin [--start_date=2011-01-01] [--end_date=2011-12-31] [--post_type=post] [--author=admin] [-- * category=Uncategorized] [--post_status=publish] [--skip_comments=1] [--file_item_count=1000]

wpshell

to sort

Vim

Retrieved from "https://wiki.thingsandstuff.org/index.php?title=WP-CLI&oldid=47493"