magento-cloud

Version: 1.32.0

This reference contains 115 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.

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

`bot`

The Magento Cloud Bot

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

`clear-cache`

Clear the CLI cache

magento-cloud clear-cache

clearcache

cc

`decode`

Decode an encoded string such as MAGENTO_CLOUD_VARIABLES

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

Arguments

`value`

Description: The variable value to decode
Required

Options

`property`

Option: --property
Shortcut: -P
Description: The property to view within the variable
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`docs`

Open the online documentation

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

Arguments

`search`

Description: Search term(s)
Default: []
Array

Options

`browser`

Option: --browser
Description: The browser to use to open the URL. Set 0 for none.
Requires a value

`pipe`

Option: --pipe
Description: Output the URL to stdout.
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`help`

Displays help for a command

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

Arguments

`command_name`

Description: The command name
Default: help

Options

`format`

Option: --format
Description: The output format (txt, xml, json, or md)
Default: txt
Requires a value

`raw`

Option: --raw
Description: To output raw command help
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`legacy-migrate`

Migrate from the legacy file structure

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

`list`

Lists commands

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

Arguments

`namespace`

Description: The namespace name

Options

`raw`

Option: --raw
Description: To output raw command list
Default: false
Does not accept a value

`format`

Option: --format
Description: The output format (txt, xml, json, or md)
Default: txt
Requires a value

`multi`

Execute a command on multiple projects

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

Arguments

`cmd`

Description: The command to execute
Required

Options

`projects`

Option: --projects
Shortcut: -p
Description: A list of project IDs, separated by commas and/or whitespace
Requires a value

`continue`

Option: --continue
Description: Continue running commands even if an exception is encountered
Default: false
Does not accept a value

`sort`

Option: --sort
Description: A property by which to sort the list of project options
Default: title
Requires a value

`reverse`

Option: --reverse
Description: Reverse the order of project options
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`web`

Open the Web UI

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

`welcome`

Welcome to Magento Cloud

magento-cloud welcome

`activity:get`

View detailed information on a single activity

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`

Description: The activity ID. Defaults to the most recent activity.

Options

`type`

Option: --type
Description: Filter recent activities by type
Requires a value

`all`

Option: --all
Shortcut: -a
Description: Check recent activities on all environments
Default: false
Does not accept a value

`property`

Option: --property
Shortcut: -P
Description: The property to view
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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]

activities

act

`activity:log`

Display the log for an activity

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`

Description: The activity ID. Defaults to the most recent activity.

Options

`refresh`

Option: --refresh
Description: Activity refresh interval (seconds). Set to 0 to disable refreshing.
Default: 3
Requires a value

`timestamps`

Option: --timestamps
Shortcut: -t
Description: Display a timestamp next to each message
Default: false
Does not accept a value

`type`

Option: --type
Description: Filter recent activities by type
Requires a value

`all`

Option: --all
Shortcut: -a
Description: Check recent activities on all environments
Default: false
Does not accept a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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]

`app:list`

List apps in the project

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

apps

`auth:browser-login`

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

login

`auth:info`

Display your account information

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

Arguments

`property`

Description: The account property to view

Options

`property`

Option: --property
Shortcut: -P
Description: The account property to view (alternate syntax)
Requires a value

`refresh`

Option: --refresh
Description: Whether to refresh the cache
Default: false
Does not accept a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`auth:logout`

Log out of Magento Cloud

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

logout

`auth:password-login`

magento-cloud auth:password-login

auth:login

`auth:token`

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

magento-cloud auth:token

`blackfire:setup`

Setup Blackfire.io integration for the project

magento-cloud blackfire:setup [-p|--project PROJECT] [--host HOST] [-W|--no-wait] [--wait]

`certificate:add`

Add an SSL certificate to the project

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

`certificate:delete`

Delete a certificate from the project

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

Arguments

`id`

Description: The certificate ID (or the start of it)
Required

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`certificate:get`

View a certificate

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

Arguments

`id`

Description: The certificate ID (or the start of it)
Required

Options

`property`

Option: --property
Shortcut: -P
Description: The certificate property to view
Requires a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`certificate:list`

List project certificates

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]

