ece-tools reference

The ece-tools package is a set of scripts and tools designed to manage and deploy Magento Commerce Cloud projects. The ece-tools package simplifies many Magento Commerce Cloud processes, such as Docker environment deployment, cron management, and project verification. You can view and contribute to the open-source ece-tools repository on Github.

If you use a version of Magento Commerce Cloud that does not contain the ece-tools package, then your project requires an upgrade. If you currently use the ece-tools package and you need to update it, see Update ece-tools version.

The ece-tools package is compatible with Magento Commerce—starting with version 2.1.4—and contains scripts and Magento Commerce Cloud commands designed to help manage your code and automatically build and deploy your projects.

To list the available ece-tools commands:

1
php ./vendor/bin/ece-tools list

Build and deploy

The ece-tools package performs operations for the build, deploy, and post-deploy stages for launching your Magento Commerce Cloud application. By default, these commands are in the hooks property of the .magento.app.yaml configuration file.

Docker configuration generator

The ece-tools package provides all the commands necessary to launch a Docker development environment.

The following example lists the ece-tools Docker commands:

1
php ./vendor/bin/ece-tools list | grep docker

Sample response:

1
2
3
 docker
  docker:build              Build docker configuration
  docker:config:convert     Convert raw config to .env files configuration

Services, routes, and variables

You can use the ece-tools package to display detailed information about the Base64-encoded Cloud variables used in any Cloud environment. The following command shows all services, routes, and variables.

1
php ./vendor/bin/ece-tools env:config:show

To display a specific set of information, use the following format:

1
php ./vendor/bin/ece-tools env:config:show <option>

• services—Displays the relationship data from the MAGENTO_CLOUD_RELATIONSHIPS environment variable, defined in the services.yaml file.
• routes—Displays the configured routes for the project using the MAGENTO_CLOUD_ROUTES environment variable.
• variables—Displays the configured variables for the project using the MAGENTO_CLOUD_VARIABLES environment variable.

Sample output for the services option:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Magento Cloud Services:
+-----------------------------------+----------------------------------+
| Service Configuration             | Value                            |
+-----------------------------------+----------------------------------+
| database:                                                            |
+-----------------------------------+----------------------------------+
| host                              | 127.0.0.1                        |
| password                          | <password>                       |
| port                              | 3306                             |
+-----------------------------------+----------------------------------+
| elasticsearch:                                                       |
+-----------------------------------+----------------------------------+
| host                              | 127.0.0.1                        |
| port                              | 9200                             |
...

Verify environment configuration

There is a set of verification commands available to help evaluate the configuration of your project. See Smart wizards in the Optimize deployment section for a detailed description of each wizard command. The wizard:ideal-state command runs automatically during the build phase.

To verify the ideal state of your project:

1
./vendor/bin/ece-tools wizard:ideal-state

Sample output:

1
Ideal state is configured

For current Magento Commerce Cloud release information, see Release notes for ece-tools.