magento-cloud

Version: 1.35.2

This reference contains 125 commands available through the magento-cloud command-line tool. The initial list is auto generated using the magento-cloud list command at the Magento Commerce Cloud edition.

Reference

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

Options

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

Options

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

Options

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

Arguments

value

The variable value to decode

  • Required

Options

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

Arguments

Search term(s)

  • Default: []

  • Array

Options

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

Arguments

command_name

The command name

  • Default: help

Options

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

Options

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

Arguments

namespace

The namespace name

Options

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

Arguments

cmd

The command to execute

  • Required

Options

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

Options

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

Options

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

Options

--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 [--type TYPE] [-a|--all] [-P|--property PROPERTY] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<id>]

Arguments

id

The activity ID. Defaults to the most recent activity.

Options

--type

Filter recent activities by type

  • Requires a value
--all, -a

Check recent activities on all environments

  • Default: false

  • Does not accept a value

--property, -P

The property to view

  • 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”, or “tsv”)

  • 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] [-a|--all] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT]

1
activities

1
act

Options

--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
--all, -a

Check activities on all environments

  • Default: false

  • Does not accept a value

--format

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

  • 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] [-a|--all] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [--] [<id>]

Arguments

id

The activity ID. Defaults to the most recent activity.

Options

--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 recent activities by type

  • Requires a value
--all, -a

Check recent activities on all environments

  • 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] [-H|--header HEADER] [--] [<path>]

Arguments

path

The API path

Options

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

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

Options

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

Options

--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”, or “tsv”)

  • 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

Options

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

Options

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

Arguments

property

The account property to view

Options

--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”, or “tsv”)

  • 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

Options

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

Options

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

Options

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

Options

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

Options

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

Arguments

id

The certificate ID (or the start of it)

  • Required

Options

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

Arguments

id

The certificate ID (or the start of it)

  • Required

Options

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

Options

--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”, or “tsv”)

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

Arguments

commit

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

  • Default: HEAD

Options

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

Arguments

commit

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

Options

--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”, or “tsv”)

  • 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

Options

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

Options

--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”, or “tsv”)

  • 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

Arguments

query

An SQL statement to execute

Options

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

Arguments

name

The domain name

  • Required

Options

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

Arguments

name

The domain name

  • Required

Options

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

Arguments

name

The domain name

Options

--property, -P

The domain property to view

  • Requires a value
--format

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

  • 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

Options

--format

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

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

Arguments

name

The domain name

  • Required

Options

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

Arguments

environment

The environment(s) to activate

  • Default: []

  • Array

Options

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

Arguments

id

The ID (branch name) of the new environment

parent

The parent of the new environment

Options

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

Arguments

id

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

Options

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

Arguments

environment

The environment(s) to delete

  • Default: []

  • Array

Options

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

Options

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

Arguments

property

The name of the property

value

Set a new value for the property

Options

--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”, or “tsv”)

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

Arguments

url

A URL to a Git repository

  • Required

Options

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

Options

--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”, or “tsv”)

  • 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

Arguments

type

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

Options

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

Arguments

environment

The environment to merge

Options

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

Arguments

source

The source ref: a branch name or commit hash

  • Default: HEAD

Options

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

Options

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

Arguments

environment

The environment

Options

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

Arguments

files

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

  • Default: []

  • Array

Options

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

Arguments

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)

Options

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

Arguments

cmd

A command to run on the environment.

  • Default: []

  • Array

Options

--pipe

Output the SSH URL only.

  • Default: false

  • Does not accept a value

--all

Output all SSH URLs (for every app).

  • Default: false

  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value
--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:synchronize

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

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

1
sync

Arguments

synchronize

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

  • Default: []

  • Array

Options

--rebase

Synchronize code by rebasing instead of merging

  • Default: false

  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value
--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:url

Get the public URLs of an environment

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

1
url

Options

--primary, -1

Only return the URL for the primary route

  • Default: false

  • Does not accept a value

--browser

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

  • Requires a value
--pipe

Output the URL to stdout.

  • Default: false

  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value
--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

environment:xdebug

Open a tunnel to Xdebug on the environment

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

1
xdebug

Options

--port

The local port

  • Default: 9000

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

integration:activity:get

View detailed information on a single integration activity

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

Arguments

integration

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

activity

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

Options

--property, -P

The property to view

  • Requires a value
--project, -p

The project ID or URL

  • Requires a value
--host

The project’s API hostname

  • Requires a value
--environment, -e

[Deprecated option, not used]

  • Requires a value
--format

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

  • 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

integration:activity:list

Get a list of activities for an integration

1
magento-cloud i:act [--type TYPE] [--limit LIMIT] [--start START] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [--] [<id>]

1
i:act

1
integration:activities

Arguments

id

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

Options

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

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

  • 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

[Deprecated option, not 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

integration:activity:log

Display the log for an integration activity

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

Arguments

integration

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

activity

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

Options

--timestamps, -t

Display a timestamp next to each message

  • Default: false

  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value
--host

The project’s API hostname

  • Requires a value
--environment, -e

[Deprecated option, not used]

  • Requires a value
--help, -h

Display this help message

  • Default: false

  • Does not accept a value

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

integration:add

Add an integration to the project

1
magento-cloud integration:add [--type TYPE] [--base-url BASE-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--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] [--room ROOM] [--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] [-p|--project PROJECT] [--host HOST] [-W|--no-wait] [--wait]

Options

--type

The integration type (‘bitbucket’, ‘bitbucket_server’, ‘github’, ‘gitlab’, ‘hipchat’, ‘webhook’, ‘health.email’, ‘health.pagerduty’, ‘health.slack’, ‘health.webhook’, ‘script’)

  • Requires a value
--base-url

The base URL of the server installation

  • Requires a value
--username

The Bitbucket Server username

  • Requires a value
--token

An access token for the integration

  • Requires a value
--key

A Bitbucket OAuth consumer key

  • Requires a value
--secret

A Bitbucket OAuth consumer secret

  • Requires a value
--server-project

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

  • Requires a value
--repository

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

  • Requires a value
--build-merge-requests

GitLab: build merge requests as environments

  • Default: true

  • Requires a value

--build-pull-requests

Build every pull request as an environment

  • Default: true

  • Requires a value

--build-draft-pull-requests

Build draft pull requests

  • Default: true

  • Requires a value

--build-pull-requests-post-merge

Build pull requests based on their post-merge state

  • Default: false

  • Requires a value

--build-wip-merge-requests

GitLab: build WIP merge requests

  • Default: true

  • Requires a value

--merge-requests-clone-parent-data

GitLab: clone data for merge requests

  • Default: true

  • Requires a value

--pull-requests-clone-parent-data

Clone the parent environment’s data for pull requests

  • Default: true

  • Requires a value

--resync-pull-requests

Re-sync pull request environment data on every build

  • Default: false

  • Requires a value

--fetch-branches

Fetch all branches from the remote (as inactive environments)

  • Default: true

  • Requires a value

--prune-branches

Delete branches that do not exist on the remote

  • Default: true

  • Requires a value

--room

HipChat room ID

  • Requires a value
--url

Webhook: a URL to receive JSON data

  • Requires a value
--shared-key

Webhook: the JWS shared secret key

  • Requires a value
--file

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

  • Requires a value
--events

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

  • Default: *

  • Requires a value

--states

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

  • Default: complete

  • Requires a value

--environments

The environment IDs to include

  • Default: *

  • Requires a value

--excluded-environments

The environment IDs to exclude

  • Default: []

  • Requires a value

--from-address

[Optional] Custom From address for alert emails

  • Requires a value
--recipients

The recipient email address(es)

  • Default: []

  • Requires a value

--channel

The Slack channel

  • Requires a value
--routing-key

The PagerDuty routing key

  • Requires a value
--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

integration:delete

Delete an integration from a project

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

Arguments

id

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

Options

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

integration:get

View details of an integration

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

Arguments

id

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

Options

--property, -P

The integration property to view

  • Accepts a value
--format

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

  • 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

integration:list

View a list of project integration(s)

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

1
integrations

Options

--format

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

  • 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

integration:update

Update an integration

1
magento-cloud integration:update [--type TYPE] [--base-url BASE-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--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] [--room ROOM] [--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] [-p|--project PROJECT] [--host HOST] [-W|--no-wait] [--wait] [--] [<id>]

Arguments

id

The ID of the integration to update

Options

--type

The integration type (‘bitbucket’, ‘bitbucket_server’, ‘github’, ‘gitlab’, ‘hipchat’, ‘webhook’, ‘health.email’, ‘health.pagerduty’, ‘health.slack’, ‘health.webhook’, ‘script’)

  • Requires a value
--base-url

The base URL of the server installation

  • Requires a value
--username

The Bitbucket Server username

  • Requires a value
--token

An access token for the integration

  • Requires a value
--key

A Bitbucket OAuth consumer key

  • Requires a value
--secret

A Bitbucket OAuth consumer secret

  • Requires a value
--server-project

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

  • Requires a value
--repository

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

  • Requires a value
--build-merge-requests

GitLab: build merge requests as environments

  • Default: true

  • Requires a value

--build-pull-requests

Build every pull request as an environment

  • Default: true

  • Requires a value

--build-draft-pull-requests

Build draft pull requests

  • Default: true

  • Requires a value

--build-pull-requests-post-merge

Build pull requests based on their post-merge state

  • Default: false

  • Requires a value

--build-wip-merge-requests

GitLab: build WIP merge requests

  • Default: true

  • Requires a value

--merge-requests-clone-parent-data

GitLab: clone data for merge requests

  • Default: true

  • Requires a value

--pull-requests-clone-parent-data

Clone the parent environment’s data for pull requests

  • Default: true

  • Requires a value

--resync-pull-requests

Re-sync pull request environment data on every build

  • Default: false

  • Requires a value

--fetch-branches

Fetch all branches from the remote (as inactive environments)

  • Default: true

  • Requires a value

--prune-branches

Delete branches that do not exist on the remote

  • Default: true

  • Requires a value

--room

HipChat room ID

  • Requires a value
--url

Webhook: a URL to receive JSON data

  • Requires a value
--shared-key

Webhook: the JWS shared secret key

  • Requires a value
--file

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

  • Requires a value
--events

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

  • Default: *

  • Requires a value

--states

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

  • Default: complete

  • Requires a value

--environments

The environment IDs to include

  • Default: *

  • Requires a value

--excluded-environments

The environment IDs to exclude

  • Default: []

  • Requires a value

--from-address

[Optional] Custom From address for alert emails

  • Requires a value
--recipients

The recipient email address(es)

  • Default: []

  • Requires a value

--channel

The Slack channel

  • Requires a value
--routing-key

The PagerDuty routing key

  • Requires a value
--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

integration:validate

Validate an existing integration

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

Arguments

id

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

Options

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

local:build

Build the current project locally

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

1
build

Arguments

app

Specify application(s) to build

  • Default: []

  • Array

Options

Use absolute links

  • Default: false

  • Does not accept a value

--source, -s

The source directory. Defaults to the current project root.

  • Requires a value
--destination, -d

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

  • Requires a value
--copy, -c

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

  • Default: false

  • Does not accept a value

--clone

Use Git to clone the current HEAD to the build directory

  • Default: false

  • Does not accept a value

--run-deploy-hooks

Run deploy and/or post_deploy hooks

  • Default: false

  • Does not accept a value

--no-clean

Do not remove old builds

  • Default: false

  • Does not accept a value

--no-archive

Do not create or use a build archive

  • Default: false

  • Does not accept a value

--no-backup

Do not back up the previous build

  • Default: false

  • Does not accept a value

--no-cache

Disable caching

  • Default: false

  • Does not accept a value

--no-build-hooks

Do not run post-build hooks

  • Default: false

  • Does not accept a value

--no-deps

Do not install build dependencies locally

  • Default: false

  • Does not accept a value

--working-copy

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

  • Default: false

  • Does not accept a value

--concurrency

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

  • Default: 4

  • Requires a value

--lock

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

  • Default: false

  • Does not accept a value

--help, -h

Display this help message

  • Default: false

  • Does not accept a value

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

local:clean

Remove old project builds

1
magento-cloud clean [--keep KEEP] [--max-age MAX-AGE] [--include-active]

1
clean

Options

--keep

The maximum number of builds to keep

  • Default: 5

  • Requires a value

--max-age

The maximum age of builds, in seconds. Ignored if not set.

  • Requires a value
--include-active

Delete active build(s) too

  • 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

local:dir

Find the local project root

1
magento-cloud dir [<subdir>]

1
dir

Arguments

subdir

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

Options

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

mount:download

Download files from a mount, using rsync

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

Options

--all, -a

Download from all mounts

  • Default: false

  • Does not accept a value

--mount, -m

The mount (as an app-relative path)

  • Requires a value
--target

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

  • Requires a value
--source-path

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

  • Default: false

  • Does not accept a value

--delete

Whether to delete extraneous files in the target directory

  • Default: false

  • Does not accept a value

--exclude

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

  • Default: []

  • Requires a value

--include

File(s) to include in the download (pattern)

  • Default: []

  • Requires a value

--refresh

Whether to refresh the cache

  • Default: false

  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value
--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

mount:list

Get a list of mounts

1
magento-cloud mounts [--paths] [--refresh] [--format FORMAT] [--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER]

1
mounts

Options

--paths

Output the mount paths only (one per line)

  • Default: false

  • Does not accept a value

--refresh

Whether to refresh the cache

  • Default: false

  • Does not accept a value

--format

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

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

mount:size

Check the disk usage of mounts

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

Options

--bytes, -B

Show sizes in bytes

  • Default: false

  • Does not accept a value

--refresh

Refresh the cache

  • Default: false

  • Does not accept a value

--format

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

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

mount:upload

Upload files to a mount, using rsync

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

Options

--source

A directory containing files to upload

  • Requires a value
--mount, -m

The mount (as an app-relative path)

  • Requires a value
--delete

Whether to delete extraneous files in the mount

  • Default: false

  • Does not accept a value

--exclude

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

  • Default: []

  • Requires a value

--include

File(s) to include in the upload (pattern)

  • Default: []

  • Requires a value

--refresh

Whether to refresh the cache

  • Default: false

  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value
--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

project:clear-build-cache

Clear a project’s build cache

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

Options

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

project:curl

Run an authenticated cURL request on a project’s API

1
magento-cloud project:curl [-X|--request REQUEST] [-d|--data DATA] [-i|--include] [-I|--head] [--disable-compression] [-H|--header HEADER] [-p|--project PROJECT] [--host HOST] [--] [<path>]

Arguments

path

The API path

Options

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

--header, -H

Extra header(s)

  • Default: []

  • 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

project:get

Clone a project locally

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

1
get

Arguments

project

The project ID

directory

The directory to clone to. Defaults to the project title

Options

--environment, -e

The environment ID to clone. Defaults to ‘master’ or the first available environment

  • Requires a value
--depth

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

  • Requires a value
--build

Build the project after cloning

  • Default: false

  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value
--host

The project’s API hostname

  • 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

project:info

Read or set properties for a project

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

1
project:metadata

Arguments

property

The name of the property

value

Set a new value for the property

Options

--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”, or “tsv”)

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

