Welcome to WP-CLI!
WP-CLI is the official command line tool for interacting with and managing your WordPress sites.
WP-CLI is the official command line tool for interacting with and managing your WordPress sites.
There are two issues in the backlog we’d love your input on:
Feel free to weigh in as you see fit.
Have a question about something related to WP-CLI? There are now two places you can go for general help:
#clichannel in the WordPress.org Slack to chat with whomever might be available at the time. This option is best for quick questions.
Want to help others with their use of WP-CLI? Click “Subscribe to this topic tag” to receive email notifications of new forum discussion:
In preparation for the 2017 WordPress Community Summit (“CS”) on June 13th-14th before WordCamp Europe in Paris, France we’ve been asked to provide the following (in summary):
This post serves as a request for input for the above three areas. Note that these three requests are detailed further with some clarifying notes on Make/Summit.
Feel free to ping me privately in Slack if you prefer. I will send a summary of the responses with the Community Summit team on Wednesday, March 1st (as I’ll be offline on Thursday and Friday).
Excited to experiment with a couple new WP-CLI commands?
wp doctor and
wp profile are now available for everyone to install.
wp doctor lets you diagnose problems within WordPress by running a series of checks for symptoms. It includes an API for defining your own diagnosis, as well as writing custom checks.
$ wp @daniel doctor check --all Running checks 100% [============================================================================================] 0:02 / 0:09 +----------------------------+---------+--------------------------------------------------------------------+ | name | status | message | +----------------------------+---------+--------------------------------------------------------------------+ | core-verify-checksums | success | WordPress verifies against its checksums. | | file-eval | success | All 'php' files passed check for 'eval\(.*base64_decode\(.*'. | | autoload-options-size | success | Autoloaded options size (16.25kb) is less than threshold (900kb). | | constant-savequeries-falsy | success | Constant 'SAVEQUERIES' is undefined. | | constant-wp-debug-falsy | success | Constant 'WP_DEBUG' is defined falsy. | | core-update | success | WordPress is at the latest version. | | cron-count | success | Total number of cron jobs is within normal operating expectations. | | cron-duplicates | success | All cron job counts are within normal operating expectations. | | option-blog-public | success | Site is public as expected. | | plugin-active-count | success | Number of active plugins (2) is less than threshold (80). | | plugin-deactivated | success | Less than 40 percent of plugins are deactivated. | | plugin-update | success | Plugins are up to date. | | theme-update | warning | 1 theme has an update available. | +----------------------------+---------+--------------------------------------------------------------------+
wp profile quickly identifies what’s slow with WordPress, by giving you visibility into key I/O indicators.
$ wp @daniel profile stage --fields=stage,time,cache_ratio +------------+---------+-------------+ | stage | time | cache_ratio | +------------+---------+-------------+ | bootstrap | 0.2643s | 80% | | main_query | 0.0186s | 85.71% | | template | 0.0489s | 93.71% | +------------+---------+-------------+ | total (3) | 0.3318s | 86.47% | +------------+---------+-------------+
Both packages are in early stages of development — feedback welcome!
Happy release day!
Today, I’m excited to bring you WP-CLI v1.1.0, chock full of enhancements and bug fixes.
Want to get props in the next release? There are a few projects we’ll be working on:
And, in case you missed it: I’m looking for help maintaining WP-CLI (paid opportunity, commitment of 5-10 hours/week). Know someone who might fit? Email firstname.lastname@example.org or ping ‘danielbachhuber’ on the WordPress Slack.
wp cache *:
wp cache type:
wp (comment|post|user) list:
wp core config:
--forceparameter for overwriting existing
wp core is-installed:
wp_guess_url()when core isn’t installed [#3711]
wp core language install:
translations_api()so that WordPress reports the correct language download file [#3748]
wp core update:
--version=(nightly|trunk), which will download the latest nightly build [#3645]
wp core update-db:
wpmu_upgrade_siteoption for all networks, not just current, to ensure the admin notice is dismissed [#3659]
wp db *:
wp help db importto be run when WordPress has been downloaded, a wp-config.php has been created, but WordPress hasn’t yet been installed [#3780]
wp db cli:
wp db export:
wp media regenerate:
wp plugin install:
wp scaffold plugin:
wp scaffold plugin-tests:
wp scaffold (plugin-tests|theme-tests):
wp scaffold _s:
wp site create:
$pathto form proper path then global
$baseisn’t ‘/’ [#3688]
wp site option list:
wp theme install:
wp theme mod get:
--field=<field>argument for fetching a particular field [#3644]
WP_CLI::runcommand()correctly persists current process’ environment variables [#3683, #3730]
wp-config.phpvariables to local scope too, enabling WordPress to properly change
$table_prefixin multisite [#3695]
Contributors to this release (pull requests, documentation, and package authors): amq, bgeihsgt, danielbachhuber, edpittol, ernilambar, greatislander, inderpreet99, louisremi, lwh, metodiew, migueldemoura, miya0001, mmcev106, nikschavan, ntwb, nylen, ocean90, ramoonus, rosswintle, szepeviktor, trepmal, westonruter
You can browse the full list of resolved issues on Github.
WP-CLI’s long-form documentation has a new shiny home: make.wordpress.org/cli/handbook
Want to suggest an edit?
Click on the “Edit” next to the title to submit your changes via pull request workflow. The documents are tracked in a GitHub repo for easy collaboration. Just like with code changes, documentation contributors receive credit in every WP-CLI release.
Have five minutes to make the documentation better?
At the heart of it, WP-CLI commands enable you to do anything you want with WordPress, faster. Performing some task at the command line almost always yields some (often huge) amount of efficiency gain over the alternative.
For instance, consider the following (from #2523):
theme listcommand without
urlparameter shows if a theme is enabled for the network and active in the default site.
If you pass the
urlof a site of the network, this command shows if a theme is active in that site.
But i can’t find a way to list which themes are inactive in every site of the network so i can safely disable and delete them, and i’d love to have this feature
Without WP-CLI, you’d need to:
With WP-CLI, you can simply run
wp find-unused-themes. Pretty much infinity time savings.
So, what do you wish you had a WP-CLI command for?
There’s no such thing as a bad idea. We’ll implement the best, and maintain them as canonical WP-CLI community packages.
But wait, how will you pick which ideas to build?
That’s a great question — I’d love your input on how to decide.
The end goal for the WP-CLI package index is to be a directory of well-maintained, canonical features. Packages will be considered community projects shepherded by one or more maintainers, instead of the domain of a specific author. There’s a two-fold benefit in taking this approach:
But, we need to work out how we get from 0 to 1 (idea to initial implementation), and then 1 to n (ongoing development and maintenance).
But wait, who’s “we”?
That’s a great question too.
I’m now actively looking for someone to help me run with this vision. They’ll focus on facilitating great community packages: soliciting and vetting ideas, establishing best practices and standards, and supporting package maintainers. The best candidate sweats the little details, and commitment is already a part of their track record.
In the near future, we’ll be looking for people to maintain packages in the directory. Our goal is for maintainership to be a rewarding, enjoyable experience — and for maintainers to extend the same to contributors.
Know anyone who might fit either of these roles? I’d love to hear from you. Email email@example.com or ping ‘danielbachhuber’ on the WordPress Slack.
As announced last week, WP-CLI is now an official WordPress.org project. I consider this the best possible outcome of my efforts trying to identify sustainability for the project over the last year. Frankly, it’s hard to communicate how relieved I am.
But wait, what does that actually mean?
Most of the details are still to be worked out. On a high-level, these are the big changes:
The decision to make WP-CLI an official WordPress project also means there’s a clear path forward for me to invest more of my own time into the WP-CLI roadmap. Concurrent with the transition process over the next couple of months, I want to move forward the conversation of how we realize a future where WP-CLI is the fastest way to do anything with WordPress. If that’s something you’re interested in, stay tuned!
In order to successfully and completely migrate the wp-cli.org website to wordpress.org (and WordPress), it’s important to understand its current form:
These are the core functions needing to be replicated on WordPress.org. Ideally, the work done would be the foundation of where I’d love to see the WP-CLI website go in the future:
Fortunately, Github makes it easy to transfer repositories between organizations. Before we make the switch, we need to dot the i’s and cross the t’s on these core functions:
It’s also worth noting there will be more WP-CLI repositories in the future. Each new feature will be developed as an independent package. In fact, existing features (e.g. search-replace) are going to be split out into separate packages too. We’ll need an organizational structure that can accommodate this growth (let it be github.com/wordpress/wp-search-replace-command or github.com/wp-cli-packages/search-replace-command).
Anything I’ve missed? Have a question about something I didn’t cover? Hit me up with a comment!
Update 3 12/28: WP-CLI is now an official WordPress project. Fundraising will continue into 2017.
Update 2 12/15: Undecided on how much WP-CLI is worth to you? The experiment ends Dec 28th — please make a decision by then 🙂
Update 1 (12/13): Up to 17 subscribers so far. If we can get to 50, I’ll launch a members-only forum.
Last week, I tweeted:
At a decision point with @wpcli: it’s too large for me to voluntarily maintain. Have an opinion on its future? I’d love to chat.
Last February, I started a business, runcommand, as an indirect way of being able to invest my time into WP-CLI. The business is doing alright, not great but not horrible. What I’ve come to realize, though, is that my time is zero-sum. I’m incentivized to spend time on runcommand, when I’d rather spend it on WP-CLI.
Ultimately, the challenge I’m running into is opportunity cost. I’d love to be able to invest more into WP-CLI, but doing so comes at the cost of other business pursuits. Because WP-CLI is such a large project, the several hours I volunteer each week are basically enough to fight entropy — not make headway on larger initiatives.
The response to my tweet has been overwhelmingly supportive. One future I’m considering is directly commercializing WP-CLI, through patreon-esque membership, advertising on the website, and other ideas to be determined.
So, dear reader, a question: how much is WP-CLI worth to you?
Or, phrased another way, how much time does WP-CLI save you?
If the experiment goes well, then we’re in business! Your purchase will support ongoing maintenance of WP-CLI, as well as development of new commands like wp doctor and wp profile, improvements to the website and package index, and so on.
If the experiment doesn’t go well, then at least I can say I tried 🙂 To avoid any risk with the investment above, a full refund will be made available to you should the campaign not reach its goal, before we look at other approaches to help with maintaining the project.
Happy to take any questions you might have: firstname.lastname@example.org. I’ll keep the list below updated as new questions come in.
Have you tried crowdfunding?
Yep! See the post I wrote, “Using Kickstarter to fund open source“. Nadia Eghbal has a series of great articles on open source sustainability as well.
How much money do you want to see to consider this a success?
I have a number, but I’m not going to share it. I want to see if this is a viable approach for funding a for-profit business.
What if I want to pay a different amount?
Email me, and I’ll create a purchase link for you.
Do I get anything special for paying the amount I paid?
Potentially, but nothing to announce at this point.
I do have some ideas in mind for offerings at different levels (e.g. members-only support forum, feature prioritization, etc.).
Do I need to keep paying after I pay the first time?
Well, if everyone cancels, then the business will tank 🙂
All levels are billed annually unless you disable automatic renewal.
What if I’m an existing runcommand customer?
If the experiment goes well, then
wp doctor and
wp profile will become completely open source. I’ll reach out about the other aspects of your purchase.
What about scribu and Andreas?
I’ve been talking with them a bit. We’re all very interested to see how this plays out.