diff --git a/src/bin/vip-export-sql.js b/src/bin/vip-export-sql.js index dc008f77f..e2d48ca1a 100755 --- a/src/bin/vip-export-sql.js +++ b/src/bin/vip-export-sql.js @@ -6,12 +6,19 @@ import { makeCommandTracker } from '../lib/tracker'; const examples = [ { - usage: 'vip export sql @mysite.develop', - description: 'Export SQL file from your site and save it to the current directory', + usage: 'vip @example-app.develop export sql', + description: + 'Download an archived copy of the most recent database backup for an environment to the current local directory.', }, { - usage: 'vip export sql @mysite.develop --output=~/Desktop/export.sql.gz', - description: 'The output file can be specified with the --output flag', + usage: 'vip @example-app.develop export sql --output=~/Desktop/export.sql.gz', + description: + 'Download an archived copy of the most recent database backup for an environment to a specific file path.', + }, + { + usage: 'vip @example-app.develop export sql --generate-backup', + description: + 'Generate a fresh database backup for an environment and download a copy of that backup.', }, ]; @@ -38,11 +45,11 @@ command( { requiredArgs: 0, usage: 'vip export sql', } ) - .option( 'output', 'Specify the location where you want to save the export file' ) .option( - 'generate-backup', - 'Exports a freshly created database backup instead of using the latest existing one' + 'output', + 'Download the file to a specific local directory path with a custom file name.' ) + .option( 'generate-backup', 'Generate a fresh database backup and export a copy of that backup.' ) .examples( examples ) .argv( process.argv, async ( arg, { app, env, output, generateBackup } ) => { const trackerFn = makeCommandTracker( 'export_sql', { diff --git a/src/bin/vip-export.js b/src/bin/vip-export.js index 0181ebe72..e7cc13074 100755 --- a/src/bin/vip-export.js +++ b/src/bin/vip-export.js @@ -4,10 +4,13 @@ import command from '../lib/cli/command'; import { trackEvent } from '../lib/tracker'; command() - .command( 'sql', 'Export the contents of your database to an SQL file' ) + .command( + 'sql', + 'Generate a copy of a database backup for an environment and download it as an archived SQL file.' + ) .example( - 'vip export sql @mysite.develop', - 'Export the contents of your database to an SQL file' + 'vip @example-app.develop export sql', + 'Download a copy of the most recent database backup for an environment as an archived SQL file to the current local directory.' ) .argv( process.argv, async () => { await trackEvent( 'vip_export_command_execute' ); diff --git a/src/bin/vip.js b/src/bin/vip.js index 102ef5d83..b132f08ff 100755 --- a/src/bin/vip.js +++ b/src/bin/vip.js @@ -31,7 +31,7 @@ const runCmd = async function () { .command( 'cache', 'Manage page cache for your VIP applications' ) .command( 'config', 'Set configuration for your VIP applications' ) .command( 'dev-env', 'Use local dev-environment' ) - .command( 'export', 'Export data from your VIP application' ) + .command( 'export', 'Export a copy of data associated with an environment.' ) .command( 'import', 'Import media or SQL files into your VIP applications' ) .command( 'logs', 'Get logs from your VIP applications' ) .command( 'search-replace', 'Perform search and replace tasks on files' )