project:list

Get a list of all active projects

1
magento-cloud project:list [--pipe] [--host HOST] [--title TITLE] [--my] [--refresh REFRESH] [--sort SORT] [--reverse] [--format FORMAT] [--columns COLUMNS] [--no-header]

1
projects

1
pro

Options

--pipe

Output a simple list of project IDs

  • Default: false

  • Does not accept a value

--host

Filter by region hostname (exact match)

  • Requires a value
--title

Filter by title (case-insensitive search)

  • Requires a value
--my

Display only the projects you own

  • Default: false

  • Does not accept a value

--refresh

Whether to refresh the list

  • Default: 1

  • Requires a value

--sort

A property to sort by

  • Default: title

  • Requires a value

--reverse

Sort in reverse (descending) order

  • Default: false

  • Does not accept a value

--format

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

  • 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

project:set-remote

Set the remote project for the current Git repository

1
magento-cloud project:set-remote [<project>]

Arguments

project

The project ID

Options

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

project:variable:delete

<fg=white;bg=red>[ DEPRECATED ]</> Delete a variable from a project

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

Arguments

name

The variable name

  • Required

Options

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

project:variable:get

<fg=white;bg=red>[ DEPRECATED ]</> View variable(s) for a project

1
magento-cloud project:variable:get [--pipe] [--format FORMAT] [--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--host HOST] [--] [<name>]

