node_terminus

{ "application": { "name": "Terminus", "version": "2.0.0" }, "commands": [ { "name": "aliases", "usage": [ "aliases [--print] [--location [LOCATION]]", "aliases Saves Pantheon Drush aliases for sites on which the currently logged-in user is on the team to ~/.drush/pantheon.aliases.drushrc.php.", "aliases --print Displays Pantheon Drush aliases for sites on which the currently logged-in user is on the team.", "aliases --location=<full_path> Saves Pantheon Drush aliases for sites on which the currently logged-in user is on the team to <full_path>.", "drush:aliases" ], "description": "Generates Pantheon Drush aliases for sites on which the currently logged-in user is on the team.", "help": "Generates Pantheon Drush aliases for sites on which the currently logged-in user is on the team.", "definition": { "arguments": [], "options": { "print": { "name": "--print", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Print aliases only", "default": false }, "location": { "name": "--location", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "Path and filename; default: ~/.drush/pantheon.aliases.drushrc.php will be used", "default": null }, "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "art", "usage": [ "art [<name>]", "art Displays the list of available artwork.", "art <artwork> Displays the <artwork> artwork." ], "description": "Displays Pantheon ASCII artwork.", "help": "Displays Pantheon ASCII artwork.", "definition": { "arguments": { "name": { "name": "name", "is_required": false, "is_array": false, "description": "Artwork name", "default": "random" } }, "options": { "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "help", "usage": [ "help [--format FORMAT] [--raw] [--] [<command_name>]" ], "description": "Displays help for a command", "help": "The <info>help</info> command displays help for a given command:\n\n <info>php /home/circleci/.composer/vendor/pantheon-systems/terminus/bin/terminus help list</info>\n\nYou can also output the help in other formats by using the <comment>--format</comment> option:\n\n <info>php /home/circleci/.composer/vendor/pantheon-systems/terminus/bin/terminus help --format=xml list</info>\n\nTo display the list of available commands, please use the <info>list</info> command.", "definition": { "arguments": { "command_name": { "name": "command_name", "is_required": false, "is_array": false, "description": "The command name", "default": "help" } }, "options": { "format": { "name": "--format", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "The output format (txt, xml, json, or md)", "default": "txt" }, "raw": { "name": "--raw", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "To output raw command help", "default": false }, "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "list", "usage": [ "list [--raw] [--format FORMAT] [-h|--help] [-q|--quiet] [-v|vv|vvv|--verbose] [-V|--version] [--ansi] [--no-ansi] [-n|--no-interaction] [-y|--yes] [--] <command> [<namespace>]" ], "description": "Lists commands", "help": "The <info>list</info> command lists all commands:\n\n <info>php /home/circleci/.composer/vendor/pantheon-systems/terminus/bin/terminus list</info>\n\nYou can also display the commands for a specific namespace:\n\n <info>php /home/circleci/.composer/vendor/pantheon-systems/terminus/bin/terminus list test</info>\n\nYou can also output the information in other formats by using the <comment>--format</comment> option:\n\n <info>php /home/circleci/.composer/vendor/pantheon-systems/terminus/bin/terminus list --format=xml</info>\n\nIt's also possible to get raw list of commands (useful for embedding command runner):\n\n <info>php /home/circleci/.composer/vendor/pantheon-systems/terminus/bin/terminus list --raw</info>", "definition": { "arguments": { "namespace": { "name": "namespace", "is_required": false, "is_array": false, "description": "The namespace name", "default": null } }, "options": { "raw": { "name": "--raw", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "To output raw command list", "default": false }, "format": { "name": "--format", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "The output format (txt, xml, json, or md)", "default": "txt" } } }, "hidden": false }, { "name": "alpha:env:metrics", "usage": [ "alpha:env:metrics [--period [PERIOD]] [--datapoints [DATAPOINTS]] [--format FORMAT] [--fields FIELDS] [--field FIELD] [--] <site_env>", "alpha:env:metrics <site>.<env> Displays metrics for <site>'s <env> environment.", "alpha:env:metrics <site> Displays the combined metrics for all of <site>'s environments.", "alpha:env:metrics <site> --fields=datetime,pages_served Displays only the pages", "alpha:metrics" ], "description": "Displays the pages served and unique visit metrics for the specified site's environment. The most recent data up to the current day is returned.", "help": "Displays the pages served and unique visit metrics for the specified site's environment. The most recent data up to the current day is returned.", "definition": { "arguments": { "site_env": { "name": "site_env", "is_required": true, "is_array": false, "description": "Site & environment in the format `site-name.env`. Defaults to the live environment if `.env` is not specified.", "default": null } }, "options": { "period": { "name": "--period", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "The time period for each data point (month|week|day)", "default": "day" }, "datapoints": { "name": "--datapoints", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "How much data to return in total, or 'auto' to select a resonable default based on the selected period.", "default": "auto" }, "format": { "name": "--format", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "Format the result data. Available formats: csv,json,list,null,php,print-r,sections,string,table,tsv,var_dump,var_export,xml,yaml", "default": "table" }, "fields": { "name": "--fields", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "Available fields: Period (datetime), Visits (visits), Pages Served (pages_served)", "default": "" }, "field": { "name": "--field", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "Select just one field, and force format to 'string'.", "default": "" }, "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "auth:login", "usage": [ "auth:login [--machine-token [MACHINE-TOKEN]] [--email [EMAIL]]", "auth:login --machine-token=<machine_token> Logs in a user granted the machine token <machine_token>.", "auth:login Logs in a user with a previously saved machine token.", "auth:login --email=<email> Logs in a user with a previously saved machine token belonging to <email>.", "login" ], "description": "Logs in a user to Pantheon.", "help": "Logs in a user to Pantheon.", "definition": { "arguments": [], "options": { "machine-token": { "name": "--machine-token", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "Grants access for a user and is saved for future logins", "default": null }, "email": { "name": "--email", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "Uses an existing machine token for this user", "default": null }, "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "auth:logout", "usage": [ "auth:logout", "auth:logout Logs out of Pantheon and removes saved session and machine tokens.", "logout" ], "description": "Logs out the currently logged-in user and deletes any saved machine tokens.", "help": "Logs out the currently logged-in user and deletes any saved machine tokens.", "definition": { "arguments": [], "options": { "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "auth:whoami", "usage": [ "auth:whoami [--format FORMAT] [--fields FIELDS] [--field FIELD]", "auth:whoami Displays the email of the logged-in user.", "auth:whoami --format=table Displays the current session and user's data.", "whoami" ], "description": "Displays information about the currently logged-in user.", "help": "Displays information about the currently logged-in user.", "definition": { "arguments": [], "options": { "format": { "name": "--format", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "Format the result data. Available formats: csv,json,list,null,php,print-r,string,table,tsv,var_dump,var_export,xml,yaml", "default": "string" }, "fields": { "name": "--fields", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "Available fields: First Name (firstname), Last Name (lastname), Email (email), ID (id)", "default": "" }, "field": { "name": "--field", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "Select just one field, and force format to 'string'.", "default": "" }, "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "backup:automatic:disable", "usage": [ "backup:automatic:disable <site_env>", "backup:automatic:disable <site>.<env> Disables the regular backup schedule for <site>'s <env> environment." ], "description": "Disables automatic backups.", "help": "Disables automatic backups.", "definition": { "arguments": { "site_env": { "name": "site_env", "is_required": true, "is_array": false, "description": "Site & environment in the format `site-name.env`", "default": null } }, "options": { "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "backup:automatic:enable", "usage": [ "backup:automatic:enable [--day [DAY]] [--] <site_env>", "backup:automatic:enable <site>.<env> Enables automatic daily backups of <site>'s <env> environment that are retained for one week and weekly backups that are retained for one month.", "backup:automatic:enable <site>.<env> --day=<day> Enables automatic daily backups of <site>'s <env> environment that are retained for one week and weekly backups on <day> that are retained for one month." ], "description": "Enables automatic daily backups that are retained for one week and weekly backups retained for one month.", "help": "Enables automatic daily backups that are retained for one week and weekly backups retained for one month.", "definition": { "arguments": { "site_env": { "name": "site_env", "is_required": true, "is_array": false, "description": "Site & environment in the format `site-name.env`", "default": null } }, "options": { "day": { "name": "--day", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "Day of the week to make the month-long backup in any format recognized by PHP strtotime", "default": null }, "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "backup:automatic:info", "usage": [ "backup:automatic:info [--format FORMAT] [--fields FIELDS] [--field FIELD] [--] <site_env>", "backup:automatic:info <site>.<env> Displays the day when <site>'s <env> environment's weekly backup is created'.", "backup:automatic:info <site>.<env> --format=table Displays the hour of <site>'s <env> environment's daily backups (retained for one week) and the day on which its weekly backups (retained for one month) are made." ], "description": "Displays the hour when daily backups are created and the day of the week when weekly backups are created.", "help": "Displays the hour when daily backups are created and the day of the week when weekly backups are created.", "definition": { "arguments": { "site_env": { "name": "site_env", "is_required": true, "is_array": false, "description": "Site & environment in the format `site-name.env`", "default": null } }, "options": { "format": { "name": "--format", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "Format the result data. Available formats: csv,json,list,null,php,print-r,string,table,tsv,var_dump,var_export,xml,yaml", "default": "string" }, "fields": { "name": "--fields", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "Available fields: Daily Backup Hour (daily_backup_hour), Weekly Backup Day (weekly_backup_day)", "default": "" }, "field": { "name": "--field", "shortcut": "", "accept_value": true, "is_value_required": true, "is_multiple": false, "description": "Select just one field, and force format to 'string'.", "default": "" }, "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "backup:create", "usage": [ "backup:create [--element [ELEMENT]] [--keep-for [KEEP-FOR]] [--] <site_env>", "backup:create <site>.<env> Creates a backup of <site>'s <env> environment.", "backup:create <site>.<env> --element=<element> Creates a backup of <site>'s <env> environment's <element>.", "backup:create <site>.<env> --keep-for=<days> Creates a backup of <site>'s <env> environment and retains it for <days> days.", "backup:create <site>.<env> --keep-for=<days> Creates a backup of <site>'s <env> environment's <element> and retains it for <days> days." ], "description": "Creates a backup of a specific site and environment.", "help": "Creates a backup of a specific site and environment.", "definition": { "arguments": { "site_env": { "name": "site_env", "is_required": true, "is_array": false, "description": "Site & environment in the format `site-name.env`", "default": null } }, "options": { "element": { "name": "--element", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "[all|code|files|database|db] Element to be backed up", "default": "all" }, "keep-for": { "name": "--keep-for", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "Retention period, in days, to retain backup", "default": 365 }, "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "backup:get", "usage": [ "backup:get [--file [FILE]] [--element [ELEMENT]] [--to [TO]] [--] <site_env>", "backup:get <site>.<env> Displays the URL for the most recent backup of any type in <site>'s <env> environment.", "backup:get <site>.<env> --file=<file_name> Displays the URL for the backup with the file name <file_name> in <site>'s <env> environment.", "backup:get <site>.<env> --element=<element> Displays the URL for the most recent <element> backup in <site>'s <env> environment.", "backup:get <site>.<env> --to=<path> Saves the most recent backup of any type in <site>'s <env> environment to <path>.", "backup:get <site>.<env> --to=<path> Saves the most recent <element> backup in <site>'s <env> environment to <path>." ], "description": "Displays the download URL for a specific backup or latest backup.", "help": "Displays the download URL for a specific backup or latest backup.", "definition": { "arguments": { "site_env": { "name": "site_env", "is_required": true, "is_array": false, "description": "Site & environment in the format `site-name.env`", "default": null } }, "options": { "file": { "name": "--file", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "[filename.tgz] Name of backup file", "default": null }, "element": { "name": "--element", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "[code|files|database|db] Backup element to retrieve", "default": "files" }, "to": { "name": "--to", "shortcut": "", "accept_value": true, "is_value_required": false, "is_multiple": false, "description": "Local path to save to", "default": null }, "help": { "name": "--help", "shortcut": "-h", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this help message", "default": false }, "quiet": { "name": "--quiet", "shortcut": "-q", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not output any message", "default": false }, "verbose": { "name": "--verbose", "shortcut": "-v|-vv|-vvv", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug", "default": false }, "version": { "name": "--version", "shortcut": "-V", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Display this application version", "default": false }, "ansi": { "name": "--ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Force ANSI output", "default": false }, "no-ansi": { "name": "--no-ansi", "shortcut": "", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Disable ANSI output", "default": false }, "no-interaction": { "name": "--no-interaction", "shortcut": "-n", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Do not ask any interactive question", "default": false }, "yes": { "name": "--yes", "shortcut": "-y", "accept_value": false, "is_value_required": false, "is_multiple": false, "description": "Answer all confirmations with \"yes\"", "default": false } } }, "hidden": false }, { "name": "backup:info", "usage": [ "backup:info [--file [FILE]] [--element [ELEMENT]] [--format FORMAT] [--fields FIELDS] [--field FIELD] [--] <site_env>", "backup:info <site>.<env> Displays information about the most recent backup of any type in <site>'s <env> environment.",