Topics

On this page

Last updated on Dec 9, 2021

ee cli check-update

Check to see if there is a newer version of EE available.

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

OPTIONS

[–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.

[–format=<format>]
: Render output in a particular format.

default: table
options:

EXAMPLES

# Check for update.
$ ee cli check-update
Success: EE is at the latest version.

# Check for update and new version is available.
$ ee cli check-update
+---------+-------------+------------------------------------------------------------------------------------------+
| version | update_type | package_url                                                                              |
+---------+-------------+------------------------------------------------------------------------------------------+
| 0.24.1  | patch       | https://github.com/EasyEngine/easyengine/releases/download/v4.0.0-beta.1/easyengine.phar |
+---------+-------------+------------------------------------------------------------------------------------------+

SUBCOMMANDS

NameDescription
ee cli alias

List available EE aliases.

ee cli cmd-dump

Dump the list of installed commands, as JSON.

ee cli completions

Generate tab completion strings.

ee cli has-command

Detects if a command exists

ee cli info

Print various details about the EE environment.

ee cli param-dump

Dump the list of global parameters, as JSON or in var_export format.

ee cli self-uninstall

Uninstalls easyengine completely along with all sites

ee cli update

Update EE to the latest release.

ee cli version

Print EE version.

GLOBAL PARAMETERS

Argument Description
–sites_path=<path> Absolute path to where all sites will be stored.
–locale=<locale> Locale for WordPress.
–le-mail=<le-mail> Mail-id to be used for letsencrypt.
–wp-mail=<wp-mail> Default Mail-id to be used for WordPress site installation.
–sysctl=<true/false> Whether to add sysctl config in docker-compose.
–[no-]color Whether to colorize the output.
–debug[=<group>] Show all PHP errors; add verbosity to EE bootstrap.
–quiet Suppress informational messages.