certificates

certs

`commit:get`

Show commit details

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`

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

Options

`property`

Option: --property
Shortcut: -P
Description: The commit property to display.
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`format`

Option: --format
Description: DEPRECATED
Requires a value

`columns`

Option: --columns
Description: DEPRECATED
Default: []
Requires a value

`no-header`

Option: --no-header
Description: DEPRECATED
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`commit:list`

List commits

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

commits

Arguments

`commit`

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

Options

`limit`

Option: --limit
Description: The number of commits to display.
Default: 10
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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]

sql-dump

environment:sql-dump

`db:size`

Estimate the disk usage of a database

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]

`db:sql`

Run SQL on the remote database

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

sql

environment:sql

Arguments

`query`

Description: An SQL statement to execute

Options

`raw`

Option: --raw
Description: Produce raw, non-tabular output
Default: false
Does not accept a value

`schema`

Option: --schema
Description: 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`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`app`

Option: --app
Shortcut: -A
Description: The remote application name
Requires a value

`relationship`

Option: --relationship
Shortcut: -r
Description: The service relationship to use
Requires a value

`identity-file`

Option: --identity-file
Shortcut: -i
Description: An SSH identity (private key) to use
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

magento-cloud domain:add [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [--host HOST] [-W|--no-wait] [--wait] [--] <name>

Arguments

`name`

Description: The domain name
Required

Options

`cert`

Option: --cert
Description: The path to the certificate file for this domain
Requires a value

`key`

Option: --key
Description: The path to the private key file for the provided certificate.
Requires a value

`chain`

Option: --chain
Description: The path to the certificate chain file or files for the provided certificate
Default: []
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`domain:delete`

Delete a domain from the project

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

Arguments

`name`

Description: The domain name
Required

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`domain:get`

Show detailed information for a domain

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`

Description: The domain name

Options

`property`

Option: --property
Shortcut: -P
Description: The domain property to view
Requires a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`domain:list`

Get a list of all domains

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

domains

`domain:update`

Update a domain

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

Arguments

`name`

Description: The domain name
Required

Options

`cert`

Option: --cert
Description: The path to the certificate file for this domain
Requires a value

`key`

Option: --key
Description: The path to the private key file for the provided certificate.
Requires a value

`chain`

Option: --chain
Description: The path to the certificate chain file or files for the provided certificate
Default: []
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`environment:activate`

Activate an environment

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

Arguments

`environment`

Description: The environment(s) to activate
Default: []
Array

Options

`parent`

Option: --parent
Description: Set a new environment parent before activating
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`environment:branch`

Branch an environment

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

branch

Arguments

`id`

Description: The ID (branch name) of the new environment

`parent`

Description: The parent of the new environment

Options

`title`

Option: --title
Description: The title of the new environment
Requires a value

`force`

Option: --force
Description: Create the new environment even if the branch cannot be checked out locally
Default: false
Does not accept a value

`no-clone-parent`

Option: --no-clone-parent
Description: Do not clone the parent branch’s data
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`identity-file`

Option: --identity-file
Shortcut: -i
Description: An SSH identity (private key) to use
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`environment:checkout`

Check out an environment

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

checkout

Arguments

`id`

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

Options

`identity-file`

Option: --identity-file
Shortcut: -i
Description: An SSH identity (private key) to use
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`environment:delete`

Delete an environment

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

Arguments

`environment`

Description: The environment(s) to delete
Default: []
Array

Options

`delete-branch`

Option: --delete-branch
Description: Delete the remote Git branch(es) too
Default: false
Does not accept a value

`no-delete-branch`

Option: --no-delete-branch
Description: Do not delete the remote Git branch(es)
Default: false
Does not accept a value

`inactive`

Option: --inactive
Description: Delete all inactive environments
Default: false
Does not accept a value

`merged`

Option: --merged
Description: Delete all merged environments
Default: false
Does not accept a value

`exclude`

Option: --exclude
Description: Environments not to delete
Default: []
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

httpaccess

`environment:info`

Read or set properties for an environment

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

environment:metadata

Arguments

`property`

Description: The name of the property

`value`

Description: Set a new value for the property

Options

`refresh`

Option: --refresh
Description: Whether to refresh the cache
Default: false
Does not accept a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

Arguments

`url`

Description: A URL to a Git repository
Required

Options

`profile`

Option: --profile
Description: The name of the profile
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`environment:list`

Get a list of environments

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

environments

env

`environment:logs`

Read an environment’s logs

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

log

logs

Arguments

`type`

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

Options

`lines`

Option: --lines
Description: The number of lines to show
Default: 100
Requires a value

`tail`

Option: --tail
Description: Continuously tail the log
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`app`

Option: --app
Shortcut: -A
Description: The remote application name
Requires a value

`worker`

Option: --worker
Description: A worker name
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`environment:merge`

Merge an environment

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

merge

Arguments

`environment`

Description: The environment to merge

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`environment:push`

Push code to an environment

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

push

Arguments

`source`

Description: The source ref: a branch name or commit hash
Default: HEAD

Options

`target`

Option: --target
Description: The target branch name
Requires a value

`force`

Option: --force
Shortcut: -f
Description: Allow non-fast-forward updates
Default: false
Does not accept a value

`force-with-lease`

Option: --force-with-lease
Description: Allow non-fast-forward updates, if the remote-tracking branch is up to date
Default: false
Does not accept a value

`set-upstream`

Option: --set-upstream
Shortcut: -u
Description: Set the target environment as the upstream for the source branch
Default: false
Does not accept a value

`activate`

Option: --activate
Description: Activate the environment before pushing
Default: false
Does not accept a value

`branch`

Option: --branch
Description: DEPRECATED: alias of –activate
Default: false
Does not accept a value

`parent`

Option: --parent
Description: Set a new environment parent (only used with –activate or –branch)
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`identity-file`

Option: --identity-file
Shortcut: -i
Description: An SSH identity (private key) to use
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`environment:redeploy`

Redeploy an environment

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

redeploy

`environment:relationships`

Show an environment’s relationships

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

relationships

Arguments

`environment`

Description: The environment

Options

`property`

Option: --property
Shortcut: -P
Description: The relationship property to view
Requires a value

`refresh`

Option: --refresh
Description: Whether to refresh the relationships
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`app`

Option: --app
Shortcut: -A
Description: The remote application name
Requires a value

`identity-file`

Option: --identity-file
Shortcut: -i
Description: An SSH identity (private key) to use
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

Arguments

`environment`

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

`branch`

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

Options

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`environment:ssh`

SSH to the current environment

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

ssh

Arguments

`cmd`

Description: A command to run on the environment.
Default: []
Array

Options

`pipe`

Option: --pipe
Description: Output the SSH URL only.
Default: false
Does not accept a value

`all`

Option: --all
Description: Output all SSH URLs (for every app).
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`app`

Option: --app
Shortcut: -A
Description: The remote application name
Requires a value

`worker`

Option: --worker
Description: A worker name
Requires a value

`identity-file`

Option: --identity-file
Shortcut: -i
Description: An SSH identity (private key) to use
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

sync

Arguments

`synchronize`

Description: What to synchronize: “code”, “data” or both
Default: []
Array

Options

`rebase`

Option: --rebase
Description: Synchronize code by rebasing instead of merging
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

url

`integration:add`

Add an integration to the project

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-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--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] [--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]

`integration:delete`

Delete an integration from a project

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

Arguments

`id`

Description: The integration ID
Required

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`integration:get`

View details of an integration

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

Arguments

`id`

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

Options

`property`

Option: --property
Shortcut: -P
Description: The integration property to view
Accepts a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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)

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

integrations

`integration:update`

Update an integration

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-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--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] [--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`

Description: The ID of the integration to update
Required

Options

`type`

Option: --type
Description: The integration type (‘bitbucket’, ‘bitbucket_server’, ‘github’, ‘gitlab’, ‘hipchat’, ‘webhook’, ‘health.email’, ‘health.pagerduty’, ‘health.slack’)
Requires a value

`base-url`

Option: --base-url
Description: The base URL of the server installation
Requires a value

`username`

Option: --username
Description: The Bitbucket Server username
Requires a value

`token`

Option: --token
Description: An access token for the integration
Requires a value

`key`

Option: --key
Description: A Bitbucket OAuth consumer key
Requires a value

`secret`

Option: --secret
Description: A Bitbucket OAuth consumer secret
Requires a value

`server-project`

Option: --server-project
Description: The project (e.g. ‘namespace/repo’)
Requires a value

`repository`

Option: --repository
Description: The repository to track (e.g. ‘foo/bar’)
Requires a value

`build-merge-requests`

Option: --build-merge-requests
Description: GitLab: build merge requests as environments
Default: true
Requires a value

`build-pull-requests`

Option: --build-pull-requests
Description: Build every pull request as an environment
Default: true
Requires a value

`build-pull-requests-post-merge`

Option: --build-pull-requests-post-merge
Description: Build pull requests based on their post-merge state
Default: false
Requires a value

`merge-requests-clone-parent-data`

Option: --merge-requests-clone-parent-data
Description: GitLab: clone data for merge requests
Default: true
Requires a value

`pull-requests-clone-parent-data`

Option: --pull-requests-clone-parent-data
Description: Clone the parent environment’s data for pull requests
Default: true
Requires a value

`resync-pull-requests`

Option: --resync-pull-requests
Description: Re-sync pull request environment data on every build
Default: false
Requires a value

`fetch-branches`

Option: --fetch-branches
Description: Fetch all branches from the remote (as inactive environments)
Default: true
Requires a value

`prune-branches`

Option: --prune-branches
Description: Delete branches that do not exist on the remote
Default: true
Requires a value

`room`

Option: --room
Description: HipChat room ID
Requires a value

`url`

Option: --url
Description: Generic webhook: a URL to receive JSON data
Requires a value

`events`

Option: --events
Description: A list of events to report, e.g. environment.push
Default: *
Requires a value

`states`

Option: --states
Description: A list of states to report, e.g. pending, in_progress, complete
Default: complete
Requires a value

`environments`

Option: --environments
Description: The environment IDs to include
Default: *
Requires a value

`excluded-environments`

Option: --excluded-environments
Description: The environment IDs to exclude
Default: []
Requires a value

`from-address`

Option: --from-address
Description: The From address for alert emails
Requires a value

`recipients`

Option: --recipients
Description: The recipient email address(es)
Default: []
Requires a value

`channel`

Option: --channel
Description: The Slack channel
Requires a value

`routing-key`

Option: --routing-key
Description: The PagerDuty routing key
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`integration:validate`

Validate an existing integration

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

Arguments

`id`

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

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`local:build`

Build the current project locally

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

build

Arguments

`app`

Description: Specify application(s) to build
Default: []
Array

Options

`abslinks`

Option: --abslinks
Shortcut: -a
Description: Use absolute links
Default: false
Does not accept a value

`source`

Option: --source
Shortcut: -s
Description: The source directory. Defaults to the current project root.
Requires a value

`destination`

Option: --destination
Shortcut: -d
Description: The destination, to which the web root of each app will be symlinked. Default: _www
Requires a value

`copy`

Option: --copy
Shortcut: -c
Description: Copy to a build directory, instead of symlinking from the source
Default: false
Does not accept a value

`clone`

Option: --clone
Description: Use Git to clone the current HEAD to the build directory
Default: false
Does not accept a value

`run-deploy-hooks`

Option: --run-deploy-hooks
Description: Run deploy and/or post_deploy hooks
Default: false
Does not accept a value

`no-clean`

Option: --no-clean
Description: Do not remove old builds
Default: false
Does not accept a value

`no-archive`

Option: --no-archive
Description: Do not create or use a build archive
Default: false
Does not accept a value

`no-backup`

Option: --no-backup
Description: Do not back up the previous build
Default: false
Does not accept a value

`no-cache`

Option: --no-cache
Description: Disable caching
Default: false
Does not accept a value

`no-build-hooks`

Option: --no-build-hooks
Description: Do not run post-build hooks
Default: false
Does not accept a value

`no-deps`

Option: --no-deps
Description: Do not install build dependencies locally
Default: false
Does not accept a value

`working-copy`

Option: --working-copy
Description: 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`

Option: --concurrency
Description: Drush: set the number of concurrent projects that will be processed at the same time
Default: 4
Requires a value

`lock`

Option: --lock
Description: Drush: create or update a lock file (only available with Drush version 7+)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`local:clean`

Remove old project builds

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

clean

`local:dir`

Find the local project root

magento-cloud dir [<subdir>]

dir

Arguments

`subdir`

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

Options

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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]

`mount:list`

Get a list of mounts

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

mounts

`mount:size`

Check the disk usage of mounts

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]

`mount:upload`

Upload files to a mount, using rsync

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

`project:clear-build-cache`

Clear a project’s build cache

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

`project:curl`

Run a cURL request on a project’s API

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`

Description: The API path

Options

`request`

Option: --request
Shortcut: -X
Description: The request method to use
Requires a value

`data`

Option: --data
Shortcut: -d
Description: Data to send
Requires a value

`include`

Option: --include
Shortcut: -i
Description: Include headers in the output
Default: false
Does not accept a value

`head`

Option: --head
Shortcut: -I
Description: Fetch headers only
Default: false
Does not accept a value

`disable-compression`

Option: --disable-compression
Description: Do not use the curl –compressed flag
Default: false
Does not accept a value

`header`

Option: --header
Shortcut: -H
Description: Extra header(s)
Default: []
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`project:get`

Clone a project locally

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

get

Arguments

`project`

Description: The project ID

`directory`

Description: The directory to clone to. Defaults to the project title

Options

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID to clone. Defaults to ‘master’ or the first available environment
Requires a value

`depth`

Option: --depth
Description: Create a shallow clone: limit the number of commits in the history
Requires a value

`build`

Option: --build
Description: Build the project after cloning
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`identity-file`

Option: --identity-file
Shortcut: -i
Description: An SSH identity (private key) to use
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

project:metadata

Arguments

`property`

Description: The name of the property

`value`

Description: Set a new value for the property

Options

`refresh`

Option: --refresh
Description: Whether to refresh the cache
Default: false
Does not accept a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

projects

pro

`project:set-remote`

Set the remote project for the current Git repository

magento-cloud project:set-remote <project>

Arguments

`project`

Description: The project ID
Required

Options

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

Arguments

`name`

Description: The variable name
Required

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

project-variables

pvget

project:variable:list

Arguments

`name`

Description: The name of the variable

Options

`pipe`

Option: --pipe
Description: Output the full variable value only (a “name” must be specified)
Default: false
Does not accept a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

pvset

Arguments

`name`

Description: The variable name
Required

`value`

Description: The variable value
Required

Options

`json`

Option: --json
Description: Mark the value as JSON
Default: false
Does not accept a value

`no-visible-build`

Option: --no-visible-build
Description: Do not expose this variable at build time
Default: false
Does not accept a value

`no-visible-runtime`

Option: --no-visible-runtime
Description: Do not expose this variable at runtime
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

Arguments

`path`

Description: The path to the file
Required

Options

`commit`

Option: --commit
Shortcut: -c
Description: The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`repo:ls`

List files in the project repository

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

Arguments

`path`

Description: The path to a subdirectory

Options

`directories`

Option: --directories
Shortcut: -d
Description: Show directories only
Default: false
Does not accept a value

`files`

Option: --files
Shortcut: -f
Description: Show files only
Default: false
Does not accept a value

`git-style`

Option: --git-style
Description: Style output similar to “git ls-tree”
Default: false
Does not accept a value

`commit`

Option: --commit
Shortcut: -c
Description: The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`route:get`

View a resolved route

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`

Description: The route’s original URL

Options

`id`

Option: --id
Description: A route ID to select
Requires a value

`primary`

Option: --primary
Shortcut: -1
Description: Select the primary route
Default: false
Does not accept a value

`property`

Option: --property
Shortcut: -P
Description: The property to display
Requires a value

`refresh`

Option: --refresh
Description: Bypass the cache of routes
Default: false
Does not accept a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`app`

Option: --app
Shortcut: -A
Description: [Deprecated option, no longer used]
Requires a value

`identity-file`

Option: --identity-file
Shortcut: -i
Description: [Deprecated option, no longer used]
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`route:list`

List all routes for an environment

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

routes

environment:routes

Arguments

`environment`

Description: The environment ID

Options

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`self:install`

Install or update CLI configuration files

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

local:install

`self:stats`

View stats on GitHub package downloads

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

`self:update`

Update the CLI to the latest version

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

self-update

update

`service:list`

List services in the project

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

services

`service:mongo:dump`

Create a binary archive dump of data from MongoDB

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

mongodump

`service:mongo:export`

Export data from MongoDB

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

mongoexport

`service:mongo:restore`

Restore a binary archive dump of data into MongoDB

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

mongorestore

`service:mongo:shell`

Use the MongoDB shell

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

mongo

`service:redis-cli`

Access the Redis CLI

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

redis

Arguments

`args`

Description: Arguments to add to the Redis command

Options

`relationship`

Option: --relationship
Shortcut: -r
Description: The service relationship to use
Requires a value

`identity-file`

Option: --identity-file
Shortcut: -i
Description: An SSH identity (private key) to use
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`app`

Option: --app
Shortcut: -A
Description: The remote application name
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`snapshot:create`

Make a snapshot of an environment

magento-cloud snapshot:create [-p|--project PROJECT] [--host HOST] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]

backup

environment:backup

Arguments

`environment`

Description: The environment

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`snapshot:list`

List available snapshots of an environment

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]

snapshots

`snapshot:restore`

Restore an environment snapshot

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

environment:restore

Arguments

`snapshot`

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

Options

`target`

Option: --target
Description: The environment to restore to. Defaults to the snapshot’s current environment
Requires a value

`branch-from`

Option: --branch-from
Description: If the –target does not yet exist, this specifies the parent of the new environment
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

Arguments

`operation`

Description: The operation name
Required

Options

`variable`

Option: --variable
Description: A variable to set during the operation, in the format type:name=value
Default: []
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`ssh-key:add`

Add a new SSH key

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

Arguments

`path`

Description: The path to an existing SSH public key

Options

`name`

Option: --name
Description: A name to identify the key
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`ssh-key:delete`

Delete an SSH key

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

Arguments

`id`

Description: The ID of the SSH key to delete

Options

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

ssh-keys

`subscription:info`

Read or modify subscription properties

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`

Description: The name of the property

`value`

Description: Set a new value for the property

Options

`id`

Option: --id
Shortcut: -s
Description: The subscription ID
Requires a value

`date-fmt`

Option: --date-fmt
Description: The date format (as a PHP date format string)
Default: c
Requires a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`tunnel:close`

Close SSH tunnels

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

`tunnel:info`

View relationship info for SSH tunnels

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]

