@salesforce/cli 2.45.4 → 2.45.6-qa.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/README.md +70 -60
- package/bin/dev.js +5 -3
- package/bin/run.js +8 -25
- package/dist/cli.js +21 -38
- package/dist/help/sfCommandHelp.js +1 -1
- package/dist/help/sfHelp.js +6 -5
- package/dist/hooks/display-release-notes.js +4 -10
- package/dist/hooks/incomplete.js +3 -2
- package/dist/hooks/pluginsPreinstall.js +2 -2
- package/dist/hooks/prerun.js +1 -1
- package/dist/logger.js +22 -0
- package/npm-shrinkwrap.json +4307 -2465
- package/oclif.lock +556 -413
- package/oclif.manifest.json +1 -1
- package/package.json +15 -16
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
|
|
|
24
24
|
$ sf COMMAND
|
|
25
25
|
running command...
|
|
26
26
|
$ sf (--version|-v)
|
|
27
|
-
@salesforce/cli/2.45.
|
|
27
|
+
@salesforce/cli/2.45.6-qa.0 linux-x64 node-v20.13.1
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -404,7 +404,7 @@ Generate an Apex trigger.
|
|
|
404
404
|
USAGE
|
|
405
405
|
$ sf apex generate trigger -n <value> [--json] [--flags-dir <value>] [-t ApexTrigger] [-d <value>] [--api-version
|
|
406
406
|
<value>] [-s <value>] [-e before insert|before update|before delete|after insert|after update|after delete|after
|
|
407
|
-
undelete]
|
|
407
|
+
undelete...]
|
|
408
408
|
|
|
409
409
|
FLAGS
|
|
410
410
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -669,8 +669,8 @@ Invoke Apex tests in an org.
|
|
|
669
669
|
```
|
|
670
670
|
USAGE
|
|
671
671
|
$ sf apex run test -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-l
|
|
672
|
-
RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value
|
|
673
|
-
[-w <value>] [-y] [-v -c]
|
|
672
|
+
RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value>... | -s <value>... | -t <value>...] [-r
|
|
673
|
+
human|tap|junit|json] [-w <value>] [-y] [-v -c]
|
|
674
674
|
|
|
675
675
|
FLAGS
|
|
676
676
|
-c, --code-coverage Retrieve code coverage results.
|
|
@@ -761,7 +761,9 @@ FLAG DESCRIPTIONS
|
|
|
761
761
|
For multiple suites, repeat the flag for each.
|
|
762
762
|
--suite-names Suite1 --suite-names Suite2
|
|
763
763
|
|
|
764
|
-
-t, --tests=<value>...
|
|
764
|
+
-t, --tests=<value>...
|
|
765
|
+
|
|
766
|
+
Apex test class names or IDs and, if applicable, test methods to run; default is all tests.
|
|
765
767
|
|
|
766
768
|
If you specify --tests, you can't specify --class-names or --suite-names
|
|
767
769
|
For multiple tests, repeat the flag for each.
|
|
@@ -842,7 +844,7 @@ EXAMPLES
|
|
|
842
844
|
$ sf autocomplete --refresh-cache
|
|
843
845
|
```
|
|
844
846
|
|
|
845
|
-
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/3.1.
|
|
847
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/3.1.2/src/commands/autocomplete/index.ts)_
|
|
846
848
|
|
|
847
849
|
## `sf commands`
|
|
848
850
|
|
|
@@ -850,8 +852,8 @@ List all sf commands.
|
|
|
850
852
|
|
|
851
853
|
```
|
|
852
854
|
USAGE
|
|
853
|
-
$ sf commands [--json] [-c id|plugin|summary|type | --tree] [--deprecated] [-x | ] [--hidden]
|
|
854
|
-
| ] [--sort id|plugin|summary|type | ]
|
|
855
|
+
$ sf commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
|
|
856
|
+
[--no-truncate | ] [--sort id|plugin|summary|type | ]
|
|
855
857
|
|
|
856
858
|
FLAGS
|
|
857
859
|
-c, --columns=<option>... Only show provided columns (comma-separated).
|
|
@@ -871,7 +873,7 @@ DESCRIPTION
|
|
|
871
873
|
List all sf commands.
|
|
872
874
|
```
|
|
873
875
|
|
|
874
|
-
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.0.
|
|
876
|
+
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.0.2/src/commands/commands.ts)_
|
|
875
877
|
|
|
876
878
|
## `sf config get`
|
|
877
879
|
|
|
@@ -1521,7 +1523,8 @@ Import data from one or more JSON files into an org.
|
|
|
1521
1523
|
|
|
1522
1524
|
```
|
|
1523
1525
|
USAGE
|
|
1524
|
-
$ sf data import beta tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value
|
|
1526
|
+
$ sf data import beta tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>...] [-p
|
|
1527
|
+
<value>]
|
|
1525
1528
|
|
|
1526
1529
|
FLAGS
|
|
1527
1530
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -1564,7 +1567,7 @@ Import data from one or more JSON files into an org.
|
|
|
1564
1567
|
|
|
1565
1568
|
```
|
|
1566
1569
|
USAGE
|
|
1567
|
-
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value
|
|
1570
|
+
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>... | -p <value>]
|
|
1568
1571
|
|
|
1569
1572
|
FLAGS
|
|
1570
1573
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -2446,7 +2449,8 @@ Assign a permission set to one or more users of a scratch org.
|
|
|
2446
2449
|
|
|
2447
2450
|
```
|
|
2448
2451
|
USAGE
|
|
2449
|
-
$ sf org assign permset -n <value
|
|
2452
|
+
$ sf org assign permset -n <value>... -o <value> [--json] [--flags-dir <value>] [-b <value>...] [--api-version
|
|
2453
|
+
<value>]
|
|
2450
2454
|
|
|
2451
2455
|
FLAGS
|
|
2452
2456
|
-b, --on-behalf-of=<value>... Username or alias to assign the permission set to.
|
|
@@ -2490,7 +2494,7 @@ Assign a permission set license to one or more users of a scratch org.
|
|
|
2490
2494
|
|
|
2491
2495
|
```
|
|
2492
2496
|
USAGE
|
|
2493
|
-
$ sf org assign permsetlicense -n <value
|
|
2497
|
+
$ sf org assign permsetlicense -n <value>... -o <value> [--json] [--flags-dir <value>] [-b <value>...] [--api-version
|
|
2494
2498
|
<value>]
|
|
2495
2499
|
|
|
2496
2500
|
FLAGS
|
|
@@ -2536,8 +2540,8 @@ Create a sandbox org.
|
|
|
2536
2540
|
|
|
2537
2541
|
```
|
|
2538
2542
|
USAGE
|
|
2539
|
-
$ sf org create sandbox -o <value> [--json] [--flags-dir <value>] [-f <value>] [-s] [-a <value>] [-w <
|
|
2540
|
-
--async] [-i <
|
|
2543
|
+
$ sf org create sandbox -o <value> [--json] [--flags-dir <value>] [-f <value>] [-s] [-a <value>] [-w <minutes> |
|
|
2544
|
+
--async] [-i <seconds> | ] [-n <value>] [-c <value> | -l Developer|Developer_Pro|Partial|Full] [--no-prompt]
|
|
2541
2545
|
[--no-track-source]
|
|
2542
2546
|
|
|
2543
2547
|
FLAGS
|
|
@@ -2655,7 +2659,7 @@ Create a scratch org.
|
|
|
2655
2659
|
USAGE
|
|
2656
2660
|
$ sf org create scratch -v <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [-d] [-f <value>] [-c] [-e
|
|
2657
2661
|
developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional]
|
|
2658
|
-
[-m] [-y <
|
|
2662
|
+
[-m] [-y <days>] [-w <minutes>] [--api-version <value>] [-i <value>] [-t] [--username <value>] [--description
|
|
2659
2663
|
<value>] [--name <value>] [--release preview|previous] [--admin-email <value>] [--source-org <value>]
|
|
2660
2664
|
|
|
2661
2665
|
FLAGS
|
|
@@ -3170,7 +3174,7 @@ Generate a random password for scratch org users.
|
|
|
3170
3174
|
|
|
3171
3175
|
```
|
|
3172
3176
|
USAGE
|
|
3173
|
-
$ sf org generate password -o <value> [--json] [--flags-dir <value>] [-b <value
|
|
3177
|
+
$ sf org generate password -o <value> [--json] [--flags-dir <value>] [-b <value>...] [-l <value>] [-c <value>]
|
|
3174
3178
|
[--api-version <value>]
|
|
3175
3179
|
|
|
3176
3180
|
FLAGS
|
|
@@ -3470,7 +3474,7 @@ Display record counts for the specified standard or custom objects.
|
|
|
3470
3474
|
|
|
3471
3475
|
```
|
|
3472
3476
|
USAGE
|
|
3473
|
-
$ sf org list sobject record-counts -o <value> [--json] [--flags-dir <value>] [-s <value
|
|
3477
|
+
$ sf org list sobject record-counts -o <value> [--json] [--flags-dir <value>] [-s <value>...] [--api-version <value>]
|
|
3474
3478
|
|
|
3475
3479
|
FLAGS
|
|
3476
3480
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -4044,8 +4048,8 @@ Refresh a sandbox org using the sandbox name.
|
|
|
4044
4048
|
|
|
4045
4049
|
```
|
|
4046
4050
|
USAGE
|
|
4047
|
-
$ sf org refresh sandbox -o <value> [--json] [--flags-dir <value>] [--no-auto-activate] [-w <
|
|
4048
|
-
<
|
|
4051
|
+
$ sf org refresh sandbox -o <value> [--json] [--flags-dir <value>] [--no-auto-activate] [-w <minutes> | --async] [-i
|
|
4052
|
+
<seconds> | ] [-n <value>] [-f <value>] [--no-prompt]
|
|
4049
4053
|
|
|
4050
4054
|
FLAGS
|
|
4051
4055
|
-f, --definition-file=<value> Path to a sandbox definition file for overriding its configuration when you refresh it.
|
|
@@ -4089,7 +4093,9 @@ EXAMPLES
|
|
|
4089
4093
|
$ sf org refresh sandbox --definition-file devSbx3-config.json --target-org prodOrg
|
|
4090
4094
|
|
|
4091
4095
|
FLAG DESCRIPTIONS
|
|
4092
|
-
-f, --definition-file=<value>
|
|
4096
|
+
-f, --definition-file=<value>
|
|
4097
|
+
|
|
4098
|
+
Path to a sandbox definition file for overriding its configuration when you refresh it.
|
|
4093
4099
|
|
|
4094
4100
|
The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during
|
|
4095
4101
|
a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name
|
|
@@ -4121,7 +4127,7 @@ Check the status of a sandbox creation, and log in to it if it's ready.
|
|
|
4121
4127
|
|
|
4122
4128
|
```
|
|
4123
4129
|
USAGE
|
|
4124
|
-
$ sf org resume sandbox [--json] [--flags-dir <value>] [-w <
|
|
4130
|
+
$ sf org resume sandbox [--json] [--flags-dir <value>] [-w <minutes>] [-n <value> | -i <value>] [-l] [-o <value>]
|
|
4125
4131
|
|
|
4126
4132
|
FLAGS
|
|
4127
4133
|
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
@@ -5440,7 +5446,7 @@ EXAMPLES
|
|
|
5440
5446
|
$ sf plugins
|
|
5441
5447
|
```
|
|
5442
5448
|
|
|
5443
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5449
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.2/src/commands/plugins/index.ts)_
|
|
5444
5450
|
|
|
5445
5451
|
## `sf plugins discover`
|
|
5446
5452
|
|
|
@@ -5485,7 +5491,7 @@ EXAMPLES
|
|
|
5485
5491
|
$ sf plugins inspect @salesforce/plugin-packaging
|
|
5486
5492
|
```
|
|
5487
5493
|
|
|
5488
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5494
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.2/src/commands/plugins/inspect.ts)_
|
|
5489
5495
|
|
|
5490
5496
|
## `sf plugins install PLUGIN`
|
|
5491
5497
|
|
|
@@ -5534,7 +5540,7 @@ EXAMPLES
|
|
|
5534
5540
|
$ sf plugins install someuser/someplugin
|
|
5535
5541
|
```
|
|
5536
5542
|
|
|
5537
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5543
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.2/src/commands/plugins/install.ts)_
|
|
5538
5544
|
|
|
5539
5545
|
## `sf plugins link PATH`
|
|
5540
5546
|
|
|
@@ -5564,7 +5570,7 @@ EXAMPLES
|
|
|
5564
5570
|
$ sf plugins link @salesforce/plugin-packaging
|
|
5565
5571
|
```
|
|
5566
5572
|
|
|
5567
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5573
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.2/src/commands/plugins/link.ts)_
|
|
5568
5574
|
|
|
5569
5575
|
## `sf plugins reset`
|
|
5570
5576
|
|
|
@@ -5579,7 +5585,7 @@ FLAGS
|
|
|
5579
5585
|
--reinstall Reinstall all plugins after uninstalling.
|
|
5580
5586
|
```
|
|
5581
5587
|
|
|
5582
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5588
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.2/src/commands/plugins/reset.ts)_
|
|
5583
5589
|
|
|
5584
5590
|
## `sf plugins trust verify`
|
|
5585
5591
|
|
|
@@ -5636,7 +5642,7 @@ EXAMPLES
|
|
|
5636
5642
|
$ sf plugins uninstall @salesforce/plugin-packaging
|
|
5637
5643
|
```
|
|
5638
5644
|
|
|
5639
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5645
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.2/src/commands/plugins/uninstall.ts)_
|
|
5640
5646
|
|
|
5641
5647
|
## `sf plugins update`
|
|
5642
5648
|
|
|
@@ -5654,7 +5660,7 @@ DESCRIPTION
|
|
|
5654
5660
|
Update installed plugins.
|
|
5655
5661
|
```
|
|
5656
5662
|
|
|
5657
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5663
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.2/src/commands/plugins/update.ts)_
|
|
5658
5664
|
|
|
5659
5665
|
## `sf project convert mdapi`
|
|
5660
5666
|
|
|
@@ -5662,8 +5668,8 @@ Convert metadata retrieved via Metadata API into the source format used in Sales
|
|
|
5662
5668
|
|
|
5663
5669
|
```
|
|
5664
5670
|
USAGE
|
|
5665
|
-
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value
|
|
5666
|
-
-x <value> | -m <value
|
|
5671
|
+
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value>...
|
|
5672
|
+
| -x <value> | -m <value>...]
|
|
5667
5673
|
|
|
5668
5674
|
FLAGS
|
|
5669
5675
|
-d, --output-dir=<value> Directory to store your files in after they’re converted to source format; can be an
|
|
@@ -5726,7 +5732,7 @@ Convert source-formatted files into metadata that you can deploy using Metadata
|
|
|
5726
5732
|
```
|
|
5727
5733
|
USAGE
|
|
5728
5734
|
$ sf project convert source [--json] [--flags-dir <value>] [--api-version <value>] [-r <value>] [-d <value>] [-n <value>]
|
|
5729
|
-
[-p <value
|
|
5735
|
+
[-p <value>... | -x <value> | -m <value>...]
|
|
5730
5736
|
|
|
5731
5737
|
FLAGS
|
|
5732
5738
|
-d, --output-dir=<value> [default: metadataPackage_1717296698220] Output directory to store the Metadata
|
|
@@ -5856,8 +5862,8 @@ Delete source from your project and from a non-source-tracked org.
|
|
|
5856
5862
|
```
|
|
5857
5863
|
USAGE
|
|
5858
5864
|
$ sf project delete source -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>] [--tests
|
|
5859
|
-
<value
|
|
5860
|
-
-c]] [--verbose]
|
|
5865
|
+
<value>...] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>...] [-p <value>...] [-f
|
|
5866
|
+
[-t | -c]] [--verbose]
|
|
5861
5867
|
|
|
5862
5868
|
FLAGS
|
|
5863
5869
|
-c, --check-only Validate delete command but don't delete anything from the org or the local project.
|
|
@@ -6032,7 +6038,7 @@ Cancel a deploy operation.
|
|
|
6032
6038
|
|
|
6033
6039
|
```
|
|
6034
6040
|
USAGE
|
|
6035
|
-
$ sf project deploy cancel [--json] [--flags-dir <value>] [-o <value>] [--async | -w <
|
|
6041
|
+
$ sf project deploy cancel [--json] [--flags-dir <value>] [-o <value>] [--async | -w <minutes>] [-i <value>] [-r]
|
|
6036
6042
|
|
|
6037
6043
|
FLAGS
|
|
6038
6044
|
-i, --job-id=<value> Job ID of the deploy operation you want to cancel.
|
|
@@ -6104,7 +6110,7 @@ Preview a deployment to see what will deploy to the org, the potential conflicts
|
|
|
6104
6110
|
|
|
6105
6111
|
```
|
|
6106
6112
|
USAGE
|
|
6107
|
-
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value
|
|
6113
|
+
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value>... | -m <value>...]
|
|
6108
6114
|
[--concise]
|
|
6109
6115
|
|
|
6110
6116
|
FLAGS
|
|
@@ -6187,8 +6193,8 @@ Quickly deploy a validated deployment to an org.
|
|
|
6187
6193
|
|
|
6188
6194
|
```
|
|
6189
6195
|
USAGE
|
|
6190
|
-
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <
|
|
6191
|
-
<value>] [-r] [-a <value>]
|
|
6196
|
+
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <minutes>] [--concise | --verbose] [-i <value>]
|
|
6197
|
+
[-o <value>] [-r] [-a <value>]
|
|
6192
6198
|
|
|
6193
6199
|
FLAGS
|
|
6194
6200
|
-a, --api-version=<value> Target API version for the deploy.
|
|
@@ -6281,8 +6287,8 @@ Check or poll for the status of a deploy operation.
|
|
|
6281
6287
|
```
|
|
6282
6288
|
USAGE
|
|
6283
6289
|
$ sf project deploy report [--json] [--flags-dir <value>] [-o <value>] [-i <value>] [-r] [--coverage-formatters
|
|
6284
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
6285
|
-
<value>] [-w <
|
|
6290
|
+
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...] [--junit]
|
|
6291
|
+
[--results-dir <value>] [-w <minutes>]
|
|
6286
6292
|
|
|
6287
6293
|
FLAGS
|
|
6288
6294
|
-i, --job-id=<value> Job ID of the deploy operation you want to check the status of.
|
|
@@ -6372,8 +6378,8 @@ Resume watching a deploy operation and update source tracking when the deploy co
|
|
|
6372
6378
|
|
|
6373
6379
|
```
|
|
6374
6380
|
USAGE
|
|
6375
|
-
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <
|
|
6376
|
-
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6381
|
+
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <minutes>]
|
|
6382
|
+
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...]
|
|
6377
6383
|
[--junit] [--results-dir <value>]
|
|
6378
6384
|
|
|
6379
6385
|
FLAGS
|
|
@@ -6469,11 +6475,11 @@ Deploy metadata to an org from your local project.
|
|
|
6469
6475
|
|
|
6470
6476
|
```
|
|
6471
6477
|
USAGE
|
|
6472
|
-
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <
|
|
6473
|
-
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value
|
|
6474
|
-
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value
|
|
6475
|
-
| --metadata-dir <value>]] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6476
|
-
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6478
|
+
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <minutes>] [--concise |
|
|
6479
|
+
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value>...] [-l
|
|
6480
|
+
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value>... | -m
|
|
6481
|
+
<value>... | --metadata-dir <value>]] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6482
|
+
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...]
|
|
6477
6483
|
[--junit] [--results-dir <value>]
|
|
6478
6484
|
|
|
6479
6485
|
FLAGS
|
|
@@ -6713,10 +6719,11 @@ Validate a metadata deployment without actually executing it.
|
|
|
6713
6719
|
```
|
|
6714
6720
|
USAGE
|
|
6715
6721
|
$ sf project deploy validate -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [--concise | --verbose] [-m
|
|
6716
|
-
<value
|
|
6717
|
-
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <
|
|
6718
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
6719
|
-
<value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ]
|
|
6722
|
+
<value>...] [-d <value>...] [--single-package --metadata-dir <value>] [-t <value>...] [-l
|
|
6723
|
+
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <minutes>] [-g] [--coverage-formatters
|
|
6724
|
+
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...] [--junit]
|
|
6725
|
+
[--results-dir <value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ]
|
|
6726
|
+
[--post-destructive-changes <value> ]
|
|
6720
6727
|
|
|
6721
6728
|
FLAGS
|
|
6722
6729
|
-a, --api-version=<value> Target API version for the validation.
|
|
@@ -7006,8 +7013,8 @@ Create a project manifest that lists the metadata components you want to deploy
|
|
|
7006
7013
|
|
|
7007
7014
|
```
|
|
7008
7015
|
USAGE
|
|
7009
|
-
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value
|
|
7010
|
-
-t pre|post|destroy|package] [-c managed|unlocked --from-org <value>] [-d <value>]
|
|
7016
|
+
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>...] [-p <value>...] [-n
|
|
7017
|
+
<value> | -t pre|post|destroy|package] [-c managed|unlocked... --from-org <value>] [-d <value>]
|
|
7011
7018
|
|
|
7012
7019
|
FLAGS
|
|
7013
7020
|
-c, --include-packages=<option>... Package types (managed, unlocked) whose metadata is included in the manifest; by
|
|
@@ -7228,8 +7235,9 @@ Retrieve metadata from an org to your local project.
|
|
|
7228
7235
|
|
|
7229
7236
|
```
|
|
7230
7237
|
USAGE
|
|
7231
|
-
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value
|
|
7232
|
-
<value
|
|
7238
|
+
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value>... | -d
|
|
7239
|
+
<value>...] [-r <value> | -n <value>... | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name
|
|
7240
|
+
<value> ]
|
|
7233
7241
|
|
|
7234
7242
|
FLAGS
|
|
7235
7243
|
-a, --api-version=<value> Target API version for the retrieve.
|
|
@@ -7367,7 +7375,9 @@ FLAG DESCRIPTIONS
|
|
|
7367
7375
|
If the target directory matches one of the package directories in your sfdx-project.json file, the command fails.
|
|
7368
7376
|
Running the command multiple times with the same target adds new files and overwrites existing files.
|
|
7369
7377
|
|
|
7370
|
-
-w, --wait=<value>
|
|
7378
|
+
-w, --wait=<value>
|
|
7379
|
+
|
|
7380
|
+
Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
7371
7381
|
|
|
7372
7382
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
7373
7383
|
|
|
@@ -7591,7 +7601,7 @@ DESCRIPTION
|
|
|
7591
7601
|
Once you select a command, hit enter and it will show the help for that command.
|
|
7592
7602
|
```
|
|
7593
7603
|
|
|
7594
|
-
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.1.
|
|
7604
|
+
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.1.1/src/commands/search.ts)_
|
|
7595
7605
|
|
|
7596
7606
|
## `sf sobject describe`
|
|
7597
7607
|
|
|
@@ -7776,7 +7786,7 @@ EXAMPLES
|
|
|
7776
7786
|
$ sf update --available
|
|
7777
7787
|
```
|
|
7778
7788
|
|
|
7779
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.3.
|
|
7789
|
+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.3.3/src/commands/update.ts)_
|
|
7780
7790
|
|
|
7781
7791
|
## `sf version`
|
|
7782
7792
|
|
|
@@ -7796,7 +7806,7 @@ FLAG DESCRIPTIONS
|
|
|
7796
7806
|
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
|
|
7797
7807
|
```
|
|
7798
7808
|
|
|
7799
|
-
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.
|
|
7809
|
+
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.2/src/commands/version.ts)_
|
|
7800
7810
|
|
|
7801
7811
|
## `sf visualforce generate component`
|
|
7802
7812
|
|
|
@@ -7936,6 +7946,6 @@ EXAMPLES
|
|
|
7936
7946
|
$ sf which "foo bar baz"
|
|
7937
7947
|
```
|
|
7938
7948
|
|
|
7939
|
-
_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.2.
|
|
7949
|
+
_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.2.1/src/commands/which.ts)_
|
|
7940
7950
|
|
|
7941
7951
|
<!-- commandsstop -->
|
package/bin/dev.js
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
#!/usr/bin/env ts-node
|
|
2
2
|
|
|
3
3
|
async function main() {
|
|
4
|
-
const
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
const { settings } = await import('@oclif/core/settings');
|
|
5
|
+
const { execute } = await import('@oclif/core/execute');
|
|
6
|
+
|
|
7
|
+
settings.performanceEnabled = true;
|
|
8
|
+
await execute({ development: true, dir: import.meta.url });
|
|
7
9
|
}
|
|
8
10
|
|
|
9
11
|
await main();
|
package/bin/run.js
CHANGED
|
@@ -3,30 +3,13 @@
|
|
|
3
3
|
// Pre-process/prune flags before creating or running the actual CLI
|
|
4
4
|
(await import('../dist/flags.js')).preprocessCliFlags(process);
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
6
|
+
// Since the CLI is a single process, we can have a larger amount of max listeners since
|
|
7
|
+
// the process gets shut down. Don't set it to 0 (no limit) since we should still be aware
|
|
8
|
+
// of rouge event listeners
|
|
9
|
+
process.setMaxListeners(parseInt(process.env.SF_MAX_EVENT_LISTENERS, 10) || 1000);
|
|
9
10
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
async function main() {
|
|
13
|
-
// Since the CLI is a single process, we can have a larger amount of max listeners since
|
|
14
|
-
// the process gets shut down. Don't set it to 0 (no limit) since we should still be aware
|
|
15
|
-
// of rouge event listeners
|
|
16
|
-
process.setMaxListeners(parseInt(process.env.SF_MAX_EVENT_LISTENERS, 10) || 1000);
|
|
17
|
-
|
|
18
|
-
// Don't let other plugins override the CLI specified max listener count
|
|
19
|
-
process.setMaxListeners = () => {};
|
|
11
|
+
// Don't let other plugins override the CLI specified max listener count
|
|
12
|
+
process.setMaxListeners = () => {};
|
|
20
13
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
.run()
|
|
24
|
-
.then(async () => {
|
|
25
|
-
await oclif.flush();
|
|
26
|
-
})
|
|
27
|
-
.catch(async (err) => {
|
|
28
|
-
await oclif.handle(err);
|
|
29
|
-
});
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
await main();
|
|
14
|
+
const cli = await import('../dist/cli.js');
|
|
15
|
+
await cli.run();
|
package/dist/cli.js
CHANGED
|
@@ -7,11 +7,10 @@
|
|
|
7
7
|
import { platform, arch, release } from 'node:os';
|
|
8
8
|
import { resolve } from 'node:path';
|
|
9
9
|
import { fileURLToPath } from 'node:url';
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import
|
|
13
|
-
import {
|
|
14
|
-
const debug = Debug('sf');
|
|
10
|
+
import { execute } from '@oclif/core/execute';
|
|
11
|
+
import { Config } from '@oclif/core/config';
|
|
12
|
+
import NodeEnv, { Env } from './util/env.js';
|
|
13
|
+
import { logger } from './logger.js';
|
|
15
14
|
const envVars = [
|
|
16
15
|
...new Set([
|
|
17
16
|
...Object.keys(process.env).filter((e) => e.startsWith('SF_') || e.startsWith('SFDX_')),
|
|
@@ -32,13 +31,6 @@ export const UPDATE_DISABLED_INSTALLER = 'Manual and automatic CLI updates have
|
|
|
32
31
|
export const UPDATE_DISABLED_NPM = 'Use "npm update --global @salesforce/cli" to update npm-based installations.';
|
|
33
32
|
export const UPDATE_DISABLED_DEMO = 'Manual and automatic CLI updates have been disabled in DEMO mode. ' +
|
|
34
33
|
'To check for a new version, unset the environment variable SF_ENV.';
|
|
35
|
-
export function configureUpdateSites(config, env = nodeEnv) {
|
|
36
|
-
const npmRegistry = env.getNpmRegistryOverride();
|
|
37
|
-
if (npmRegistry) {
|
|
38
|
-
// Override config value if set via envar
|
|
39
|
-
set(config, 'pjson.oclif.warn-if-update-available.registry', npmRegistry);
|
|
40
|
-
}
|
|
41
|
-
}
|
|
42
34
|
export function configureAutoUpdate(envars) {
|
|
43
35
|
if (envars.isDemoMode()) {
|
|
44
36
|
// Disable autoupdates in demo mode
|
|
@@ -62,11 +54,12 @@ export function configureAutoUpdate(envars) {
|
|
|
62
54
|
envars.setUpdateInstructions(UPDATE_DISABLED_NPM);
|
|
63
55
|
}
|
|
64
56
|
}
|
|
65
|
-
function debugCliInfo(
|
|
57
|
+
function debugCliInfo(env, config) {
|
|
66
58
|
function debugSection(section, items) {
|
|
67
59
|
const pad = 25;
|
|
68
|
-
|
|
69
|
-
|
|
60
|
+
const header = `### ${section} ###`;
|
|
61
|
+
logger.debug('%s', header.padStart(pad));
|
|
62
|
+
items.forEach(([name, value]) => logger.debug('%s: %s', name.padStart(pad), value));
|
|
70
63
|
}
|
|
71
64
|
debugSection('OS', [
|
|
72
65
|
['platform', platform()],
|
|
@@ -76,8 +69,8 @@ function debugCliInfo(version, channel, env, config) {
|
|
|
76
69
|
]);
|
|
77
70
|
debugSection('NODE', [['version', process.versions.node]]);
|
|
78
71
|
debugSection('CLI', [
|
|
79
|
-
['version', version],
|
|
80
|
-
['channel', channel],
|
|
72
|
+
['version', config.version],
|
|
73
|
+
['channel', config.channel],
|
|
81
74
|
['bin', config.bin],
|
|
82
75
|
['data', config.dataDir],
|
|
83
76
|
['cache', config.cacheDir],
|
|
@@ -86,26 +79,16 @@ function debugCliInfo(version, channel, env, config) {
|
|
|
86
79
|
debugSection('ENV', [...envVars].map((key) => [key, env.getString(key, '<not set>')]));
|
|
87
80
|
debugSection('ARGS', process.argv.map((arg, i) => [i.toString(), arg]));
|
|
88
81
|
}
|
|
89
|
-
export function
|
|
90
|
-
|
|
91
|
-
const
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
channel,
|
|
101
|
-
});
|
|
102
|
-
await config.load();
|
|
103
|
-
configureUpdateSites(config, environment);
|
|
104
|
-
configureAutoUpdate(environment);
|
|
105
|
-
debugCliInfo(version, channel, environment, config);
|
|
106
|
-
// Example of how run is used in a test https://github.com/salesforcecli/cli/pull/171/files#diff-1deee0a575599b2df117c280da319f7938aaf6fdb0c04bcdbde769dbf464be69R46
|
|
107
|
-
return run ? run(args, config) : oclifRun(args, config);
|
|
108
|
-
},
|
|
109
|
-
};
|
|
82
|
+
export async function run() {
|
|
83
|
+
configureAutoUpdate(NodeEnv);
|
|
84
|
+
const config = await Config.load({
|
|
85
|
+
root: resolve(fileURLToPath(import.meta.url), '..'),
|
|
86
|
+
logger,
|
|
87
|
+
enablePerf: true,
|
|
88
|
+
});
|
|
89
|
+
debugCliInfo(NodeEnv, config);
|
|
90
|
+
return execute({
|
|
91
|
+
loadOptions: config,
|
|
92
|
+
});
|
|
110
93
|
}
|
|
111
94
|
//# sourceMappingURL=cli.js.map
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Licensed under the BSD 3-Clause license.
|
|
5
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
6
|
*/
|
|
7
|
-
import { CommandHelp } from '@oclif/core';
|
|
7
|
+
import { CommandHelp } from '@oclif/core/help';
|
|
8
8
|
export class SfCommandHelp extends CommandHelp {
|
|
9
9
|
constructor(command, config, opts) {
|
|
10
10
|
super(command, config, opts);
|
package/dist/help/sfHelp.js
CHANGED
|
@@ -4,10 +4,11 @@
|
|
|
4
4
|
* Licensed under the BSD 3-Clause license.
|
|
5
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
6
|
*/
|
|
7
|
-
import { Help
|
|
8
|
-
import
|
|
9
|
-
import
|
|
7
|
+
import { Help } from '@oclif/core/help';
|
|
8
|
+
import { toConfiguredId } from '@oclif/core/util/ids';
|
|
9
|
+
import { Ansis } from 'ansis';
|
|
10
10
|
import { SfCommandHelp } from './sfCommandHelp.js';
|
|
11
|
+
const ansis = new Ansis();
|
|
11
12
|
export default class SfHelp extends Help {
|
|
12
13
|
constructor(config, opts) {
|
|
13
14
|
super(config, opts);
|
|
@@ -54,9 +55,9 @@ export default class SfHelp extends Help {
|
|
|
54
55
|
log(...args) {
|
|
55
56
|
const formatted = args.map((arg) => {
|
|
56
57
|
let formattedArg = arg.slice();
|
|
57
|
-
const matches =
|
|
58
|
+
const matches = ansis.strip(formattedArg).match(this.commandIdRegex) ?? [];
|
|
58
59
|
for (const match of matches) {
|
|
59
|
-
formattedArg = formattedArg.replaceAll(match,
|
|
60
|
+
formattedArg = formattedArg.replaceAll(match, ansis.dim(match));
|
|
60
61
|
}
|
|
61
62
|
return formattedArg;
|
|
62
63
|
});
|
|
@@ -1,10 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
* Copyright (c) 2021, salesforce.com, inc.
|
|
3
|
-
* All rights reserved.
|
|
4
|
-
* Licensed under the BSD 3-Clause license.
|
|
5
|
-
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
-
*/
|
|
7
|
-
import { ux } from '@oclif/core';
|
|
1
|
+
import ux from '@oclif/core/ux';
|
|
8
2
|
export const hook = async function ({ config }) {
|
|
9
3
|
if (process.env.SF_HIDE_RELEASE_NOTES === 'true')
|
|
10
4
|
return;
|
|
@@ -13,9 +7,9 @@ export const hook = async function ({ config }) {
|
|
|
13
7
|
}
|
|
14
8
|
catch (err) {
|
|
15
9
|
const error = err;
|
|
16
|
-
ux.
|
|
17
|
-
ux.
|
|
18
|
-
ux.
|
|
10
|
+
ux.stdout('NOTE: This error can be ignored in CI and may be silenced in the future');
|
|
11
|
+
ux.stdout('- Set the SF_HIDE_RELEASE_NOTES env var to "true" to skip this script\n');
|
|
12
|
+
ux.stdout(error.message);
|
|
19
13
|
}
|
|
20
14
|
};
|
|
21
15
|
export default hook;
|
package/dist/hooks/incomplete.js
CHANGED
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
* Licensed under the BSD 3-Clause license.
|
|
5
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
6
|
*/
|
|
7
|
-
import
|
|
8
|
-
import { toConfiguredId, toStandardizedId
|
|
7
|
+
import os from 'node:os';
|
|
8
|
+
import { toConfiguredId, toStandardizedId } from '@oclif/core/util/ids';
|
|
9
|
+
import { loadHelpClass } from '@oclif/core/help';
|
|
9
10
|
function buildChoices(matches, config) {
|
|
10
11
|
const configuredIds = matches.map((p) => toConfiguredId(p.id, config));
|
|
11
12
|
const maxCommandLength = configuredIds.reduce((max, id) => Math.max(max, id.length), 0);
|
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
* Licensed under the BSD 3-Clause license.
|
|
5
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
6
|
*/
|
|
7
|
-
import {
|
|
7
|
+
import { handle } from '@oclif/core/handle';
|
|
8
8
|
const hook = async function (options) {
|
|
9
9
|
const verifySignHookResult = await this.config.runHook('plugins:preinstall:verify:signature', options);
|
|
10
10
|
const pluginTrustFailure = verifySignHookResult.failures.find((failure) => failure.plugin.name === '@salesforce/plugin-trust');
|
|
11
11
|
if (pluginTrustFailure !== undefined) {
|
|
12
|
-
await
|
|
12
|
+
await handle(pluginTrustFailure.error);
|
|
13
13
|
}
|
|
14
14
|
};
|
|
15
15
|
export default hook;
|