Cloud CLI reference

Version: 1.46.1

This reference contains 119 commands available through the magento-cloud command-line tool.
The initial list is auto generated using the magento-cloud list command at Adobe Commerce on cloud infrastructure.

NOTE
This reference is generated from the application codebase. To change the content, you can update the source code for the corresponding command implementation in the codebase repository and submit your changes for review. Another way is to Give us feedback (find the link at the upper right). For contribution guidelines, see Code Contributions.

clear-cache

Clear the CLI cache

magento-cloud cc

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

decode

Decode an encoded string such as MAGENTO_CLOUD_VARIABLES

magento-cloud decode [-P|--property PROPERTY] [--] <value>

value

The variable value to decode

  • Required

--property, -P

The property to view within the variable

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

docs

Open the online documentation

magento-cloud docs [--browser BROWSER] [--pipe] [--] [<search>]...

Search term(s)

  • Default: []

  • Array

--browser

The browser to use to open the URL. Set 0 for none.

  • Requires a value

--pipe

Output the URL to stdout.

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

help

Displays help for a command

magento-cloud help [--format FORMAT] [--raw] [--] [<command_name>]

command_name

The command name

  • Default: help

--format

The output format (txt, json, or md)

  • Default: txt
  • Requires a value

--raw

To output raw command help

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

list

Lists commands

magento-cloud list [--raw] [--format FORMAT] [--all] [--] [<namespace>]

command

The command to execute

  • Required

namespace

The namespace name

--raw

To output raw command list

  • Default: false
  • Does not accept a value

--format

The output format (txt, xml, json, or md)

  • Default: txt
  • Requires a value

--all

Show all commands, including hidden ones

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

multi

Execute a command on multiple projects

magento-cloud multi [-p|--projects PROJECTS] [--continue] [--sort SORT] [--reverse] [--] <cmd> (<cmd>)...

cmd

The command to execute

  • Default: []

  • Required

  • Array

--projects, -p

A list of project IDs, separated by commas and/or whitespace

  • Requires a value

--continue

Continue running commands even if an exception is encountered

  • Default: false
  • Does not accept a value

--sort

A property by which to sort the list of project options

  • Default: title
  • Requires a value

--reverse

Reverse the order of project options

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

web

Open the project in the Web UI

magento-cloud web [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

--browser

The browser to use to open the URL. Set 0 for none.

  • Requires a value

--pipe

Output the URL to stdout.

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

activity:cancel

Cancel an activity

magento-cloud activity:cancel [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]

id

The activity ID. Defaults to the most recent cancellable activity.

--type, -t

Filter by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard for the type, e.g. ‘%var%’ to select variable-related activities.

  • Default: []
  • Requires a value

--exclude-type, -x

Exclude by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard to exclude types.

  • Default: []
  • Requires a value

--all, -a

Check recent activities on all environments (when selecting a default activity)

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

activity:get

View detailed information on a single activity

magento-cloud activity:get [-P|--property PROPERTY] [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<id>]

id

The activity ID. Defaults to the most recent activity.

--property, -P

The property to view

  • Requires a value

--type, -t

Filter by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard for the type, e.g. ‘%var%’ to select variable-related activities.

  • Default: []
  • Requires a value

--exclude-type, -x

Exclude by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard to exclude types.

  • Default: []
  • Requires a value

--state

Filter by state (when selecting a default activity): in_progress, pending, complete, or cancelled. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--result

Filter by result (when selecting a default activity): success or failure

  • Requires a value

--incomplete, -i

Include only incomplete activities (when selecting a default activity). This is a shorthand for <info>–state=in_progress,pending</info>

  • Default: false
  • Does not accept a value

--all, -a

Check recent activities on all environments (when selecting a default activity)

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

activity:list

Get a list of activities for an environment or project

magento-cloud activities [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMIT] [--start START] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

--type, -t

Filter activities by type Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The first part of the activity name can be omitted, e.g. ‘cron’ can select ‘environment.cron’ activities. The % or * characters can be used as a wildcard, e.g. ‘%var%’ to select variable-related activities.

  • Default: []
  • Requires a value

--exclude-type, -x

Exclude activities by type. Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The first part of the activity name can be omitted, e.g. ‘cron’ can exclude ‘environment.cron’ activities. The % or * characters can be used as a wildcard to exclude types.

  • Default: []
  • Requires a value

--limit

Limit the number of results displayed

  • Default: 10
  • Requires a value

--start

Only activities created before this date will be listed

  • Requires a value

--state

Filter activities by state: in_progress, pending, complete, or cancelled. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--result

Filter activities by result: success or failure

  • Requires a value

--incomplete, -i

Only list incomplete activities

  • Default: false
  • Does not accept a value

--all, -a

List activities on all environments

  • Default: false
  • Does not accept a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: id*, created*, description*, progress*, state*, result*, completed, environments, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

activity:log

Display the log for an activity

magento-cloud activity:log [--refresh REFRESH] [-t|--timestamps] [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]

id

The activity ID. Defaults to the most recent activity.

--refresh

Activity refresh interval (seconds). Set to 0 to disable refreshing.

  • Default: 3
  • Requires a value

--timestamps, -t

Display a timestamp next to each message

  • Default: false
  • Does not accept a value

--type

Filter by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard for the type, e.g. ‘%var%’ to select variable-related activities.

  • Default: []
  • Requires a value

--exclude-type, -x

Exclude by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard to exclude types.

  • Default: []
  • Requires a value

--state

Filter by state (when selecting a default activity): in_progress, pending, complete, or cancelled. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--result

Filter by result (when selecting a default activity): success or failure

  • Requires a value

--incomplete, -i

Include only incomplete activities (when selecting a default activity). This is a shorthand for <info>–state=in_progress,pending</info>

  • Default: false
  • Does not accept a value

--all, -a

Check recent activities on all environments (when selecting a default activity)

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

app:config-get

View the configuration of an app

magento-cloud app:config-get [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE]

--property, -P

The configuration property to view

  • Requires a value

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--identity-file, -i

[Deprecated option, no longer used]

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

app:list

List apps in the project

magento-cloud apps [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--pipe

Output a list of app names only

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: name*, type*, disk, path, size (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

auth:api-token-login

Log in to Magento Cloud using an API token

magento-cloud auth:api-token-login

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

auth:browser-login

Log in to Magento Cloud via a browser

magento-cloud login [-f|--force] [--browser BROWSER] [--pipe]

--force, -f

Log in again, even if already logged in

  • Default: false
  • Does not accept a value

--browser

The browser to use to open the URL. Set 0 for none.

  • Requires a value

--pipe

Output the URL to stdout.

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

auth:info

Display your account information

magento-cloud auth:info [--no-auto-login] [-P|--property PROPERTY] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--] [<property>]

property

The account property to view

--no-auto-login

Skips auto login. Nothing will be output if not logged in, and the exit code will be 0, assuming no other errors.

  • Default: false
  • Does not accept a value

--property, -P

The account property to view (alternate syntax)

  • Requires a value

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

auth:logout

Log out of Magento Cloud

magento-cloud logout [-a|--all] [--other]

--all, -a

Log out from all local sessions

  • Default: false
  • Does not accept a value

--other

Log out from other local sessions

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

blackfire:setup

Setup Blackfire.io integration for the project

magento-cloud blackfire:setup [--server_id SERVER_ID] [--server_token SERVER_TOKEN] [-p|--project PROJECT] [-W|--no-wait] [--wait]

--server_id

The server id

  • Requires a value

--server_token

The server token

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

certificate:add

Add an SSL certificate to the project

magento-cloud certificate:add [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [-W|--no-wait] [--wait]

--cert

The path to the certificate file

  • Requires a value

--key

The path to the certificate private key file

  • Requires a value

--chain

The path to the certificate chain file

  • Default: []
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

certificate:delete

Delete a certificate from the project

magento-cloud certificate:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] <id>

id

The certificate ID (or the start of it)

  • Required

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

certificate:get

View a certificate

magento-cloud certificate:get [-P|--property PROPERTY] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--] <id>

id

The certificate ID (or the start of it)

  • Required

--property, -P

The certificate property to view

  • Requires a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

certificate:list

List project certificates

magento-cloud certificates [--domain DOMAIN] [--exclude-domain EXCLUDE-DOMAIN] [--issuer ISSUER] [--only-auto] [--no-auto] [--ignore-expiry] [--only-expired] [--no-expired] [--pipe-domains] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

--domain

Filter by domain name (case-insensitive search)

  • Requires a value

--exclude-domain

Exclude certificates, matching by domain name (case-insensitive search)

  • Requires a value

--issuer

Filter by issuer

  • Requires a value

--only-auto

Show only auto-provisioned certificates

  • Default: false
  • Does not accept a value

--no-auto

Show only manually added certificates

  • Default: false
  • Does not accept a value

--ignore-expiry

Show both expired and non-expired certificates

  • Default: false
  • Does not accept a value

--only-expired

Show only expired certificates

  • Default: false
  • Does not accept a value

--no-expired

Show only non-expired certificates (default)

  • Default: false
  • Does not accept a value

--pipe-domains

Only return a list of domain names covered by the certificates

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: created, domains, expires, id, issuer. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

commit:get

Show commit details

magento-cloud commit:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--date-fmt DATE-FMT] [--] [<commit>]