`tunnel:list`

List SSH tunnels

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

tunnels

`tunnel:open`

Open SSH tunnels to an app’s relationships

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

`tunnel:single`

Open a single SSH tunnel to an app relationship

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]

`user:add`

Add a user to the project

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

Arguments

`email`

Description: The user’s email address

Options

`role`

Option: --role
Shortcut: -r
Description: 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`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`user:delete`

Delete a user from the project

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

Arguments

`email`

Description: The user’s email address
Required

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`user:get`

View a user’s role(s)

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

user:role

Arguments

`email`

Description: The user’s email address

Options

`level`

Option: --level
Shortcut: -l
Description: The role level (‘project’ or ‘environment’)
Requires a value

`pipe`

Option: --pipe
Description: Output the role to stdout (after making any changes)
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`role`

Option: --role
Shortcut: -r
Description: [Deprecated: use user:update to change a user’s role(s)]
Requires a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`user:list`

List project users

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

users

`user:update`

Update user role(s) on a project

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

Arguments

`email`

Description: The user’s email address

Options

`role`

Option: --role
Shortcut: -r
Description: 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`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`variable:create`

Create a variable

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`

Description: The variable name

Options

`level`

Option: --level
Shortcut: -l
Description: The level at which to set the variable (‘project’ or ‘environment’)
Requires a value

`name`

Option: --name
Description: The variable name
Requires a value

`value`

Option: --value
Description: The variable’s value
Requires a value

`json`

Option: --json
Description: Whether the variable is JSON-formatted
Default: false
Requires a value

`sensitive`

Option: --sensitive
Description: Whether the variable is sensitive
Default: false
Requires a value

`prefix`

Option: --prefix
Description: The variable name’s prefix (e.g. ‘none’ or ‘env:’)
Default: none
Requires a value

`enabled`

Option: --enabled
Description: Whether the variable should be enabled
Default: true
Requires a value

`inheritable`

Option: --inheritable
Description: Whether the variable is inheritable by child environments
Default: true
Requires a value

`visible-build`

Option: --visible-build
Description: Whether the variable should be visible at build time
Default: true
Requires a value

`visible-runtime`

Option: --visible-runtime
Description: Whether the variable should be visible at runtime
Default: true
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`variable:delete`

Delete a variable

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

Arguments

`name`

Description: The variable name
Required

Options

`level`

Option: --level
Shortcut: -l
Description: The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

Arguments

`name`

Description: The name of the variable
Required

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

Arguments

`name`

Description: The name of the variable
Required

Options

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`variable:get`

View a variable

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

vget

Arguments

`name`

Description: The name of the variable

Options

`property`

Option: --property
Shortcut: -P
Description: View a single variable property
Requires a value

`level`

Option: --level
Shortcut: -l
Description: The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)
Requires a value

`format`

Option: --format
Description: The output format (“table”, “csv”, or “tsv”)
Default: table
Requires a value

`columns`

Option: --columns
Description: Columns to display (comma-separated list, or multiple values)
Default: []
Requires a value

`no-header`

Option: --no-header
Description: Do not output the table header
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`pipe`

Option: --pipe
Description: [Deprecated option] Output the variable value only
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`variable:list`

List variables

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

variables

var

`variable:set`

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

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

vset

Arguments

`name`

Description: The variable name
Required

`value`

Description: The variable value
Required

Options

`json`

Option: --json
Description: Mark the value as JSON
Default: false
Does not accept a value

`disabled`

Option: --disabled
Description: Mark the variable as disabled
Default: false
Does not accept a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: Answer “no” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`variable:update`

Update a variable

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`