1
project-variables

1
pvget

1
project:variable:list

Arguments

name

The name of the variable

Options

--pipe

Output the full variable value only (a “name” must be specified)

  • Default: false

  • Does not accept a value

--format

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

  • 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

project:variable:set

<fg=white;bg=red>[ DEPRECATED ]</> Set a variable for a project

1
magento-cloud pvset [--json] [--no-visible-build] [--no-visible-runtime] [-p|--project PROJECT] [--host HOST] [-W|--no-wait] [--wait] [--] <name> <value>

1
pvset

Arguments

name

The variable name

  • Required

value

The variable value

  • Required

Options

--json

Mark the value as JSON

  • Default: false

  • Does not accept a value

--no-visible-build

Do not expose this variable at build time

  • Default: false

  • Does not accept a value

--no-visible-runtime

Do not expose this variable at runtime

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

repo:cat

Read a file in the project repository

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

Arguments

path

The path to the file

  • Required

Options

--commit, -c

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

  • Requires a value
--project, -p

The project ID or URL

  • Requires a value
--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

repo:ls

List files in the project repository

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

Arguments

path

The path to a subdirectory

Options

--directories, -d

Show directories only

  • Default: false

  • Does not accept a value

--files, -f

Show files only

  • Default: false

  • Does not accept a value