commit

The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.

  • Default: HEAD

--property, -P

The commit property to display.

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

commit:list

List commits

magento-cloud commits [--limit LIMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<commit>]

commit

The starting Git commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.

--limit

The number of commits to display.

  • Default: 10
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: author, date, sha, summary. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

db:dump

Create a local dump of the remote database

magento-cloud db:dump [--schema SCHEMA] [-f|--file FILE] [-d|--directory DIRECTORY] [-z|--gzip] [-t|--timestamp] [-o|--stdout] [--table TABLE] [--exclude-table EXCLUDE-TABLE] [--schema-only] [--charset CHARSET] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE]

--schema

The schema to dump. Omit to use the default schema (usually “main”).

  • Requires a value

--file, -f

A custom filename for the dump

  • Requires a value

--directory, -d

A custom directory for the dump

  • Requires a value

--gzip, -z

Compress the dump using gzip

  • Default: false
  • Does not accept a value

--timestamp, -t

Add a timestamp to the dump filename

  • Default: false
  • Does not accept a value

--stdout, -o

Output to STDOUT instead of a file

  • Default: false
  • Does not accept a value

--table

Table(s) to include

  • Default: []
  • Requires a value

--exclude-table

Table(s) to exclude

  • Default: []
  • Requires a value

--schema-only

Dump only schemas, no data

  • Default: false
  • Does not accept a value

--charset

The character set encoding for the dump

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--relationship, -r

The service relationship to use

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

db:size

Estimate the disk usage of a database

magento-cloud db:size [-B|--bytes] [-C|--cleanup] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-i|--identity-file IDENTITY-FILE]

--bytes, -B

Show sizes in bytes.

  • Default: false
  • Does not accept a value

--cleanup, -C

Check if tables can be cleaned up and show me recommendations (InnoDb only).

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--relationship, -r

The service relationship to use

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: max, percent_used, used. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

db:sql

Run SQL on the remote database

magento-cloud sql [--raw] [--schema SCHEMA] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [--] [<query>]

query

An SQL statement to execute

--raw

Produce raw, non-tabular output

  • Default: false
  • Does not accept a value

--schema

The schema to use. Omit to use the default schema (usually “main”). Pass an empty string to not use any schema.

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--relationship, -r

The service relationship to use

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

domain:add

Add a new domain to the project

magento-cloud domain:add [--cert CERT] [--key KEY] [--chain CHAIN] [--attach ATTACH] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

name

The domain name

  • Required

--cert

The path to the certificate file for this domain

  • Requires a value

--key

The path to the private key file for the provided certificate.

  • Requires a value

--chain

The path to the certificate chain file or files for the provided certificate

  • Default: []
  • Requires a value

--attach

The production domain that this one replaces in the environment’s routes. Required for non-production environment domains.

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

domain:delete

Delete a domain from the project

magento-cloud domain:delete [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

name

The domain name

  • Required

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

domain:get

Show detailed information for a domain

magento-cloud domain:get [-P|--property PROPERTY] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<name>]

name

The domain name

--property, -P

The domain property to view

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

domain:list

Get a list of all domains

magento-cloud domains [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: name*, ssl*, created_at*, registered_name, replacement_for, type, updated_at (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

domain:update

Update a domain

magento-cloud domain:update [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

name

The domain name

  • Required

--cert

The path to the certificate file for this domain

  • Requires a value

--key

The path to the private key file for the provided certificate.

  • Requires a value

--chain

The path to the certificate chain file or files for the provided certificate

  • Default: []
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:activate

Activate an environment

magento-cloud environment:activate [--parent PARENT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]...

environment

The environment(s) to activate

  • Default: []

  • Array

--parent

Set a new environment parent before activating

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:branch

Branch an environment

magento-cloud branch [--title TITLE] [--type TYPE] [--no-clone-parent] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<id>] [<parent>]

id

The ID (branch name) of the new environment

parent

The parent of the new environment

--title

The title of the new environment

  • Requires a value

--type

The type of the new environment

  • Requires a value

--no-clone-parent

Do not clone the parent environment’s data

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:checkout

Check out an environment

magento-cloud checkout [-i|--identity-file IDENTITY-FILE] [--] [<id>]

id

The ID of the environment to check out. For example: “sprint2”

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:delete

Delete one or more environments

magento-cloud environment:delete [--delete-branch] [--no-delete-branch] [--type TYPE] [-t|--only-type ONLY-TYPE] [--exclude EXCLUDE] [--exclude-type EXCLUDE-TYPE] [--inactive] [--merged] [--allow-delete-parent] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]...

environment

The environment(s) to delete. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []

  • Array

--delete-branch

Delete Git branch(es) for inactive environments, without confirmation

  • Default: false
  • Does not accept a value

--no-delete-branch

Do not delete any Git branch(es) (inactive environments)

  • Default: false
  • Does not accept a value

--type

Delete all environments of a type (adding to any others selected) Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--only-type, -t

Only delete environments of a specific type Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--exclude

Environment(s) not to delete. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--exclude-type

Environment type(s) of which not to delete Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--inactive

Delete all inactive environments (adding to any others selected)

  • Default: false
  • Does not accept a value

--merged

Delete all merged environments (adding to any others selected)

  • Default: false
  • Does not accept a value

--allow-delete-parent

Allow environments that have children to be deleted

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:http-access

Update HTTP access settings for an environment

magento-cloud httpaccess [--access ACCESS] [--auth AUTH] [--enabled ENABLED] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

--access

Access restriction in the format “permission:address”. Use 0 to clear all addresses.

  • Default: []
  • Requires a value

--auth

HTTP Basic auth credentials in the format “username:password”. Use 0 to clear all credentials.

  • Default: []
  • Requires a value

--enabled

Whether access control should be enabled: 1 to enable, 0 to disable

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:info

Read or set properties for an environment

magento-cloud environment:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<property>] [<value>]