Description: The variable name
Required

Options

`level`

Option: --level
Shortcut: -l
Description: The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)
Requires a value

`value`

Option: --value
Description: The variable’s value
Requires a value

`json`

Option: --json
Description: Whether the variable is JSON-formatted
Default: false
Requires a value

`sensitive`

Option: --sensitive
Description: Whether the variable is sensitive
Default: false
Requires a value

`enabled`

Option: --enabled
Description: Whether the variable should be enabled
Default: true
Requires a value

`inheritable`

Option: --inheritable
Description: Whether the variable is inheritable by child environments
Default: true
Requires a value

`visible-build`

Option: --visible-build
Description: Whether the variable should be visible at build time
Default: true
Requires a value

`visible-runtime`

Option: --visible-runtime
Description: Whether the variable should be visible at runtime
Default: true
Requires a value

`project`

Option: --project
Shortcut: -p
Description: The project ID or URL
Requires a value

`host`

Option: --host
Description: The project’s API hostname
Requires a value

`environment`

Option: --environment
Shortcut: -e
Description: The environment ID
Requires a value

`no-wait`

Option: --no-wait
Shortcut: -W
Description: Do not wait for the operation to complete
Default: false
Does not accept a value

`wait`

Option: --wait
Description: Wait for the operation to complete (default)
Default: false
Does not accept a value

`help`

Option: --help
Shortcut: -h
Description: Display this help message
Default: false
Does not accept a value

`quiet`

Option: --quiet
Shortcut: -q
Description: Do not output any message
Default: false
Does not accept a value

`verbose`

Option: --verbose
Shortcut: -v|-vv|-vvv
Description: Increase the verbosity of messages
Default: false
Does not accept a value

`version`

Option: --version
Shortcut: -V
Description: Display this application version
Default: false
Does not accept a value

`yes`

Option: --yes
Shortcut: -y
Description: Answer “yes” to any yes/no questions; disable interaction
Default: false
Does not accept a value

`no`

Option: --no
Shortcut: -n
Description: 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

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

workers

Nov 27th, 2019