--git-style

Style output similar to “git ls-tree”

  • Default: false

  • Does not accept a value

--commit, -c

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

  • Requires a value
--project, -p

The project ID or URL

  • Requires a value
--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

route:get

View detailed information about a route

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

Arguments

route

The route’s original URL

Options

--id

A route ID to select

  • Requires a value
--primary, -1

Select the primary route

  • Default: false

  • Does not accept a value

--property, -P

The property to display

  • Requires a value
--refresh

Bypass the cache of routes

  • Default: false

  • Does not accept a value

--date-fmt

The date format (as a PHP date format string)

  • Default: c

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value
--host

The project’s API hostname

  • Requires a value
--environment, -e

The environment ID

  • Requires a value
--app, -A

[Deprecated option, no longer used]

  • Requires a value
--identity-file, -i

[Deprecated option, no longer used]

  • Requires a value
--help, -h

Display this help message

  • Default: false

  • Does not accept a value

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

route:list

List all routes for an environment

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

1
routes

1
environment:routes

Arguments

environment

The environment ID

Options

--refresh

Bypass the cache of routes

  • Default: false

  • Does not accept a value

--format

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

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

self:install

Install or update CLI configuration files

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

1
local:install

Options

--shell-type

The shell type for autocompletion (bash or zsh)

  • Requires a value
--help, -h

Display this help message

  • Default: false

  • Does not accept a value

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

self:stats

View stats on GitHub package downloads

1
magento-cloud self:stats [-p|--page PAGE] [-c|--count COUNT] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

Options

--page, -p

Page number

  • Default: 1

  • Requires a value

--count, -c

Results per page (max: 100)

  • Default: 20

  • Requires a value

--format

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

  • 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

self:update

Update the CLI to the latest version

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

1
self-update

1
update

Options

--no-major

Only update between minor or patch versions

  • Default: false

  • Does not accept a value

--unstable

Update to a new unstable version, if available

  • Default: false

  • Does not accept a value

--manifest

Override the manifest file location

  • Requires a value
--current-version

Override the current version

  • Requires a value
--timeout

A timeout for the version check

  • Default: 30

  • Requires a value

--help, -h

Display this help message

  • Default: false

  • Does not accept a value

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

service:list

List services in the project

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

1
services

Options

--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”, or “tsv”)

  • 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

service:mongo:dump

Create a binary archive dump of data from MongoDB

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

1
mongodump

Options

--collection, -c

The collection to dump

  • Requires a value
--gzip, -z

Compress the dump using gzip

  • Default: false

  • Does not accept a value

--stdout, -o

Output to STDOUT instead of a file

  • Default: false

  • Does not accept a value

--relationship, -r

The service relationship to use

  • Requires a value
--identity-file, -i

An SSH identity (private key) to use

  • Requires a value
--project, -p

The project ID or URL

  • Requires a value
--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
--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

service:mongo:export

Export data from MongoDB

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

1
mongoexport

Options

--collection, -c

The collection to export

  • Requires a value
--jsonArray

Export data as a single JSON array

  • Default: false

  • Does not accept a value

--type

The export type, e.g. “csv”

  • Requires a value
--fields, -f

The fields to export

  • Default: []

  • Requires a value

--relationship, -r

The service relationship to use

  • Requires a value
--identity-file, -i

An SSH identity (private key) to use

  • Requires a value
--project, -p

The project ID or URL

  • Requires a value