property

The name of the property

value

Set a new value for the property

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:init

Initialize an environment from a public Git repository

magento-cloud environment:init [--profile PROFILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <url>

url

A URL to a Git repository

  • Required

--profile

The name of the profile

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:list

Get a list of environments

magento-cloud environments [-I|--no-inactive] [--pipe] [--refresh REFRESH] [--sort SORT] [--reverse] [--type TYPE] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

--no-inactive, -I

Do not show inactive environments

  • Default: false
  • Does not accept a value

--pipe

Output a simple list of environment IDs.

  • Default: false
  • Does not accept a value

--refresh

Whether to refresh the list.

  • Default: 1
  • Requires a value

--sort

A property to sort by

  • Default: title
  • Requires a value

--reverse

Sort in reverse (descending) order

  • Default: false
  • Does not accept a value

--type

Filter the list by environment type(s). Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: id*, title*, status*, type*, created, machine_name, updated (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:logs

Read an environment’s logs

magento-cloud log [--lines LINES] [--tail] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [--] [<type>]

type

The log type, e.g. “access” or “error”

--lines

The number of lines to show

  • Default: 100
  • Requires a value

--tail

Continuously tail the log

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--instance, -I

An instance ID

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:merge

Merge an environment

magento-cloud merge [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]

environment

The environment to merge

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:pause

Pause an environment

magento-cloud environment:pause [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:push

Push code to an environment

magento-cloud push [--target TARGET] [-f|--force] [--force-with-lease] [-u|--set-upstream] [--activate] [--parent PARENT] [--type TYPE] [--no-clone-parent] [-W|--no-wait] [--wait] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-i|--identity-file IDENTITY-FILE] [--] [<source>]

source

The source ref: a branch name or commit hash

  • Default: HEAD

--target

The target branch name. Defaults to the current branch.

  • Requires a value

--force, -f

Allow non-fast-forward updates

  • Default: false
  • Does not accept a value

--force-with-lease

Allow non-fast-forward updates, if the remote-tracking branch is up to date

  • Default: false
  • Does not accept a value

--set-upstream, -u

Set the target environment as the upstream for the source branch. This will also set the target project as the remote for the local repository.

  • Default: false
  • Does not accept a value

--activate

Activate the environment before pushing

  • Default: false
  • Does not accept a value

--parent

Set the new environment parent (only used with --activate)

  • Requires a value

--type

Set the environment type (only used with --activate )

  • Requires a value

--no-clone-parent

Do not clone the parent branch’s data (only used with --activate)

  • Default: false
  • Does not accept a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:redeploy

Redeploy an environment

magento-cloud redeploy [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:relationships

Show an environment’s relationships

magento-cloud relationships [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE] [--] [<environment>]

environment

The environment

--property, -P

The relationship property to view

  • Requires a value

--refresh

Whether to refresh the relationships

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:resume

Resume a paused environment

magento-cloud environment:resume [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:scp

Copy files to and from an environment using scp

magento-cloud scp [-r|--recursive] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE] [--] [<files>]...

files

Files to copy. Use the remote: prefix to define remote locations.

  • Default: []

  • Array

--recursive, -r

Recursively copy entire directories

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--instance, -I

An instance ID

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:ssh

SSH to the current environment

magento-cloud ssh [--pipe] [--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE] [--] [<cmd>]...

cmd

A command to run on the environment.

  • Default: []

  • Array

--pipe

Output the SSH URL only.

  • Default: false
  • Does not accept a value

--all

Output all SSH URLs (for every app).

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--instance, -I

An instance ID

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:synchronize

Synchronize an environment’s code and/or data from its parent

magento-cloud sync [--rebase] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<synchronize>]...

synchronize

What to synchronize: “code”, “data” or both

  • Default: []

  • Array

--rebase

Synchronize code by rebasing instead of merging

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:url

Get the public URLs of an environment

magento-cloud url [-1|--primary] [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

--primary, -1

Only return the URL for the primary route

  • Default: false
  • Does not accept a value

--browser

The browser to use to open the URL. Set 0 for none.

  • Requires a value

--pipe

Output the URL to stdout.

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

environment:xdebug

Open a tunnel to Xdebug on the environment

magento-cloud xdebug [--port PORT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE]

--port

The local port

  • Default: 9000
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--instance, -I

An instance ID

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

integration:activity:get

View detailed information on a single integration activity

magento-cloud integration:activity:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<integration>] [<activity>]

integration

An integration ID. Leave blank to choose from a list.

activity

The activity ID. Defaults to the most recent integration activity.

--property, -P

The property to view

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

[Deprecated option, not used]

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

integration:activity:list

Get a list of activities for an integration

magento-cloud int:act [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMIT] [--start START] [--state STATE] [--result RESULT] [-i|--incomplete] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]

id

An integration ID. Leave blank to choose from a list.

--type

Filter activities by type. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--exclude-type, -x

Exclude activities by type. Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard to exclude types.

  • Default: []
  • Requires a value

--limit

Limit the number of results displayed

  • Default: 10
  • Requires a value

--start

Only activities created before this date will be listed

  • Requires a value

--state

Filter activities by state. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--result

Filter activities by result

  • Requires a value

--incomplete, -i

Only list incomplete activities

  • Default: false
  • Does not accept a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: id*, created*, description*, type*, state*, result*, completed (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

[Deprecated option, not used]

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

integration:activity:log

Display the log for an integration activity

magento-cloud integration:activity:log [-t|--timestamps] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<integration>] [<activity>]

integration

An integration ID. Leave blank to choose from a list.

activity

The activity ID. Defaults to the most recent integration activity.

--timestamps, -t

Display a timestamp next to each message

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

[Deprecated option, not used]

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

integration:add

Add an integration to the project

magento-cloud integration:add [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BITBUCKET-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--license-key LICENSE-KEY] [--server-project SERVER-PROJECT] [--repository REPOSITORY] [--build-merge-requests BUILD-MERGE-REQUESTS] [--build-pull-requests BUILD-PULL-REQUESTS] [--build-draft-pull-requests BUILD-DRAFT-PULL-REQUESTS] [--build-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--build-wip-merge-requests BUILD-WIP-MERGE-REQUESTS] [--merge-requests-clone-parent-data MERGE-REQUESTS-CLONE-PARENT-DATA] [--pull-requests-clone-parent-data PULL-REQUESTS-CLONE-PARENT-DATA] [--resync-pull-requests RESYNC-PULL-REQUESTS] [--fetch-branches FETCH-BRANCHES] [--prune-branches PRUNE-BRANCHES] [--resources-init RESOURCES-INIT] [--url URL] [--shared-key SHARED-KEY] [--file FILE] [--events EVENTS] [--states STATES] [--environments ENVIRONMENTS] [--excluded-environments EXCLUDED-ENVIRONMENTS] [--from-address FROM-ADDRESS] [--recipients RECIPIENTS] [--channel CHANNEL] [--routing-key ROUTING-KEY] [--category CATEGORY] [--index INDEX] [--sourcetype SOURCETYPE] [--protocol PROTOCOL] [--syslog-host SYSLOG-HOST] [--syslog-port SYSLOG-PORT] [--facility FACILITY] [--message-format MESSAGE-FORMAT] [--auth-mode AUTH-MODE] [--auth-token AUTH-TOKEN] [--verify-tls VERIFY-TLS] [--header HEADER] [-p|--project PROJECT] [-W|--no-wait] [--wait]

--type

The integration type (‘bitbucket’, ‘bitbucket_server’, ‘github’, ‘gitlab’, ‘webhook’, ‘health.email’, ‘health.pagerduty’, ‘health.slack’, ‘health.webhook’, ‘httplog’, ‘script’, ‘newrelic’, ‘splunk’, ‘sumologic’, ‘syslog’)

  • Requires a value

--base-url

The base URL of the server installation

  • Requires a value

--bitbucket-url

The base URL of the Bitbucket Server installation

  • Requires a value

--username

The Bitbucket Server username

  • Requires a value

--token

An authentication or access token for the integration

  • Requires a value

--key

A Bitbucket OAuth consumer key

  • Requires a value

--secret

A Bitbucket OAuth consumer secret

  • Requires a value

--license-key

The New Relic Logs license key

  • Requires a value

--server-project

The project (e.g. ‘namespace/repo’)

  • Requires a value

--repository

The repository to track (e.g. ‘owner/repository’)

  • Requires a value

--build-merge-requests

GitLab: build merge requests as environments

  • Default: true
  • Requires a value

--build-pull-requests

Build every pull request as an environment

  • Default: true
  • Requires a value

--build-draft-pull-requests

Build draft pull requests

  • Default: true
  • Requires a value

--build-pull-requests-post-merge

Build pull requests based on their post-merge state

  • Default: false
  • Requires a value

--build-wip-merge-requests

GitLab: build WIP merge requests

  • Default: true
  • Requires a value

--merge-requests-clone-parent-data

GitLab: clone data for merge requests

  • Default: true
  • Requires a value

--pull-requests-clone-parent-data

Clone the parent environment’s data for pull requests

  • Default: true
  • Requires a value

--resync-pull-requests

Re-sync pull request environment data on every build

  • Default: false
  • Requires a value

--fetch-branches

Fetch all branches from the remote (as inactive environments)

  • Default: true
  • Requires a value

--prune-branches

Delete branches that do not exist on the remote

  • Default: true
  • Requires a value

--resources-init

The resources to use when initializing a new service (‘minimum’, ‘default’, ‘manual’, ‘parent’)

  • Requires a value

--url

The URL or API endpoint for the integration

  • Requires a value

--shared-key

Webhook: the JWS shared secret key

  • Requires a value

--file

The name of a local file that contains the script to upload

  • Requires a value

--events

A list of events to act on, e.g. environment.push

  • Default: *
  • Requires a value

--states

A list of states to act on, e.g. pending, in_progress, complete

  • Default: complete
  • Requires a value

--environments

The environment IDs to include

  • Default: *
  • Requires a value

--excluded-environments

The environment IDs to exclude

  • Default: []
  • Requires a value

--from-address

[Optional] Custom From address for alert emails

  • Requires a value

--recipients

The recipient email address(es)

  • Default: []
  • Requires a value

--channel

The Slack channel

  • Requires a value

--routing-key

The PagerDuty routing key

  • Requires a value

--category

The Sumo Logic category, used for filtering

  • Requires a value

--index

The Splunk index

  • Requires a value

--sourcetype

The Splunk event source type

  • Requires a value

--protocol

Syslog transport protocol (‘tcp’, ‘udp’, ‘tls’)

  • Default: tls
  • Requires a value

--syslog-host

Syslog relay/collector host

  • Requires a value

--syslog-port

Syslog relay/collector port

  • Requires a value

--facility

Syslog facility

  • Default: 1
  • Requires a value

--message-format

Syslog message format (‘rfc3164’ or ‘rfc5424’)

  • Default: rfc5424
  • Requires a value

--auth-mode

Authentication mode (‘prefix’ or ‘structured_data’)

  • Default: prefix
  • Requires a value

--auth-token

Authentication token

  • Requires a value

--verify-tls

Whether HTTPS certificate verification should be enabled (recommended)

  • Default: true
  • Requires a value

--header

HTTP header(s) to use in POST requests. Separate names and values with a colon (:).

  • Default: []
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

integration:delete

Delete an integration from a project

magento-cloud integration:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<id>]

