handbook/commands/cli/check-update.md

wp cli check-update

Checks to see if there is a newer version of WP-CLI available.

This command runs on the before_wp_load hook, just before the WP load process begins.

Queries the GitHub releases API. Returns available versions if there are updates available, or success message if using the latest release.

Unauthenticated requests to the GitHub API are rate limited to 60 per hour per IP address. If you are experiencing rate limit issues, you can generate a GitHub personal access token and set the GITHUB_TOKEN environment variable before running this command. Authenticated requests have a higher rate limit of 5,000 per hour. The token only needs public repository read access (no specific scopes required for public data).

OPTIONS

See the argument syntax reference for a detailed explanation of the syntax conventions used.

[--patch]

Only list patch updates.

[--minor]

Only list minor updates.

[--major]

Only list major updates.

[--field=<field>]

Prints the value of a single field for each update.

[--fields=<fields>]

Limit the output to specific object fields. Defaults to version,update_type,package_url,status,requires_php.

[--format=<format>]

Render output in a particular format. --- default: table options:

• table
• csv
• json
• count
• yaml ---

EXAMPLES

# Check for update.
$ wp cli check-update
Success: WP-CLI is at the latest version.

# Check for update and new version is available.
$ wp cli check-update
+---------+-------------+-------------------------------------------------------------------------------+
| version | update_type | package_url                                                                   |
+---------+-------------+-------------------------------------------------------------------------------+
| 0.24.1  | patch       | https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar |
+---------+-------------+-------------------------------------------------------------------------------+

# Check for update using a GitHub token to increase rate limit.
$ GITHUB_TOKEN=ghp_... wp cli check-update
Success: WP-CLI is at the latest version.

GLOBAL PARAMETERS

These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.

Argument	Description
--path=<path>	Path to the WordPress files.
--url=<url>	Pretend request came from given URL. In multisite, this argument is how the target site is specified.
--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]	Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant").
--ssh-args=<args>	Pass additional arguments to SSH (or other tools specified by --ssh scheme).
--http=<http>	Perform operation against a remote WordPress installation over HTTP.
--user=<id|login|email>	Set the WordPress user.
--skip-plugins[=<plugins>]	Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded.
--skip-themes[=<themes>]	Skip loading all themes, or a comma-separated list of themes.
--skip-packages	Skip loading all installed packages.
--require=<path>	Load PHP file before running the command (may be used more than once).
--exec=<php-code>	Execute PHP code before running the command (may be used more than once).
--context=<context>	Load WordPress in a given context.
--[no-]color	Whether to colorize the output.
--debug[=<group>]	Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help.
--prompt[=<assoc>]	Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values.
--quiet	Suppress informational messages.
--alias=<name>	Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file.
--assume-https	Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer.