@salesforce/cli 1.26.0 → 1.27.0

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.27.0](https://github.com/salesforcecli/cli/compare/v1.26.0...v1.27.0) (2022-05-04)
+
 ## [1.26.0](https://github.com/salesforcecli/cli/compare/v1.25.2...v1.26.0) (2022-04-28)
 
 ### Bug Fixes

package/README.md

@@ -31,7 +31,7 @@ $ npm install -g @salesforce/cli
 $ sf COMMAND
 running command...
 $ sf (--version|-v)
-@salesforce/cli/1.26.0 linux-x64 node-v14.19.1
+@salesforce/cli/1.27.0 linux-x64 node-v14.19.2
 $ sf --help [COMMAND]
 USAGE
   $ sf COMMAND
@@ -52,6 +52,11 @@ USAGE
 - [`sf deploy`](#sf-deploy)
 - [`sf deploy functions`](#sf-deploy-functions)
 - [`sf deploy metadata`](#sf-deploy-metadata)
+- [`sf deploy metadata cancel`](#sf-deploy-metadata-cancel)
+- [`sf deploy metadata quick`](#sf-deploy-metadata-quick)
+- [`sf deploy metadata report`](#sf-deploy-metadata-report)
+- [`sf deploy metadata resume`](#sf-deploy-metadata-resume)
+- [`sf deploy metadata validate`](#sf-deploy-metadata-validate)
 - [`sf env compute collaborator add`](#sf-env-compute-collaborator-add)
 - [`sf env create compute`](#sf-env-create-compute)
 - [`sf env create sandbox`](#sf-env-create-sandbox)
@@ -130,7 +135,7 @@ EXAMPLES
   $ sf autocomplete --refresh-cache
 ```
 
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.2.0/src/commands/autocomplete/index.ts)_
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.0/src/commands/autocomplete/index.ts)_
 
 ## `sf config get`
 
@@ -333,7 +338,7 @@ EXAMPLES
     $ sf deploy --interactive
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.3.0/src/commands/deploy.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.4.2/src/commands/deploy.ts)_
 
 ## `sf deploy functions`
 
@@ -355,8 +360,9 @@ Deploy metadata in source format to an org from your local project.
 
 ```
 USAGE
-  $ sf deploy metadata [--json] [-a <value>] [--dry-run] [-r] [-g] [-x <value>] [-m <value>] [-d <value>] [-o
-    <value>] [-t <value>] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--verbose] [-w <value>]
+  $ sf deploy metadata [--json] [-a <value>] [--async | -w <value>] [--concise | --verbose] [--dry-run] [-r] [-g] [-x
+    <value>] [-m <value>] [-d <value>] [-o <value>] [-t <value>] [-l
+    NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg]
 
 FLAGS
   -a, --api-version=<value>    Target API version for the deploy.
@@ -371,6 +377,8 @@ FLAGS
   -w, --wait=<minutes>         [default: [object Object]] Number of minutes to wait for command to complete and display
                                results.
   -x, --manifest=<value>       Full file path for manifest (package.xml) of components to deploy.
+  --async                      Run the command asynchronously.
+  --concise                    Show concise output of the deploy result.
   --dry-run                    Validate deploy and run Apex tests but don’t save to the org.
   --verbose                    Show verbose output of the deploy result.
 
@@ -385,9 +393,6 @@ DESCRIPTION
   This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org.
   This command doesn’t attempt to merge your source with the versions in your org.
 
-  To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue
-  to use the CLI.
-
   To deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with
   multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax
   applies to --manifest and --source-dir.
@@ -484,19 +489,439 @@ FLAG DESCRIPTIONS
 
   -w, --wait=<minutes>  Number of minutes to wait for command to complete and display results.
 
-    If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
+    If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
+    returns the job ID. To resume the deployment, run "sf deploy metadata resume". To check the status of the
+    deployment, run "sf deploy metadata report".
 
   -x, --manifest=<value>  Full file path for manifest (package.xml) of components to deploy.
 
     All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
 
+  --async  Run the command asynchronously.
+
+    The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the
+    CLI. To resume the deployment, run "sf deploy metadata resume". To check the status of the deployment, run "sf
+    deploy metadata report".
+
 CONFIGURATION VARIABLES
-  target-org  Username or alias of the org that all commands run against by default. (sf only)
-  apiVersion  API version of your project. Default: API version of your Dev Hub org. (sfdx only)
+  target-org       Username or alias of the org that all commands run against by default. (sf only)
+  org-api-version  API version of your project. Default: API version of your Dev Hub org.
 
 ENVIRONMENT VARIABLES
   SF_TARGET_ORG        Username or alias of your default org. Overrides the target-org configuration variable.
   SF_USE_PROGRESS_BAR  Set to false to disable the progress bar when running the metadata deploy command.
+
+ERROR CODES
+  Succeeded (0)          The deploy succeeded.
+  Canceled (1)           The deploy was canceled.
+  Failed (1)             The deploy failed.
+  SucceededPartial (68)  The deploy partially succeeded.
+  InProgress (69)        The deploy is in progress.
+  Pending (69)           The deploy is pending.
+  Canceling (69)         The deploy is being canceled.
+```
+
+## `sf deploy metadata cancel`
+
+Cancel a deploy operation.
+
+```
+USAGE
+  $ sf deploy metadata cancel [--json] [--async | -w <value>] [-i <value>] [-r]
+
+FLAGS
+  -i, --job-id=<value>   Job ID of the deploy operation you want to cancel.
+  -r, --use-most-recent  Use the job ID of the most recent deploy operation.
+  -w, --wait=<minutes>   Number of minutes to wait for the command to complete and display results.
+  --async                Run the command asynchronously.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Cancel a deploy operation.
+
+  Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard
+  deploys, quick deploys, deploy validations, and deploy cancellations.
+
+  Run this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most
+  recent deploy operation.
+
+EXAMPLES
+  Cancel a deploy operation using a job ID:
+
+    $ sf deploy metadata cancel --job-id 0Af0x000017yLUFCA2
+
+  Cancel the most recent deploy operation:
+
+    $ sf deploy metadata cancel --use-most-recent
+
+FLAG DESCRIPTIONS
+  -i, --job-id=<value>  Job ID of the deploy operation you want to cancel.
+
+    These commands return a job ID if they time out or you specified the --async flag:
+
+    - sf deploy metadata
+    - sf deploy metadata validate
+    - sf deploy metadata quick
+    - sf deploy metadata cancel
+
+    The job ID is valid for 10 days from when you started the deploy operation.
+
+  -r, --use-most-recent  Use the job ID of the most recent deploy operation.
+
+    For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
+    If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.
+
+  -w, --wait=<minutes>  Number of minutes to wait for the command to complete and display results.
+
+    If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To
+    resume watching the cancellation, run "sf deploy metadata resume". To check the status of the cancellation, run "sf
+    deploy metadata report".
+
+  --async  Run the command asynchronously.
+
+    The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To
+    resume watching the cancellation, run "sf deploy metadata resume". To check the status of the cancellation, run "sf
+    deploy metadata report".
+```
+
+## `sf deploy metadata quick`
+
+Quickly deploy a validated deployment to an org.
+
+```
+USAGE
+  $ sf deploy metadata quick [--json] [--async | -w <value>] [--concise | --verbose] [-i <value>] [-o <value>] [-r]
+
+FLAGS
+  -i, --job-id=<value>      Job ID of the deployment you want to quick deploy.
+  -o, --target-org=<value>  Login username or alias for the target org.
+  -r, --use-most-recent     Use the job ID of the most recently validated deployment.
+  -w, --wait=<minutes>      [default: [object Object]] Number of minutes to wait for the command to complete and display
+                            results.
+  --async                   Run the command asynchronously.
+  --concise                 Show concise output of the deploy result.
+  --verbose                 Show verbose output of the deploy result.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Quickly deploy a validated deployment to an org.
+
+  Before you run this command, first create a validated deployment with the "sf deploy metadata validate" command, which
+  returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command.
+  Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently
+  validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.
+
+  Executing this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These
+  tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the
+  deployment to your production org take several hours and you don’t want to risk a failed deploy.
+
+  This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org.
+  This command doesn’t attempt to merge your source with the versions in your org.
+
+EXAMPLES
+  Run a quick deploy to your default org using a job ID:
+
+    $ sf deploy metadata quick --job-id 0Af0x000017yLUFCA2
+
+  Asynchronously run a quick deploy of the most recently validated deployment to an org with alias "my-prod-org":
+
+    $ sf deploy metadata quick --async --use-most-recent --target-org my-prod-org
+
+FLAG DESCRIPTIONS
+  -i, --job-id=<value>  Job ID of the deployment you want to quick deploy.
+
+    The job ID is valid for 10 days from when you started the validation.
+
+  -o, --target-org=<value>  Login username or alias for the target org.
+
+    Overrides your default org.
+
+  -r, --use-most-recent  Use the job ID of the most recently validated deployment.
+
+    For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most
+    recent deployment validation was more than 3 days ago, this flag won't find a job ID.
+
+  -w, --wait=<minutes>  Number of minutes to wait for the command to complete and display results.
+
+    If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To
+    resume watching the deploy, run "sf deploy metadata resume". To check the status of the deploy, run "sf deploy
+    metadata report".
+
+  --async  Run the command asynchronously.
+
+    The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To
+    resume watching the deploy, run "sf deploy metadata resume". To check the status of the deploy, run "sf deploy
+    metadata report".
+
+ERROR CODES
+  Succeeded (0)          The deploy succeeded.
+  Canceled (1)           The deploy was canceled.
+  Failed (1)             The deploy failed.
+  SucceededPartial (68)  The deploy partially succeeded.
+  InProgress (69)        The deploy is in progress.
+  Pending (69)           The deploy is pending.
+  Canceling (69)         The deploy is being canceled.
+```
+
+## `sf deploy metadata report`
+
+Check the status of a deploy operation.
+
+```
+USAGE
+  $ sf deploy metadata report [--json] [-i <value>] [-r]
+
+FLAGS
+  -i, --job-id=<value>   Job ID of the deploy operation you want to check the status of.
+  -r, --use-most-recent  Use the job ID of the most recent deploy operation.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Check the status of a deploy operation.
+
+  Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.
+
+  Run this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most
+  recent deploy operation.
+
+EXAMPLES
+  Check the status using a job ID:
+
+    $ sf deploy metadata report --job-id 0Af0x000017yLUFCA2
+
+  Check the status of the most recent deploy operation:
+
+    $ sf deploy metadata report --use-most-recent
+
+FLAG DESCRIPTIONS
+  -i, --job-id=<value>  Job ID of the deploy operation you want to check the status of.
+
+    These commands return a job ID if they time out or you specified the --async flag:
+
+    - sf deploy metadata
+    - sf deploy metadata validate
+    - sf deploy metadata quick
+    - sf deploy metadata cancel
+
+    The job ID is valid for 10 days from when you started the deploy operation.
+
+  -r, --use-most-recent  Use the job ID of the most recent deploy operation.
+
+    For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
+    If your most recent operation was more than 3 days ago, this flag won't find a job ID.
+```
+
+## `sf deploy metadata resume`
+
+Resume watching a deploy operation.
+
+```
+USAGE
+  $ sf deploy metadata resume [--json] [--concise | --verbose] [-i <value>] [-r] [-w <value>]
+
+FLAGS
+  -i, --job-id=<value>   Job ID of the deploy operation you want to resume.
+  -r, --use-most-recent  Use the job ID of the most recent deploy operation.
+  -w, --wait=<minutes>   Number of minutes to wait for the command to complete and display results.
+  --concise              Show concise output of the deploy operation result.
+  --verbose              Show verbose output of the deploy operation result.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Resume watching a deploy operation.
+
+  Use this command to resume watching a deploy operation if the original command times out or you specified the --async
+  flag. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations. This
+  command doesn't resume the original operation itself, because the operation always continues after you've started it,
+  regardless of whether you're watching it or not.
+
+  Run this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most
+  recent deploy operation.
+
+EXAMPLES
+  Resume watching a deploy operation using a job ID:
+
+    $ sf deploy metadata resume --job-id 0Af0x000017yLUFCA2
+
+  Resume watching the most recent deploy operation:
+
+    $ sf deploy metadata resume --use-most-recent
+
+FLAG DESCRIPTIONS
+  -i, --job-id=<value>  Job ID of the deploy operation you want to resume.
+
+    These commands return a job ID if they time out or you specified the --async flag:
+
+    - sf deploy metadata
+    - sf deploy metadata validate
+    - sf deploy metadata quick
+    - sf deploy metadata cancel
+
+    The job ID is valid for 10 days from when you started the deploy operation.
+
+  -r, --use-most-recent  Use the job ID of the most recent deploy operation.
+
+    For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
+    If your most recent operation was more than 3 days ago, this flag won't find a job ID.
+
+  -w, --wait=<minutes>  Number of minutes to wait for the command to complete and display results.
+
+    If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To
+    resume watching the deploy operation, run this command again. To check the status of the deploy operation, run "sf
+    deploy metadata report".
+
+ENVIRONMENT VARIABLES
+  SF_USE_PROGRESS_BAR  Set to false to disable the progress bar when running the metadata deploy command.
+
+ERROR CODES
+  Succeeded (0)          The deploy succeeded.
+  Canceled (1)           The deploy was canceled.
+  Failed (1)             The deploy failed.
+  SucceededPartial (68)  The deploy partially succeeded.
+  InProgress (69)        The deploy is in progress.
+  Pending (69)           The deploy is pending.
+  Canceling (69)         The deploy is being canceled.
+```
+
+## `sf deploy metadata validate`
+
+Validate a metadata deployment without actually executing it.
+
+```
+USAGE
+  $ sf deploy metadata validate [--json] [-a <value>] [--async] [--concise | --verbose] [-x <value> | -m <value> | -d <value>]
+    [-o <value>] [-t <value>] [-l RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <value>]
+
+FLAGS
+  -a, --api-version=<value>    Target API version for the validation.
+  -d, --source-dir=<value>...  Path to the local source files to validate for deployment.
+  -l, --test-level=<option>    [default: RunLocalTests] Deployment Apex testing level.
+                               <options: RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests>
+  -m, --metadata=<value>...    Metadata component names to validate for deployment.
+  -o, --target-org=<value>     Login username or alias for the target org.
+  -t, --tests=<value>...       Apex tests to run when --test-level is RunSpecifiedTests.
+  -w, --wait=<minutes>         [default: [object Object]] Number of minutes to wait for the command to complete and
+                               display results.
+  -x, --manifest=<value>       Full file path for manifest (package.xml) of components to validate for deployment.
+  --async                      Run the command asynchronously.
+  --concise                    Show concise output of the validation result.
+  --verbose                    Show verbose output of the validation result.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Validate a metadata deployment without actually executing it.
+
+  Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This
+  command is similar to "sf deploy metadata", except you're required to run Apex tests, and the command returns a job ID
+  rather than executing the deployment. If the validation succeeds, then you pass this job ID to the "sf deploy metadata
+  quick" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests.
+  The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to
+  your production org take several hours and you don’t want to risk a failed deploy.
+
+  You must run this command from within a project.
+
+  This command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy
+  overwrites the corresponding metadata in your org.
+
+  To validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single
+  --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double
+  quotes. The same syntax applies to --manifest and --source-dir.
+
+EXAMPLES
+  NOTE: These examples focus on validating large deployments.  See the help for "sf deploy metadata" for examples of deploying smaller sets of metadata which you can also use to validate.
+
+  Validate the deployment of all source files in a directory to the default org:
+
+    $ sf deploy metadata validate --source-dir path/to/source
+
+  Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately
+  returns the job ID:
+
+    $ sf deploy metadata validate --source-dir path/to/source --async --test-level RunAllTestsInOrg --target-org \
+      my-prod-org
+
+  Validate the deployment of all components listed in a manifest:
+
+    $ sf deploy metadata validate --manifest path/to/package.xml
+
+FLAG DESCRIPTIONS
+  -a, --api-version=<value>  Target API version for the validation.
+
+    Use this flag to override the default API version, which is the latest version supported the CLI, with the API
+    version in your package.xml file.
+
+  -d, --source-dir=<value>...  Path to the local source files to validate for deployment.
+
+    The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder
+    (in which case the operation is applied to all metadata types in the directory and its subdirectories).
+
+    If you specify this flag, don’t specify --metadata or --manifest.
+
+  -l, --test-level=RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests  Deployment Apex testing level.
+
+    Valid values are:
+
+    - RunSpecifiedTests — Runs only the tests that you specify with the --run-tests flag. Code coverage requirements
+    differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of
+    75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
+    trigger individually and is different than the overall coverage percentage.
+
+    - RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked
+    packages. This test level is the default for production deployments that include Apex classes or triggers.
+
+    - RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
+
+    If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
+    information, see [Running Tests in a
+    Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)
+    in the "Metadata API Developer Guide".
+
+  -o, --target-org=<value>  Login username or alias for the target org.
+
+    Overrides your default org.
+
+  -w, --wait=<minutes>  Number of minutes to wait for the command to complete and display results.
+
+    If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
+    returns the job ID. To resume watching the validation, run "sf deploy metadata resume". To check the status of the
+    validation, run "sf deploy metadata report".
+
+  -x, --manifest=<value>  Full file path for manifest (package.xml) of components to validate for deployment.
+
+    All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
+
+  --async  Run the command asynchronously.
+
+    The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the
+    CLI. To resume watching the validation, run "sf deploy metadata resume". To check the status of the validation, run
+    "sf deploy metadata report".
+
+CONFIGURATION VARIABLES
+  target-org       Username or alias of the org that all commands run against by default. (sf only)
+  org-api-version  API version of your project. Default: API version of your Dev Hub org.
+
+ENVIRONMENT VARIABLES
+  SF_TARGET_ORG        Username or alias of your default org. Overrides the target-org configuration variable.
+  SF_USE_PROGRESS_BAR  Set to false to disable the progress bar when running the metadata deploy command.
+
+ERROR CODES
+  Succeeded (0)          The deploy succeeded.
+  Canceled (1)           The deploy was canceled.
+  Failed (1)             The deploy failed.
+  SucceededPartial (68)  The deploy partially succeeded.
+  InProgress (69)        The deploy is in progress.
+  Pending (69)           The deploy is pending.
+  Canceling (69)         The deploy is being canceled.
 ```
 
 ## `sf env compute collaborator add`
@@ -2118,14 +2543,12 @@ FLAG DESCRIPTIONS
     If you specify this parameter, don’t specify --metadata or --source-dir.
 
 CONFIGURATION VARIABLES
-  target-org  Username or alias of the org that all commands run against by default. (sf only)
-  apiVersion  API version of your project. Default: API version of your Dev Hub org. (sfdx only)
+  target-org       Username or alias of the org that all commands run against by default. (sf only)
+  org-api-version  API version of your project. Default: API version of your Dev Hub org.
 
 ENVIRONMENT VARIABLES
-  SF_TARGET_ORG          Username or alias of your default org. Overrides the target-org configuration variable.
-  SFDX_DEFAULTUSERNAME   Username or alias of your default org. Overrides the defaultusername configuration value.
-  SFDX_USE_PROGRESS_BAR  Set to false to disable the progress bar when running force:mdapi:deploy, force:source:deploy,
-                         or force:source:push.
+  SF_TARGET_ORG        Username or alias of your default org. Overrides the target-org configuration variable.
+  SF_USE_PROGRESS_BAR  Set to false to disable the progress bar when running the metadata deploy command.
 ```
 
 ## `sf run function`