-
·
Licensing
WP-CLI is licensed under the MIT license. This document outlines WP-CLI’s licensing expectations for third-party code. Accepting third-party code into the official repository/organization All code accepted into repositories under the official WP-CLI GitHub organization must be compatible with the MIT license. This ensures that WP-CLI can remain freely usable, modifiable, and distributable by anyone. Bundling…
-
·
Verifying WP-CLI Downloads
This guide explains how to cryptographically verify the authenticity and integrity of WP-CLI releases after downloading them from the Internet and before installing them on your system. Why verify downloads? Verifying downloads ensures: Authenticity: The file was created and signed by the WP-CLI maintainers Integrity: The file has not been corrupted or tampered with during…
-
·
Figure out why WordPress is slow
wp profile is a WP-CLI command to help you quickly identify what’s slow with WordPress. It’s designed to work alongside Xdebug and New Relic because it’s easy to deploy to any server that has WP-CLI. With wp profile, you gain quick visibility into key performance metrics (execution time, query count, cache hit/miss ratio, etc.) to…
-
·
Given /^a WP( [^s]+)? install(?:ation)? in [‘"]?([^’"]+)[‘"]?$/
Installs WordPress in a given directory. Usage Scenario: My example scenario Given a WP installation in ‘foo’ … Scenario: My other scenario Given a WP install in ‘bar’ … Scenario: My version-specific scenario Given a WP 6.4.2 installation in ‘subdir’ … Behat steps documentation is generated from the WP-CLI codebase on every release. To suggest…
-
·
Argument Syntax
WP-CLI commands use a standardized syntax to describe their arguments and options. Understanding this syntax will help you use commands correctly and avoid confusion. Syntax Conventions The command synopsis uses specific formatting to indicate whether arguments are required or optional, and what type of values they accept. Required Arguments Arguments without square brackets are required…
-
·
Contributions
Bug reports – Help ensure your issue is resolved in a timely manner. Contributing – An introduction to the contributing process. WordCamp Contributor Day – Quick-start guide for WordCamp Contributor Days. Ideas – Up-vote existing ideas or submit your own. Governance – Summary of those behind WP-CLI. Licensing – License requirements for third-party code and…
-
·
Guides
Installing – Recommended and alternative installation mechanisms. Quick start – Where to begin after you’ve installed WP-CLI for the first time. Running commands remotely – Learn how to remotely control multiple servers at once. Commands cookbook – The full 101 how commands work, writing your own, and sharing them with the world. Writing Behat Tests…
-
·
References
Argument Syntax – Explanation of the syntax conventions used in command synopsis. Global parameters – Variables defining how a command is executed, including which WordPress user the command is run as and which WordPress instance the command is run against. Built-in commands – Commands included in every copy of WP-CLI. Internal API – Stable utilities…
-
·
X-post: The Incident Response Team is looking for new members
X-comment from +make.wordpress.org/community: Comment on The Incident Response Team is looking for new members Login to Reply
-
·
When /^I (run|try) `([^`]+)` from ‘([^s]+)’$/
Run or try a given command in a subdirectory. Usage run expects an exit code 0, whereas try allows for non-zero exit codes. Scenario: My example scenario When I run `wp core is-installed` Then STDOUT should be empty When I run `wp core is-installed` from ‘foo/wp-content’ Then STDOUT should be empty Behat steps documentation is…