| 1 | module.exports = {
|
| 2 | description: 'check the status of a metadata deployment',
|
| 3 | longDescription: 'Checks the current status of an asynchronous metadata deployment.',
|
| 4 | help: `Specify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates to the deploy status.
|
| 5 |
|
| 6 | Examples:
|
| 7 |
|
| 8 | Deploy a directory of files to the org
|
| 9 | $ sfdx force:source:deploy -d <directory>
|
| 10 | Now cancel this deployment and wait two minutes
|
| 11 | $ sfdx force:source:deploy:cancel -w 2
|
| 12 |
|
| 13 | If you have multiple deployments in progress and want to cancel a specific one, specify the job ID
|
| 14 | $ sfdx force:source:deploy:cancel -i <jobid>
|
| 15 | Check the status of the cancel job
|
| 16 | $ sfdx force:source:deploy:report`,
|
| 17 |
|
| 18 | jobId: 'job ID of the deployment you want to check; defaults to your most recent CLI deployment if not specified',
|
| 19 | jobIdLong: 'The job ID (asyncId) of the deployment you want to check. If not specified, the default value is the ID of the most recent metadata deployment you ran using Salesforce CLI. Use with -w to resume waiting.'
|
| 20 | };
|