--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
--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

service:mongo:restore

Restore a binary archive dump of data into MongoDB

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

1
mongorestore

Options

--collection, -c

The collection to restore

  • Requires a value
--relationship, -r

The service relationship to use

  • Requires a value
--identity-file, -i

An SSH identity (private key) to use

  • Requires a value
--project, -p

The project ID or URL

  • Requires a value
--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
--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

service:mongo:shell

Use the MongoDB shell

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

1
mongo

Options

--eval

Pass a JavaScript fragment to the shell

  • Requires a value
--relationship, -r

The service relationship to use

  • Requires a value
--identity-file, -i

An SSH identity (private key) to use

  • Requires a value
--project, -p

The project ID or URL

  • Requires a value
--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
--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

service:redis-cli

Access the Redis CLI

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

1
redis

Arguments

args

Arguments to add to the Redis command

Options

--relationship, -r

The service relationship to use

  • Requires a value
--identity-file, -i

An SSH identity (private key) to use

  • Requires a value
--project, -p

The project ID or URL

  • Requires a value
--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
--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

session:switch

<fg=white;bg=red>[ BETA ]</> Switch between sessions

1
magento-cloud session:switch [<id>]

Arguments

id

The new session ID

Options

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

snapshot:create

Make a snapshot of an environment

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

1
backup

1
backup:create

1
environment:backup

Arguments

environment

The environment

Options

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

snapshot:list

List available snapshots of an environment

1
magento-cloud snapshots [--limit LIMIT] [--start START] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT]

1
snapshots

1
backups

1
backup:list

Options

--limit

Limit the number of snapshots to list

  • Default: 10

  • Requires a value

--start

Only snapshots created before this date will be listed

  • Requires a value
--format

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

  • 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

snapshot:restore

Restore an environment snapshot

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

1
environment:restore

1
snapshot:restore

Arguments

snapshot

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

Options

--target

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

  • Requires a value
--branch-from

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

  • Requires a value
--project, -p

The project ID or URL

  • Requires a value
--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

source-operation:run

<fg=white;bg=red>[ BETA ]</> Run a source operation

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

Arguments

operation

The operation name

  • Required

Options

--variable

A variable to set during the operation, in the format type:name=value

  • 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

ssh-cert:load

Generate an SSH certificate

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

Options

--refresh-only

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

  • Default: false

  • Does not accept a value

--new

Force the certificate to be refreshed

  • Default: false

  • Does not accept a value

--new-key

[Deprecated] Use –new instead

  • Default: false

  • Does not accept a value

--help, -h

Display this help message

  • Default: false

  • Does not accept a value

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

ssh-key:add

Add a new SSH key

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

Arguments

path

The path to an existing SSH public key

Options

--name

A name to identify the key

  • 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

ssh-key:delete

Delete an SSH key

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

Arguments

id

The ID of the SSH key to delete

Options

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

ssh-key:list

Get a list of SSH keys in your account

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

1
ssh-keys

Options

--format

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

  • 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

subscription:info

Read or modify subscription properties

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

Arguments

property

The name of the property

value

Set a new value for the property

Options

--id, -s

The subscription ID

  • Requires a value
--date-fmt

The date format (as a PHP date format string)

  • Default: c

  • Requires a value

--format

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

  • 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

tunnel:close

Close SSH tunnels

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

Options

--all, -a

Close all tunnels

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

tunnel:info

View relationship info for SSH tunnels

1
magento-cloud tunnel:info [-P|--property PROPERTY] [-c|--encode] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [-A|--app APP] [--format FORMAT] [--columns COLUMNS] [--no-header]

Options

--property, -P

The relationship property to view

  • Requires a value
--encode, -c

Output as base64-encoded JSON

  • Default: false

  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value
--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
--format

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

  • 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

tunnel:list

List SSH tunnels

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

1
tunnels

Options

--all, -a

View all tunnels

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

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

  • 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

tunnel:open

Open SSH tunnels to an app’s relationships

1
magento-cloud tunnel:open [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE]

Options

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

tunnel:single

Open a single SSH tunnel to an app relationship

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

Options

--port

The local port

  • 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

user:add

Add a user to the project

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

Arguments

email

The user’s email address

Options

--role, -r

