magento-cloud

Version: 1.38.1

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

This reference is generated from the Magento codebase. To change the content, you can update the source code for the corresponding command implementation in Magento 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 Magento Code Contributions.

_completion

BASH completion hook.

1
_completion [-g|--generate-hook] [-p|--program PROGRAM] [-m|--multiple] [--shell-type [SHELL-TYPE]]

--generate-hook, -g

Generate BASH code that sets up completion for this application.

• Default: false

• Does not accept a value

--program, -p

Program name that should trigger completion (defaults to the absolute application path).

• Requires a value

--multiple, -m

Generated hook can be used for multiple applications.

• Default: false

• Does not accept a value

--shell-type

Set the shell type (zsh or bash). Otherwise this is determined automatically.

• Accepts a value

bot

The Magento Cloud Bot

1
magento-cloud bot [--party] [--parrot]

--party

• Default: false

• Does not accept a value

--parrot

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

clear-cache

Clear the CLI cache

1
magento-cloud clear-cache

1
clearcache

1
cc

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

decode

Decode an encoded string such as MAGENTO_CLOUD_VARIABLES

1
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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

docs

Open the online documentation

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

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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

help

Displays help for a command

1
help [--format FORMAT] [--raw] [--] [<command_name>]

command_name

The command name

• Default: help

--format