id

The integration ID. Leave blank to choose from a list.

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

integration:get

View details of an integration

magento-cloud integration:get [-P|--property [PROPERTY]] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--] [<id>]

id

An integration ID. Leave blank to choose from a list.

--property, -P

The integration property to view

  • Accepts a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

integration:list

View a list of project integration(s)

magento-cloud integrations [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: id, summary, type. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

integration:update

Update an integration

magento-cloud integration:update [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BITBUCKET-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--license-key LICENSE-KEY] [--server-project SERVER-PROJECT] [--repository REPOSITORY] [--build-merge-requests BUILD-MERGE-REQUESTS] [--build-pull-requests BUILD-PULL-REQUESTS] [--build-draft-pull-requests BUILD-DRAFT-PULL-REQUESTS] [--build-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--build-wip-merge-requests BUILD-WIP-MERGE-REQUESTS] [--merge-requests-clone-parent-data MERGE-REQUESTS-CLONE-PARENT-DATA] [--pull-requests-clone-parent-data PULL-REQUESTS-CLONE-PARENT-DATA] [--resync-pull-requests RESYNC-PULL-REQUESTS] [--fetch-branches FETCH-BRANCHES] [--prune-branches PRUNE-BRANCHES] [--resources-init RESOURCES-INIT] [--url URL] [--shared-key SHARED-KEY] [--file FILE] [--events EVENTS] [--states STATES] [--environments ENVIRONMENTS] [--excluded-environments EXCLUDED-ENVIRONMENTS] [--from-address FROM-ADDRESS] [--recipients RECIPIENTS] [--channel CHANNEL] [--routing-key ROUTING-KEY] [--category CATEGORY] [--index INDEX] [--sourcetype SOURCETYPE] [--protocol PROTOCOL] [--syslog-host SYSLOG-HOST] [--syslog-port SYSLOG-PORT] [--facility FACILITY] [--message-format MESSAGE-FORMAT] [--auth-mode AUTH-MODE] [--auth-token AUTH-TOKEN] [--verify-tls VERIFY-TLS] [--header HEADER] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<id>]