The user’s project role (‘admin’ or ‘viewer’) or environment-specific role (e.g. ‘master:contributor’ or ‘stage:viewer’). The character % can be used as a wildcard in the environment ID e.g. ‘%:viewer’. The role can be abbreviated, e.g. ‘master:c’.

  • 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

user:delete

Delete a user from the project

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

Arguments

email

The user’s email address

  • Required

Options

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

user:get

View a user’s role(s)

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

1
user:role

Arguments

email

The user’s email address

Options

--level, -l

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

  • Requires a value
--pipe

Output the role to stdout (after making any changes)

  • Default: false

  • Does not accept a value

--project, -p

The project ID or URL

  • Requires a value
--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

--role, -r

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

  • Requires a value
--help, -h

Display this help message

  • Default: false

  • Does not accept a value

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

user:list

List project users

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

1
users

Options

--format

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

  • 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

user:update

Update user role(s) on a project

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

Arguments

email

The user’s email address

Options

--role, -r

The user’s project role (‘admin’ or ‘viewer’) or environment-specific role (e.g. ‘master:contributor’ or ‘stage:viewer’). The character % can be used as a wildcard in the environment ID e.g. ‘%:viewer’. The role can be abbreviated, e.g. ‘master:c’.

  • 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

variable:create

Create a variable

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

Arguments

name

The variable name

Options

--level, -l

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

  • Requires a value
--name

The variable name

  • Requires a value
--value

The variable’s value

  • Requires a value
--json

Whether the variable is JSON-formatted

  • Default: false

  • Requires a value

--sensitive

Whether the variable is sensitive

  • Default: false

  • Requires a value

--prefix

The variable name’s prefix (e.g. ‘none’ or ‘env:’)

  • Default: none

  • Requires a value

--enabled

Whether the variable should be enabled

  • Default: true

  • Requires a value

--inheritable

Whether the variable is inheritable by child environments

  • Default: true

  • Requires a value

--visible-build

Whether the variable should be visible at build time

  • Default: true

  • Requires a value

--visible-runtime

Whether the variable should be visible at runtime

  • Default: true

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value
--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

variable:delete

Delete a variable

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

Arguments

name

The variable name

  • Required

Options

--level, -l

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

  • 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

variable:disable

<fg=white;bg=red>[ DEPRECATED ]</> Disable an enabled environment-level variable

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

Arguments

name

The name of the variable

  • Required

Options

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

variable:enable

<fg=white;bg=red>[ DEPRECATED ]</> Enable a disabled environment-level variable

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

Arguments

name

The name of the variable

  • Required

Options

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

variable:get

View a variable

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

1
vget

Arguments

name

The name of the variable

Options

--property, -P

View a single variable property

  • Requires a value
--level, -l

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

  • Requires a value
--format

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

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

[Deprecated option] Output the variable value only

  • Default: false

  • Does not accept a value

--help, -h

Display this help message

  • Default: false

  • Does not accept a value

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

variable:list

List variables

1
magento-cloud variable:list [-l|--level LEVEL] [--format FORMAT] [--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT]

1
variables

1
var

Options

--level, -l

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

  • Requires a value
--format

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

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

variable:set

<fg=white;bg=red>[ DEPRECATED ]</> Set a variable for an environment

1
magento-cloud vset [--json] [--disabled] [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name> <value>

1
vset

Arguments

name

The variable name

  • Required

value

The variable value

  • Required

Options

--json

Mark the value as JSON

  • Default: false

  • Does not accept a value

--disabled

Mark the variable as disabled

  • 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

variable:update

Update a variable

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

Arguments

name

The variable name

  • Required

Options

--level, -l

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

  • Requires a value
--value

The variable’s value

  • Requires a value
--json

Whether the variable is JSON-formatted

  • Default: false

  • Requires a value

--sensitive

Whether the variable is sensitive

  • Default: false

  • Requires a value

--enabled

Whether the variable should be enabled

  • Default: true

  • Requires a value

--inheritable

Whether the variable is inheritable by child environments

  • Default: true

  • Requires a value

--visible-build

Whether the variable should be visible at build time

  • Default: true

  • Requires a value

--visible-runtime

Whether the variable should be visible at runtime

  • Default: true

  • Requires a value

--project, -p

The project ID or URL

  • Requires a value
--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

worker:list

Get a list of all deployed workers

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

1
workers

Options

--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”, or “tsv”)

  • 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