The output format (txt, xml, 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

legacy-migrate

Migrate from the legacy file structure

1
magento-cloud legacy-migrate [--no-backup]

--no-backup

Do not create a backup of the project.

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

list

Lists commands

1
list [--raw] [--format FORMAT] [--all] [--] [<namespace>]

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

multi

Execute a command on multiple projects

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

cmd

The command to execute

• Required

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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

web

Open the Web UI

1
magento-cloud web [--browser BROWSER] [--pipe] [-p|--project PROJECT] [--host HOST] [-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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

welcome

Welcome to Magento Cloud

1
magento-cloud welcome

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

winky

1
magento-cloud winky

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

activity:cancel

Cancel an activity

1
magento-cloud activity:cancel [--type TYPE] [-a|--all] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [--] [<id>]

id

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

--type

Filter by type (when selecting a default activity)

• 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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

activity:get

View detailed information on a single activity

1
magento-cloud activity:get [-P|--property PROPERTY] [--type TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [--format FORMAT] [--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

Filter by type (when selecting a default activity)

• Requires a value

--state

Filter by state (when selecting a default activity): in_progress, pending, complete, or cancelled

• 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 --state=in_progress,pending

• 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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--format

The output format (“table”, “csv”, “tsv”, or “plain”)

• Default: table

• Requires a value

--columns

Columns to display (comma-separated list, or multiple values)

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

activity:list

Get a list of activities for an environment or project

1
magento-cloud activity:list [--type TYPE] [--limit LIMIT] [--start START] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT]

1
activities

1
act

--type

Filter activities by type

• 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

• 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

Columns to display (comma-separated list, or multiple values)

• 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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

activity:log

Display the log for an activity

1
magento-cloud activity:log [--refresh REFRESH] [-t|--timestamps] [--type TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--host HOST] [-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)

• Requires a value

--state

Filter by state (when selecting a default activity): in_progress, pending, complete, or cancelled

• 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 --state=in_progress,pending

• 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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

api:curl

Run an authenticated cURL request on the Magento Cloud API

1
magento-cloud api:curl [-X|--request REQUEST] [-d|--data DATA] [-i|--include] [-I|--head] [--disable-compression] [--enable-glob] [-H|--header HEADER] [--] [<path>]

path

The API path

--request, -X

The request method to use

• Requires a value

--data, -d

Data to send

• Requires a value

--include, -i

Include headers in the output

• Default: false

• Does not accept a value

--head, -I

Fetch headers only

• Default: false

• Does not accept a value

--disable-compression

Do not use the curl –compressed flag

• Default: false

• Does not accept a value

--enable-glob

Enable curl globbing (remove the –globoff flag)

• Default: false

• Does not accept a value

--header, -H

Extra header(s)

• Default: []

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

app:config-get

View the configuration of an app

1
magento-cloud app:config-get [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [--host HOST] [-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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

app:list

List apps in the project

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

1
apps

--refresh

Whether to refresh the cache

• Default: false

• Does not accept a value

--project, -p

The project ID or URL

• Requires a value

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--format

The output format (“table”, “csv”, “tsv”, or “plain”)

• Default: table

• Requires a value

--columns

Columns to display (comma-separated list, or multiple values)

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

auth:api-token-login

Log in to Magento Cloud using an API token

1
magento-cloud auth:api-token-login

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

auth:browser-login

Log in to Magento Cloud via a browser

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

1
login

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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

auth:info

Display your account information

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

property

The account property to view

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

Columns to display (comma-separated list, or multiple values)

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

auth:logout

Log out of Magento Cloud

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

1
logout

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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

auth:password-login

<fg=white;bg=red>[ DEPRECATED ]</> Log in to Magento Cloud using a username and password

1
magento-cloud auth:password-login

1
auth:login

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

auth:token

Obtain an OAuth 2 access token for requests to Magento Cloud APIs

1
magento-cloud auth:token

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

blackfire:setup

Setup Blackfire.io integration for the project

1
magento-cloud blackfire:setup [--server_id SERVER_ID] [--server_token SERVER_TOKEN] [-p|--project PROJECT] [--host HOST] [-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

--host

The project’s API hostname

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

certificate:add

Add an SSL certificate to the project

1
magento-cloud certificate:add [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [--host HOST] [-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

--host

The project’s API hostname

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

certificate:delete

Delete a certificate from the project

1
magento-cloud certificate:delete [-p|--project PROJECT] [--host HOST] [-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

--host

The project’s API hostname

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

certificate:get

View a certificate

1
magento-cloud certificate:get [-P|--property PROPERTY] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--host HOST] [--] <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

--host

The project’s API hostname

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

certificate:list

List project certificates

1
magento-cloud certificate:list [--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] [--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--host HOST]

1
certificates

1
certs

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

Columns to display (comma-separated list, or multiple values)

• 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

--host

The project’s API hostname

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

commit:get

Show commit details

1
magento-cloud commit:get [-P|--property PROPERTY] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [--date-fmt DATE-FMT] [--format FORMAT] [--columns COLUMNS] [--no-header] [--] [<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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--date-fmt

The date format (as a PHP date format string)

• Default: c

• Requires a value

--format

DEPRECATED

• Requires a value

--columns

DEPRECATED

• Default: []

• Requires a value

--no-header

DEPRECATED

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

commit:list

List commits

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

1
commits

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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--format

The output format (“table”, “csv”, “tsv”, or “plain”)

• Default: table

• Requires a value

--columns

Columns to display (comma-separated list, or multiple values)

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

db:dump

Create a local dump of the remote database

1
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] [--host HOST] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE]

1
sql-dump

1
environment:sql-dump

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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

db:size

Estimate the disk usage of a database

1
magento-cloud db:size [-B|--bytes] [-C|--cleanup] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [--format FORMAT] [--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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

Columns to display (comma-separated list, or multiple values)

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

db:sql

Run SQL on the remote database

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

1
sql

1
environment:sql

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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

domain:add

Add a new domain to the project

1
magento-cloud domain:add [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [--host HOST] [-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

--host

The project’s API hostname

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

domain:delete

Delete a domain from the project

1
magento-cloud domain:delete [-p|--project PROJECT] [--host HOST] [-W|--no-wait] [--wait] [--] <name>

name

The domain name

• Required

--project, -p

The project ID or URL

• Requires a value

--host

The project’s API hostname

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

domain:get

Show detailed information for a domain

1
magento-cloud domain:get [-P|--property PROPERTY] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--host HOST] [--] [<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

Columns to display (comma-separated list, or multiple values)

• 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

--host

The project’s API hostname

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

domain:list

Get a list of all domains

1
magento-cloud domains [--format FORMAT] [--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--host HOST]

1
domains

--format

The output format (“table”, “csv”, “tsv”, or “plain”)

• Default: table

• Requires a value

--columns

Columns to display (comma-separated list, or multiple values)

• 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

--host

The project’s API hostname

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

domain:update

Update a domain

1
magento-cloud domain:update [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [--host HOST] [-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

--host

The project’s API hostname

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:activate

Activate an environment

1
magento-cloud environment:activate [--parent PARENT] [-p|--project PROJECT] [--host HOST] [-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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:branch

Branch an environment

1
magento-cloud branch [--title TITLE] [--force] [--no-clone-parent] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [-i|--identity-file IDENTITY-FILE] [--] [<id>] [<parent>]

1
branch

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

--force

Create the new environment even if the branch cannot be checked out locally

• Default: false

• Does not accept a value

--no-clone-parent

Do not clone the parent branch’s data

• Default: false

• Does not accept a value

--project, -p

The project ID or URL

• Requires a value

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:checkout

Check out an environment

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

1
checkout

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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:delete

Delete an environment

1
magento-cloud environment:deactivate [--delete-branch] [--no-delete-branch] [--inactive] [--merged] [--exclude EXCLUDE] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]...

1
environment:deactivate

environment

The environment(s) to delete

• Default: []

• Array

--delete-branch

Delete the remote Git branch(es) too

• Default: false

• Does not accept a value

--no-delete-branch

Do not delete the remote Git branch(es)

• Default: false

• Does not accept a value

--inactive

Delete all inactive environments

• Default: false

• Does not accept a value

--merged

Delete all merged environments

• Default: false

• Does not accept a value

--exclude

Environments not to delete

• Default: []

• Requires a value

--project, -p

The project ID or URL

• Requires a value

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:http-access

Update HTTP access settings for an environment

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

1
httpaccess

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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:info

Read or set properties for an environment

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

1
environment:metadata

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

Columns to display (comma-separated list, or multiple values)

• 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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:init

Initialize an environment from a public Git repository

1
magento-cloud environment:init [--profile PROFILE] [-p|--project PROJECT] [--host HOST] [-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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:list

Get a list of environments

1
magento-cloud environment:list [-I|--no-inactive] [--pipe] [--refresh REFRESH] [--sort SORT] [--reverse] [--format FORMAT] [--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--host HOST]

1
environments

1
env

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

--format

The output format (“table”, “csv”, “tsv”, or “plain”)

• Default: table

• Requires a value

--columns

Columns to display (comma-separated list, or multiple values)

• 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

--host

The project’s API hostname

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:logs

Read an environment’s logs

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

1
log

1
logs

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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--app, -A

The remote application name

• Requires a value

--worker

A worker name

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:merge

Merge an environment

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

1
merge

environment

The environment to merge

--project, -p

The project ID or URL

• Requires a value

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:push

Push code to an environment

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

1
push

source

The source ref: a branch name or commit hash

• Default: HEAD

--target

The target branch name

• 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

• Default: false

• Does not accept a value

--activate

Activate the environment before pushing

• Default: false

• Does not accept a value

--branch

DEPRECATED: alias of –activate

• Default: false

• Does not accept a value

--parent

Set a new environment parent (only used with –activate or –branch)

• 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

--project, -p

The project ID or URL

• Requires a value

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:redeploy

Redeploy an environment

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

1
redeploy

--project, -p

The project ID or URL

• Requires a value

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:relationships

Show an environment’s relationships

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

1
relationships

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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:scp

Copy files to and from current environment using scp

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

1
scp

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

--host

The project’s API hostname

• Requires a value

--environment, -e

The environment ID

• Requires a value

--app, -A

The remote application name

• Requires a value

--worker

A worker 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

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:set-remote

Set the remote environment to map to a branch

1
magento-cloud environment:set-remote <environment> [<branch>]

environment

The environment machine name. Set to 0 to remove the mapping for a branch

• Required

branch

The Git branch to map (defaults to the current branch)

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any 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 any yes/no questions; disable interaction

• Default: false

• Does not accept a value

--no, -n

Answer “no” to any yes/no questions; disable interaction

• Default: false

• Does not accept a value

environment:ssh

SSH to the current environment

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

1
ssh

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