id

The ID of the integration to update

--type

The integration type (‘bitbucket’, ‘bitbucket_server’, ‘github’, ‘gitlab’, ‘webhook’, ‘health.email’, ‘health.pagerduty’, ‘health.slack’, ‘health.webhook’, ‘httplog’, ‘script’, ‘newrelic’, ‘splunk’, ‘sumologic’, ‘syslog’)

  • Requires a value

--base-url

The base URL of the server installation

  • Requires a value

--bitbucket-url

The base URL of the Bitbucket Server installation

  • Requires a value

--username

The Bitbucket Server username

  • Requires a value

--token

An authentication or access token for the integration

  • Requires a value

--key

A Bitbucket OAuth consumer key

  • Requires a value

--secret

A Bitbucket OAuth consumer secret

  • Requires a value

--license-key

The New Relic Logs license key

  • Requires a value

--server-project

The project (e.g. ‘namespace/repo’)

  • Requires a value

--repository

The repository to track (e.g. ‘owner/repository’)

  • Requires a value

--build-merge-requests

GitLab: build merge requests as environments

  • Default: true
  • Requires a value

--build-pull-requests

Build every pull request as an environment

  • Default: true
  • Requires a value

--build-draft-pull-requests

Build draft pull requests

  • Default: true
  • Requires a value

--build-pull-requests-post-merge

Build pull requests based on their post-merge state

  • Default: false
  • Requires a value

--build-wip-merge-requests

GitLab: build WIP merge requests

  • Default: true
  • Requires a value

--merge-requests-clone-parent-data

GitLab: clone data for merge requests

  • Default: true
  • Requires a value

--pull-requests-clone-parent-data

Clone the parent environment’s data for pull requests

  • Default: true
  • Requires a value

--resync-pull-requests

Re-sync pull request environment data on every build

  • Default: false
  • Requires a value

--fetch-branches

Fetch all branches from the remote (as inactive environments)

  • Default: true
  • Requires a value

--prune-branches

Delete branches that do not exist on the remote

  • Default: true
  • Requires a value

--resources-init

The resources to use when initializing a new service (‘minimum’, ‘default’, ‘manual’, ‘parent’)

  • Requires a value

--url

The URL or API endpoint for the integration

  • Requires a value

--shared-key

Webhook: the JWS shared secret key

  • Requires a value

--file

The name of a local file that contains the script to upload

  • Requires a value

--events

A list of events to act on, e.g. environment.push

  • Default: *
  • Requires a value

--states

A list of states to act on, e.g. pending, in_progress, complete

  • Default: complete
  • Requires a value

--environments

The environment IDs to include

  • Default: *
  • Requires a value

--excluded-environments

The environment IDs to exclude

  • Default: []
  • Requires a value

--from-address

[Optional] Custom From address for alert emails

  • Requires a value

--recipients

The recipient email address(es)

  • Default: []
  • Requires a value

--channel

The Slack channel

  • Requires a value

--routing-key

The PagerDuty routing key

  • Requires a value

--category

The Sumo Logic category, used for filtering

  • Requires a value

--index

The Splunk index

  • Requires a value

--sourcetype

The Splunk event source type

  • Requires a value

--protocol

Syslog transport protocol (‘tcp’, ‘udp’, ‘tls’)

  • Default: tls
  • Requires a value

--syslog-host

Syslog relay/collector host

  • Requires a value

--syslog-port

Syslog relay/collector port

  • Requires a value

--facility

Syslog facility

  • Default: 1
  • Requires a value

--message-format

Syslog message format (‘rfc3164’ or ‘rfc5424’)

  • Default: rfc5424
  • Requires a value

--auth-mode

Authentication mode (‘prefix’ or ‘structured_data’)

  • Default: prefix
  • Requires a value

--auth-token

Authentication token

  • Requires a value

--verify-tls

Whether HTTPS certificate verification should be enabled (recommended)

  • Default: true
  • Requires a value

--header

HTTP header(s) to use in POST requests. Separate names and values with a colon (:).

  • Default: []
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

integration:validate

Validate an existing integration

magento-cloud integration:validate [-p|--project PROJECT] [--] [<id>]

id

An integration ID. Leave blank to choose from a list.

--project, -p

The project ID or URL

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

local:build

Build the current project locally

magento-cloud build [-a|--abslinks] [-s|--source SOURCE] [-d|--destination DESTINATION] [-c|--copy] [--clone] [--run-deploy-hooks] [--no-clean] [--no-archive] [--no-backup] [--no-cache] [--no-build-hooks] [--no-deps] [--working-copy] [--concurrency CONCURRENCY] [--lock] [--] [<app>]...

app

Specify application(s) to build

  • Default: []

  • Array

Use absolute links

  • Default: false
  • Does not accept a value

--source, -s

The source directory. Defaults to the current project root.

  • Requires a value

--destination, -d

The destination, to which the web root of each app will be symlinked. Default: _www

  • Requires a value

--copy, -c

Copy to a build directory, instead of symlinking from the source

  • Default: false
  • Does not accept a value

--clone

Use Git to clone the current HEAD to the build directory

  • Default: false
  • Does not accept a value

--run-deploy-hooks

Run deploy and/or post_deploy hooks

  • Default: false
  • Does not accept a value

--no-clean

Do not remove old builds

  • Default: false
  • Does not accept a value

--no-archive

Do not create or use a build archive

  • Default: false
  • Does not accept a value

--no-backup

Do not back up the previous build

  • Default: false
  • Does not accept a value

--no-cache

Disable caching

  • Default: false
  • Does not accept a value

--no-build-hooks

Do not run post-build hooks

  • Default: false
  • Does not accept a value

--no-deps

Do not install build dependencies locally

  • Default: false
  • Does not accept a value

--working-copy

Drush: use git to clone a repository of each Drupal module rather than simply downloading a version

  • Default: false
  • Does not accept a value

--concurrency

Drush: set the number of concurrent projects that will be processed at the same time

  • Default: 4
  • Requires a value

--lock

Drush: create or update a lock file (only available with Drush version 7+)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

local:dir

Find the local project root

magento-cloud dir [<subdir>]

subdir

The subdirectory to find (‘local’, ‘web’ or ‘shared’)

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

metrics:all

Show CPU, disk and memory metrics for an environment

