@salesforce/cli 1.26.0 → 1.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,12 @@
2
2
 
3
3
  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.
4
4
 
5
+ ## [1.29.0](https://github.com/salesforcecli/cli/compare/v1.28.0...v1.29.0) (2022-05-18)
6
+
7
+ ## [1.28.0](https://github.com/salesforcecli/cli/compare/v1.27.0...v1.28.0) (2022-05-11)
8
+
9
+ ## [1.27.0](https://github.com/salesforcecli/cli/compare/v1.26.0...v1.27.0) (2022-05-04)
10
+
5
11
  ## [1.26.0](https://github.com/salesforcecli/cli/compare/v1.25.2...v1.26.0) (2022-04-28)
6
12
 
7
13
  ### Bug Fixes
package/README.md CHANGED
@@ -31,7 +31,7 @@ $ npm install -g @salesforce/cli
31
31
  $ sf COMMAND
32
32
  running command...
33
33
  $ sf (--version|-v)
34
- @salesforce/cli/1.26.0 linux-x64 node-v14.19.1
34
+ @salesforce/cli/1.29.0 linux-x64 node-v14.19.3
35
35
  $ sf --help [COMMAND]
36
36
  USAGE
37
37
  $ sf COMMAND
@@ -52,6 +52,11 @@ USAGE
52
52
  - [`sf deploy`](#sf-deploy)
53
53
  - [`sf deploy functions`](#sf-deploy-functions)
54
54
  - [`sf deploy metadata`](#sf-deploy-metadata)
55
+ - [`sf deploy metadata cancel`](#sf-deploy-metadata-cancel)
56
+ - [`sf deploy metadata quick`](#sf-deploy-metadata-quick)
57
+ - [`sf deploy metadata report`](#sf-deploy-metadata-report)
58
+ - [`sf deploy metadata resume`](#sf-deploy-metadata-resume)
59
+ - [`sf deploy metadata validate`](#sf-deploy-metadata-validate)
55
60
  - [`sf env compute collaborator add`](#sf-env-compute-collaborator-add)
56
61
  - [`sf env create compute`](#sf-env-create-compute)
57
62
  - [`sf env create sandbox`](#sf-env-create-sandbox)
@@ -130,7 +135,7 @@ EXAMPLES
130
135
  $ sf autocomplete --refresh-cache
131
136
  ```
132
137
 
133
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.2.0/src/commands/autocomplete/index.ts)_
138
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.0/src/commands/autocomplete/index.ts)_
134
139
 
135
140
  ## `sf config get`
136
141
 
@@ -333,7 +338,7 @@ EXAMPLES
333
338
  $ sf deploy --interactive
334
339
  ```
335
340
 
336
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.3.0/src/commands/deploy.ts)_
341
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.4.3/src/commands/deploy.ts)_
337
342
 
338
343
  ## `sf deploy functions`
339
344
 
@@ -355,8 +360,9 @@ Deploy metadata in source format to an org from your local project.
355
360
 
356
361
  ```
357
362
  USAGE
358
- $ sf deploy metadata [--json] [-a <value>] [--dry-run] [-r] [-g] [-x <value>] [-m <value>] [-d <value>] [-o
359
- <value>] [-t <value>] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--verbose] [-w <value>]
363
+ $ sf deploy metadata [--json] [-a <value>] [--async | -w <value>] [--concise | --verbose] [--dry-run] [-r] [-g] [-x
364
+ <value>] [-m <value>] [--single-package --metadata-dir <value>] [-d <value>] [-o <value>] [-t <value>] [-l
365
+ NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg]
360
366
 
361
367
  FLAGS
362
368
  -a, --api-version=<value> Target API version for the deploy.
@@ -371,7 +377,12 @@ FLAGS
371
377
  -w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for command to complete and display
372
378
  results.
373
379
  -x, --manifest=<value> Full file path for manifest (package.xml) of components to deploy.
380
+ --async Run the command asynchronously.
381
+ --concise Show concise output of the deploy result.
374
382
  --dry-run Validate deploy and run Apex tests but don’t save to the org.
383
+ --metadata-dir=<value> Root of directory or zip file of metadata formatted files to deploy.
384
+ --single-package Indicates that the metadata zip file points to a directory structure for a single
385
+ package.
375
386
  --verbose Show verbose output of the deploy result.
376
387
 
377
388
  GLOBAL FLAGS
@@ -385,9 +396,6 @@ DESCRIPTION
385
396
  This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org.
386
397
  This command doesn’t attempt to merge your source with the versions in your org.
387
398
 
388
- To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue
389
- to use the CLI.
390
-
391
399
  To deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with
392
400
  multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax
393
401
  applies to --manifest and --source-dir.
@@ -484,19 +492,443 @@ FLAG DESCRIPTIONS
484
492
 
485
493
  -w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
486
494
 
487
- If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
495
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
496
+ returns the job ID. To resume the deployment, run "sf deploy metadata resume". To check the status of the
497
+ deployment, run "sf deploy metadata report".
488
498
 
489
499
  -x, --manifest=<value> Full file path for manifest (package.xml) of components to deploy.
490
500
 
491
501
  All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
492
502
 
503
+ --async Run the command asynchronously.
504
+
505
+ The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the
506
+ CLI. To resume the deployment, run "sf deploy metadata resume". To check the status of the deployment, run "sf
507
+ deploy metadata report".
508
+
493
509
  CONFIGURATION VARIABLES
494
- target-org Username or alias of the org that all commands run against by default. (sf only)
495
- apiVersion API version of your project. Default: API version of your Dev Hub org. (sfdx only)
510
+ target-org Username or alias of the org that all commands run against by default. (sf only)
511
+ org-api-version API version of your project. Default: API version of your Dev Hub org.
496
512
 
497
513
  ENVIRONMENT VARIABLES
498
514
  SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
499
515
  SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
516
+
517
+ ERROR CODES
518
+ Succeeded (0) The deploy succeeded.
519
+ Canceled (1) The deploy was canceled.
520
+ Failed (1) The deploy failed.
521
+ SucceededPartial (68) The deploy partially succeeded.
522
+ InProgress (69) The deploy is in progress.
523
+ Pending (69) The deploy is pending.
524
+ Canceling (69) The deploy is being canceled.
525
+ ```
526
+
527
+ ## `sf deploy metadata cancel`
528
+
529
+ Cancel a deploy operation.
530
+
531
+ ```
532
+ USAGE
533
+ $ sf deploy metadata cancel [--json] [--async | -w <value>] [-i <value>] [-r]
534
+
535
+ FLAGS
536
+ -i, --job-id=<value> Job ID of the deploy operation you want to cancel.
537
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
538
+ -w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
539
+ --async Run the command asynchronously.
540
+
541
+ GLOBAL FLAGS
542
+ --json Format output as json.
543
+
544
+ DESCRIPTION
545
+ Cancel a deploy operation.
546
+
547
+ Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard
548
+ deploys, quick deploys, deploy validations, and deploy cancellations.
549
+
550
+ 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
551
+ recent deploy operation.
552
+
553
+ EXAMPLES
554
+ Cancel a deploy operation using a job ID:
555
+
556
+ $ sf deploy metadata cancel --job-id 0Af0x000017yLUFCA2
557
+
558
+ Cancel the most recent deploy operation:
559
+
560
+ $ sf deploy metadata cancel --use-most-recent
561
+
562
+ FLAG DESCRIPTIONS
563
+ -i, --job-id=<value> Job ID of the deploy operation you want to cancel.
564
+
565
+ These commands return a job ID if they time out or you specified the --async flag:
566
+
567
+ - sf deploy metadata
568
+ - sf deploy metadata validate
569
+ - sf deploy metadata quick
570
+ - sf deploy metadata cancel
571
+
572
+ The job ID is valid for 10 days from when you started the deploy operation.
573
+
574
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
575
+
576
+ For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
577
+ If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.
578
+
579
+ -w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
580
+
581
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To
582
+ resume watching the cancellation, run "sf deploy metadata resume". To check the status of the cancellation, run "sf
583
+ deploy metadata report".
584
+
585
+ --async Run the command asynchronously.
586
+
587
+ The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To
588
+ resume watching the cancellation, run "sf deploy metadata resume". To check the status of the cancellation, run "sf
589
+ deploy metadata report".
590
+ ```
591
+
592
+ ## `sf deploy metadata quick`
593
+
594
+ Quickly deploy a validated deployment to an org.
595
+
596
+ ```
597
+ USAGE
598
+ $ sf deploy metadata quick [--json] [--async | -w <value>] [--concise | --verbose] [-i <value>] [-o <value>] [-r]
599
+
600
+ FLAGS
601
+ -i, --job-id=<value> Job ID of the deployment you want to quick deploy.
602
+ -o, --target-org=<value> Login username or alias for the target org.
603
+ -r, --use-most-recent Use the job ID of the most recently validated deployment.
604
+ -w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for the command to complete and display
605
+ results.
606
+ --async Run the command asynchronously.
607
+ --concise Show concise output of the deploy result.
608
+ --verbose Show verbose output of the deploy result.
609
+
610
+ GLOBAL FLAGS
611
+ --json Format output as json.
612
+
613
+ DESCRIPTION
614
+ Quickly deploy a validated deployment to an org.
615
+
616
+ Before you run this command, first create a validated deployment with the "sf deploy metadata validate" command, which
617
+ returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command.
618
+ Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently
619
+ validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.
620
+
621
+ Executing this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These
622
+ tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the
623
+ deployment to your production org take several hours and you don’t want to risk a failed deploy.
624
+
625
+ This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org.
626
+ This command doesn’t attempt to merge your source with the versions in your org.
627
+
628
+ EXAMPLES
629
+ Run a quick deploy to your default org using a job ID:
630
+
631
+ $ sf deploy metadata quick --job-id 0Af0x000017yLUFCA2
632
+
633
+ Asynchronously run a quick deploy of the most recently validated deployment to an org with alias "my-prod-org":
634
+
635
+ $ sf deploy metadata quick --async --use-most-recent --target-org my-prod-org
636
+
637
+ FLAG DESCRIPTIONS
638
+ -i, --job-id=<value> Job ID of the deployment you want to quick deploy.
639
+
640
+ The job ID is valid for 10 days from when you started the validation.
641
+
642
+ -o, --target-org=<value> Login username or alias for the target org.
643
+
644
+ Overrides your default org.
645
+
646
+ -r, --use-most-recent Use the job ID of the most recently validated deployment.
647
+
648
+ For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most
649
+ recent deployment validation was more than 3 days ago, this flag won't find a job ID.
650
+
651
+ -w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
652
+
653
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To
654
+ resume watching the deploy, run "sf deploy metadata resume". To check the status of the deploy, run "sf deploy
655
+ metadata report".
656
+
657
+ --async Run the command asynchronously.
658
+
659
+ The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To
660
+ resume watching the deploy, run "sf deploy metadata resume". To check the status of the deploy, run "sf deploy
661
+ metadata report".
662
+
663
+ ERROR CODES
664
+ Succeeded (0) The deploy succeeded.
665
+ Canceled (1) The deploy was canceled.
666
+ Failed (1) The deploy failed.
667
+ SucceededPartial (68) The deploy partially succeeded.
668
+ InProgress (69) The deploy is in progress.
669
+ Pending (69) The deploy is pending.
670
+ Canceling (69) The deploy is being canceled.
671
+ ```
672
+
673
+ ## `sf deploy metadata report`
674
+
675
+ Check the status of a deploy operation.
676
+
677
+ ```
678
+ USAGE
679
+ $ sf deploy metadata report [--json] [-i <value>] [-r]
680
+
681
+ FLAGS
682
+ -i, --job-id=<value> Job ID of the deploy operation you want to check the status of.
683
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
684
+
685
+ GLOBAL FLAGS
686
+ --json Format output as json.
687
+
688
+ DESCRIPTION
689
+ Check the status of a deploy operation.
690
+
691
+ Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.
692
+
693
+ 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
694
+ recent deploy operation.
695
+
696
+ EXAMPLES
697
+ Check the status using a job ID:
698
+
699
+ $ sf deploy metadata report --job-id 0Af0x000017yLUFCA2
700
+
701
+ Check the status of the most recent deploy operation:
702
+
703
+ $ sf deploy metadata report --use-most-recent
704
+
705
+ FLAG DESCRIPTIONS
706
+ -i, --job-id=<value> Job ID of the deploy operation you want to check the status of.
707
+
708
+ These commands return a job ID if they time out or you specified the --async flag:
709
+
710
+ - sf deploy metadata
711
+ - sf deploy metadata validate
712
+ - sf deploy metadata quick
713
+ - sf deploy metadata cancel
714
+
715
+ The job ID is valid for 10 days from when you started the deploy operation.
716
+
717
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
718
+
719
+ For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
720
+ If your most recent operation was more than 3 days ago, this flag won't find a job ID.
721
+ ```
722
+
723
+ ## `sf deploy metadata resume`
724
+
725
+ Resume watching a deploy operation.
726
+
727
+ ```
728
+ USAGE
729
+ $ sf deploy metadata resume [--json] [--concise | --verbose] [-i <value>] [-r] [-w <value>]
730
+
731
+ FLAGS
732
+ -i, --job-id=<value> Job ID of the deploy operation you want to resume.
733
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
734
+ -w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
735
+ --concise Show concise output of the deploy operation result.
736
+ --verbose Show verbose output of the deploy operation result.
737
+
738
+ GLOBAL FLAGS
739
+ --json Format output as json.
740
+
741
+ DESCRIPTION
742
+ Resume watching a deploy operation.
743
+
744
+ Use this command to resume watching a deploy operation if the original command times out or you specified the --async
745
+ flag. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations. This
746
+ command doesn't resume the original operation itself, because the operation always continues after you've started it,
747
+ regardless of whether you're watching it or not.
748
+
749
+ 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
750
+ recent deploy operation.
751
+
752
+ EXAMPLES
753
+ Resume watching a deploy operation using a job ID:
754
+
755
+ $ sf deploy metadata resume --job-id 0Af0x000017yLUFCA2
756
+
757
+ Resume watching the most recent deploy operation:
758
+
759
+ $ sf deploy metadata resume --use-most-recent
760
+
761
+ FLAG DESCRIPTIONS
762
+ -i, --job-id=<value> Job ID of the deploy operation you want to resume.
763
+
764
+ These commands return a job ID if they time out or you specified the --async flag:
765
+
766
+ - sf deploy metadata
767
+ - sf deploy metadata validate
768
+ - sf deploy metadata quick
769
+ - sf deploy metadata cancel
770
+
771
+ The job ID is valid for 10 days from when you started the deploy operation.
772
+
773
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
774
+
775
+ For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
776
+ If your most recent operation was more than 3 days ago, this flag won't find a job ID.
777
+
778
+ -w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
779
+
780
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To
781
+ resume watching the deploy operation, run this command again. To check the status of the deploy operation, run "sf
782
+ deploy metadata report".
783
+
784
+ ENVIRONMENT VARIABLES
785
+ SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
786
+
787
+ ERROR CODES
788
+ Succeeded (0) The deploy succeeded.
789
+ Canceled (1) The deploy was canceled.
790
+ Failed (1) The deploy failed.
791
+ SucceededPartial (68) The deploy partially succeeded.
792
+ InProgress (69) The deploy is in progress.
793
+ Pending (69) The deploy is pending.
794
+ Canceling (69) The deploy is being canceled.
795
+ ```
796
+
797
+ ## `sf deploy metadata validate`
798
+
799
+ Validate a metadata deployment without actually executing it.
800
+
801
+ ```
802
+ USAGE
803
+ $ sf deploy metadata validate [--json] [-a <value>] [--async] [--concise | --verbose] [-x <value>] [-m <value>] [-d <value>]
804
+ [--single-package --metadata-dir <value>] [-o <value>] [-t <value>] [-l
805
+ RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <value>]
806
+
807
+ FLAGS
808
+ -a, --api-version=<value> Target API version for the validation.
809
+ -d, --source-dir=<value>... Path to the local source files to validate for deployment.
810
+ -l, --test-level=<option> [default: RunLocalTests] Deployment Apex testing level.
811
+ <options: RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests>
812
+ -m, --metadata=<value>... Metadata component names to validate for deployment.
813
+ -o, --target-org=<value> Login username or alias for the target org.
814
+ -t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
815
+ -w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for the command to complete and
816
+ display results.
817
+ -x, --manifest=<value> Full file path for manifest (package.xml) of components to validate for deployment.
818
+ --async Run the command asynchronously.
819
+ --concise Show concise output of the validation result.
820
+ --metadata-dir=<value> Root of directory or zip file of metadata formatted files to deploy.
821
+ --single-package Indicates that the metadata zip file points to a directory structure for a single
822
+ package.
823
+ --verbose Show verbose output of the validation result.
824
+
825
+ GLOBAL FLAGS
826
+ --json Format output as json.
827
+
828
+ DESCRIPTION
829
+ Validate a metadata deployment without actually executing it.
830
+
831
+ Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This
832
+ command is similar to "sf deploy metadata", except you're required to run Apex tests, and the command returns a job ID
833
+ rather than executing the deployment. If the validation succeeds, then you pass this job ID to the "sf deploy metadata
834
+ quick" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests.
835
+ The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to
836
+ your production org take several hours and you don’t want to risk a failed deploy.
837
+
838
+ You must run this command from within a project.
839
+
840
+ This command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy
841
+ overwrites the corresponding metadata in your org.
842
+
843
+ To validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single
844
+ --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double
845
+ quotes. The same syntax applies to --manifest and --source-dir.
846
+
847
+ EXAMPLES
848
+ 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.
849
+
850
+ Validate the deployment of all source files in a directory to the default org:
851
+
852
+ $ sf deploy metadata validate --source-dir path/to/source
853
+
854
+ Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately
855
+ returns the job ID:
856
+
857
+ $ sf deploy metadata validate --source-dir path/to/source --async --test-level RunAllTestsInOrg --target-org \
858
+ my-prod-org
859
+
860
+ Validate the deployment of all components listed in a manifest:
861
+
862
+ $ sf deploy metadata validate --manifest path/to/package.xml
863
+
864
+ FLAG DESCRIPTIONS
865
+ -a, --api-version=<value> Target API version for the validation.
866
+
867
+ Use this flag to override the default API version, which is the latest version supported the CLI, with the API
868
+ version in your package.xml file.
869
+
870
+ -d, --source-dir=<value>... Path to the local source files to validate for deployment.
871
+
872
+ The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder
873
+ (in which case the operation is applied to all metadata types in the directory and its subdirectories).
874
+
875
+ If you specify this flag, don’t specify --metadata or --manifest.
876
+
877
+ -l, --test-level=RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests Deployment Apex testing level.
878
+
879
+ Valid values are:
880
+
881
+ - RunSpecifiedTests — Runs only the tests that you specify with the --run-tests flag. Code coverage requirements
882
+ differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of
883
+ 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
884
+ trigger individually and is different than the overall coverage percentage.
885
+
886
+ - RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked
887
+ packages. This test level is the default for production deployments that include Apex classes or triggers.
888
+
889
+ - RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
890
+
891
+ If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
892
+ information, see [Running Tests in a
893
+ Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)
894
+ in the "Metadata API Developer Guide".
895
+
896
+ -o, --target-org=<value> Login username or alias for the target org.
897
+
898
+ Overrides your default org.
899
+
900
+ -w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
901
+
902
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
903
+ returns the job ID. To resume watching the validation, run "sf deploy metadata resume". To check the status of the
904
+ validation, run "sf deploy metadata report".
905
+
906
+ -x, --manifest=<value> Full file path for manifest (package.xml) of components to validate for deployment.
907
+
908
+ All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
909
+
910
+ --async Run the command asynchronously.
911
+
912
+ The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the
913
+ CLI. To resume watching the validation, run "sf deploy metadata resume". To check the status of the validation, run
914
+ "sf deploy metadata report".
915
+
916
+ CONFIGURATION VARIABLES
917
+ target-org Username or alias of the org that all commands run against by default. (sf only)
918
+ org-api-version API version of your project. Default: API version of your Dev Hub org.
919
+
920
+ ENVIRONMENT VARIABLES
921
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
922
+ SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
923
+
924
+ ERROR CODES
925
+ Succeeded (0) The deploy succeeded.
926
+ Canceled (1) The deploy was canceled.
927
+ Failed (1) The deploy failed.
928
+ SucceededPartial (68) The deploy partially succeeded.
929
+ InProgress (69) The deploy is in progress.
930
+ Pending (69) The deploy is pending.
931
+ Canceling (69) The deploy is being canceled.
500
932
  ```
501
933
 
502
934
  ## `sf env compute collaborator add`
@@ -2118,14 +2550,12 @@ FLAG DESCRIPTIONS
2118
2550
  If you specify this parameter, don’t specify --metadata or --source-dir.
2119
2551
 
2120
2552
  CONFIGURATION VARIABLES
2121
- target-org Username or alias of the org that all commands run against by default. (sf only)
2122
- apiVersion API version of your project. Default: API version of your Dev Hub org. (sfdx only)
2553
+ target-org Username or alias of the org that all commands run against by default. (sf only)
2554
+ org-api-version API version of your project. Default: API version of your Dev Hub org.
2123
2555
 
2124
2556
  ENVIRONMENT VARIABLES
2125
- SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
2126
- SFDX_DEFAULTUSERNAME Username or alias of your default org. Overrides the defaultusername configuration value.
2127
- SFDX_USE_PROGRESS_BAR Set to false to disable the progress bar when running force:mdapi:deploy, force:source:deploy,
2128
- or force:source:push.
2557
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
2558
+ SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
2129
2559
  ```
2130
2560
 
2131
2561
  ## `sf run function`