You are reading the documentation for version 2.2. Magento 2.3 is the latest version available. Ensure you are reading the documentation for your version of Magento.

Magento Cloud CLI reference

The Magento Cloud CLI is the utility for managing Magento Cloud projects and environments, which implements many features of the Project Web Interface and more. This utility provides an advanced management interface for developers, DevOps and system administrators, for doing routines and automation tasks. You can install and use this utility for all Magento Commerce Cloud Starter and Pro Integration environments. You cannot use these commands for the Pro Staging and Production environments which aren’t listed in the cloud UI.

You can install the Magento Cloud CLI when setting up your local environment for development:

Common commands

The following lists the available magento-cloud CLI commands:

1
magento-cloud list

Magento designed these commands to manage Cloud Integration environments. It is a best practice to run the Magento Cloud CLI from a project directory, because you can omit the -p <project ID> parameter.

Action Command
Log in to a project magento-cloud login
Clone a project to a directory magento-cloud project:get <PROJECT_ID> <DIRECTORY> -e <ENVIRONMENT_ID>
Note: If you want to clone the master environment, omit the -e <ENVIRONMENT_ID> parameter.

Environment commands

The environment name is different from the environment ID only if you use spaces or capital letters in the environment name. An environment ID consists of all lowercase letters, numbers, and allowed symbols. Capital letters in an environment name are converted to lowercase in the ID; spaces in an environment name are converted to dashes.

An environment name cannot include characters reserved for your Linux shell or for regular expressions. Forbidden characters include curly braces ({ }), parentheses, asterisk (*), angle brackets (< >), ampersand (&), percent (%), and other characters.

The magento-cloud environment:list command displays environment hierarchies, whereas git branch does not. If you have any nested environments, use the following:

1
magento-cloud environment:list

Common environment commands

Action Command
Checkout environment magento-cloud environment:checkout <ENVIRONMENT_ID>
Merge change to parent environment magento-cloud environment:merge -p <PROJECT_ID> -e <ENVIRONMENT_ID>
Synchronize with parent environment magento-cloud environment:synchronize -p <PROJECT_ID> -e <ENVIRONMENT_ID> {code|data}
List environment variables magento-cloud variable:list
Set a variable value magento-cloud variable:set <VARIABLE_NAME> <VARIABLE_VALUE>

Redeploy the environment

Trigger a redeployment without using a push. You must verify and confirm the environment to redeploy. Do not use redeploy if there is a build in a pending state.

1
2
magento-cloud environment:redeploy
Are you sure you want to redeploy the environment <environment_name>? [Y/n]

Git commands

You may notice that some of these commands are similar to Git commands. The magento-cloud commands directly connect to the Magento Git-based Cloud project with additional features. For example, when you push a Git branch, it is not activated until you access GitHub. The Magento CLI command includes activation.

To create a new branch, use the magento-cloud command so the branch is activated.

1
magento-cloud environment:branch <NAME> <PARENT_BRANCH>

Pushing an empty commit forces a redeployment. For example:

1
git commit --allow-empty -m "redeploy" && git push <BRANCH_NAME>

Some actions, such as adding a user, do not result in deployment.

Command help

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
magento-cloud help
Command: help
Description: Displays help for a command

Usage:
 help [--format FORMAT] [--raw] [--] [<command_name>]

Arguments:
  command               The command to execute
  command_name          The command name [default: "help"]

Options:
      --format=FORMAT   The output format (txt, xml, json, or md) [default: "txt"]
      --raw             To output raw command help
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
  -y, --yes             Answer "yes" to all prompts; disable interaction
  -n, --no              Answer "no" to all prompts
  -v|vv|vvv, --verbose  Increase the verbosity of messages

Help:
 The help command displays help for a given command:

   php /Users/username/.magento-cloud/bin/magento-cloud help list

 You can also output the help in other formats by using the --format option:

   php /Users/username/.magento-cloud/bin/magento-cloud help --format=xml list

 To display the list of available commands, please use the list command.

Update Magento Cloud CLI

The Magento Cloud CLI checks for available updates upon login, but you can also check for updates using the self:update command. If there is an update available, follow the instructions and enter Y for yes to update the CLI.

If your Magento Cloud CLI is up to date, you see the following response:

1
magento-cloud update
1
2
Checking for Magento Cloud CLI updates (current version: X.XX.X)
No updates found