Version: 1.44.0
This reference contains 119 commands available through the magento-cloud
command-line tool.
The initial list is auto generated using the magento-cloud list
command at Adobe Commerce on cloud infrastructure.
This reference is generated from the application codebase. To change the content, you can update the source code for the corresponding command implementation in the codebase repository and submit your changes for review. Another way is to Give us feedback (find the link at the upper right). For contribution guidelines, see Code Contributions.
clear-cache
Clear the CLI cache
magento-cloud clear-cache
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
decode
Decode an encoded string such as MAGENTO_CLOUD_VARIABLES
magento-cloud decode [-P|--property PROPERTY] [--] <value>
value
The variable value to decode
--property
, -P
The property to view within the variable
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
docs
Open the online documentation
magento-cloud docs [--browser BROWSER] [--pipe] [--] [<search>]...
search
Search term(s)
Default: []
Array
--browser
The browser to use to open the URL. Set 0 for none.
--pipe
Output the URL to stdout.
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
help
Displays help for a command
magento-cloud help [--format FORMAT] [--raw] [--] [<command_name>]
command_name
The command name
help
--format
The output format (txt, json, or md)
txt
--raw
To output raw command help
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
list
Lists commands
magento-cloud list [--raw] [--format FORMAT] [--all] [--] [<namespace>]
command
The command to execute
namespace
The namespace name
--raw
To output raw command list
false
--format
The output format (txt, xml, json, or md)
txt
--all
Show all commands, including hidden ones
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
multi
Execute a command on multiple projects
magento-cloud multi [-p|--projects PROJECTS] [--continue] [--sort SORT] [--reverse] [--] <cmd> (<cmd>)...
cmd
The command to execute
Default: []
Required
Array
--projects
, -p
A list of project IDs, separated by commas and/or whitespace
--continue
Continue running commands even if an exception is encountered
false
--sort
A property by which to sort the list of project options
title
--reverse
Reverse the order of project options
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
web
Open the Web UI
magento-cloud web [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]
--browser
The browser to use to open the URL. Set 0 for none.
--pipe
Output the URL to stdout.
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
activity:cancel
Cancel an activity
magento-cloud activity:cancel [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]
id
The activity ID. Defaults to the most recent cancellable activity.
--type
, -t
Filter by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard for the type, e.g. ‘%var%’ to select variable-related activities.
[]
--exclude-type
, -x
Exclude by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard to exclude types.
[]
--all
, -a
Check recent activities on all environments (when selecting a default activity)
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
activity:get
View detailed information on a single activity
magento-cloud activity:get [-P|--property PROPERTY] [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<id>]
id
The activity ID. Defaults to the most recent activity.
--property
, -P
The property to view
--type
, -t
Filter by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard for the type, e.g. ‘%var%’ to select variable-related activities.
[]
--exclude-type
, -x
Exclude by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard to exclude types.
[]
--state
Filter by state (when selecting a default activity): in_progress, pending, complete, or cancelled. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--result
Filter by result (when selecting a default activity): success or failure
--incomplete
, -i
Include only incomplete activities (when selecting a default activity). This is a shorthand for <info>–state=in_progress,pending</info>
false
--all
, -a
Check recent activities on all environments (when selecting a default activity)
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
activity:list
Get a list of activities for an environment or project
magento-cloud activity:list [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMIT] [--start START] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]
--type
, -t
Filter activities by type Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The first part of the activity name can be omitted, e.g. ‘cron’ can select ‘environment.cron’ activities. The % or * characters can be used as a wildcard, e.g. ‘%var%’ to select variable-related activities.
[]
--exclude-type
, -x
Exclude activities by type. Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The first part of the activity name can be omitted, e.g. ‘cron’ can exclude ‘environment.cron’ activities. The % or * characters can be used as a wildcard to exclude types.
[]
--limit
Limit the number of results displayed
10
--start
Only activities created before this date will be listed
--state
Filter activities by state: in_progress, pending, complete, or cancelled. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--result
Filter activities by result: success or failure
--incomplete
, -i
Only list incomplete activities
false
--all
, -a
List activities on all environments
false
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: id*, created*, description*, progress*, state*, result*, completed, environments, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
activity:log
Display the log for an activity
magento-cloud activity:log [--refresh REFRESH] [-t|--timestamps] [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]
id
The activity ID. Defaults to the most recent activity.
--refresh
Activity refresh interval (seconds). Set to 0 to disable refreshing.
3
--timestamps
, -t
Display a timestamp next to each message
false
--type
Filter by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard for the type, e.g. ‘%var%’ to select variable-related activities.
[]
--exclude-type
, -x
Exclude by type (when selecting a default activity). Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard to exclude types.
[]
--state
Filter by state (when selecting a default activity): in_progress, pending, complete, or cancelled. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--result
Filter by result (when selecting a default activity): success or failure
--incomplete
, -i
Include only incomplete activities (when selecting a default activity). This is a shorthand for <info>–state=in_progress,pending</info>
false
--all
, -a
Check recent activities on all environments (when selecting a default activity)
false
--date-fmt
The date format (as a PHP date format string)
c
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
app:config-get
View the configuration of an app
magento-cloud app:config-get [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE]
--property
, -P
The configuration property to view
--refresh
Whether to refresh the cache
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--identity-file
, -i
[Deprecated option, no longer used]
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
app:list
List apps in the project
magento-cloud app:list [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]
--refresh
Whether to refresh the cache
false
--pipe
Output a list of app names only
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: name*, type*, disk, path, size (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
auth:api-token-login
Log in to Magento Cloud using an API token
magento-cloud auth:api-token-login
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
auth:browser-login
Log in to Magento Cloud via a browser
magento-cloud auth:browser-login [-f|--force] [--browser BROWSER] [--pipe]
--force
, -f
Log in again, even if already logged in
false
--browser
The browser to use to open the URL. Set 0 for none.
--pipe
Output the URL to stdout.
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
auth:info
Display your account information
magento-cloud auth:info [--no-auto-login] [-P|--property PROPERTY] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--] [<property>]
property
The account property to view
--no-auto-login
Skips auto login. Nothing will be output if not logged in, and the exit code will be 0, assuming no other errors.
false
--property
, -P
The account property to view (alternate syntax)
--refresh
Whether to refresh the cache
false
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
auth:logout
Log out of Magento Cloud
magento-cloud auth:logout [-a|--all] [--other]
--all
, -a
Log out from all local sessions
false
--other
Log out from other local sessions
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
blackfire:setup
Setup Blackfire.io integration for the project
magento-cloud blackfire:setup [--server_id SERVER_ID] [--server_token SERVER_TOKEN] [-p|--project PROJECT] [-W|--no-wait] [--wait]
--server_id
The server id
--server_token
The server token
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
certificate:add
Add an SSL certificate to the project
magento-cloud certificate:add [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [-W|--no-wait] [--wait]
--cert
The path to the certificate file
--key
The path to the certificate private key file
--chain
The path to the certificate chain file
[]
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
certificate:delete
Delete a certificate from the project
magento-cloud certificate:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] <id>
id
The certificate ID (or the start of it)
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
certificate:get
View a certificate
magento-cloud certificate:get [-P|--property PROPERTY] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--] <id>
id
The certificate ID (or the start of it)
--property
, -P
The certificate property to view
--date-fmt
The date format (as a PHP date format string)
c
--project
, -p
The project ID or URL
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
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] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]
--domain
Filter by domain name (case-insensitive search)
--exclude-domain
Exclude certificates, matching by domain name (case-insensitive search)
--issuer
Filter by issuer
--only-auto
Show only auto-provisioned certificates
false
--no-auto
Show only manually added certificates
false
--ignore-expiry
Show both expired and non-expired certificates
false
--only-expired
Show only expired certificates
false
--no-expired
Show only non-expired certificates (default)
false
--pipe-domains
Only return a list of domain names covered by the certificates
false
--date-fmt
The date format (as a PHP date format string)
c
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: created, domains, expires, id, issuer. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
commit:get
Show commit details
magento-cloud commit:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--date-fmt DATE-FMT] [--] [<commit>]
commit
The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.
HEAD
--property
, -P
The commit property to display.
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
commit:list
List commits
magento-cloud commit:list [--limit LIMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<commit>]
commit
The starting Git commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.
--limit
The number of commits to display.
10
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: author, date, sha, summary. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
db:dump
Create a local dump of the remote database
magento-cloud db:dump [--schema SCHEMA] [-f|--file FILE] [-d|--directory DIRECTORY] [-z|--gzip] [-t|--timestamp] [-o|--stdout] [--table TABLE] [--exclude-table EXCLUDE-TABLE] [--schema-only] [--charset CHARSET] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE]
--schema
The schema to dump. Omit to use the default schema (usually “main”).
--file
, -f
A custom filename for the dump
--directory
, -d
A custom directory for the dump
--gzip
, -z
Compress the dump using gzip
false
--timestamp
, -t
Add a timestamp to the dump filename
false
--stdout
, -o
Output to STDOUT instead of a file
false
--table
Table(s) to include
[]
--exclude-table
Table(s) to exclude
[]
--schema-only
Dump only schemas, no data
false
--charset
The character set encoding for the dump
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--relationship
, -r
The service relationship to use
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
db:size
Estimate the disk usage of a database
magento-cloud db:size [-B|--bytes] [-C|--cleanup] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-i|--identity-file IDENTITY-FILE]
--bytes
, -B
Show sizes in bytes.
false
--cleanup
, -C
Check if tables can be cleaned up and show me recommendations (InnoDb only).
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--relationship
, -r
The service relationship to use
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: max, percent_used, used. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
db:sql
Run SQL on the remote database
magento-cloud db:sql [--raw] [--schema SCHEMA] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [--] [<query>]
query
An SQL statement to execute
--raw
Produce raw, non-tabular output
false
--schema
The schema to use. Omit to use the default schema (usually “main”). Pass an empty string to not use any schema.
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--relationship
, -r
The service relationship to use
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
domain:add
Add a new domain to the project
magento-cloud domain:add [--cert CERT] [--key KEY] [--chain CHAIN] [--attach ATTACH] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>
name
The domain name
--cert
The path to the certificate file for this domain
--key
The path to the private key file for the provided certificate.
--chain
The path to the certificate chain file or files for the provided certificate
[]
--attach
The production domain that this one replaces in the environment’s routes. Required for non-production environment domains.
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
domain:delete
Delete a domain from the project
magento-cloud domain:delete [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>
name
The domain name
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
domain:get
Show detailed information for a domain
magento-cloud domain:get [-P|--property PROPERTY] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<name>]
name
The domain name
--property
, -P
The domain property to view
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
domain:list
Get a list of all domains
magento-cloud domain:list [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: name*, ssl*, created_at*, registered_name, replacement_for, type, updated_at (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
domain:update
Update a domain
magento-cloud domain:update [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>
name
The domain name
--cert
The path to the certificate file for this domain
--key
The path to the private key file for the provided certificate.
--chain
The path to the certificate chain file or files for the provided certificate
[]
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:activate
Activate an environment
magento-cloud environment:activate [--parent PARENT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]...
environment
The environment(s) to activate
Default: []
Array
--parent
Set a new environment parent before activating
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:branch
Branch an environment
magento-cloud branch [--title TITLE] [--type TYPE] [--no-clone-parent] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<id>] [<parent>]
id
The ID (branch name) of the new environment
parent
The parent of the new environment
--title
The title of the new environment
--type
The type of the new environment
--no-clone-parent
Do not clone the parent environment’s data
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:checkout
Check out an environment
magento-cloud environment:checkout [-i|--identity-file IDENTITY-FILE] [--] [<id>]
id
The ID of the environment to check out. For example: “sprint2”
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:delete
Delete one or more environments
magento-cloud environment:delete [--delete-branch] [--no-delete-branch] [--type TYPE] [-t|--only-type ONLY-TYPE] [--exclude EXCLUDE] [--exclude-type EXCLUDE-TYPE] [--inactive] [--merged] [--allow-delete-parent] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]...
environment
The environment(s) to delete. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
Default: []
Array
--delete-branch
Delete Git branch(es) for inactive environments, without confirmation
false
--no-delete-branch
Do not delete any Git branch(es) (inactive environments)
false
--type
Delete all environments of a type (adding to any others selected) Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--only-type
, -t
Only delete environments of a specific type Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--exclude
Environment(s) not to delete. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--exclude-type
Environment type(s) of which not to delete Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--inactive
Delete all inactive environments (adding to any others selected)
false
--merged
Delete all merged environments (adding to any others selected)
false
--allow-delete-parent
Allow environments that have children to be deleted
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:http-access
Update HTTP access settings for an environment
magento-cloud environment:http-access [--access ACCESS] [--auth AUTH] [--enabled ENABLED] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]
--access
Access restriction in the format “permission:address”. Use 0 to clear all addresses.
[]
--auth
HTTP Basic auth credentials in the format “username:password”. Use 0 to clear all credentials.
[]
--enabled
Whether access control should be enabled: 1 to enable, 0 to disable
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:info
Read or set properties for an environment
magento-cloud environment:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<property>] [<value>]
property
The name of the property
value
Set a new value for the property
--refresh
Whether to refresh the cache
false
--date-fmt
The date format (as a PHP date format string)
c
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:init
Initialize an environment from a public Git repository
magento-cloud environment:init [--profile PROFILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <url>
url
A URL to a Git repository
--profile
The name of the profile
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:list
Get a list of environments
magento-cloud environment:list [-I|--no-inactive] [--pipe] [--refresh REFRESH] [--sort SORT] [--reverse] [--type TYPE] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]
--no-inactive
, -I
Do not show inactive environments
false
--pipe
Output a simple list of environment IDs.
false
--refresh
Whether to refresh the list.
1
--sort
A property to sort by
title
--reverse
Sort in reverse (descending) order
false
--type
Filter the list by environment type(s). Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: id*, title*, status*, type*, created, machine_name, updated (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:logs
Read an environment’s logs
magento-cloud environment:logs [--lines LINES] [--tail] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [--] [<type>]
type
The log type, e.g. “access” or “error”
--lines
The number of lines to show
100
--tail
Continuously tail the log
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--instance
, -I
An instance ID
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:merge
Merge an environment
magento-cloud environment:merge [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]
environment
The environment to merge
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:pause
Pause an environment
magento-cloud environment:pause [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:push
Push code to an environment
magento-cloud environment:push [--target TARGET] [-f|--force] [--force-with-lease] [-u|--set-upstream] [--activate] [--parent PARENT] [--type TYPE] [--no-clone-parent] [-W|--no-wait] [--wait] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-i|--identity-file IDENTITY-FILE] [--] [<source>]
source
The source ref: a branch name or commit hash
HEAD
--target
The target branch name
--force
, -f
Allow non-fast-forward updates
false
--force-with-lease
Allow non-fast-forward updates, if the remote-tracking branch is up to date
false
--set-upstream
, -u
Set the target environment as the upstream for the source branch
false
--activate
Activate the environment before pushing
false
--parent
Set the new environment parent (only used with --activate)
--type
Set the environment type (only used with --activate )
--no-clone-parent
Do not clone the parent branch’s data (only used with --activate)
false
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:redeploy
Redeploy an environment
magento-cloud environment:redeploy [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:relationships
Show an environment’s relationships
magento-cloud environment:relationships [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE] [--] [<environment>]
environment
The environment
--property
, -P
The relationship property to view
--refresh
Whether to refresh the relationships
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:resume
Resume a paused environment
magento-cloud environment:resume [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:scp
Copy files to and from an environment using scp
magento-cloud environment:scp [-r|--recursive] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE] [--] [<files>]...
files
Files to copy. Use the remote: prefix to define remote locations.
Default: []
Array
--recursive
, -r
Recursively copy entire directories
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--instance
, -I
An instance ID
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:ssh
SSH to the current environment
magento-cloud environment:ssh [--pipe] [--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE] [--] [<cmd>]...
cmd
A command to run on the environment.
Default: []
Array
--pipe
Output the SSH URL only.
false
--all
Output all SSH URLs (for every app).
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--instance
, -I
An instance ID
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:synchronize
Synchronize an environment’s code and/or data from its parent
magento-cloud environment:synchronize [--rebase] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<synchronize>]...
synchronize
What to synchronize: “code”, “data” or both
Default: []
Array
--rebase
Synchronize code by rebasing instead of merging
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:url
Get the public URLs of an environment
magento-cloud environment:url [-1|--primary] [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]
--primary
, -1
Only return the URL for the primary route
false
--browser
The browser to use to open the URL. Set 0 for none.
--pipe
Output the URL to stdout.
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
environment:xdebug
Open a tunnel to Xdebug on the environment
magento-cloud environment:xdebug [--port PORT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE]
--port
The local port
9000
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--instance
, -I
An instance ID
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
integration:activity:get
View detailed information on a single integration activity
magento-cloud integration:activity:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<integration>] [<activity>]
integration
An integration ID. Leave blank to choose from a list.
activity
The activity ID. Defaults to the most recent integration activity.
--property
, -P
The property to view
--project
, -p
The project ID or URL
--environment
, -e
[Deprecated option, not used]
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
integration:activity:list
Get a list of activities for an integration
magento-cloud integration:activity:list [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMIT] [--start START] [--state STATE] [--result RESULT] [-i|--incomplete] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]
id
An integration ID. Leave blank to choose from a list.
--type
Filter activities by type. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--exclude-type
, -x
Exclude activities by type. Values may be split by commas (e.g. “a,b,c”) and/or whitespace. The % or * characters can be used as a wildcard to exclude types.
[]
--limit
Limit the number of results displayed
10
--start
Only activities created before this date will be listed
--state
Filter activities by state. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--result
Filter activities by result
--incomplete
, -i
Only list incomplete activities
false
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: id*, created*, description*, type*, state*, result*, completed (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--project
, -p
The project ID or URL
--environment
, -e
[Deprecated option, not used]
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
integration:activity:log
Display the log for an integration activity
magento-cloud integration:activity:log [-t|--timestamps] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<integration>] [<activity>]
integration
An integration ID. Leave blank to choose from a list.
activity
The activity ID. Defaults to the most recent integration activity.
--timestamps
, -t
Display a timestamp next to each message
false
--date-fmt
The date format (as a PHP date format string)
c
--project
, -p
The project ID or URL
--environment
, -e
[Deprecated option, not used]
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
integration:add
Add an integration to the project
magento-cloud integration:add [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BITBUCKET-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--license-key LICENSE-KEY] [--server-project SERVER-PROJECT] [--repository REPOSITORY] [--build-merge-requests BUILD-MERGE-REQUESTS] [--build-pull-requests BUILD-PULL-REQUESTS] [--build-draft-pull-requests BUILD-DRAFT-PULL-REQUESTS] [--build-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--build-wip-merge-requests BUILD-WIP-MERGE-REQUESTS] [--merge-requests-clone-parent-data MERGE-REQUESTS-CLONE-PARENT-DATA] [--pull-requests-clone-parent-data PULL-REQUESTS-CLONE-PARENT-DATA] [--resync-pull-requests RESYNC-PULL-REQUESTS] [--fetch-branches FETCH-BRANCHES] [--prune-branches PRUNE-BRANCHES] [--url URL] [--shared-key SHARED-KEY] [--file FILE] [--events EVENTS] [--states STATES] [--environments ENVIRONMENTS] [--excluded-environments EXCLUDED-ENVIRONMENTS] [--from-address FROM-ADDRESS] [--recipients RECIPIENTS] [--channel CHANNEL] [--routing-key ROUTING-KEY] [--category CATEGORY] [--index INDEX] [--sourcetype SOURCETYPE] [--protocol PROTOCOL] [--syslog-host SYSLOG-HOST] [--syslog-port SYSLOG-PORT] [--facility FACILITY] [--message-format MESSAGE-FORMAT] [--auth-mode AUTH-MODE] [--auth-token AUTH-TOKEN] [--verify-tls VERIFY-TLS] [--header HEADER] [-p|--project PROJECT] [-W|--no-wait] [--wait]
--type
The integration type (‘bitbucket’, ‘bitbucket_server’, ‘github’, ‘gitlab’, ‘webhook’, ‘health.email’, ‘health.pagerduty’, ‘health.slack’, ‘health.webhook’, ‘httplog’, ‘script’, ‘newrelic’, ‘splunk’, ‘sumologic’, ‘syslog’)
--base-url
The base URL of the server installation
--bitbucket-url
The base URL of the Bitbucket Server installation
--username
The Bitbucket Server username
--token
An authentication or access token for the integration
--key
A Bitbucket OAuth consumer key
--secret
A Bitbucket OAuth consumer secret
--license-key
The New Relic Logs license key
--server-project
The project (e.g. ‘namespace/repo’)
--repository
The repository to track (e.g. ‘owner/repository’)
--build-merge-requests
GitLab: build merge requests as environments
true
--build-pull-requests
Build every pull request as an environment
true
--build-draft-pull-requests
Build draft pull requests
true
--build-pull-requests-post-merge
Build pull requests based on their post-merge state
false
--build-wip-merge-requests
GitLab: build WIP merge requests
true
--merge-requests-clone-parent-data
GitLab: clone data for merge requests
true
--pull-requests-clone-parent-data
Clone the parent environment’s data for pull requests
true
--resync-pull-requests
Re-sync pull request environment data on every build
false
--fetch-branches
Fetch all branches from the remote (as inactive environments)
true
--prune-branches
Delete branches that do not exist on the remote
true
--url
The URL or API endpoint for the integration
--shared-key
Webhook: the JWS shared secret key
--file
The name of a local file that contains the script to upload
--events
A list of events to act on, e.g. environment.push
*
--states
A list of states to act on, e.g. pending, in_progress, complete
complete
--environments
The environment IDs to include
*
--excluded-environments
The environment IDs to exclude
[]
--from-address
[Optional] Custom From address for alert emails
--recipients
The recipient email address(es)
[]
--channel
The Slack channel
--routing-key
The PagerDuty routing key
--category
The Sumo Logic category, used for filtering
--index
The Splunk index
--sourcetype
The Splunk event source type
--protocol
Syslog transport protocol (‘tcp’, ‘udp’, ‘tls’)
tls
--syslog-host
Syslog relay/collector host
--syslog-port
Syslog relay/collector port
--facility
Syslog facility
1
--message-format
Syslog message format (‘rfc3164’ or ‘rfc5424’)
rfc5424
--auth-mode
Authentication mode (‘prefix’ or ‘structured_data’)
prefix
--auth-token
Authentication token
--verify-tls
Whether HTTPS certificate verification should be enabled (recommended)
true
--header
HTTP header(s) to use in POST requests. Separate names and values with a colon (:).
[]
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
integration:delete
Delete an integration from a project
magento-cloud integration:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<id>]
id
The integration ID. Leave blank to choose from a list.
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
integration:get
View details of an integration
magento-cloud integration:get [-P|--property [PROPERTY]] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--] [<id>]
id
An integration ID. Leave blank to choose from a list.
--property
, -P
The integration property to view
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
integration:list
View a list of project integration(s)
magento-cloud integration:list [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: id, summary, type. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
integration:update
Update an integration
magento-cloud integration:update [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BITBUCKET-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--license-key LICENSE-KEY] [--server-project SERVER-PROJECT] [--repository REPOSITORY] [--build-merge-requests BUILD-MERGE-REQUESTS] [--build-pull-requests BUILD-PULL-REQUESTS] [--build-draft-pull-requests BUILD-DRAFT-PULL-REQUESTS] [--build-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--build-wip-merge-requests BUILD-WIP-MERGE-REQUESTS] [--merge-requests-clone-parent-data MERGE-REQUESTS-CLONE-PARENT-DATA] [--pull-requests-clone-parent-data PULL-REQUESTS-CLONE-PARENT-DATA] [--resync-pull-requests RESYNC-PULL-REQUESTS] [--fetch-branches FETCH-BRANCHES] [--prune-branches PRUNE-BRANCHES] [--url URL] [--shared-key SHARED-KEY] [--file FILE] [--events EVENTS] [--states STATES] [--environments ENVIRONMENTS] [--excluded-environments EXCLUDED-ENVIRONMENTS] [--from-address FROM-ADDRESS] [--recipients RECIPIENTS] [--channel CHANNEL] [--routing-key ROUTING-KEY] [--category CATEGORY] [--index INDEX] [--sourcetype SOURCETYPE] [--protocol PROTOCOL] [--syslog-host SYSLOG-HOST] [--syslog-port SYSLOG-PORT] [--facility FACILITY] [--message-format MESSAGE-FORMAT] [--auth-mode AUTH-MODE] [--auth-token AUTH-TOKEN] [--verify-tls VERIFY-TLS] [--header HEADER] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<id>]
id
The ID of the integration to update
--type
The integration type (‘bitbucket’, ‘bitbucket_server’, ‘github’, ‘gitlab’, ‘webhook’, ‘health.email’, ‘health.pagerduty’, ‘health.slack’, ‘health.webhook’, ‘httplog’, ‘script’, ‘newrelic’, ‘splunk’, ‘sumologic’, ‘syslog’)
--base-url
The base URL of the server installation
--bitbucket-url
The base URL of the Bitbucket Server installation
--username
The Bitbucket Server username
--token
An authentication or access token for the integration
--key
A Bitbucket OAuth consumer key
--secret
A Bitbucket OAuth consumer secret
--license-key
The New Relic Logs license key
--server-project
The project (e.g. ‘namespace/repo’)
--repository
The repository to track (e.g. ‘owner/repository’)
--build-merge-requests
GitLab: build merge requests as environments
true
--build-pull-requests
Build every pull request as an environment
true
--build-draft-pull-requests
Build draft pull requests
true
--build-pull-requests-post-merge
Build pull requests based on their post-merge state
false
--build-wip-merge-requests
GitLab: build WIP merge requests
true
--merge-requests-clone-parent-data
GitLab: clone data for merge requests
true
--pull-requests-clone-parent-data
Clone the parent environment’s data for pull requests
true
--resync-pull-requests
Re-sync pull request environment data on every build
false
--fetch-branches
Fetch all branches from the remote (as inactive environments)
true
--prune-branches
Delete branches that do not exist on the remote
true
--url
The URL or API endpoint for the integration
--shared-key
Webhook: the JWS shared secret key
--file
The name of a local file that contains the script to upload
--events
A list of events to act on, e.g. environment.push
*
--states
A list of states to act on, e.g. pending, in_progress, complete
complete
--environments
The environment IDs to include
*
--excluded-environments
The environment IDs to exclude
[]
--from-address
[Optional] Custom From address for alert emails
--recipients
The recipient email address(es)
[]
--channel
The Slack channel
--routing-key
The PagerDuty routing key
--category
The Sumo Logic category, used for filtering
--index
The Splunk index
--sourcetype
The Splunk event source type
--protocol
Syslog transport protocol (‘tcp’, ‘udp’, ‘tls’)
tls
--syslog-host
Syslog relay/collector host
--syslog-port
Syslog relay/collector port
--facility
Syslog facility
1
--message-format
Syslog message format (‘rfc3164’ or ‘rfc5424’)
rfc5424
--auth-mode
Authentication mode (‘prefix’ or ‘structured_data’)
prefix
--auth-token
Authentication token
--verify-tls
Whether HTTPS certificate verification should be enabled (recommended)
true
--header
HTTP header(s) to use in POST requests. Separate names and values with a colon (:).
[]
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
integration:validate
Validate an existing integration
magento-cloud integration:validate [-p|--project PROJECT] [--] [<id>]
id
An integration ID. Leave blank to choose from a list.
--project
, -p
The project ID or URL
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
local:build
Build the current project locally
magento-cloud local:build [-a|--abslinks] [-s|--source SOURCE] [-d|--destination DESTINATION] [-c|--copy] [--clone] [--run-deploy-hooks] [--no-clean] [--no-archive] [--no-backup] [--no-cache] [--no-build-hooks] [--no-deps] [--working-copy] [--concurrency CONCURRENCY] [--lock] [--] [<app>]...
app
Specify application(s) to build
Default: []
Array
--abslinks
, -a
Use absolute links
false
--source
, -s
The source directory. Defaults to the current project root.
--destination
, -d
The destination, to which the web root of each app will be symlinked. Default: _www
--copy
, -c
Copy to a build directory, instead of symlinking from the source
false
--clone
Use Git to clone the current HEAD to the build directory
false
--run-deploy-hooks
Run deploy and/or post_deploy hooks
false
--no-clean
Do not remove old builds
false
--no-archive
Do not create or use a build archive
false
--no-backup
Do not back up the previous build
false
--no-cache
Disable caching
false
--no-build-hooks
Do not run post-build hooks
false
--no-deps
Do not install build dependencies locally
false
--working-copy
Drush: use git to clone a repository of each Drupal module rather than simply downloading a version
false
--concurrency
Drush: set the number of concurrent projects that will be processed at the same time
4
--lock
Drush: create or update a lock file (only available with Drush version 7+)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
local:dir
Find the local project root
magento-cloud local:dir [<subdir>]
subdir
The subdirectory to find (‘local’, ‘web’ or ‘shared’)
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
metrics:all
<fg=white;bg=red> BETA </> Show CPU, disk and memory metrics for an environment
magento-cloud metrics [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]
--range
, -r
The time range. Metrics will be loaded for this duration until the end time (–to). You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>5m</comment>, maximum <comment>8h</comment> or more (depending on the project), default <comment>10m</comment>.
--interval
, -i
The time interval. Defaults to a division of the range. You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>1m</comment>, maximum <comment>1h</comment>.
--to
The end time. Defaults to now.
--latest
, -1
Show only the latest single data point
false
--service
, -s
Filter by service or application name The % or * characters may be used as a wildcard.
[]
--type
Filter by service type (if --service is not provided). The version is not required. The % or * characters may be used as a wildcard.
[]
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: timestamp*, service*, cpu_percent*, mem_percent*, disk_percent*, tmp_disk_percent*, cpu_limit, cpu_used, disk_limit, disk_used, inodes_limit, inodes_percent, inodes_used, mem_limit, mem_used, tmp_disk_limit, tmp_disk_used, tmp_inodes_limit, tmp_inodes_percent, tmp_inodes_used, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
metrics:cpu
<fg=white;bg=red> BETA </> Show CPU usage of an environment
magento-cloud metrics:cpu [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]
--range
, -r
The time range. Metrics will be loaded for this duration until the end time (–to). You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>5m</comment>, maximum <comment>8h</comment> or more (depending on the project), default <comment>10m</comment>.
--interval
, -i
The time interval. Defaults to a division of the range. You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>1m</comment>, maximum <comment>1h</comment>.
--to
The end time. Defaults to now.
--latest
, -1
Show only the latest single data point
false
--service
, -s
Filter by service or application name The % or * characters may be used as a wildcard.
[]
--type
Filter by service type (if --service is not provided). The version is not required. The % or * characters may be used as a wildcard.
[]
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: timestamp*, service*, used*, limit*, percent*, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
metrics:disk-usage
Show disk usage of an environment
magento-cloud metrics:disk-usage [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [--tmp] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]
--bytes
, -B
Show sizes in bytes
false
--range
, -r
The time range. Metrics will be loaded for this duration until the end time (–to). You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>5m</comment>, maximum <comment>8h</comment> or more (depending on the project), default <comment>10m</comment>.
--interval
, -i
The time interval. Defaults to a division of the range. You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>1m</comment>, maximum <comment>1h</comment>.
--to
The end time. Defaults to now.
--latest
, -1
Show only the latest single data point
false
--service
, -s
Filter by service or application name The % or * characters may be used as a wildcard.
[]
--type
Filter by service type (if --service is not provided). The version is not required. The % or * characters may be used as a wildcard.
[]
--tmp
Report temporary disk usage (shows columns: timestamp, service, tmp_used, tmp_limit, tmp_percent, tmp_ipercent)
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: timestamp*, service*, used*, limit*, percent*, ipercent*, tmp_percent*, ilimit, iused, tmp_ilimit, tmp_ipercent, tmp_iused, tmp_limit, tmp_used, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
metrics:memory
<fg=white;bg=red> BETA </> Show memory usage of an environment
magento-cloud metrics:memory [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]
--bytes
, -B
Show sizes in bytes
false
--range
, -r
The time range. Metrics will be loaded for this duration until the end time (–to). You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>5m</comment>, maximum <comment>8h</comment> or more (depending on the project), default <comment>10m</comment>.
--interval
, -i
The time interval. Defaults to a division of the range. You can specify units: hours (h), minutes (m), or seconds (s). Minimum <comment>1m</comment>, maximum <comment>1h</comment>.
--to
The end time. Defaults to now.
--latest
, -1
Show only the latest single data point
false
--service
, -s
Filter by service or application name The % or * characters may be used as a wildcard.
[]
--type
Filter by service type (if --service is not provided). The version is not required. The % or * characters may be used as a wildcard.
[]
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: timestamp*, service*, used*, limit*, percent*, type (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
mount:download
Download files from a mount, using rsync
magento-cloud mount:download [-a|--all] [-m|--mount MOUNT] [--target TARGET] [--source-path] [--delete] [--exclude EXCLUDE] [--include INCLUDE] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE]
--all
, -a
Download from all mounts
false
--mount
, -m
The mount (as an app-relative path)
--target
The directory to which files will be downloaded. If --all is used, the mount path will be appended
--source-path
Use the mount’s source path (rather than the mount path) as a subdirectory of the target, when --all is used
false
--delete
Whether to delete extraneous files in the target directory
false
--exclude
File(s) to exclude from the download (pattern)
[]
--include
File(s) to include in the download (pattern)
[]
--refresh
Whether to refresh the cache
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--instance
, -I
An instance ID
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
mount:list
Get a list of mounts
magento-cloud mount:list [--paths] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]
--paths
Output the mount paths only (one per line)
false
--refresh
Whether to refresh the cache
false
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: definition, path. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--instance
, -I
An instance ID
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
mount:size
Check the disk usage of mounts
magento-cloud mount:size [-B|--bytes] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]
--bytes
, -B
Show sizes in bytes
false
--refresh
Refresh the cache
false
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: available, max, mounts, percent_used, sizes, used. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--identity-file
, -i
An SSH identity (private key) to use
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--instance
, -I
An instance ID
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
mount:upload
Upload files to a mount, using rsync
magento-cloud mount:upload [--source SOURCE] [-m|--mount MOUNT] [--delete] [--exclude EXCLUDE] [--include INCLUDE] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE]
--source
A directory containing files to upload
--mount
, -m
The mount (as an app-relative path)
--delete
Whether to delete extraneous files in the mount
false
--exclude
File(s) to exclude from the upload (pattern)
[]
--include
File(s) to include in the upload (pattern)
[]
--refresh
Whether to refresh the cache
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--instance
, -I
An instance ID
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
operation:list
<fg=white;bg=red> BETA </> List runtime operations on an environment
magento-cloud operation:list [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]
--full
Do not limit the length of command to display. The default limit is 24 lines.
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: service*, name*, start*, role, stop (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
operation:run
<fg=white;bg=red> BETA </> Run an operation on the environment
magento-cloud operation:run [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-W|--no-wait] [--wait] [--] [<operation>]
operation
The operation name
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--worker
A worker name
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
project:clear-build-cache
Clear a project’s build cache
magento-cloud project:clear-build-cache [-p|--project PROJECT]
--project
, -p
The project ID or URL
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
project:get
Clone a project locally
magento-cloud project:get [-e|--environment ENVIRONMENT] [--depth DEPTH] [--build] [-p|--project PROJECT] [-i|--identity-file IDENTITY-FILE] [--] [<project>] [<directory>]
project
The project ID
directory
The directory to clone to. Defaults to the project title
--environment
, -e
The environment ID to clone. Defaults to the project default, or the first available environment
--depth
Create a shallow clone: limit the number of commits in the history
--build
Build the project after cloning
false
--project
, -p
The project ID or URL
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
project:info
Read or set properties for a project
magento-cloud project:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<property>] [<value>]
property
The name of the property
value
Set a new value for the property
--refresh
Whether to refresh the cache
false
--date-fmt
The date format (as a PHP date format string)
c
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
project:list
Get a list of all active projects
magento-cloud project:list [--pipe] [--host HOST] [--title TITLE] [--my] [--refresh REFRESH] [--sort SORT] [--reverse] [--page PAGE] [-c|--count COUNT] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]
--pipe
Output a simple list of project IDs. Disables pagination.
false
--host
Filter by region hostname (exact match)
--title
Filter by title (case-insensitive search)
--my
Display only the projects you own
false
--refresh
Whether to refresh the list
1
--sort
A property to sort by
title
--reverse
Sort in reverse (descending) order
false
--page
Page number. This enables pagination, despite configuration or --count. Ignored if --pipe is specified.
--count
, -c
The number of projects to display per page. Use 0 to disable pagination. Ignored if --page is specified.
--format
The output format: table, csv, tsv, or plain
table
--columns
Columns to display. Available columns: id*, title*, region*, created_at, endpoint, organization_id, organization_label, organization_name, region_label, status, ui_url (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
project:set-remote
Set the remote project for the current Git repository
magento-cloud project:set-remote [<project>]
project
The project ID
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
repo:cat
Read a file in the project repository
magento-cloud repo:cat [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] <path>
path
The path to the file
--commit
, -c
The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
repo:ls
List files in the project repository
magento-cloud repo:ls [-d|--directories] [-f|--files] [--git-style] [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<path>]
path
The path to a subdirectory
--directories
, -d
Show directories only
false
--files
, -f
Show files only
false
--git-style
Style output similar to “git ls-tree”
false
--commit
, -c
The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
repo:read
Read a directory or file in the project repository
magento-cloud repo:read [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<path>]
path
The path to the directory or file
--commit
, -c
The commit SHA. This can also accept “HEAD”, and caret (^) or tilde (~) suffixes for parent commits.
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
route:get
View detailed information about a route
magento-cloud route:get [--id ID] [-1|--primary] [-P|--property PROPERTY] [--refresh] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE] [--] [<route>]
route
The route’s original URL
--id
A route ID to select
--primary
, -1
Select the primary route
false
--property
, -P
The property to display
--refresh
Bypass the cache of routes
false
--date-fmt
The date format (as a PHP date format string)
c
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
[Deprecated option, no longer used]
--identity-file
, -i
[Deprecated option, no longer used]
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
route:list
List all routes for an environment
magento-cloud route:list [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<environment>]
environment
The environment ID
--refresh
Bypass the cache of routes
false
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: route*, type*, to*, url (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
self:install
Install or update CLI configuration files
magento-cloud self:install [--shell-type SHELL-TYPE]
--shell-type
The shell type for autocompletion (bash or zsh)
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
self:update
Update the CLI to the latest version
magento-cloud self:update [--no-major] [--unstable] [--manifest MANIFEST] [--current-version CURRENT-VERSION] [--timeout TIMEOUT]
--no-major
Only update between minor or patch versions
false
--unstable
Update to a new unstable version, if available
false
--manifest
Override the manifest file location
--current-version
Override the current version
--timeout
A timeout for the version check
30
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
service:list
List services in the project
magento-cloud service:list [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]
--refresh
Whether to refresh the cache
false
--pipe
Output a list of service names only
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: disk, name, size, type. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
service:mongo:dump
Create a binary archive dump of data from MongoDB
magento-cloud service:mongo:dump [-c|--collection COLLECTION] [-z|--gzip] [-o|--stdout] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]
--collection
, -c
The collection to dump
--gzip
, -z
Compress the dump using gzip
false
--stdout
, -o
Output to STDOUT instead of a file
false
--relationship
, -r
The service relationship to use
--identity-file
, -i
An SSH identity (private key) to use
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
service:mongo:export
Export data from MongoDB
magento-cloud service:mongo:export [-c|--collection COLLECTION] [--jsonArray] [--type TYPE] [-f|--fields FIELDS] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]
--collection
, -c
The collection to export
--jsonArray
Export data as a single JSON array
false
--type
The export type, e.g. “csv”
--fields
, -f
The fields to export
[]
--relationship
, -r
The service relationship to use
--identity-file
, -i
An SSH identity (private key) to use
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
service:mongo:restore
Restore a binary archive dump of data into MongoDB
magento-cloud service:mongo:restore [-c|--collection COLLECTION] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]
--collection
, -c
The collection to restore
--relationship
, -r
The service relationship to use
--identity-file
, -i
An SSH identity (private key) to use
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
service:mongo:shell
Use the MongoDB shell
magento-cloud service:mongo:shell [--eval EVAL] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]
--eval
Pass a JavaScript fragment to the shell
--relationship
, -r
The service relationship to use
--identity-file
, -i
An SSH identity (private key) to use
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
service:redis-cli
Access the Redis CLI
magento-cloud service:redis-cli [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] [<args>]
args
Arguments to add to the Redis command
--relationship
, -r
The service relationship to use
--identity-file
, -i
An SSH identity (private key) to use
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
snapshot:create
Make a snapshot of an environment
magento-cloud snapshot:create [--live] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]
environment
The environment
--live
Live backup: do not stop the environment. If set, this leaves the environment running and open to connections during the backup. This reduces downtime, at the risk of backing up data in an inconsistent state.
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
snapshot:delete
Delete an environment snapshot
magento-cloud snapshot:delete [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<id>]
id
The ID of the snapshot. Required in non-interactive mode.
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
snapshot:get
View an environment snapshot
magento-cloud snapshot:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--date-fmt DATE-FMT] [--] [<id>]
id
The ID of the snapshot. Defaults to the most recent one.
--property
, -P
The property to display.
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--date-fmt
The date format (as a PHP date format string)
c
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
snapshot:list
List available snapshots of an environment
magento-cloud snapshot:list [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--date-fmt
The date format (as a PHP date format string)
c
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
snapshot:restore
Restore an environment snapshot
magento-cloud snapshot:restore [--target TARGET] [--branch-from BRANCH-FROM] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<snapshot>]
snapshot
The name of the snapshot. Defaults to the most recent one
--target
The environment to restore to. Defaults to the snapshot’s current environment
--branch-from
If the --target does not yet exist, this specifies the parent of the new environment
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
source-operation:list
List source operations on an environment
magento-cloud source-operation:list [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]
--full
Do not limit the length of command to display. The default limit is 24 lines.
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: app, command, operation. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
source-operation:run
Run a source operation
magento-cloud source-operation:run [--variable VARIABLE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<operation>]
operation
The operation name
--variable
A variable to set during the operation, in the format <info>type:name=value</info>
[]
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
ssh-cert:load
Generate an SSH certificate
magento-cloud ssh-cert:load [--refresh-only] [--new] [--new-key]
--refresh-only
Only refresh the certificate, if necessary (do not write SSH config)
false
--new
Force the certificate to be refreshed
false
--new-key
[Deprecated] Use --new instead
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
ssh-key:add
Add a new SSH key
magento-cloud ssh-key:add [--name NAME] [--] [<path>]
path
The path to an existing SSH public key
--name
A name to identify the key
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
ssh-key:delete
Delete an SSH key
magento-cloud ssh-key:delete [<id>]
id
The ID of the SSH key to delete
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
ssh-key:list
Get a list of SSH keys in your account
magento-cloud ssh-key:list [--format FORMAT] [-c|--columns COLUMNS] [--no-header]
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: id*, title*, path*, fingerprint (* = default columns). The character “+” can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
subscription:info
Read or modify subscription properties
magento-cloud subscription:info [-s|--id ID] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--] [<property>] [<value>]
property
The name of the property
value
Set a new value for the property
--id
, -s
The subscription ID
--date-fmt
The date format (as a PHP date format string)
c
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
tunnel:close
Close SSH tunnels
magento-cloud tunnel:close [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]
--all
, -a
Close all tunnels
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
tunnel:info
View relationship info for SSH tunnels
magento-cloud tunnel:info [-P|--property PROPERTY] [-c|--encode] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--format FORMAT] [--columns COLUMNS] [--no-header]
--property
, -P
The relationship property to view
--encode
, -c
Output as base64-encoded JSON
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--format
The output format: table, csv, tsv, or plain
table
--columns
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
tunnel:list
List SSH tunnels
magento-cloud tunnel:list [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]
--all
, -a
View all tunnels
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
tunnel:open
Open SSH tunnels to an app’s relationships
magento-cloud tunnel:open [-g|--gateway-ports] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE]
--gateway-ports
, -g
Allow remote hosts to connect to local forwarded ports
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
tunnel:single
Open a single SSH tunnel to an app relationship
magento-cloud tunnel:single [--port PORT] [-g|--gateway-ports] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE]
--port
The local port
--gateway-ports
, -g
Allow remote hosts to connect to local forwarded ports
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--app
, -A
The remote application name
--relationship
, -r
The service relationship to use
--identity-file
, -i
An SSH identity (private key) to use
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
user:add
Add a user to the project
magento-cloud user:add [-r|--role ROLE] [--force-invite] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<email>]
email
The user’s email address
--role
, -r
The user’s project role (‘admin’ or ‘viewer’) or environment type role (e.g. ‘staging:contributor’ or ‘production:viewer’). To remove a user from an environment type, set the role as ‘none’. The % or * characters can be used as a wildcard for the environment type, e.g. ‘%:viewer’ to give the user the ‘viewer’ role on all types. The role can be abbreviated, e.g. ‘production:v’.
[]
--force-invite
Send an invitation, even if one has already been sent
false
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
user:delete
Delete a user from the project
magento-cloud user:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] <email>
email
The user’s email address
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
user:get
View a user’s role(s)
magento-cloud user:get [-l|--level LEVEL] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [-r|--role ROLE] [--] [<email>]
email
The user’s email address
--level
, -l
The role level (‘project’ or ‘environment’)
--pipe
Output the role to stdout (after making any changes)
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--role
, -r
[Deprecated: use user:update to change a user’s role(s)]
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
user:list
List project users
magento-cloud user:list [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: email, id, name, role. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
user:update
Update user role(s) on a project
magento-cloud user:update [-r|--role ROLE] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<email>]
email
The user’s email address
--role
, -r
The user’s project role (‘admin’ or ‘viewer’) or environment type role (e.g. ‘staging:contributor’ or ‘production:viewer’). To remove a user from an environment type, set the role as ‘none’. The % or * characters can be used as a wildcard for the environment type, e.g. ‘%:viewer’ to give the user the ‘viewer’ role on all types. The role can be abbreviated, e.g. ‘production:v’.
[]
--project
, -p
The project ID or URL
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
variable:create
Create a variable
magento-cloud variable:create [-u|--update] [-l|--level LEVEL] [--name NAME] [--value VALUE] [--json JSON] [--sensitive SENSITIVE] [--prefix PREFIX] [--enabled ENABLED] [--inheritable INHERITABLE] [--visible-build VISIBLE-BUILD] [--visible-runtime VISIBLE-RUNTIME] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<name>]
name
The variable name
--update
, -u
Update the variable if it already exists
false
--level
, -l
The level at which to set the variable (‘project’ or ‘environment’)
--name
The variable name
--value
The variable’s value
--json
Whether the variable value is JSON-formatted
false
--sensitive
Whether the variable value is sensitive
false
--prefix
The variable name’s prefix which can determine its type, e.g. ‘env’. Only applicable if the name does not already contain a prefix. (e.g. ‘none’ or ‘env:’)
none
--enabled
Whether the variable should be enabled on the environment
true
--inheritable
Whether the variable is inheritable by child environments
true
--visible-build
Whether the variable should be visible at build time
--visible-runtime
Whether the variable should be visible at runtime
true
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
variable:delete
Delete a variable
magento-cloud variable:delete [-l|--level LEVEL] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>
name
The variable name
--level
, -l
The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
variable:get
View a variable
magento-cloud variable:get [-P|--property PROPERTY] [-l|--level LEVEL] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--pipe] [--] [<name>]
name
The name of the variable
--property
, -P
View a single variable property
--level
, -l
The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--pipe
[Deprecated option] Output the variable value only
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
variable:list
List variables
magento-cloud variable:list [-l|--level LEVEL] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]
--level
, -l
The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: is_enabled, level, name, value. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
variable:update
Update a variable
magento-cloud variable:update [--allow-no-change] [-l|--level LEVEL] [--value VALUE] [--json JSON] [--sensitive SENSITIVE] [--enabled ENABLED] [--inheritable INHERITABLE] [--visible-build VISIBLE-BUILD] [--visible-runtime VISIBLE-RUNTIME] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>
name
The variable name
--allow-no-change
Return success (zero exit code) if no changes were provided
false
--level
, -l
The variable level (‘project’, ‘environment’, ‘p’ or ‘e’)
--value
The variable’s value
--json
Whether the variable value is JSON-formatted
false
--sensitive
Whether the variable value is sensitive
false
--enabled
Whether the variable should be enabled on the environment
true
--inheritable
Whether the variable is inheritable by child environments
true
--visible-build
Whether the variable should be visible at build time
--visible-runtime
Whether the variable should be visible at runtime
true
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--no-wait
, -W
Do not wait for the operation to complete
false
--wait
Wait for the operation to complete (default)
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false
worker:list
Get a list of all deployed workers
magento-cloud worker:list [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]
--refresh
Whether to refresh the cache
false
--pipe
Output a list of worker names only
false
--project
, -p
The project ID or URL
--environment
, -e
The environment ID. Use “.” to select the project’s default environment.
--format
The output format: table, csv, tsv, or plain
table
--columns
, -c
Columns to display. Available columns: commands, name, type. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. “a,b,c”) and/or whitespace.
[]
--no-header
Do not output the table header
false
--help
, -h
Display this help message
false
--verbose
, -v|-vv|-vvv
Increase the verbosity of messages
false
--version
, -V
Display this application version
false
--yes
, -y
Answer “yes” to confirmation questions; accept the default value for other questions; disable interaction
false
--no-interaction
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: <comment>MAGENTO_CLOUD_CLI_NO_INTERACTION=1</comment>
false