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.

clear-cache

Clear the CLI cache

magento-cloud cc

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

decode

Decode an encoded string such as MAGENTO_CLOUD_VARIABLES

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

value

The variable value to decode

--property, -P

The property to view within the variable

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

docs

Open the online documentation

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

search

Search term(s)

--browser

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

--pipe

Output the URL to stdout.

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

help

Displays help for a command

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

command_name

The command name

--format

The output format (txt, json, or md)

--raw

To output raw command help

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

list

Lists commands

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

command

The command to execute

namespace

The namespace name

--raw

To output raw command list

--format

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

--all

Show all commands, including hidden ones

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

multi

Execute a command on multiple projects

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

cmd

The command to execute

--projects, -p

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

--continue

Continue running commands even if an exception is encountered

--sort

A property by which to sort the list of project options

--reverse

Reverse the order of project options

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--pipe

Output the URL to stdout.

--project, -p

The project ID or URL

--environment, -e

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

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

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

--all, -a

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

--project, -p

The project ID or URL

--environment, -e

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

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

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

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

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

--result

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

--incomplete, -i

Include only incomplete activities (when selecting a default activity). This is a shorthand for --state=in_progress,pending

--all, -a

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

--project, -p

The project ID or URL

--environment, -e

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

--format

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

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

--no-header

Do not output the table header

--date-fmt

The date format (as a PHP date format string)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

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

--limit

Limit the number of results displayed

--start

Only activities created before this date will be listed

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

--result

Filter activities by result: success or failure

--incomplete, -i

Only list incomplete activities

--all, -a

List activities on all environments

--format

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

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

--no-header

Do not output the table header

--date-fmt

The date format (as a PHP date format string)

--project, -p

The project ID or URL

--environment, -e

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

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--timestamps, -t

Display a timestamp next to each message

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

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

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

--result

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

--incomplete, -i

Include only incomplete activities (when selecting a default activity). This is a shorthand for --state=in_progress,pending

--all, -a

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

--date-fmt

The date format (as a PHP date format string)

--project, -p

The project ID or URL

--environment, -e

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

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--refresh

Whether to refresh the cache

--project, -p

The project ID or URL

--environment, -e

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

--app, -A

The remote application name

--identity-file, -i

[Deprecated option, no longer used]

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--pipe

Output a list of app names only

--project, -p

The project ID or URL

--environment, -e

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

--format

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

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

--no-header

Do not output the table header

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--browser

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

--pipe

Output the URL to stdout.

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--property, -P

The account property to view (alternate syntax)

--refresh

Whether to refresh the cache

--format

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

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

--no-header

Do not output the table header

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

auth:logout

Log out of Magento Cloud

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

--all, -a

Log out from all local sessions

--other

Log out from other local sessions

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--server_token

The server token

--project, -p

The project ID or URL

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--key

The path to the certificate private key file

--chain

The path to the certificate chain file

--project, -p

The project ID or URL

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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)

--project, -p

The project ID or URL

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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)

--property, -P

The certificate property to view

--date-fmt

The date format (as a PHP date format string)

--project, -p

The project ID or URL

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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)

--exclude-domain

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

--issuer

Filter by issuer

--only-auto

Show only auto-provisioned certificates

--no-auto

Show only manually added certificates

--ignore-expiry

Show both expired and non-expired certificates

--only-expired

Show only expired certificates

--no-expired

Show only non-expired certificates (default)

--pipe-domains

Only return a list of domain names covered by the certificates

--date-fmt

The date format (as a PHP date format string)

--format

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

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

--no-header

Do not output the table header

--project, -p

The project ID or URL

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--property, -P

The commit property to display.

--project, -p

The project ID or URL

--environment, -e

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

--date-fmt

The date format (as a PHP date format string)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--project, -p

The project ID or URL

--environment, -e

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

--format

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

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

--no-header

Do not output the table header

--date-fmt

The date format (as a PHP date format string)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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”).

--file, -f

A custom filename for the dump

--directory, -d

A custom directory for the dump

--gzip, -z

Compress the dump using gzip

--timestamp, -t

Add a timestamp to the dump filename

--stdout, -o

Output to STDOUT instead of a file

--table

Table(s) to include

--exclude-table

Table(s) to exclude

--schema-only

Dump only schemas, no data

--charset

The character set encoding for the dump

--project, -p

The project ID or URL

--environment, -e

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

--app, -A

The remote application name

--relationship, -r

The service relationship to use

--identity-file, -i

An SSH identity (private key) to use

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--cleanup, -C

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

--project, -p

The project ID or URL

--environment, -e

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

--app, -A

The remote application name

--relationship, -r

The service relationship to use

--format

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

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

--no-header

Do not output the table header

--identity-file, -i

An SSH identity (private key) to use

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--schema

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

--project, -p

The project ID or URL

--environment, -e

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

--app, -A

The remote application name

--relationship, -r

The service relationship to use

--identity-file, -i

An SSH identity (private key) to use

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--cert

The path to the certificate file for this domain

--key

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

--chain

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

--attach

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

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--format

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

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

--no-header

Do not output the table header

--date-fmt

The date format (as a PHP date format string)

--project, -p

The project ID or URL

--environment, -e

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

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

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

--no-header

Do not output the table header

--project, -p

The project ID or URL

--environment, -e

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

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--cert

The path to the certificate file for this domain

--key

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

--chain

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

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--parent

Set a new environment parent before activating

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--type

The type of the new environment

--no-clone-parent

Do not clone the parent environment’s data

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--delete-branch

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

--no-delete-branch

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

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

--only-type, -t

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

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

--exclude-type

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

--inactive

Delete all inactive environments (adding to any others selected)

--merged

Delete all merged environments (adding to any others selected)

--allow-delete-parent

Allow environments that have children to be deleted

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--auth

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

--enabled

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

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--date-fmt

The date format (as a PHP date format string)

--format

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

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

--no-header

Do not output the table header

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--profile

The name of the profile

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--pipe

Output a simple list of environment IDs.

--refresh

Whether to refresh the list.

--sort

A property to sort by

--reverse

Sort in reverse (descending) order

--type

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

--format

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

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

--no-header

Do not output the table header

--project, -p

The project ID or URL

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--tail

Continuously tail the log

--project, -p

The project ID or URL

--environment, -e

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

--app, -A

The remote application name

--worker

A worker name

--instance, -I

An instance ID

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--target

The target branch name. Defaults to the current branch.

--force, -f

Allow non-fast-forward updates

--force-with-lease

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

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

--activate

Activate the environment before pushing

--parent

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

--type

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

--no-clone-parent

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--project, -p

The project ID or URL

--environment, -e

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

--identity-file, -i

An SSH identity (private key) to use

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--refresh

Whether to refresh the relationships

--project, -p

The project ID or URL

--environment, -e

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

--app, -A

The remote application name

--identity-file, -i

An SSH identity (private key) to use

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--recursive, -r

Recursively copy entire directories

--project, -p

The project ID or URL

--environment, -e

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

--app, -A

The remote application name

--worker

A worker name

--instance, -I

An instance ID

--identity-file, -i

An SSH identity (private key) to use

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

--pipe

Output the SSH URL only.

--all

Output all SSH URLs (for every app).

--project, -p

The project ID or URL

--environment, -e

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

--app, -A

The remote application name

--worker

A worker name

--instance, -I

An instance ID

--identity-file, -i

An SSH identity (private key) to use

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--rebase

Synchronize code by rebasing instead of merging

--project, -p

The project ID or URL

--environment, -e

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--browser

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

--pipe

Output the URL to stdout.

--project, -p

The project ID or URL

--environment, -e

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

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--project, -p

The project ID or URL

--environment, -e

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

--app, -A

The remote application name

--worker

A worker name

--instance, -I

An instance ID

--identity-file, -i

An SSH identity (private key) to use

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--project, -p

The project ID or URL

--environment, -e

[Deprecated option, not used]

--format

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

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

--no-header