magento-cloud metrics [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

--bytes, -B

Show sizes in bytes

  • Default: false
  • Does not accept a value

--range, -r

The time range. Metrics will be loaded for this duration until the end time (–to). You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>5m</comment>, maximum <comment>8h</comment> or more (depending on the project), default <comment>10m</comment>.

  • Requires a value

--interval, -i

The time interval. Defaults to a division of the range. You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>1m</comment>.

  • Requires a value

--to

The end time. Defaults to now.

  • Requires a value

--latest, -1

Show only the latest single data point

  • Default: false
  • Does not accept a value

--service, -s

Filter by service or application name The % or * characters may be used as a wildcard.

  • Default: []
  • Requires a value

--type

Filter by service type (if --service is not provided). The version is not required. The % or * characters may be used as a wildcard.

  • Default: []
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: timestamp*, service*, cpu_percent*, mem_percent*, disk_percent*, tmp_disk_percent*, cpu_limit, cpu_used, disk_limit, disk_used, inodes_limit, inodes_percent, inodes_used, mem_limit, mem_used, tmp_disk_limit, tmp_disk_used, tmp_inodes_limit, tmp_inodes_percent, tmp_inodes_used, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

metrics:cpu

Show CPU usage of an environment

magento-cloud cpu [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

--range, -r

The time range. Metrics will be loaded for this duration until the end time (–to). You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>5m</comment>, maximum <comment>8h</comment> or more (depending on the project), default <comment>10m</comment>.

  • Requires a value

--interval, -i

The time interval. Defaults to a division of the range. You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>1m</comment>.

  • Requires a value

--to

The end time. Defaults to now.

  • Requires a value

--latest, -1

Show only the latest single data point

  • Default: false
  • Does not accept a value

--service, -s

Filter by service or application name The % or * characters may be used as a wildcard.

  • Default: []
  • Requires a value

--type

Filter by service type (if --service is not provided). The version is not required. The % or * characters may be used as a wildcard.

  • Default: []
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: timestamp*, service*, used*, limit*, percent*, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

metrics:disk-usage

Show disk usage of an environment

magento-cloud disk [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [--tmp] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

--bytes, -B

Show sizes in bytes

  • Default: false
  • Does not accept a value

--range, -r

The time range. Metrics will be loaded for this duration until the end time (–to). You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>5m</comment>, maximum <comment>8h</comment> or more (depending on the project), default <comment>10m</comment>.

  • Requires a value

--interval, -i

The time interval. Defaults to a division of the range. You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>1m</comment>.

  • Requires a value

--to

The end time. Defaults to now.

  • Requires a value

--latest, -1

Show only the latest single data point

  • Default: false
  • Does not accept a value

--service, -s

Filter by service or application name The % or * characters may be used as a wildcard.

  • Default: []
  • Requires a value

--type

Filter by service type (if --service is not provided). The version is not required. The % or * characters may be used as a wildcard.

  • Default: []
  • Requires a value

--tmp

Report temporary disk usage (shows columns: timestamp, service, tmp_used, tmp_limit, tmp_percent, tmp_ipercent)

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: timestamp*, service*, used*, limit*, percent*, ipercent*, tmp_percent*, ilimit, iused, tmp_ilimit, tmp_ipercent, tmp_iused, tmp_limit, tmp_used, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

metrics:memory

Show memory usage of an environment

magento-cloud mem [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

--bytes, -B

Show sizes in bytes

  • Default: false
  • Does not accept a value

--range, -r

The time range. Metrics will be loaded for this duration until the end time (–to). You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>5m</comment>, maximum <comment>8h</comment> or more (depending on the project), default <comment>10m</comment>.

  • Requires a value

--interval, -i

The time interval. Defaults to a division of the range. You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>1m</comment>.

  • Requires a value

--to

The end time. Defaults to now.

  • Requires a value

--latest, -1

Show only the latest single data point

  • Default: false
  • Does not accept a value

--service, -s

Filter by service or application name The % or * characters may be used as a wildcard.

  • Default: []
  • Requires a value

--type

Filter by service type (if --service is not provided). The version is not required. The % or * characters may be used as a wildcard.

  • Default: []
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: timestamp*, service*, used*, limit*, percent*, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

mount:download

Download files from a mount, using rsync

magento-cloud mount:download [-a|--all] [-m|--mount MOUNT] [--target TARGET] [--source-path] [--delete] [--exclude EXCLUDE] [--include INCLUDE] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE]

--all, -a

Download from all mounts

  • Default: false
  • Does not accept a value

--mount, -m

The mount (as an app-relative path)

  • Requires a value

--target

The directory to which files will be downloaded. If --all is used, the mount path will be appended

  • Requires a value

--source-path

Use the mount’s source path (rather than the mount path) as a subdirectory of the target, when --all is used

  • Default: false
  • Does not accept a value

--delete

Whether to delete extraneous files in the target directory

  • Default: false
  • Does not accept a value

--exclude

File(s) to exclude from the download (pattern)

  • Default: []
  • Requires a value

--include

File(s) not to exclude (pattern)

  • Default: []
  • Requires a value

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--instance, -I

An instance ID

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

mount:list

Get a list of mounts

magento-cloud mounts [--paths] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]

--paths

Output the mount paths only (one per line)

  • Default: false
  • Does not accept a value

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: definition, path. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--instance, -I

An instance ID

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

mount:size

Check the disk usage of mounts

magento-cloud mount:size [-B|--bytes] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]

--bytes, -B

Show sizes in bytes

  • Default: false
  • Does not accept a value

--refresh

Refresh the cache

  • Default: false
  • Does not accept a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: available, max, mounts, percent_used, sizes, used. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--instance, -I

An instance ID

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

mount:upload

Upload files to a mount, using rsync

magento-cloud mount:upload [--source SOURCE] [-m|--mount MOUNT] [--delete] [--exclude EXCLUDE] [--include INCLUDE] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE]

--source

A directory containing files to upload

  • Requires a value

--mount, -m

The mount (as an app-relative path)

  • Requires a value

--delete

Whether to delete extraneous files in the mount

  • Default: false
  • Does not accept a value

--exclude

File(s) to exclude from the upload (pattern)

  • Default: []
  • Requires a value

--include

File(s) not to exclude (pattern)

  • Default: []
  • Requires a value

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--instance, -I

An instance ID

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

operation:list

List runtime operations on an environment

