diff --git a/sites/platform/src/administration/cli/reference.md b/sites/platform/src/administration/cli/reference.md index 76bb67e80f..ff9c3075b8 100644 --- a/sites/platform/src/administration/cli/reference.md +++ b/sites/platform/src/administration/cli/reference.md @@ -13,20 +13,20 @@ showTitle: false -# Platform.sh CLI 5.0.15 +# Platform.sh CLI 5.2.0 -- [Installation](/administration/cli/_index.md#1-install) +- [Installation](/administration/cli#1-install) - [Open an issue](https://github.com/platformsh/cli/issues) ## All commands * [`clear-cache`](#clear-cache) +* [`console`](#console) * [`decode`](#decode) * [`docs`](#docs) * [`help`](#help) * [`list`](#list) * [`multi`](#multi) -* [`web`](#web) **activity** @@ -88,6 +88,8 @@ showTitle: false * [`environment:branch`](#environmentbranch) * [`environment:checkout`](#environmentcheckout) * [`environment:delete`](#environmentdelete) +* [`environment:deploy`](#environmentdeploy) +* [`environment:deploy:type`](#environmentdeploytype) * [`environment:drush`](#environmentdrush) * [`environment:http-access`](#environmenthttp-access) * [`environment:info`](#environmentinfo) @@ -192,6 +194,7 @@ showTitle: false * [`service:mongo:restore`](#servicemongorestore) * [`service:mongo:shell`](#servicemongoshell) * [`service:redis-cli`](#serviceredis-cli) +* [`service:valkey-cli`](#servicevalkey-cli) **source-operation** @@ -271,12 +274,59 @@ platform cc * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + +* `--yes` (`-y`) + Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction + +* `--no-interaction` + Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1 + +## `console` + +Open the project in the Console + +Aliases: `web` + +### Usage + +``` +platform web [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] +``` + +#### Options + +* `--browser` (expects a value) + The browser to use to open the URL. Set 0 for none. + +* `--pipe` + Output the URL to stdout. + +* `--project` (`-p`) (expects a value) + The project ID or URL + +* `--environment` (`-e`) (expects a value) + The environment ID. Use "." to select the project's default environment. + +* `--help` (`-h`) + Display this help message + * `--version` (`-V`) Display this application version +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -306,11 +356,14 @@ platform decode [-P|--property PROPERTY] [--] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -351,11 +404,14 @@ platform docs [--browser BROWSER] [--pipe] [--] []... * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -406,11 +462,14 @@ To display the list of available commands, please use the list command. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -466,11 +525,14 @@ It's also possible to get raw list of commands (useful for embedding command run * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -510,11 +572,14 @@ platform multi [-p|--projects PROJECTS] [--continue] [--sort SORT] [--reverse] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -529,45 +594,6 @@ platform multi [-p|--projects PROJECTS] [--continue] [--sort SORT] [--reverse] [ platform multi -p l7ywemwizmmgb,o43m25zns6k2d,3nyujoslhydhx -- var -e main ``` -## `web` - -Open the project in the Web Console - -### Usage - -``` -platform web [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] -``` - -#### Options - -* `--browser` (expects a value) - The browser to use to open the URL. Set 0 for none. - -* `--pipe` - Output the URL to stdout. - -* `--project` (`-p`) (expects a value) - The project ID or URL - -* `--environment` (`-e`) (expects a value) - The environment ID. Use "." to select the project's default environment. - -* `--help` (`-h`) - Display this help message - -* `--verbose` (`-v|-vv|-vvv`) - Increase the verbosity of messages - -* `--version` (`-V`) - Display this application version - -* `--yes` (`-y`) - Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction - -* `--no-interaction` - Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1 - ## `activity:cancel` Cancel an activity @@ -603,11 +629,14 @@ platform activity:cancel [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [-a|- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -674,11 +703,14 @@ platform activity:get [-P|--property PROPERTY] [-t|--type TYPE] [-x|--exclude-ty * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -757,11 +789,14 @@ platform activities [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit L * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -773,7 +808,7 @@ platform activities [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit L * List recent activities for the current environment: ``` -platform activity:list +platform activity:list ``` * List all recent activities for the current project: @@ -854,11 +889,14 @@ platform activity:log [--refresh REFRESH] [-t|--timestamps] [--type TYPE] [-x|-- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -916,11 +954,14 @@ platform app:config-get [-P|--property PROPERTY] [--refresh] [-p|--project PROJE * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -961,7 +1002,7 @@ platform app:config-validate * Validate the project configuration files in your current directory: ``` -platform app:config-validate +platform app:config-validate ``` ## `app:list` @@ -1002,11 +1043,14 @@ platform apps [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVI * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1037,11 +1081,14 @@ Alternatively, to log in to the CLI with a browser, run: * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1095,11 +1142,14 @@ PLATFORMSH_CLI_TOKEN environment variable. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1145,11 +1195,14 @@ platform auth:info [--no-auto-login] [-P|--property PROPERTY] [--refresh] [--for * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1197,11 +1250,14 @@ platform logout [-a|--all] [--other] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1224,11 +1280,14 @@ platform auth:verify-phone-number * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1273,11 +1332,14 @@ platform backup [--live] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1289,7 +1351,7 @@ platform backup [--live] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [ * Make a backup of the current environment: ``` -platform backup:create +platform backup:create ``` * Request a backup (and exit quickly): @@ -1334,11 +1396,14 @@ platform backup:delete [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1378,11 +1443,14 @@ platform backup:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--enviro * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1425,11 +1493,14 @@ platform backups [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1485,11 +1556,14 @@ platform backup:restore [--target TARGET] [--branch-from BRANCH-FROM] [--no-code * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1501,7 +1575,7 @@ platform backup:restore [--target TARGET] [--branch-from BRANCH-FROM] [--no-code * Restore the most recent backup: ``` -platform backup:restore +platform backup:restore ``` * Restore a specific backup: @@ -1542,11 +1616,14 @@ platform certificate:add [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1583,11 +1660,14 @@ platform certificate:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1624,11 +1704,14 @@ platform certificate:get [-P|--property PROPERTY] [--date-fmt DATE-FMT] [-p|--pr * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1695,11 +1778,14 @@ platform certificates [--domain DOMAIN] [--exclude-domain EXCLUDE-DOMAIN] [--iss * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1746,11 +1832,14 @@ platform commit:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--enviro * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1762,7 +1851,7 @@ platform commit:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--enviro * Display the current commit on the environment: ``` -platform commit:get +platform commit:get ``` * Display the previous commit: @@ -1823,11 +1912,14 @@ platform commits [--limit LIMIT] [-p|--project PROJECT] [-e|--environment ENVIRO * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1839,7 +1931,7 @@ platform commits [--limit LIMIT] [-p|--project PROJECT] [-e|--environment ENVIRO * Display commits on an environment: ``` -platform commit:list +platform commit:list ``` * Display commits starting from two before the current one: @@ -1904,11 +1996,14 @@ platform db:dump [--schema SCHEMA] [-f|--file FILE] [-d|--directory DIRECTORY] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1920,7 +2015,7 @@ platform db:dump [--schema SCHEMA] [-f|--file FILE] [-d|--directory DIRECTORY] [ * Create an SQL dump file: ``` -platform db:dump +platform db:dump ``` * Create a gzipped SQL dump file named "dump.sql.gz": @@ -1968,11 +2063,14 @@ platform sql [--raw] [--schema SCHEMA] [-p|--project PROJECT] [-e|--environment * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1984,7 +2082,7 @@ platform sql [--raw] [--schema SCHEMA] [-p|--project PROJECT] [-e|--environment * Open an SQL console on the remote database: ``` -platform db:sql +platform db:sql ``` * View tables on the remote database: @@ -2041,11 +2139,14 @@ platform domain:add [--cert CERT] [--key KEY] [--chain CHAIN] [--attach ATTACH] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2097,11 +2198,14 @@ platform domain:delete [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2157,11 +2261,14 @@ platform domain:get [-P|--property PROPERTY] [--format FORMAT] [-c|--columns COL * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2201,11 +2308,14 @@ platform domains [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--pr * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2254,11 +2364,14 @@ platform domain:update [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project P * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2308,11 +2421,14 @@ platform environment:activate [--parent PARENT] [-p|--project PROJECT] [-e|--env * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2376,12 +2492,15 @@ platform branch [--title TITLE] [--type TYPE] [--no-clone-parent] [--no-checkout * `--help` (`-h`) Display this help message -* `--verbose` (`-v|-vv|-vvv`) - Increase the verbosity of messages - * `--version` (`-V`) Display this application version +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2417,11 +2536,14 @@ platform checkout [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2510,11 +2632,14 @@ This command allows you to delete environments as well as their Git branches. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2526,7 +2651,7 @@ This command allows you to delete environments as well as their Git branches. * Delete the currently checked out environment: ``` -platform environment:delete +platform environment:delete ``` * Delete the environments "test" and "example-1": @@ -2544,6 +2669,110 @@ platform environment:delete --inactive platform environment:delete --merged ``` +## `environment:deploy` + +Deploy an environment's staged changes + +Aliases: `env:deploy` + +### Usage + +``` +platform env:deploy [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] +``` + +#### Options + +* `--project` (`-p`) (expects a value) + The project ID or URL + +* `--environment` (`-e`) (expects a value) + The environment ID. Use "." to select the project's default environment. + +* `--no-wait` (`-W`) + Do not wait for the operation to complete + +* `--wait` + Wait for the operation to complete (default) + +* `--help` (`-h`) + Display this help message + +* `--version` (`-V`) + Display this application version + +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + +* `--yes` (`-y`) + Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction + +* `--no-interaction` + Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1 + +## `environment:deploy:type` + +Show or set the environment deployment type + +### Usage + +``` +platform environment:deploy:type [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [] +``` + +Choose automatic (the default) if you want your changes to be deployed immediately as they are made. +Choose manual to have changes staged until you trigger a deployment (including changes to code, variables, domains and settings). + +#### Arguments + +* `type`(optional) + The environment deployment type: automatic or manual. + +#### Options + +* `--pipe` + Output the deployment type to stdout + +* `--project` (`-p`) (expects a value) + The project ID or URL + +* `--environment` (`-e`) (expects a value) + The environment ID. Use "." to select the project's default environment. + +* `--no-wait` (`-W`) + Do not wait for the operation to complete + +* `--wait` + Wait for the operation to complete (default) + +* `--help` (`-h`) + Display this help message + +* `--version` (`-V`) + Display this application version + +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + +* `--yes` (`-y`) + Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction + +* `--no-interaction` + Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1 + +### Examples + +* Set the deployment type to "manual" (disable automatic deployments): +``` +platform environment:deploy:type manual +``` + ## `environment:drush` Run a drush command on the remote environment @@ -2575,11 +2804,14 @@ platform drush [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app A * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2647,11 +2879,14 @@ platform httpaccess [--access ACCESS] [--auth AUTH] [--enabled ENABLED] [-p|--pr * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2731,11 +2966,14 @@ platform environment:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2747,7 +2985,7 @@ platform environment:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [- * Read all environment properties: ``` -platform environment:info +platform environment:info ``` * Show the environment's status: @@ -2815,11 +3053,14 @@ platform environment:init [--profile PROFILE] [-p|--project PROJECT] [-e|--envir * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2884,11 +3125,14 @@ platform environments [-I|--no-inactive] [--status STATUS] [--pipe] [--refresh R * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2939,11 +3183,14 @@ platform log [--lines LINES] [--tail] [-p|--project PROJECT] [-e|--environment E * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2955,7 +3202,7 @@ platform log [--lines LINES] [--tail] [-p|--project PROJECT] [-e|--environment E * Display a choice of logs that can be read: ``` -platform environment:logs +platform environment:logs ``` * Read the deploy log: @@ -3009,11 +3256,14 @@ This command will initiate a Git merge of the specified environment into its par * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3059,11 +3309,14 @@ The environment will be unavailable until it is resumed. No data will be lost. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3129,11 +3382,14 @@ platform push [--target TARGET] [-f|--force] [--force-with-lease] [-u|--set-upst * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3145,7 +3401,7 @@ platform push [--target TARGET] [-f|--force] [--force-with-lease] [-u|--set-upst * Push code to the current environment: ``` -platform environment:push +platform environment:push ``` * Push code, without waiting for deployment: @@ -3187,11 +3443,14 @@ platform redeploy [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3236,11 +3495,14 @@ platform relationships [-P|--property PROPERTY] [--refresh] [-p|--project PROJEC * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3252,7 +3514,7 @@ platform relationships [-P|--property PROPERTY] [--refresh] [-p|--project PROJEC * View all the current environment's relationships: ``` -platform environment:relationships +platform environment:relationships ``` * View the 'main' environment's relationships: @@ -3292,11 +3554,14 @@ platform environment:resume [-p|--project PROJECT] [-e|--environment ENVIRONMENT * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3344,11 +3609,14 @@ platform scp [-r|--recursive] [-p|--project PROJECT] [-e|--environment ENVIRONME * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3424,11 +3692,14 @@ platform ssh [--pipe] [--all] [-o|--option OPTION] [-p|--project PROJECT] [-e|-- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3440,7 +3711,7 @@ platform ssh [--pipe] [--all] [-o|--option OPTION] [-p|--project PROJECT] [-e|-- * Open a shell over SSH: ``` -platform environment:ssh +platform environment:ssh ``` * Pass an extra option to SSH: @@ -3509,11 +3780,14 @@ parent to the child. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3565,11 +3839,14 @@ platform url [-1|--primary] [--browser BROWSER] [--pipe] [-p|--project PROJECT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3581,7 +3858,7 @@ platform url [-1|--primary] [--browser BROWSER] [--pipe] [-p|--project PROJECT] * Give a choice of URLs to open (or print all URLs if there is no browser): ``` -platform environment:url +platform environment:url ``` * Print all URLs: @@ -3634,11 +3911,14 @@ platform xdebug [--port PORT] [-p|--project PROJECT] [-e|--environment ENVIRONME * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3650,7 +3930,7 @@ platform xdebug [--port PORT] [-p|--project PROJECT] [-e|--environment ENVIRONME * Connect to Xdebug on the environment, listening locally on port 9000.: ``` -platform environment:xdebug +platform environment:xdebug ``` ## `integration:activity:get` @@ -3697,11 +3977,14 @@ platform integration:activity:get [-P|--property PROPERTY] [-p|--project PROJECT * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3770,11 +4053,14 @@ platform integration:activities [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3817,11 +4103,14 @@ platform integration:activity:log [-t|--timestamps] [--date-fmt DATE-FMT] [-p|-- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3985,11 +4274,14 @@ platform integration:add [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BI * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4038,11 +4330,14 @@ platform integration:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4085,11 +4380,14 @@ platform integration:get [-P|--property [PROPERTY]] [--format FORMAT] [-c|--colu * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4129,11 +4427,14 @@ platform integrations [-t|--type TYPE] [--format FORMAT] [-c|--columns COLUMNS] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4302,11 +4603,14 @@ platform integration:update [--type TYPE] [--base-url BASE-URL] [--bitbucket-url * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4354,11 +4658,14 @@ repository may be deleted. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4433,11 +4740,14 @@ platform build [-a|--abslinks] [-s|--source SOURCE] [-d|--destination DESTINATIO * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4449,7 +4759,7 @@ platform build [-a|--abslinks] [-s|--source SOURCE] [-d|--destination DESTINATIO * Build the current project: ``` -platform local:build +platform local:build ``` * Build the app "example" without symlinking the source files: @@ -4484,11 +4794,14 @@ platform dir [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4522,11 +4835,14 @@ platform drush-aliases [-r|--recreate] [-g|--group GROUP] [--pipe] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4597,11 +4913,14 @@ platform metrics [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4613,7 +4932,7 @@ platform metrics [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to * Show metrics for the last 10m: ``` -platform metrics:all +platform metrics:all ``` * Show metrics in five-minute intervals over the last hour: @@ -4679,11 +4998,14 @@ platform cpu [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4750,11 +5072,14 @@ platform disk [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4818,11 +5143,14 @@ platform mem [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4884,11 +5212,14 @@ platform mount:download [-a|--all] [-m|--mount MOUNT] [--target TARGET] [--sourc * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4943,11 +5274,14 @@ platform mounts [--paths] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5003,11 +5337,14 @@ platform mount:upload [--source SOURCE] [-m|--mount MOUNT] [--delete] [--exclude * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5056,11 +5393,14 @@ platform ops [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A| * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5106,11 +5446,14 @@ platform operation:run [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5145,7 +5488,7 @@ platform organization:billing:address [-o|--org ORG] [-p|--project PROJECT] [--d The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--date-fmt` (expects a value) The date format (as a PHP date format string) @@ -5162,11 +5505,14 @@ platform organization:billing:address [-o|--org ORG] [-p|--project PROJECT] [--d * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5198,7 +5544,7 @@ platform organization:billing:profile [-o|--org ORG] [-p|--project PROJECT] [--d The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--date-fmt` (expects a value) The date format (as a PHP date format string) @@ -5215,11 +5561,14 @@ platform organization:billing:profile [-o|--org ORG] [-p|--project PROJECT] [--d * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5257,11 +5606,14 @@ Access to individual projects (API and SSH) is managed separately, for now. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5285,16 +5637,19 @@ platform organization:delete [-o|--org ORG] [-p|--project PROJECT] The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5309,7 +5664,7 @@ View or change organization details ### Usage ``` -platform organization:info [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--] [] [] +platform organization:info [-o|--org ORG] [-p|--project PROJECT] [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--] [] [] ``` #### Arguments @@ -5326,7 +5681,10 @@ platform organization:info [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DAT The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used + +* `--refresh` + Refresh the cache * `--date-fmt` (expects a value) The date format (as a PHP date format string) @@ -5343,11 +5701,14 @@ platform organization:info [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DAT * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5407,11 +5768,14 @@ platform orgs [--my] [--sort SORT] [--reverse] [--format FORMAT] [-c|--columns C * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5443,7 +5807,7 @@ platform org:subs [--page PAGE] [-c|--count COUNT] [-o|--org ORG] [-p|--project The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--format` (expects a value) The output format: table, csv, tsv, or plain @@ -5457,11 +5821,14 @@ platform org:subs [--page PAGE] [-c|--count COUNT] [-o|--org ORG] [-p|--project * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5495,11 +5862,14 @@ platform organization:user:add [-o|--org ORG] [--permission PERMISSION] [--] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5580,11 +5953,14 @@ platform organization:user:get [-o|--org ORG] [-P|--property PROPERTY] [--date-f * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5633,11 +6009,14 @@ platform org:users [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5685,11 +6064,14 @@ platform oups [-o|--org ORG] [--list-all] [--format FORMAT] [-c|--columns COLUMN * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5723,11 +6105,14 @@ platform organization:user:update [-o|--org ORG] [--permission PERMISSION] [--] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5753,11 +6138,14 @@ platform project:clear-build-cache [-p|--project PROJECT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5774,7 +6162,7 @@ Aliases: `create` ### Usage ``` -platform create [-o|--org ORG] [--title TITLE] [--region REGION] [--plan PLAN] [--environments ENVIRONMENTS] [--storage STORAGE] [--default-branch DEFAULT-BRANCH] [--set-remote] [--no-set-remote] +platform create [-o|--org ORG] [--title TITLE] [--region REGION] [--plan PLAN] [--environments ENVIRONMENTS] [--storage STORAGE] [--default-branch DEFAULT-BRANCH] [--init-repo INIT-REPO] [--set-remote] [--no-set-remote] ``` Use this command to create a new project. @@ -5813,20 +6201,26 @@ to STDERR. * `--default-branch` (expects a value) The default Git branch name for the project (the production environment) +* `--init-repo` (expects a value) + URL of a Git repository to use for initialization. A GitHub path such as "platformsh-templates/nuxtjs" can be used. + * `--set-remote` - Set the new project as the remote for this repository. This is the default if no remote project is already set. + Set the new project as the remote for the local project directory. This is the default if no remote is already set. * `--no-set-remote` - Do not set the new project as the remote for this repository + Do not set the new project as the remote * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5857,11 +6251,14 @@ platform project:delete [-p|--project PROJECT] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5906,11 +6303,14 @@ platform get [-e|--environment ENVIRONMENT] [--depth DEPTH] [--build] [-p|--proj * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5972,11 +6372,14 @@ platform project:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|-- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5988,7 +6391,7 @@ platform project:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|-- * Read all project properties: ``` -platform project:info +platform project:info ``` * Show the project's Git URL: @@ -6034,7 +6437,7 @@ platform project:init * Create the starter YAML files for your project: ``` -platform project:init +platform project:init ``` ## `project:list` @@ -6096,11 +6499,14 @@ platform projects [--pipe] [--region REGION] [--title TITLE] [--my] [--refresh R * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6130,11 +6536,14 @@ platform set-remote [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6183,11 +6592,14 @@ platform repo:cat [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6240,11 +6652,14 @@ platform repo:ls [-d|--directories] [-f|--files] [--git-style] [-c|--commit COMM * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6283,11 +6698,14 @@ platform read [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVI * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6324,11 +6742,14 @@ platform build-resources:get [-p|--project PROJECT] [--format FORMAT] [-c|--colu * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6383,11 +6804,14 @@ platform route:get [--id ID] [-1|--primary] [-P|--property PROPERTY] [--refresh] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6442,11 +6866,14 @@ platform routes [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-heade * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6492,11 +6919,14 @@ platform services [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6542,11 +6972,14 @@ platform mongodump [-c|--collection COLLECTION] [-z|--gzip] [-o|--stdout] [-r|-- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6595,11 +7028,14 @@ platform mongoexport [-c|--collection COLLECTION] [--jsonArray] [--type TYPE] [- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6646,11 +7082,14 @@ platform mongorestore [-c|--collection COLLECTION] [-r|--relationship RELATIONSH * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6667,7 +7106,7 @@ Aliases: `mongo` ### Usage ``` -platform mongosh [--eval EVAL] [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] +platform mongo [--eval EVAL] [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] ``` #### Options @@ -6690,11 +7129,14 @@ platform mongosh [--eval EVAL] [-r|--relationship RELATIONSHIP] [-p|--project PR * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6718,13 +7160,13 @@ Aliases: `redis` ### Usage ``` -platform redis [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] [] +platform redis [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] []... ``` #### Arguments -* `args`(optional) - Arguments to add to the Redis command +* `args`(optional; multiple values allowed) + Arguments to add to the redis-cli command #### Options @@ -6743,11 +7185,14 @@ platform redis [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--env * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6759,7 +7204,7 @@ platform redis [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--env * Open the redis-cli shell: ``` -platform service:redis-cli +platform service:redis-cli ``` * Ping the Redis server: @@ -6782,6 +7227,82 @@ platform service:redis-cli -- --scan platform service:redis-cli -- "--scan --pattern '*-11*'" ``` +## `service:valkey-cli` + +Access the Valkey CLI + +Aliases: `valkey` + +### Usage + +``` +platform valkey [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] []... +``` + +#### Arguments + +* `args`(optional; multiple values allowed) + Arguments to add to the valkey-cli command + +#### Options + +* `--relationship` (`-r`) (expects a value) + The service relationship to use + +* `--project` (`-p`) (expects a value) + The project ID or URL + +* `--environment` (`-e`) (expects a value) + The environment ID. Use "." to select the project's default environment. + +* `--app` (`-A`) (expects a value) + The remote application name + +* `--help` (`-h`) + Display this help message + +* `--version` (`-V`) + Display this application version + +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + +* `--yes` (`-y`) + Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction + +* `--no-interaction` + Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1 + +### Examples + +* Open the valkey-cli shell: +``` +platform service:valkey-cli +``` + +* Ping the Valkey server: +``` +platform service:valkey-cli ping +``` + +* Show Valkey status information: +``` +platform service:valkey-cli info +``` + +* Scan keys: +``` +platform service:valkey-cli -- --scan +``` + +* Scan keys matching a pattern: +``` +platform service:valkey-cli -- "--scan --pattern '*-11*'" +``` + ## `source-operation:list` List source operations on an environment @@ -6817,11 +7338,14 @@ platform source-ops [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMEN * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6864,11 +7388,14 @@ platform source-operation:run [--variable VARIABLE] [-p|--project PROJECT] [-e|- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6923,11 +7450,14 @@ explicitly. For unattended scripts, remember to turn off interaction via * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6966,11 +7496,14 @@ To load or check your SSH certificate, run: platform ssh-cert:load * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7006,11 +7539,14 @@ To load or check your SSH certificate, run: platform ssh-cert:load * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7059,11 +7595,14 @@ To load or check your SSH certificate, run: platform ssh-cert:load * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7112,11 +7651,14 @@ platform subscription:info [-s|--id ID] [--date-fmt DATE-FMT] [--format FORMAT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7128,7 +7670,7 @@ platform subscription:info [-s|--id ID] [--date-fmt DATE-FMT] [--format FORMAT] * View all subscription properties: ``` -platform subscription:info +platform subscription:info ``` * View the subscription status: @@ -7171,11 +7713,14 @@ platform team:create [--label LABEL] [--no-check-unique] [-r|--role ROLE] [--out * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7204,11 +7749,14 @@ platform team:delete [-o|--org ORG] [-t|--team TEAM] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7232,7 +7780,7 @@ platform team:get [-o|--org ORG] [-p|--project PROJECT] [-t|--team TEAM] [-P|--p The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--team` (`-t`) (expects a value) The team ID @@ -7255,11 +7803,14 @@ platform team:get [-o|--org ORG] [-p|--project PROJECT] [-t|--team TEAM] [-P|--p * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7276,7 +7827,7 @@ Aliases: `teams` ### Usage ``` -platform teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DATE-FMT] [--format FORMAT] [--columns COLUMNS] [--no-header] +platform teams [-c|--count COUNT] [--sort SORT] [--reverse] [-A|--all] [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DATE-FMT] [--format FORMAT] [--columns COLUMNS] [--no-header] ``` #### Options @@ -7290,11 +7841,14 @@ platform teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|- * `--reverse` Sort in reverse order +* `--all` (`-A`) + List all teams in the organization (regardless of a selected project) + * `--org` (`-o`) (expects a value) The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--date-fmt` (expects a value) The date format (as a PHP date format string) @@ -7303,7 +7857,7 @@ platform teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|- The output format: table, csv, tsv, or plain * `--columns` (expects a value) - Columns to display. Available columns: id*, label*, member_count*, project_count*, project_permissions*, created_at, 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. + Columns to display. Available columns: id*, label*, member_count*, project_count*, project_permissions*, created_at, granted_at, 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 @@ -7311,11 +7865,14 @@ platform teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7323,6 +7880,23 @@ platform teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|- * `--no-interaction` Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1 +### Examples + +* List teams (in the current project, if any): +``` +platform team:list +``` + +* List all teams in an organization: +``` +platform team:list --all +``` + +* List teams with access to a specified project, including when they were added: +``` +platform team:list --project myProjectId --columns +granted_at +``` + ## `team:project:add` Add project(s) to a team @@ -7352,11 +7926,14 @@ platform team:project:add [--all] [-o|--org ORG] [-t|--team TEAM] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7440,11 +8020,14 @@ platform team:projects [-c|--count COUNT] [-o|--org ORG] [-t|--team TEAM] [--dat * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7488,11 +8071,14 @@ platform team:update [--label LABEL] [--no-check-unique] [-r|--role ROLE] [-t|-- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7526,11 +8112,14 @@ platform team:user:add [-o|--org ORG] [-t|--team TEAM] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7564,11 +8153,14 @@ platform team:user:delete [-o|--org ORG] [-t|--team TEAM] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7614,11 +8206,14 @@ platform team:users [-c|--count COUNT] [-o|--org ORG] [-t|--team TEAM] [--date-f * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7653,11 +8248,14 @@ platform tunnel:close [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRO * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7695,11 +8293,14 @@ platform tunnel:info [-P|--property PROPERTY] [-c|--encode] [-p|--project PROJEC * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7745,11 +8346,14 @@ platform tunnels [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7795,11 +8399,14 @@ extensions. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7840,11 +8447,14 @@ platform tunnel:single [--port PORT] [-g|--gateway-ports] [-p|--project PROJECT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7887,11 +8497,14 @@ platform user:add [-r|--role ROLE] [--force-invite] [-p|--project PROJECT] [-W|- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7945,11 +8558,14 @@ platform user:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8005,11 +8621,14 @@ platform user:get [-l|--level LEVEL] [--pipe] [-p|--project PROJECT] [-e|--envir * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8058,11 +8677,14 @@ platform users [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--proj * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8102,11 +8724,14 @@ platform user:update [-r|--role ROLE] [-p|--project PROJECT] [-W|--no-wait] [--w * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8191,11 +8816,14 @@ platform variable:create [-u|--update] [-l|--level LEVEL] [--name NAME] [--value * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8238,11 +8866,14 @@ platform variable:delete [-l|--level LEVEL] [-p|--project PROJECT] [-e|--environ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8303,11 +8934,14 @@ platform vget [-P|--property PROPERTY] [-l|--level LEVEL] [--format FORMAT] [-c| * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8357,11 +8991,14 @@ platform variables [-l|--level LEVEL] [--format FORMAT] [-c|--columns COLUMNS] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8428,11 +9065,14 @@ platform variable:update [--allow-no-change] [-l|--level LEVEL] [--value VALUE] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8478,11 +9118,14 @@ platform workers [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment E * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction diff --git a/sites/upsun/src/administration/cli/reference.md b/sites/upsun/src/administration/cli/reference.md index 0498f05193..af476b2936 100644 --- a/sites/upsun/src/administration/cli/reference.md +++ b/sites/upsun/src/administration/cli/reference.md @@ -13,20 +13,20 @@ showTitle: false -# Upsun CLI 5.0.15 +# Upsun CLI 5.2.0 -- [Installation](/administration/cli.md#1-install) +- [Installation](/administration/cli#1-install) - [Open an issue](https://github.com/platformsh/cli/issues) ## All commands * [`clear-cache`](#clear-cache) +* [`console`](#console) * [`decode`](#decode) * [`docs`](#docs) * [`help`](#help) * [`list`](#list) * [`multi`](#multi) -* [`web`](#web) **activity** @@ -88,6 +88,8 @@ showTitle: false * [`environment:branch`](#environmentbranch) * [`environment:checkout`](#environmentcheckout) * [`environment:delete`](#environmentdelete) +* [`environment:deploy`](#environmentdeploy) +* [`environment:deploy:type`](#environmentdeploytype) * [`environment:drush`](#environmentdrush) * [`environment:http-access`](#environmenthttp-access) * [`environment:info`](#environmentinfo) @@ -194,6 +196,7 @@ showTitle: false * [`service:mongo:restore`](#servicemongorestore) * [`service:mongo:shell`](#servicemongoshell) * [`service:redis-cli`](#serviceredis-cli) +* [`service:valkey-cli`](#servicevalkey-cli) **source-operation** @@ -273,12 +276,59 @@ upsun cc * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + +* `--yes` (`-y`) + Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction + +* `--no-interaction` + Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: UPSUN_CLI_NO_INTERACTION=1 + +## `console` + +Open the project in the Console + +Aliases: `web` + +### Usage + +``` +upsun web [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] +``` + +#### Options + +* `--browser` (expects a value) + The browser to use to open the URL. Set 0 for none. + +* `--pipe` + Output the URL to stdout. + +* `--project` (`-p`) (expects a value) + The project ID or URL + +* `--environment` (`-e`) (expects a value) + The environment ID. Use "." to select the project's default environment. + +* `--help` (`-h`) + Display this help message + * `--version` (`-V`) Display this application version +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -308,11 +358,14 @@ upsun decode [-P|--property PROPERTY] [--] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -353,11 +406,14 @@ upsun docs [--browser BROWSER] [--pipe] [--] []... * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -408,11 +464,14 @@ To display the list of available commands, please use the list command. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -468,11 +527,14 @@ It's also possible to get raw list of commands (useful for embedding command run * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -512,11 +574,14 @@ upsun multi [-p|--projects PROJECTS] [--continue] [--sort SORT] [--reverse] [--] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -531,45 +596,6 @@ upsun multi [-p|--projects PROJECTS] [--continue] [--sort SORT] [--reverse] [--] upsun multi -p l7ywemwizmmgb,o43m25zns6k2d,3nyujoslhydhx -- var -e main ``` -## `web` - -Open the project in the Web Console - -### Usage - -``` -upsun web [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] -``` - -#### Options - -* `--browser` (expects a value) - The browser to use to open the URL. Set 0 for none. - -* `--pipe` - Output the URL to stdout. - -* `--project` (`-p`) (expects a value) - The project ID or URL - -* `--environment` (`-e`) (expects a value) - The environment ID. Use "." to select the project's default environment. - -* `--help` (`-h`) - Display this help message - -* `--verbose` (`-v|-vv|-vvv`) - Increase the verbosity of messages - -* `--version` (`-V`) - Display this application version - -* `--yes` (`-y`) - Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction - -* `--no-interaction` - Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: UPSUN_CLI_NO_INTERACTION=1 - ## `activity:cancel` Cancel an activity @@ -605,11 +631,14 @@ upsun activity:cancel [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [-a|--al * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -676,11 +705,14 @@ upsun activity:get [-P|--property PROPERTY] [-t|--type TYPE] [-x|--exclude-type * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -759,11 +791,14 @@ upsun activities [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMI * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -775,7 +810,7 @@ upsun activities [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMI * List recent activities for the current environment: ``` -upsun activity:list +upsun activity:list ``` * List all recent activities for the current project: @@ -795,7 +830,7 @@ upsun activity:list --exclude-type '*.cron,*.backup*' * List pushes made before 15 March: ``` -upsun activity:list --type push --start {{ now.Year }}-03-15 +upsun activity:list --type push --start 2015-03-15 ``` * List up to 25 incomplete activities: @@ -856,11 +891,14 @@ upsun activity:log [--refresh REFRESH] [-t|--timestamps] [--type TYPE] [-x|--exc * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -918,11 +956,14 @@ upsun app:config-get [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -963,7 +1004,7 @@ upsun app:config-validate * Validate the project configuration files in your current directory: ``` -upsun app:config-validate +upsun app:config-validate ``` ## `app:list` @@ -1004,11 +1045,14 @@ upsun apps [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRON * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1039,11 +1083,14 @@ Alternatively, to log in to the CLI with a browser, run: * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1097,11 +1144,14 @@ UPSUN_CLI_TOKEN environment variable. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1147,11 +1197,14 @@ upsun auth:info [--no-auto-login] [-P|--property PROPERTY] [--refresh] [--format * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1199,11 +1252,14 @@ upsun logout [-a|--all] [--other] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1226,11 +1282,14 @@ upsun auth:verify-phone-number * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1275,11 +1334,14 @@ upsun backup [--live] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W| * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1291,7 +1353,7 @@ upsun backup [--live] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W| * Make a backup of the current environment: ``` -upsun backup:create +upsun backup:create ``` * Request a backup (and exit quickly): @@ -1336,11 +1398,14 @@ upsun backup:delete [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|-- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1380,11 +1445,14 @@ upsun backup:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environme * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1427,11 +1495,14 @@ upsun backups [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1453,7 +1524,7 @@ Restore an environment backup ### Usage ``` -upsun backup:restore [--target TARGET] [--branch-from BRANCH-FROM] [--no-code] [--resources-init RESOURCES-INIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [] +upsun backup:restore [--target TARGET] [--branch-from BRANCH-FROM] [--no-code] [--no-resources] [--resources-init RESOURCES-INIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [] ``` #### Arguments @@ -1472,8 +1543,11 @@ upsun backup:restore [--target TARGET] [--branch-from BRANCH-FROM] [--no-code] [ * `--no-code` Do not restore code, only data. +* `--no-resources` + Do not override the target's existing resource settings. + * `--resources-init` (expects a value) - Set the resources to use for new services: parent, default or minimum. If not set, "parent" will be used. + Set the resources to use for new services: backup, parent, default or minimum. If not set, "backup" will be used. * `--project` (`-p`) (expects a value) The project ID or URL @@ -1490,11 +1564,14 @@ upsun backup:restore [--target TARGET] [--branch-from BRANCH-FROM] [--no-code] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1506,7 +1583,7 @@ upsun backup:restore [--target TARGET] [--branch-from BRANCH-FROM] [--no-code] [ * Restore the most recent backup: ``` -upsun backup:restore +upsun backup:restore ``` * Restore a specific backup: @@ -1547,11 +1624,14 @@ upsun certificate:add [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PR * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -1588,11 +1668,14 @@ upsun certificate:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] ] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2521,11 +2646,14 @@ This command allows you to delete environments as well as their Git branches. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2537,7 +2665,7 @@ This command allows you to delete environments as well as their Git branches. * Delete the currently checked out environment: ``` -upsun environment:delete +upsun environment:delete ``` * Delete the environments "test" and "example-1": @@ -2555,6 +2683,110 @@ upsun environment:delete --inactive upsun environment:delete --merged ``` +## `environment:deploy` + +Deploy an environment's staged changes + +Aliases: `env:deploy` + +### Usage + +``` +upsun env:deploy [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] +``` + +#### Options + +* `--project` (`-p`) (expects a value) + The project ID or URL + +* `--environment` (`-e`) (expects a value) + The environment ID. Use "." to select the project's default environment. + +* `--no-wait` (`-W`) + Do not wait for the operation to complete + +* `--wait` + Wait for the operation to complete (default) + +* `--help` (`-h`) + Display this help message + +* `--version` (`-V`) + Display this application version + +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + +* `--yes` (`-y`) + Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction + +* `--no-interaction` + Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: UPSUN_CLI_NO_INTERACTION=1 + +## `environment:deploy:type` + +Show or set the environment deployment type + +### Usage + +``` +upsun environment:deploy:type [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [] +``` + +Choose automatic (the default) if you want your changes to be deployed immediately as they are made. +Choose manual to have changes staged until you trigger a deployment (including changes to code, variables, domains and settings). + +#### Arguments + +* `type`(optional) + The environment deployment type: automatic or manual. + +#### Options + +* `--pipe` + Output the deployment type to stdout + +* `--project` (`-p`) (expects a value) + The project ID or URL + +* `--environment` (`-e`) (expects a value) + The environment ID. Use "." to select the project's default environment. + +* `--no-wait` (`-W`) + Do not wait for the operation to complete + +* `--wait` + Wait for the operation to complete (default) + +* `--help` (`-h`) + Display this help message + +* `--version` (`-V`) + Display this application version + +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + +* `--yes` (`-y`) + Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction + +* `--no-interaction` + Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: UPSUN_CLI_NO_INTERACTION=1 + +### Examples + +* Set the deployment type to "manual" (disable automatic deployments): +``` +upsun environment:deploy:type manual +``` + ## `environment:drush` Run a drush command on the remote environment @@ -2586,11 +2818,14 @@ upsun drush [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2658,11 +2893,14 @@ upsun httpaccess [--access ACCESS] [--auth AUTH] [--enabled ENABLED] [-p|--proje * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2742,11 +2980,14 @@ upsun environment:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2758,7 +2999,7 @@ upsun environment:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|- * Read all environment properties: ``` -upsun environment:info +upsun environment:info ``` * Show the environment's status: @@ -2826,11 +3067,14 @@ upsun environment:init [--profile PROFILE] [-p|--project PROJECT] [-e|--environm * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2888,11 +3132,14 @@ upsun environments [-I|--no-inactive] [--status STATUS] [--pipe] [--refresh REFR * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2943,11 +3190,14 @@ upsun log [--lines LINES] [--tail] [-p|--project PROJECT] [-e|--environment ENVI * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -2959,7 +3209,7 @@ upsun log [--lines LINES] [--tail] [-p|--project PROJECT] [-e|--environment ENVI * Display a choice of logs that can be read: ``` -upsun environment:logs +upsun environment:logs ``` * Read the deploy log: @@ -3016,11 +3266,14 @@ This command will initiate a Git merge of the specified environment into its par * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3066,11 +3319,14 @@ The environment will be unavailable until it is resumed. No data will be lost. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3139,11 +3395,14 @@ upsun push [--target TARGET] [-f|--force] [--force-with-lease] [-u|--set-upstrea * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3155,7 +3414,7 @@ upsun push [--target TARGET] [-f|--force] [--force-with-lease] [-u|--set-upstrea * Push code to the current environment: ``` -upsun environment:push +upsun environment:push ``` * Push code, without waiting for deployment: @@ -3197,11 +3456,14 @@ upsun redeploy [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wa * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3246,11 +3508,14 @@ upsun relationships [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3262,7 +3527,7 @@ upsun relationships [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] * View all the current environment's relationships: ``` -upsun environment:relationships +upsun environment:relationships ``` * View the 'main' environment's relationships: @@ -3302,11 +3567,14 @@ upsun environment:resume [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3354,11 +3622,14 @@ upsun scp [-r|--recursive] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3434,11 +3705,14 @@ upsun ssh [--pipe] [--all] [-o|--option OPTION] [-p|--project PROJECT] [-e|--env * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3450,7 +3724,7 @@ upsun ssh [--pipe] [--all] [-o|--option OPTION] [-p|--project PROJECT] [-e|--env * Open a shell over SSH: ``` -upsun environment:ssh +upsun environment:ssh ``` * Pass an extra option to SSH: @@ -3522,11 +3796,14 @@ will be used for all corresponding apps and services in the child environment. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3583,11 +3860,14 @@ upsun url [-1|--primary] [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3599,7 +3879,7 @@ upsun url [-1|--primary] [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e * Give a choice of URLs to open (or print all URLs if there is no browser): ``` -upsun environment:url +upsun environment:url ``` * Print all URLs: @@ -3652,11 +3932,14 @@ upsun xdebug [--port PORT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3668,7 +3951,7 @@ upsun xdebug [--port PORT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] * Connect to Xdebug on the environment, listening locally on port 9000.: ``` -upsun environment:xdebug +upsun environment:xdebug ``` ## `integration:activity:get` @@ -3715,11 +3998,14 @@ upsun integration:activity:get [-P|--property PROPERTY] [-p|--project PROJECT] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3788,11 +4074,14 @@ upsun integration:activities [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--l * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -3835,11 +4124,14 @@ upsun integration:activity:log [-t|--timestamps] [--date-fmt DATE-FMT] [-p|--pro * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4003,11 +4295,14 @@ upsun integration:add [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BITBU * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4056,11 +4351,14 @@ upsun integration:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4474,11 +4787,14 @@ upsun metrics [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4490,7 +4806,7 @@ upsun metrics [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] * Show metrics for the last 10m: ``` -upsun metrics:all +upsun metrics:all ``` * Show metrics in five-minute intervals over the last hour: @@ -4556,11 +4872,14 @@ upsun cpu [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4627,11 +4946,14 @@ upsun disk [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4695,12 +5017,15 @@ upsun mem [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1 * `--help` (`-h`) Display this help message -* `--verbose` (`-v|-vv|-vvv`) - Increase the verbosity of messages - * `--version` (`-V`) Display this application version +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4761,11 +5086,14 @@ upsun mount:download [-a|--all] [-m|--mount MOUNT] [--target TARGET] [--source-p * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4820,11 +5148,14 @@ upsun mounts [--paths] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--n * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4880,11 +5211,14 @@ upsun mount:upload [--source SOURCE] [-m|--mount MOUNT] [--delete] [--exclude EX * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4933,11 +5267,14 @@ upsun ops [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--a * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -4983,11 +5320,14 @@ upsun operation:run [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|-- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5022,7 +5362,7 @@ upsun organization:billing:address [-o|--org ORG] [-p|--project PROJECT] [--date The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--date-fmt` (expects a value) The date format (as a PHP date format string) @@ -5039,11 +5379,14 @@ upsun organization:billing:address [-o|--org ORG] [-p|--project PROJECT] [--date * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5075,7 +5418,7 @@ upsun organization:billing:profile [-o|--org ORG] [-p|--project PROJECT] [--date The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--date-fmt` (expects a value) The date format (as a PHP date format string) @@ -5092,11 +5435,14 @@ upsun organization:billing:profile [-o|--org ORG] [-p|--project PROJECT] [--date * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5134,11 +5480,14 @@ Access to individual projects (API and SSH) is managed separately, for now. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5162,16 +5511,19 @@ upsun organization:delete [-o|--org ORG] [-p|--project PROJECT] The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5186,7 +5538,7 @@ View or change organization details ### Usage ``` -upsun organization:info [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--] [] [] +upsun organization:info [-o|--org ORG] [-p|--project PROJECT] [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--] [] [] ``` #### Arguments @@ -5203,7 +5555,10 @@ upsun organization:info [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DATE-F The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used + +* `--refresh` + Refresh the cache * `--date-fmt` (expects a value) The date format (as a PHP date format string) @@ -5220,11 +5575,14 @@ upsun organization:info [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DATE-F * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5284,11 +5642,14 @@ upsun orgs [--my] [--sort SORT] [--reverse] [--format FORMAT] [-c|--columns COLU * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5320,7 +5681,7 @@ upsun org:subs [--page PAGE] [-c|--count COUNT] [-o|--org ORG] [-p|--project PRO The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--format` (expects a value) The output format: table, csv, tsv, or plain @@ -5334,11 +5695,14 @@ upsun org:subs [--page PAGE] [-c|--count COUNT] [-o|--org ORG] [-p|--project PRO * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5372,11 +5736,14 @@ upsun organization:user:add [-o|--org ORG] [--permission PERMISSION] [--] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5457,11 +5827,14 @@ upsun organization:user:get [-o|--org ORG] [-P|--property PROPERTY] [--date-fmt * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5510,11 +5883,14 @@ upsun org:users [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [--d * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5562,11 +5938,14 @@ upsun oups [-o|--org ORG] [--list-all] [--format FORMAT] [-c|--columns COLUMNS] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5600,11 +5979,14 @@ upsun organization:user:update [-o|--org ORG] [--permission PERMISSION] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5780,11 +6174,14 @@ upsun get [-e|--environment ENVIRONMENT] [--depth DEPTH] [-p|--project PROJECT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5846,11 +6243,14 @@ upsun project:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--col * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -5862,7 +6262,7 @@ upsun project:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--col * Read all project properties: ``` -upsun project:info +upsun project:info ``` * Show the project's Git URL: @@ -5908,7 +6308,7 @@ upsun project:init * Create the starter YAML files for your project: ``` -upsun project:init +upsun project:init ``` ## `project:list` @@ -5970,11 +6370,14 @@ upsun projects [--pipe] [--region REGION] [--title TITLE] [--my] [--refresh REFR * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6004,11 +6407,14 @@ upsun set-remote [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6057,11 +6463,14 @@ upsun repo:cat [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENV * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6071,9 +6480,9 @@ upsun repo:cat [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENV ### Examples -* Read the configuration file: +* Read the services configuration file: ``` -upsun repo:cat .upsun/config.yaml +upsun repo:cat .upsun/services.yaml ``` ## `repo:ls` @@ -6114,11 +6523,14 @@ upsun repo:ls [-d|--directories] [-f|--files] [--git-style] [-c|--commit COMMIT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6157,11 +6569,14 @@ upsun read [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRON * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6198,11 +6613,14 @@ upsun build-resources:get [-p|--project PROJECT] [--format FORMAT] [-c|--columns * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6236,11 +6654,14 @@ upsun build-resources:set [--cpu CPU] [--memory MEMORY] [-p|--project PROJECT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6257,7 +6678,7 @@ Aliases: `resources`, `res` ### Usage ``` -upsun resources [-s|--service SERVICE] [--app APP] [--worker WORKER] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] +upsun resources [-s|--service SERVICE] [--app APP] [--worker WORKER] [--type TYPE] [--cpu-type [CPU-TYPE]] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] ``` #### Options @@ -6274,6 +6695,9 @@ upsun resources [-s|--service SERVICE] [--app APP] [--worker WORKER] [--type TYP * `--type` (expects a value) Filter by service, app or worker type, e.g. "postgresql" +* `--cpu-type` (expects a value) + Filter by CPU type, e.g "guaranteed" + * `--project` (`-p`) (expects a value) The project ID or URL @@ -6284,7 +6708,7 @@ upsun resources [-s|--service SERVICE] [--app APP] [--worker WORKER] [--type TYP The output format: table, csv, tsv, or plain * `--columns` (`-c`) (expects a value) - Columns to display. Available columns: service*, profile_size*, cpu*, memory*, disk*, instance_count*, base_memory, memory_ratio, profile, 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. + Columns to display. Available columns: service*, profile_size*, cpu_type*, cpu*, memory*, disk*, instance_count*, base_memory, memory_ratio, profile, 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 @@ -6292,11 +6716,14 @@ upsun resources [-s|--service SERVICE] [--app APP] [--worker WORKER] [--type TYP * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6354,11 +6781,14 @@ If the same service and resource is specified on the command line multiple times * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6423,7 +6853,7 @@ upsun resources:sizes [-s|--service SERVICE] [--profile PROFILE] [-p|--project P The output format: table, csv, tsv, or plain * `--columns` (`-c`) (expects a value) - Columns to display. Available columns: cpu, memory, size. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. "a,b,c") and/or whitespace. + Columns to display. Available columns: size*, cpu*, memory*, cpu_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 @@ -6431,11 +6861,14 @@ upsun resources:sizes [-s|--service SERVICE] [--profile PROFILE] [-p|--project P * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6490,11 +6923,14 @@ upsun route:get [--id ID] [-1|--primary] [-P|--property PROPERTY] [--refresh] [- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6549,11 +6985,14 @@ upsun routes [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6599,11 +7038,14 @@ upsun services [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENV * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6649,11 +7091,14 @@ upsun mongodump [-c|--collection COLLECTION] [-z|--gzip] [-o|--stdout] [-r|--rel * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6702,11 +7147,14 @@ upsun mongoexport [-c|--collection COLLECTION] [--jsonArray] [--type TYPE] [-f|- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6753,11 +7201,14 @@ upsun mongorestore [-c|--collection COLLECTION] [-r|--relationship RELATIONSHIP] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6774,7 +7225,7 @@ Aliases: `mongo` ### Usage ``` -upsun mongosh [--eval EVAL] [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] +upsun mongo [--eval EVAL] [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] ``` #### Options @@ -6797,11 +7248,14 @@ upsun mongosh [--eval EVAL] [-r|--relationship RELATIONSHIP] [-p|--project PROJE * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6825,13 +7279,13 @@ Aliases: `redis` ### Usage ``` -upsun redis [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] [] +upsun redis [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] []... ``` #### Arguments -* `args`(optional) - Arguments to add to the Redis command +* `args`(optional; multiple values allowed) + Arguments to add to the redis-cli command #### Options @@ -6850,11 +7304,14 @@ upsun redis [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--enviro * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6866,7 +7323,7 @@ upsun redis [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--enviro * Open the redis-cli shell: ``` -upsun service:redis-cli +upsun service:redis-cli ``` * Ping the Redis server: @@ -6889,6 +7346,82 @@ upsun service:redis-cli -- --scan upsun service:redis-cli -- "--scan --pattern '*-11*'" ``` +## `service:valkey-cli` + +Access the Valkey CLI + +Aliases: `valkey` + +### Usage + +``` +upsun valkey [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] []... +``` + +#### Arguments + +* `args`(optional; multiple values allowed) + Arguments to add to the valkey-cli command + +#### Options + +* `--relationship` (`-r`) (expects a value) + The service relationship to use + +* `--project` (`-p`) (expects a value) + The project ID or URL + +* `--environment` (`-e`) (expects a value) + The environment ID. Use "." to select the project's default environment. + +* `--app` (`-A`) (expects a value) + The remote application name + +* `--help` (`-h`) + Display this help message + +* `--version` (`-V`) + Display this application version + +* `--verbose` (`-v|-vv|-vvv`) + Increase the verbosity of messages + +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. + +* `--yes` (`-y`) + Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction + +* `--no-interaction` + Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: UPSUN_CLI_NO_INTERACTION=1 + +### Examples + +* Open the valkey-cli shell: +``` +upsun service:valkey-cli +``` + +* Ping the Valkey server: +``` +upsun service:valkey-cli ping +``` + +* Show Valkey status information: +``` +upsun service:valkey-cli info +``` + +* Scan keys: +``` +upsun service:valkey-cli -- --scan +``` + +* Scan keys matching a pattern: +``` +upsun service:valkey-cli -- "--scan --pattern '*-11*'" +``` + ## `source-operation:list` List source operations on an environment @@ -6924,11 +7457,14 @@ upsun source-ops [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -6971,11 +7507,14 @@ upsun source-operation:run [--variable VARIABLE] [-p|--project PROJECT] [-e|--en * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7030,11 +7569,14 @@ explicitly. For unattended scripts, remember to turn off interaction via * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7073,11 +7615,14 @@ To load or check your SSH certificate, run: upsun ssh-cert:load * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7113,11 +7658,14 @@ To load or check your SSH certificate, run: upsun ssh-cert:load * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7166,11 +7714,14 @@ To load or check your SSH certificate, run: upsun ssh-cert:load * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7219,11 +7770,14 @@ upsun subscription:info [-s|--id ID] [--date-fmt DATE-FMT] [--format FORMAT] [-c * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7235,7 +7789,7 @@ upsun subscription:info [-s|--id ID] [--date-fmt DATE-FMT] [--format FORMAT] [-c * View all subscription properties: ``` -upsun subscription:info +upsun subscription:info ``` * View the subscription status: @@ -7278,11 +7832,14 @@ upsun team:create [--label LABEL] [--no-check-unique] [-r|--role ROLE] [--output * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7311,11 +7868,14 @@ upsun team:delete [-o|--org ORG] [-t|--team TEAM] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7339,7 +7899,7 @@ upsun team:get [-o|--org ORG] [-p|--project PROJECT] [-t|--team TEAM] [-P|--prop The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--team` (`-t`) (expects a value) The team ID @@ -7362,11 +7922,14 @@ upsun team:get [-o|--org ORG] [-p|--project PROJECT] [-t|--team TEAM] [-P|--prop * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7383,7 +7946,7 @@ Aliases: `teams` ### Usage ``` -upsun teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DATE-FMT] [--format FORMAT] [--columns COLUMNS] [--no-header] +upsun teams [-c|--count COUNT] [--sort SORT] [--reverse] [-A|--all] [-o|--org ORG] [-p|--project PROJECT] [--date-fmt DATE-FMT] [--format FORMAT] [--columns COLUMNS] [--no-header] ``` #### Options @@ -7397,11 +7960,14 @@ upsun teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|--pr * `--reverse` Sort in reverse order +* `--all` (`-A`) + List all teams in the organization (regardless of a selected project) + * `--org` (`-o`) (expects a value) The organization name (or ID) * `--project` (`-p`) (expects a value) - The project ID or URL, to auto-select the organization if --org is not used + The project ID or URL, which auto-selects the organization if --org is not used * `--date-fmt` (expects a value) The date format (as a PHP date format string) @@ -7410,7 +7976,7 @@ upsun teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|--pr The output format: table, csv, tsv, or plain * `--columns` (expects a value) - Columns to display. Available columns: id*, label*, member_count*, project_count*, project_permissions*, created_at, 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. + Columns to display. Available columns: id*, label*, member_count*, project_count*, project_permissions*, created_at, granted_at, 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 @@ -7418,11 +7984,14 @@ upsun teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|--pr * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7430,6 +7999,23 @@ upsun teams [-c|--count COUNT] [--sort SORT] [--reverse] [-o|--org ORG] [-p|--pr * `--no-interaction` Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: UPSUN_CLI_NO_INTERACTION=1 +### Examples + +* List teams (in the current project, if any): +``` +upsun team:list +``` + +* List all teams in an organization: +``` +upsun team:list --all +``` + +* List teams with access to a specified project, including when they were added: +``` +upsun team:list --project myProjectId --columns +granted_at +``` + ## `team:project:add` Add project(s) to a team @@ -7459,11 +8045,14 @@ upsun team:project:add [--all] [-o|--org ORG] [-t|--team TEAM] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7497,11 +8086,14 @@ upsun team:project:delete [-o|--org ORG] [-t|--team TEAM] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7547,11 +8139,14 @@ upsun team:projects [-c|--count COUNT] [-o|--org ORG] [-t|--team TEAM] [--date-f * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7595,11 +8190,14 @@ upsun team:update [--label LABEL] [--no-check-unique] [-r|--role ROLE] [-t|--tea * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7633,11 +8231,14 @@ upsun team:user:add [-o|--org ORG] [-t|--team TEAM] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7671,11 +8272,14 @@ upsun team:user:delete [-o|--org ORG] [-t|--team TEAM] [--] [] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7721,11 +8325,14 @@ upsun team:users [-c|--count COUNT] [-o|--org ORG] [-t|--team TEAM] [--date-fmt * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7760,11 +8367,14 @@ upsun tunnel:close [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONME * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7802,11 +8412,14 @@ upsun tunnel:info [-P|--property PROPERTY] [-c|--encode] [-p|--project PROJECT] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7852,11 +8465,14 @@ upsun tunnels [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [ * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7902,11 +8518,14 @@ extensions. * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7947,11 +8566,14 @@ upsun tunnel:single [--port PORT] [-g|--gateway-ports] [-p|--project PROJECT] [- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -7994,11 +8616,14 @@ upsun user:add [-r|--role ROLE] [--force-invite] [-p|--project PROJECT] [-W|--no * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8052,11 +8677,14 @@ upsun user:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8112,11 +8740,14 @@ upsun user:get [-l|--level LEVEL] [--pipe] [-p|--project PROJECT] [-e|--environm * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8165,11 +8796,14 @@ upsun users [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8209,11 +8843,14 @@ upsun user:update [-r|--role ROLE] [-p|--project PROJECT] [-W|--no-wait] [--wait * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8298,11 +8935,14 @@ upsun variable:create [-u|--update] [-l|--level LEVEL] [--name NAME] [--value VA * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8345,11 +8985,14 @@ upsun variable:delete [-l|--level LEVEL] [-p|--project PROJECT] [-e|--environmen * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8410,11 +9053,14 @@ upsun vget [-P|--property PROPERTY] [-l|--level LEVEL] [--format FORMAT] [-c|--c * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8464,11 +9110,14 @@ upsun variables [-l|--level LEVEL] [--format FORMAT] [-c|--columns COLUMNS] [--n * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8535,11 +9184,14 @@ upsun variable:update [--allow-no-change] [-l|--level LEVEL] [--value VALUE] [-- * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction @@ -8585,11 +9237,14 @@ upsun workers [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVI * `--help` (`-h`) Display this help message +* `--version` (`-V`) + Display this application version + * `--verbose` (`-v|-vv|-vvv`) Increase the verbosity of messages -* `--version` (`-V`) - Display this application version +* `--quiet` (`-q`) + Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode. * `--yes` (`-y`) Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction