Content type: Handbook

  • WordCamp Contributor Day

    Welcome to WordCamp Contributor Day! We appreciate you sharing your time with WP-CLI. We’d love to help you submit at least one pull request, so we put together this guide to make it as straightforward as possible. We’re here to support you however we can. When you submit your pull request, add `Related https://github.com/wp-cli/wp-cli/issues/6295` so…

  • Customize doctor diagnostic checks

    Even though wp doctor comes with a number of default diagnostic checks, it’s designed with extensibility at its core. Checks are defined at runtime, read from a doctor.yml configuration file naming each check with its options. doctor.yml format Let’s take a look at the first two checks in the included doctor.yml: autoload-options-size: check: Autoload_Options_Size constant-savequeries-falsy:…

  • External Resources

    Blog posts & tutorials scribu: A Command-Line Interface for WordPress madewithlove: WP-CLI: WordPress Command Line Tools Mika Epstein: Command Line WP Treehouse Blog: Tame WordPress from the Command Line with wp-cli Matt Wiebe: Why You Should Develop Plugins With wp-cli Torque: Using WP CLI to Set Up a Test Version of Your Site WP Bullet…

  • Force output to a specific locale

    WP-CLI always outputs English because it doesn’t support localization. But, because WordPress supports localization, you may see non-English output when performing specific commands. For instance: $ wp theme update –all מעבר למצב תחזוקה… מוריד עדכונים מ-https://downloads.wordpress.org/theme/hueman.3.3.25.zip… Using cached file ‘/home/xxx/.wp-cli/cache/theme/hueman-3.3.25.zip’… פתיחת עדכון… התקנת גרסה חדשה… הסרת הגרסה הקודמת של התבנית… התבנית עודכנה בהצלחה. ביטול מצב…

  • Bug Reports

    Think you’ve found a bug? We’d love for you to help us get it fixed. Before you create a new issue, you should: Search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version. Check our documentation on common issues and their fixes. It’s…

  • Code Review

    Code review is a core part of the WP-CLI project’s software development workflow. Code review and pairing on code are necessary to maintain quality output, as well as build cohesive styles in our work. Having a well-understood and cohesive style can make all our work easier to approach and maintain for new as well as…

  • Committers Credo

    Some people have write access to WP-CLI repositories. These people are identified in the following teams: maintainers – Project leadership committers – Trusted contributors This “Committers credo” is a living document. It’s meant to establish generally agreed upon standards for committers, and will continue to evolve over time. Product quality WP-CLI is a project depended…

  • Behat Steps

    WP-CLI makes use of a Behat-based testing framework and provides a set of custom step definitions to write feature tests. Behat steps documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request. Given Given an empty directory – Creates an empty directory. Given /^an? (empty|non-existent) ([^\s]+) directory$/…

  • Commands Cookbook

    Creating your own custom WP-CLI command can be easier than it looks — and you can use wp scaffold package (repo) to dynamically generate everything but the command itself. Overview WP-CLI’s goal is to offer a complete alternative to the WordPress admin; for any action you might want to perform in the WordPress admin, there…

  • Documentation process during a major version release day

    Several documents need to be updated as part of the release process. While the articles can be drafted in advance, they will only be published after the official announcement has been made. Refer to the core handbook for the complete overview of the major version release process. All the items that need updating can be…