magento-cloud ops [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

--full

Do not limit the length of command to display. The default limit is 24 lines.

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: service*, name*, start*, role, stop (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

operation:run

Run an operation on the environment

magento-cloud operation:run [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-W|--no-wait] [--wait] [--] [<operation>]

operation

The operation name

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--worker

A worker name

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

project:clear-build-cache

Clear a project’s build cache

magento-cloud project:clear-build-cache [-p|--project PROJECT]

--project, -p

The project ID or URL

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

project:get

Clone a project locally

magento-cloud get [-e|--environment ENVIRONMENT] [--depth DEPTH] [--build] [-p|--project PROJECT] [-i|--identity-file IDENTITY-FILE] [--] [<project>] [<directory>]

project

The project ID

directory

The directory to clone to. Defaults to the project title

--environment, -e

The environment ID to clone. Defaults to the project default, or the first available environment

  • Requires a value

--depth

Create a shallow clone: limit the number of commits in the history

  • Requires a value

--build

Build the project after cloning

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

project:info

Read or set properties for a project

magento-cloud project:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<property>] [<value>]

property

The name of the property

value

Set a new value for the property

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

project:list

Get a list of all active projects

magento-cloud projects [--pipe] [--region REGION] [--title TITLE] [--my] [--refresh REFRESH] [--sort SORT] [--reverse] [--page PAGE] [-c|--count COUNT] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

--pipe

Output a simple list of project IDs. Disables pagination.

  • Default: false
  • Does not accept a value

--region

Filter by region (exact match)

  • Requires a value

--title

Filter by title (case-insensitive search)

  • Requires a value

--my

Display only the projects you own

  • Default: false
  • Does not accept a value

--refresh

Whether to refresh the list

  • Default: 1
  • Requires a value

--sort

A property to sort by

  • Default: title
  • Requires a value

--reverse

Sort in reverse (descending) order

  • Default: false
  • Does not accept a value

--page

Page number. This enables pagination, despite configuration or --count. Ignored if --pipe is specified.

  • Requires a value

--count, -c

The number of projects to display per page. Use 0 to disable pagination. Ignored if --page is specified.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns

Columns to display. Available columns: id*, title*, region*, created_at, organization_id, organization_label, organization_name, status (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

project:set-remote

Set the remote project for the current Git repository

magento-cloud set-remote [<project>]

project

The project ID

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

repo:cat

Read a file in the project repository

magento-cloud repo:cat [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] <path>

path

The path to the file

  • Required

--commit, -c

The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

repo:ls

List files in the project repository

magento-cloud repo:ls [-d|--directories] [-f|--files] [--git-style] [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<path>]

path

The path to a subdirectory

--directories, -d

Show directories only

  • Default: false
  • Does not accept a value

--files, -f

Show files only

  • Default: false
  • Does not accept a value

--git-style

Style output similar to “git ls-tree”

  • Default: false
  • Does not accept a value

--commit, -c

The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

repo:read

Read a directory or file in the project repository

magento-cloud read [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<path>]

path

The path to the directory or file

--commit, -c

The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

route:get

View detailed information about a route

magento-cloud route:get [--id ID] [-1|--primary] [-P|--property PROPERTY] [--refresh] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE] [--] [<route>]

route

The route’s original URL

--id

A route ID to select

  • Requires a value

--primary, -1

Select the primary route

  • Default: false
  • Does not accept a value

--property, -P

The property to display

  • Requires a value

--refresh

Bypass the cache of routes

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

[Deprecated option, no longer used]

  • Requires a value

--identity-file, -i

[Deprecated option, no longer used]

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

route:list

List all routes for an environment

magento-cloud routes [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<environment>]

environment

The environment ID

--refresh

Bypass the cache of routes

  • Default: false
  • Does not accept a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: route*, type*, to*, url (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

self:install

Install or update CLI configuration files

magento-cloud self:install [--shell-type SHELL-TYPE]

--shell-type

The shell type for autocompletion (bash or zsh)

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

self:update

Update the CLI to the latest version

magento-cloud update [--no-major] [--unstable] [--manifest MANIFEST] [--current-version CURRENT-VERSION] [--timeout TIMEOUT]

--no-major

Only update between minor or patch versions

  • Default: false
  • Does not accept a value

--unstable

Update to a new unstable version, if available

  • Default: false
  • Does not accept a value

--manifest

Override the manifest file location

  • Requires a value

--current-version

Override the current version

  • Requires a value

--timeout

A timeout for the version check

  • Default: 30
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

service:list

List services in the project

magento-cloud services [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--pipe

Output a list of service names only

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: disk, name, size, type. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

service:mongo:dump

Create a binary archive dump of data from MongoDB

magento-cloud mongodump [-c|--collection COLLECTION] [-z|--gzip] [-o|--stdout] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

--collection, -c

The collection to dump

  • Requires a value

--gzip, -z

Compress the dump using gzip

  • Default: false
  • Does not accept a value

--stdout, -o

Output to STDOUT instead of a file

  • Default: false
  • Does not accept a value

--relationship, -r

The service relationship to use

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

service:mongo:export

Export data from MongoDB

magento-cloud mongoexport [-c|--collection COLLECTION] [--jsonArray] [--type TYPE] [-f|--fields FIELDS] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

--collection, -c

The collection to export

  • Requires a value

--jsonArray

Export data as a single JSON array

  • Default: false
  • Does not accept a value

--type

The export type, e.g. “csv”

  • Requires a value

--fields, -f

The fields to export

  • Default: []
  • Requires a value

--relationship, -r

The service relationship to use

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

service:mongo:restore

Restore a binary archive dump of data into MongoDB

magento-cloud mongorestore [-c|--collection COLLECTION] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

--collection, -c

The collection to restore

  • Requires a value

--relationship, -r

The service relationship to use

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

service:mongo:shell

Use the MongoDB shell

magento-cloud mongo [--eval EVAL] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

--eval

Pass a JavaScript fragment to the shell

  • Requires a value

--relationship, -r

The service relationship to use

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

service:redis-cli

Access the Redis CLI

magento-cloud redis [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] [<args>]

args

Arguments to add to the Redis command

--relationship, -r

The service relationship to use

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

snapshot:create

Make a snapshot of an environment

magento-cloud backup [--live] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]

environment

The environment

--live

Live backup: do not stop the environment. If set, this leaves the environment running and open to connections during the backup. This reduces downtime, at the risk of backing up data in an inconsistent state.

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

snapshot:delete

Delete an environment snapshot

magento-cloud snapshot:delete [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<id>]

id

The ID of the snapshot. Required in non-interactive mode.

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

snapshot:get

View an environment snapshot

magento-cloud snapshot:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--date-fmt DATE-FMT] [--] [<id>]

id

The ID of the snapshot. Defaults to the most recent one.

--property, -P

The property to display.

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

snapshot:list

List available snapshots of an environment

magento-cloud snapshots [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

snapshot:restore

Restore an environment snapshot

magento-cloud snapshot:restore [--target TARGET] [--branch-from BRANCH-FROM] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<snapshot>]

snapshot

The name of the snapshot. Defaults to the most recent one

--target

The environment to restore to. Defaults to the snapshot’s current environment

  • Requires a value

--branch-from

If the --target does not yet exist, this specifies the parent of the new environment

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

source-operation:list

List source operations on an environment

magento-cloud source-ops [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

--full

Do not limit the length of command to display. The default limit is 24 lines.

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: app, command, operation. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

source-operation:run

Run a source operation

magento-cloud source-operation:run [--variable VARIABLE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<operation>]

operation

The operation name

--variable

A variable to set during the operation, in the format <info>type:name=value</info>

  • Default: []
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

ssh-cert:load

Generate an SSH certificate

magento-cloud ssh-cert:load [--refresh-only] [--new] [--new-key]

--refresh-only

Only refresh the certificate, if necessary (do not write SSH config)

  • Default: false
  • Does not accept a value

--new

Force the certificate to be refreshed

  • Default: false
  • Does not accept a value

--new-key

[Deprecated] Use --new instead

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

ssh-key:add

Add a new SSH key

magento-cloud ssh-key:add [--name NAME] [--] [<path>]

path

The path to an existing SSH public key

--name

A name to identify the key

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

ssh-key:delete

Delete an SSH key

magento-cloud ssh-key:delete [<id>]

id

The ID of the SSH key to delete

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

ssh-key:list

Get a list of SSH keys in your account

magento-cloud ssh-keys [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: id*, title*, path*, fingerprint (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

subscription:info

Read or modify subscription properties

magento-cloud subscription:info [-s|--id ID] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--] [<property>] [<value>]

property

The name of the property

value

Set a new value for the property

--id, -s

The subscription ID

  • Requires a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c
  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

tunnel:close

Close SSH tunnels

magento-cloud tunnel:close [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

--all, -a

Close all tunnels

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

tunnel:info

View relationship info for SSH tunnels

magento-cloud tunnel:info [-P|--property PROPERTY] [-c|--encode] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

--property, -P

The relationship property to view

  • Requires a value

--encode, -c

Output as base64-encoded JSON

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

tunnel:list

List SSH tunnels

magento-cloud tunnels [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

--all, -a

View all tunnels

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: port*, project*, environment*, app*, relationship*, url (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

tunnel:open

Open SSH tunnels to an app’s relationships

magento-cloud tunnel:open [-g|--gateway-ports] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE]

--gateway-ports, -g

Allow remote hosts to connect to local forwarded ports

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

tunnel:single

Open a single SSH tunnel to an app relationship

magento-cloud tunnel:single [--port PORT] [-g|--gateway-ports] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE]

--port

The local port

  • Requires a value

--gateway-ports, -g

Allow remote hosts to connect to local forwarded ports

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--app, -A

The remote application name

  • Requires a value

--relationship, -r

The service relationship to use

  • Requires a value

--identity-file, -i

An SSH identity (private key) to use

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

user:add

Add a user to the project

magento-cloud user:add [-r|--role ROLE] [--force-invite] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<email>]

email

The user’s email address

--role, -r

The user’s project role (‘admin’ or ‘viewer’) or environment type role (e.g. ‘staging:contributor’ or ‘production:viewer’). To remove a user from an environment type, set the role as ‘none’. The % or * characters can be used as a wildcard for the environment type, e.g. ‘%:viewer’ to give the user the ‘viewer’ role on all types. The role can be abbreviated, e.g. ‘production:v’.

  • Default: []
  • Requires a value

--force-invite

Send an invitation, even if one has already been sent

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

user:delete

Delete a user from the project

magento-cloud user:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] <email>

email

The user’s email address

  • Required

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

user:get

View a user’s role(s)

magento-cloud user:get [-l|--level LEVEL] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [-r|--role ROLE] [--] [<email>]

email

The user’s email address

--level, -l

The role level (‘project’ or ‘environment’)

  • Requires a value

--pipe

Output the role to stdout (after making any changes)

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--role, -r

[Deprecated: use user:update to change a user’s role(s)]

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

user:list

List project users

magento-cloud users [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: email*, name*, role*, id*, granted_at, updated_at (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

user:update

Update user role(s) on a project

magento-cloud user:update [-r|--role ROLE] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<email>]

email

The user’s email address

--role, -r

The user’s project role (‘admin’ or ‘viewer’) or environment type role (e.g. ‘staging:contributor’ or ‘production:viewer’). To remove a user from an environment type, set the role as ‘none’. The % or * characters can be used as a wildcard for the environment type, e.g. ‘%:viewer’ to give the user the ‘viewer’ role on all types. The role can be abbreviated, e.g. ‘production:v’.

  • Default: []
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

variable:create

Create a variable

magento-cloud variable:create [-u|--update] [-l|--level LEVEL] [--name NAME] [--value VALUE] [--json JSON] [--sensitive SENSITIVE] [--prefix PREFIX] [--enabled ENABLED] [--inheritable INHERITABLE] [--visible-build VISIBLE-BUILD] [--visible-runtime VISIBLE-RUNTIME] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<name>]

name

The variable name

--update, -u

Update the variable if it already exists

  • Default: false
  • Does not accept a value

--level, -l

The level at which to set the variable (‘project’ or ‘environment’)

  • Requires a value

--name

The variable name

  • Requires a value

--value

The variable’s value

  • Requires a value

--json

Whether the variable value is JSON-formatted

  • Default: false
  • Requires a value

--sensitive

Whether the variable value is sensitive

  • Default: false
  • Requires a value

--prefix

The variable name’s prefix which can determine its type, e.g. ‘env’. Only applicable if the name does not already contain a prefix. (e.g. ‘none’ or ‘env:’)

  • Default: none
  • Requires a value

--enabled

Whether the variable should be enabled on the environment

  • Default: true
  • Requires a value

--inheritable

Whether the variable is inheritable by child environments

  • Default: true
  • Requires a value

--visible-build

Whether the variable should be visible at build time

  • Requires a value

--visible-runtime

Whether the variable should be visible at runtime

  • Default: true
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

variable:delete

Delete a variable

magento-cloud variable:delete [-l|--level LEVEL] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

name

The variable name

  • Required

--level, -l

The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

variable:get

View a variable

magento-cloud vget [-P|--property PROPERTY] [-l|--level LEVEL] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--pipe] [--] [<name>]

name

The name of the variable

--property, -P

View a single variable property

  • Requires a value

--level, -l

The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--pipe

[Deprecated option] Output the variable value only

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

variable:list

List variables

magento-cloud variables [-l|--level LEVEL] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

--level, -l

The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: is_enabled, level, name, value. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

variable:update

Update a variable

magento-cloud variable:update [--allow-no-change] [-l|--level LEVEL] [--value VALUE] [--json JSON] [--sensitive SENSITIVE] [--enabled ENABLED] [--inheritable INHERITABLE] [--visible-build VISIBLE-BUILD] [--visible-runtime VISIBLE-RUNTIME] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

name

The variable name

  • Required

--allow-no-change

Return success (zero exit code) if no changes were provided

  • Default: false
  • Does not accept a value

--level, -l

The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)

  • Requires a value