Do not output the table header

--date-fmt

The date format (as a PHP date format string)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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.

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

--limit

Limit the number of results displayed

--start

Only activities created before this date will be listed

--state

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

--result

Filter activities by result

--incomplete, -i

Only list incomplete activities

--format

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

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

--no-header

Do not output the table header

--date-fmt

The date format (as a PHP date format string)

--project, -p

The project ID or URL

--environment, -e

[Deprecated option, not used]

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--date-fmt

The date format (as a PHP date format string)

--project, -p

The project ID or URL

--environment, -e

[Deprecated option, not used]

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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’)

--base-url

The base URL of the server installation

--bitbucket-url

The base URL of the Bitbucket Server installation

--username

The Bitbucket Server username

--token

An authentication or access token for the integration

--key

A Bitbucket OAuth consumer key

--secret

A Bitbucket OAuth consumer secret

--license-key

The New Relic Logs license key

--server-project

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

--repository

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

--build-merge-requests

GitLab: build merge requests as environments

--build-pull-requests

Build every pull request as an environment

--build-draft-pull-requests

Build draft pull requests

--build-pull-requests-post-merge

Build pull requests based on their post-merge state

--build-wip-merge-requests

GitLab: build WIP merge requests

--merge-requests-clone-parent-data

GitLab: clone data for merge requests

--pull-requests-clone-parent-data

Clone the parent environment’s data for pull requests

--resync-pull-requests

Re-sync pull request environment data on every build

--fetch-branches

Fetch all branches from the remote (as inactive environments)

--prune-branches

Delete branches that do not exist on the remote

--resources-init

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

--url

The URL or API endpoint for the integration

--shared-key

Webhook: the JWS shared secret key

--file

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

--events

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

--states

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

--environments

The environment IDs to include

--excluded-environments

The environment IDs to exclude

--from-address

[Optional] Custom From address for alert emails

--recipients

The recipient email address(es)

--channel

The Slack channel

--routing-key

The PagerDuty routing key

--category

The Sumo Logic category, used for filtering

--index

The Splunk index

--sourcetype

The Splunk event source type

--protocol

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

--syslog-host

Syslog relay/collector host

--syslog-port

Syslog relay/collector port

--facility

Syslog facility

--message-format

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

--auth-mode

Authentication mode (‘prefix’ or ‘structured_data’)

--auth-token

Authentication token

--verify-tls

Whether HTTPS certificate verification should be enabled (recommended)

--header

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

--project, -p

The project ID or URL

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--no-wait, -W

Do not wait for the operation to complete

--wait

Wait for the operation to complete (default)

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

--format

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

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

--no-header

Do not output the table header

--project, -p

The project ID or URL

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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

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

--no-header

Do not output the table header

--project, -p

The project ID or URL

--help, -h

Display this help message

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

Increase the verbosity of messages

--version, -V

Display this application version

--yes, -y

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

--no-interaction

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

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’)

--base-url

The base URL of the server installation

--bitbucket-url

The base URL of the Bitbucket Server installation

--username

The Bitbucket Server username

--token

An authentication or access token for the integration

--key

A Bitbucket OAuth consumer key

--secret

A Bitbucket OAuth consumer secret

--license-key

The New Relic Logs license key

--server-project

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

--repository

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

--build-merge-requests

GitLab: build merge requests as environments

--build-pull-requests

Build every pull request as an environment

--build-draft-pull-requests

Build draft pull requests

--build-pull-requests-post-merge

Build pull requests based on their post-merge state

--build-wip-merge-requests

GitLab: build WIP merge requests

--merge-requests-clone-parent-data

GitLab: clone data for merge requests

--pull-requests-clone-parent-data

Clone the parent environment’s data for pull requests

--resync-pull-requests

Re-sync pull request environment data on every build

--fetch-branches

Fetch all branches from the remote (as inactive environments)

--prune-branches

Delete branches that do not exist on the remote

--resources-init

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

--url

The URL or API endpoint for the integration

--shared-key

Webhook: the JWS shared secret key