What Is WP-CLI + How to Use It?

Key highlights 

How to install WP-CLI 

Installing WP-CLI is straightforward but requires meeting some prerequisites. Here’s what you’ll need before you start: 

Requirements for WP-CLI 

Once these requirements are met, follow this step-by-step guide to install WP-CLI: 

1. Download the Phar file: First, download the WP-CLI Phar file by running the following command in your terminal: 

curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar 

2. Make the file executable: After downloading, set the file to be executable: 

chmod +x wp-cli.phar 

3. Move the file: Move the Phar file to your system’s path so you can access it globally: 

sudo mv wp-cli.phar /usr/local/bin/wp 

4. Verify installation: Confirm that WP-CLI is installed successfully by running: 

wp --info 

If successful, this command will display WP-CLI version information and your PHP configuration, confirming it’s ready to use. 

Setting up WP-CLI for your WordPress website 

Download and install WordPress in seconds. Once WP-CLI is installed, setting it up for use on a specific WordPress website is simple. Follow these steps: 

1. Access the Site Directory: Navigate to the directory where your files are stored. Use this command: 

cd /path/to/wordpress/site 

2. Verify WP-CLI is working with the site: Run a test command, such as listing all installed WordPress plugins: 

wp plugin list 

Once successfully installed, you should see a list of plugins in your WordPress site directory. Now, WP-CLI is fully set up and ready to manage your site directly from the command line. This setup simplifies site management by allowing you to handle maintenance tasks, install or update WordPress plugins, and adjust settings with quick commands. It eliminates the need to navigate through the WordPress admin dashboard. 

Basic WP-CLI commands for beginners 

Here are some essential commands for beginners: 

1. Core commands 

• Check WP version: To verify your WordPress version, use: 

wp core version 

• Download WordPress: Quickly download the latest WordPress files with: 

wp core download

2. Managing plugins 

• Install a plugin: To install a plugin by name: 

wp plugin install plugin-name 

• Activate a plugin: Once installed, activate it: 

wp plugin activate plugin-name 

3. User management 

• Create a new user: Adding users is easy with: Use the wp user update command to adjust a user’s details. 

wp user create username [email protected] --role=author 

4. Database commands 

• Optimize database: To improve performance: 

wp db optimize 

5. Execute PHP code: php wp cli command  

These fundamental WP-CLI commands allow new users to start managing their WordPress sites more easily, from installing plugins to handling user accounts and optimizing databases. 

Advanced WP-CLI commands for power users 

As you become more experienced you can start leveraging advanced commands to handle complex tasks efficiently.  

1. Search and replace content 

To update a URL or replace text across multiple posts, use the following command in WP-CLI: 

wp search-replace 'old-url.com' 'new-url.com' 

This command lets you find and replace text across your database, making it easier to rebrand or update content in bulk. 

2. Cloning WordPress sites 

If you’re managing a multisite or need a staging environment, WP-CLI’s db export and db import commands can help. Start by exporting the database: 

wp db export filename.sql 

Then import it into the new site environment: 

wp db import filename.sql 

This process allows for quick site duplication, useful for testing or staging. 

3. Managing cron jobs 

WordPress uses cron jobs to handle scheduled tasks. With WP-CLI, you can list, run and delete cron events: 

• List all cron events: 

wp cron events list 

• Run a specific cron event: 

wp cron event run cron_event_name

• Delete a cron event: 

wp cron event delete cron_event_name 

This enables you to manage scheduled tasks and troubleshoot issues without needing the WordPress dashboard. 

4. Updating core, plugins and themes in bulk 

WP-CLI makes it easy to update all elements of your WordPress site. For example: 

• Update WordPress core: 

wp core update

• Update all plugins: 

wp plugin update --all 

• Update all themes: 

wp theme update --all 

Bulk updating saves time, especially when managing multiple sites and ensures your installation is secure and up-to-date. 

5. Running Arbitrary PHP code 

With WP-CLI, you can execute custom PHP code directly from the command line interface. This can be helpful for quick fixes or testing: 

wp eval 'echo get_option("siteurl");' 

The wp eval command runs PHP code within WordPress, giving you control over site functions without editing PHP files directly. 

6. Database optimization and maintenance 

To keep your site’s performance optimal, WP-CLI offers several database management commands: 

• Repair the database: 

wp db repair 

• Optimize the database: 

wp db optimize 

These commands help keep your WordPress database healthy, preventing issues and improving load times. 

7. Configuring multisite networks 

For users managing multiple sites, WP-CLI supports commands for multisite configurations. For example: 

• Enable multisite: 

wp core multisite-convert 

• Create a new site in the network: 

wp site create --slug=newsite 

Multisite commands make it easier to set up and manage a network of WordPress sites, ideal for developers handling multiple projects. 

8. Backup and restore site files and aatabases 

WP-CLI makes backups seamless with the db export command. Here’s how: 

• Export database: 

wp db export backup.sql 

• Restore database: 

wp db import backup.sql 

Regular backups safeguard against data loss, providing a simple method for site recovery. 

These advanced commands give users control over WordPress, making tasks quicker and easier. They help automate repetitive actions and handle complex operations across multiple sites. This is especially beneficial for developers managing large sites, speeding up tasks and simplifying site maintenance. 

How to use WP-CLI for site maintenance 

WP-CLI is an invaluable tool for performing essential site maintenance tasks without needing to log into the WordPress admin dashboard.  

1. Backup your database regularly 

One of the most crucial maintenance tasks is regular database backups. WP-CLI’s `db export` command exports your WordPress database into a file, useful for later restoration. 

wp db export backup.sql

Recent backups are crucial for security, protecting against data loss from crashes, hacks, or accidental deletions. 