--value

The variable’s value

  • Requires a value

--json

Whether the variable value is JSON-formatted

  • Default: false
  • Requires a value

--sensitive

Whether the variable value is sensitive

  • Default: false
  • Requires a value

--enabled

Whether the variable should be enabled on the environment

  • Default: true
  • Requires a value

--inheritable

Whether the variable is inheritable by child environments

  • Default: true
  • Requires a value

--visible-build

Whether the variable should be visible at build time

  • Requires a value

--visible-runtime

Whether the variable should be visible at runtime

  • Default: true
  • Requires a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--no-wait, -W

Do not wait for the operation to complete

  • Default: false
  • Does not accept a value

--wait

Wait for the operation to complete (default)

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value

worker:list

Get a list of all deployed workers

magento-cloud workers [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

--refresh

Whether to refresh the cache

  • Default: false
  • Does not accept a value

--pipe

Output a list of worker names only

  • Default: false
  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value

--environment, -e

The environment ID. Use “.” to select the project’s default environment.

  • Requires a value

--format

The output format: table, csv, tsv, or plain

  • Default: table
  • Requires a value

--columns, -c

Columns to display. Available columns: commands, name, type. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.

  • Default: []
  • Requires a value

--no-header

Do not output the table header

  • Default: false
  • Does not accept a value

--help, -h

Display this help message

  • Default: false
  • Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages

  • Default: false
  • Does not accept a value

--version, -V

Display this application version

  • Default: false
  • Does not accept a value

--yes, -y

Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction

  • Default: false
  • Does not accept a value

--no-interaction

Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>

  • Default: false
  • Does not accept a value
recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26