handbook/index.md

Handbook

Here are some helpful guides and resources for using WP-CLI.

Can’t find what you’re looking for? Open an issue to request improvements.

Guides

For users

• Beginner's guide - New to the command line? Start here for a beginner-friendly introduction to WP-CLI.
• Common tasks - A practical showcase of everyday WordPress management tasks you can do with WP-CLI.
• 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.
• Common issues and their fixes - In case of fire, break glass.
• External resources - Blog posts, slides and videos from users.
• Troubleshooting Guide - Get help troubleshooting common WP-CLI issues.

For developers

• Commands cookbook - The full 101 how commands work, writing your own, and sharing them with the world.
• Writing Behat Tests - How to write and run Behat tests for WP-CLI commands and packages.
• Force output to a specific locale - Localisation issue
• Identify a Plugin or Theme Conflict - Debugging advice
• Sharing WP-CLI Packages - Some words about your environment

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 considered safe to use in community commands.
• Documentation standards - Standards for annotating WP-CLI commands.
• Hosting companies - List of hosting companies where WP-CLI is installed by default.
• Shell friends - Helpful shortcuts for bash and zsh.
• Integrated tools - Plugins, wrappers, and other projects that integrate with WP-CLI in some form.

Contributing

• 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.
• Implementation details - Catalog of historical design decisions.
• Philosophy - Guidelines which inform project scope, command organization, and behavior.
• Pull requests - Submit your first bug fix or new feature.
• Release checklist - Tasks performed during the process of tagging a release.
• Roadmap - Where WP-CLI is going in the future.
• Code Review - Quality Assurance on WP-CLI
• Committers credo - Product quality, Stellar judgement, Consistent participation
• Repository Management - Naming, Versions, Milestones, Labels

Misc

• Plugin unit tests - How to set up and run PHPUnit tests for a WordPress plugin.