2. Update WordPress core, plugins and themes 

Keeping WordPress core, plugins and themes up to date is essential for security and performance. With WP-CLI, you can update multiple elements in bulk, saving time on routine updates for your website. 

• Update WordPress core: 

wp core update 

• Update plugins: 

wp plugin update --all 

• Update themes: 

wp theme update --all 

This way, you can ensure that all aspects of your site remain current, minimizing the risk of vulnerabilities from outdated software. 

3. Optimize and repair your database 

WP-CLI allows you to optimize and repair your database without additional plugins, enhancing site performance and preventing potential issues. 

• Optimize database: 

wp db optimize 

• Repair database: 

wp db repair 

These commands streamline your database by cleaning up unnecessary data, reducing storage and enhancing site speed. 

4. Clear the cache 

Clearing your site’s cache helps deliver the latest version of your content to visitors, especially after updates or changes. With WP-CLI, you can clear your cache efficiently. While specific commands may vary depending on your caching plugin, a common command for WP Super Cache is: 

wp cache flush 

Clearing the cache regularly ensures visitors see the most current content and helps troubleshoot display issues that may arise from cached files. 

5. Manage user roles and permissions 

Managing user roles is another essential maintenance task. WP-CLI allows you to create, delete and update users efficiently, which is useful when dealing with teams or making role-based access changes. 

• Create a new user 

wp user create username [email protected] --role=author 

• Update user role: 

wp user update username --role=editor 

This level of control is crucial for site security and helps administrators ensure only authorized users have specific access. 

6. Monitor and control cron jobs 

Cron jobs control the automation of scheduled tasks, such as publishing scheduled posts and clearing cache. With WP-CLI, you can monitor these tasks, troubleshoot failed jobs and manage them more efficiently. 

• List all cron events: 

wp cron event list 

• Delete a cron event: 

wp cron event delete event_name 

This allows you to keep an eye on background processes, troubleshoot issues and keep your site running smoothly. 

7. Switch to maintenance mode 

If you need to take the site offline for updates or changes, WP-CLI can easily enable maintenance mode. This lets visitors know the site is temporarily unavailable and helps prevent issues during critical updates. 

• Activate maintenance mode: 

wp maintenance-mode activate 

• Deactivate maintenance mode: 

wp maintenance-mode deactivate 

Maintenance mode is helpful for maintaining a professional appearance during updates and preventing incomplete or broken content from displaying to users. 

Tips and best practices for WP-CLI 

1. Keep your WP-CLI updated 

WP-CLI is regularly updated with new features, bug fixes and security patches. Always make sure to run the latest version by updating WP-CLI regularly. You can update it with: 

wp cli update 

2. Use aliases for multiple sites 

If you’re managing several WordPress sites, WP-CLI allows you to define aliases to streamline operations. Aliases save time by linking commands to specific sites. 

wp site list --url=example.com --path=/var/www/html 

Defining site-specific aliases is a great way to quickly switch between multiple sites without needing to reconfigure each time. 

3. Leverage wp config for customization 

WP-CLI enables you to create custom wp-config.php entries on the fly. This is useful when adding custom constants or adjusting WordPress settings from the command line. 

wp config set WP_DEBUG true --type=constant 

This command adds debugging functionality without needing to manually edit files. 

4. Batch commands for efficiency 

WP-CLI allows you to run multiple commands in sequence, making it faster to perform multiple tasks. For example, updating plugins, themes and WordPress core in one go: 

wp core update && wp plugin update --all && wp theme update --all 

Batching commands helps improve efficiency and ensures everything is updated in a single run. 

5. Backup before making changes 

Before making major changes to your WordPress site (such as updating core files, plugins or themes), it’s always good practice to back up the database and files using WP-CLI. 

wp db export backup.sql 

Backups are essential for safety and recovery in case things go wrong. 

6. Use WP-CLI with scripts 

For routine tasks, create scripts that include WP-CLI commands, such as scheduled backups, updates or maintenance tasks. Automating these operations will save you time and effort. 

7. Understand the help command 

Every WP-CLI command comes with a built-in help option. By appending –help to any WP-CLI command, you can see available options and arguments. 

wp plugin install --help 

This is especially useful for exploring new commands and keeping track of options. 

8. Debugging commands 

WP-CLI has a debug option to help identify issues in your commands or scripts. If you encounter any errors, the –debug flag can provide more insights into what’s going wrong. 

wp plugin install plugin_name --debug 

Using debugging tools helps to isolate problems and streamline solutions. 

9. Customize user permissions 

WP-CLI provides a straightforward way to manage user roles and permissions. When working with team members or clients, it’s important to ensure proper user roles are assigned: 

wp user update username --role=administrator 

This helps control access levels and maintain site security. 

10. Test on staging sites 

Whenever possible, test your commands on a staging site before running them on a live site. This practice prevents potential downtime and unforeseen errors when applying changes on the production website. 

Final thoughts

WP-CLI is more than a tool—it’s a powerful ally for WordPress developers and administrators, revolutionizing how you manage WordPress sites. From handling plugins and themes to managing users and databases, WP-CLI empowers you with efficiency and control. By mastering installation, troubleshooting, and best practices, you can seamlessly integrate WP-CLI into your workflow, saving valuable time. 

If you’re looking for a reliable hosting solution to support your WordPress site and enhance its performance Bluehost will be a great option. With excellent support for WP-CLI and robust hosting features, Bluehost ensures your site remains fast, secure, and scalable. Explore Bluehost’s hosting plans to create the perfect environment for your WordPress websites. 

For further reading, check out detailed guides on WordPress plugins, eCommerce solutions, and more to continue building a robust WordPress toolkit. 

FAQs