@salesforce/cli 2.45.6-qa.0 → 2.45.6
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 +56 -66
- package/bin/dev.js +3 -5
- package/bin/run.js +25 -8
- package/dist/cli.js +38 -21
- package/dist/help/sfCommandHelp.js +1 -1
- package/dist/help/sfHelp.js +5 -6
- package/dist/hooks/display-release-notes.js +10 -4
- package/dist/hooks/incomplete.js +2 -3
- package/dist/hooks/pluginsPreinstall.js +2 -2
- package/dist/hooks/prerun.js +1 -1
- package/npm-shrinkwrap.json +2391 -3722
- package/oclif.lock +106 -204
- package/oclif.manifest.json +1 -1
- package/package.json +8 -8
- package/dist/logger.js +0 -22
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.6
|
|
27
|
+
@salesforce/cli/2.45.6 linux-x64 node-v20.13.1
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -204,7 +204,7 @@ EXAMPLES
|
|
|
204
204
|
$ sf alias list
|
|
205
205
|
```
|
|
206
206
|
|
|
207
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.
|
|
207
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.0/src/commands/alias/list.ts)_
|
|
208
208
|
|
|
209
209
|
## `sf alias set`
|
|
210
210
|
|
|
@@ -222,7 +222,7 @@ DESCRIPTION
|
|
|
222
222
|
Set one or more aliases on your local computer.
|
|
223
223
|
|
|
224
224
|
Aliases are user-defined short names that make it easier to use the CLI. For example, users often set an alias for a
|
|
225
|
-
scratch org usernames because they're long and unintuitive.
|
|
225
|
+
scratch org usernames because they're long and unintuitive. Check the --help of a CLI command to determine where you
|
|
226
226
|
can use an alias.
|
|
227
227
|
|
|
228
228
|
You can associate an alias with only one value at a time. If you set an alias multiple times, the alias points to the
|
|
@@ -253,7 +253,7 @@ EXAMPLES
|
|
|
253
253
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
254
254
|
```
|
|
255
255
|
|
|
256
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.
|
|
256
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.0/src/commands/alias/set.ts)_
|
|
257
257
|
|
|
258
258
|
## `sf alias unset`
|
|
259
259
|
|
|
@@ -293,7 +293,7 @@ EXAMPLES
|
|
|
293
293
|
$ sf alias unset --all [--no-prompt]
|
|
294
294
|
```
|
|
295
295
|
|
|
296
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.
|
|
296
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.0/src/commands/alias/unset.ts)_
|
|
297
297
|
|
|
298
298
|
## `sf analytics generate template`
|
|
299
299
|
|
|
@@ -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
|
-
|
|
672
|
+
RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value> | -s <value> | -t <value>] [-r human|tap|junit|json]
|
|
673
|
+
[-w <value>] [-y] [-v -c]
|
|
674
674
|
|
|
675
675
|
FLAGS
|
|
676
676
|
-c, --code-coverage Retrieve code coverage results.
|
|
@@ -761,9 +761,7 @@ 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>...
|
|
765
|
-
|
|
766
|
-
Apex test class names or IDs and, if applicable, test methods to run; default is all tests.
|
|
764
|
+
-t, --tests=<value>... Apex test class names or IDs and, if applicable, test methods to run; default is all tests.
|
|
767
765
|
|
|
768
766
|
If you specify --tests, you can't specify --class-names or --suite-names
|
|
769
767
|
For multiple tests, repeat the flag for each.
|
|
@@ -852,8 +850,8 @@ List all sf commands.
|
|
|
852
850
|
|
|
853
851
|
```
|
|
854
852
|
USAGE
|
|
855
|
-
$ sf commands [--json] [-c id|plugin|summary|type
|
|
856
|
-
|
|
853
|
+
$ sf commands [--json] [-c id|plugin|summary|type | --tree] [--deprecated] [-x | ] [--hidden] [--no-truncate
|
|
854
|
+
| ] [--sort id|plugin|summary|type | ]
|
|
857
855
|
|
|
858
856
|
FLAGS
|
|
859
857
|
-c, --columns=<option>... Only show provided columns (comma-separated).
|
|
@@ -922,7 +920,7 @@ CONFIGURATION VARIABLES
|
|
|
922
920
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
923
921
|
```
|
|
924
922
|
|
|
925
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.
|
|
923
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.0/src/commands/config/get.ts)_
|
|
926
924
|
|
|
927
925
|
## `sf config list`
|
|
928
926
|
|
|
@@ -962,7 +960,7 @@ EXAMPLES
|
|
|
962
960
|
$ sf config list
|
|
963
961
|
```
|
|
964
962
|
|
|
965
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.
|
|
963
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.0/src/commands/config/list.ts)_
|
|
966
964
|
|
|
967
965
|
## `sf config set`
|
|
968
966
|
|
|
@@ -1031,7 +1029,7 @@ CONFIGURATION VARIABLES
|
|
|
1031
1029
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1032
1030
|
```
|
|
1033
1031
|
|
|
1034
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.
|
|
1032
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.0/src/commands/config/set.ts)_
|
|
1035
1033
|
|
|
1036
1034
|
## `sf config unset`
|
|
1037
1035
|
|
|
@@ -1081,7 +1079,7 @@ CONFIGURATION VARIABLES
|
|
|
1081
1079
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1082
1080
|
```
|
|
1083
1081
|
|
|
1084
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.
|
|
1082
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.0/src/commands/config/unset.ts)_
|
|
1085
1083
|
|
|
1086
1084
|
## `sf data create file`
|
|
1087
1085
|
|
|
@@ -1523,8 +1521,7 @@ Import data from one or more JSON files into an org.
|
|
|
1523
1521
|
|
|
1524
1522
|
```
|
|
1525
1523
|
USAGE
|
|
1526
|
-
$ sf data import beta tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value
|
|
1527
|
-
<value>]
|
|
1524
|
+
$ sf data import beta tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>] [-p <value>]
|
|
1528
1525
|
|
|
1529
1526
|
FLAGS
|
|
1530
1527
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -1567,7 +1564,7 @@ Import data from one or more JSON files into an org.
|
|
|
1567
1564
|
|
|
1568
1565
|
```
|
|
1569
1566
|
USAGE
|
|
1570
|
-
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value
|
|
1567
|
+
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value> | -p <value>]
|
|
1571
1568
|
|
|
1572
1569
|
FLAGS
|
|
1573
1570
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -2449,8 +2446,7 @@ Assign a permission set to one or more users of a scratch org.
|
|
|
2449
2446
|
|
|
2450
2447
|
```
|
|
2451
2448
|
USAGE
|
|
2452
|
-
$ sf org assign permset -n <value
|
|
2453
|
-
<value>]
|
|
2449
|
+
$ sf org assign permset -n <value> -o <value> [--json] [--flags-dir <value>] [-b <value>] [--api-version <value>]
|
|
2454
2450
|
|
|
2455
2451
|
FLAGS
|
|
2456
2452
|
-b, --on-behalf-of=<value>... Username or alias to assign the permission set to.
|
|
@@ -2494,7 +2490,7 @@ Assign a permission set license to one or more users of a scratch org.
|
|
|
2494
2490
|
|
|
2495
2491
|
```
|
|
2496
2492
|
USAGE
|
|
2497
|
-
$ sf org assign permsetlicense -n <value
|
|
2493
|
+
$ sf org assign permsetlicense -n <value> -o <value> [--json] [--flags-dir <value>] [-b <value>] [--api-version
|
|
2498
2494
|
<value>]
|
|
2499
2495
|
|
|
2500
2496
|
FLAGS
|
|
@@ -2540,8 +2536,8 @@ Create a sandbox org.
|
|
|
2540
2536
|
|
|
2541
2537
|
```
|
|
2542
2538
|
USAGE
|
|
2543
|
-
$ sf org create sandbox -o <value> [--json] [--flags-dir <value>] [-f <value>] [-s] [-a <value>] [-w <
|
|
2544
|
-
--async] [-i <
|
|
2539
|
+
$ sf org create sandbox -o <value> [--json] [--flags-dir <value>] [-f <value>] [-s] [-a <value>] [-w <value> |
|
|
2540
|
+
--async] [-i <value> | ] [-n <value>] [-c <value> | -l Developer|Developer_Pro|Partial|Full] [--no-prompt]
|
|
2545
2541
|
[--no-track-source]
|
|
2546
2542
|
|
|
2547
2543
|
FLAGS
|
|
@@ -2659,7 +2655,7 @@ Create a scratch org.
|
|
|
2659
2655
|
USAGE
|
|
2660
2656
|
$ sf org create scratch -v <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [-d] [-f <value>] [-c] [-e
|
|
2661
2657
|
developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional]
|
|
2662
|
-
[-m] [-y <
|
|
2658
|
+
[-m] [-y <value>] [-w <value>] [--api-version <value>] [-i <value>] [-t] [--username <value>] [--description
|
|
2663
2659
|
<value>] [--name <value>] [--release preview|previous] [--admin-email <value>] [--source-org <value>]
|
|
2664
2660
|
|
|
2665
2661
|
FLAGS
|
|
@@ -3174,7 +3170,7 @@ Generate a random password for scratch org users.
|
|
|
3174
3170
|
|
|
3175
3171
|
```
|
|
3176
3172
|
USAGE
|
|
3177
|
-
$ sf org generate password -o <value> [--json] [--flags-dir <value>] [-b <value
|
|
3173
|
+
$ sf org generate password -o <value> [--json] [--flags-dir <value>] [-b <value>] [-l <value>] [-c <value>]
|
|
3178
3174
|
[--api-version <value>]
|
|
3179
3175
|
|
|
3180
3176
|
FLAGS
|
|
@@ -3474,7 +3470,7 @@ Display record counts for the specified standard or custom objects.
|
|
|
3474
3470
|
|
|
3475
3471
|
```
|
|
3476
3472
|
USAGE
|
|
3477
|
-
$ sf org list sobject record-counts -o <value> [--json] [--flags-dir <value>] [-s <value
|
|
3473
|
+
$ sf org list sobject record-counts -o <value> [--json] [--flags-dir <value>] [-s <value>] [--api-version <value>]
|
|
3478
3474
|
|
|
3479
3475
|
FLAGS
|
|
3480
3476
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -4048,8 +4044,8 @@ Refresh a sandbox org using the sandbox name.
|
|
|
4048
4044
|
|
|
4049
4045
|
```
|
|
4050
4046
|
USAGE
|
|
4051
|
-
$ sf org refresh sandbox -o <value> [--json] [--flags-dir <value>] [--no-auto-activate] [-w <
|
|
4052
|
-
<
|
|
4047
|
+
$ sf org refresh sandbox -o <value> [--json] [--flags-dir <value>] [--no-auto-activate] [-w <value> | --async] [-i
|
|
4048
|
+
<value> | ] [-n <value>] [-f <value>] [--no-prompt]
|
|
4053
4049
|
|
|
4054
4050
|
FLAGS
|
|
4055
4051
|
-f, --definition-file=<value> Path to a sandbox definition file for overriding its configuration when you refresh it.
|
|
@@ -4093,9 +4089,7 @@ EXAMPLES
|
|
|
4093
4089
|
$ sf org refresh sandbox --definition-file devSbx3-config.json --target-org prodOrg
|
|
4094
4090
|
|
|
4095
4091
|
FLAG DESCRIPTIONS
|
|
4096
|
-
-f, --definition-file=<value>
|
|
4097
|
-
|
|
4098
|
-
Path to a sandbox definition file for overriding its configuration when you refresh it.
|
|
4092
|
+
-f, --definition-file=<value> Path to a sandbox definition file for overriding its configuration when you refresh it.
|
|
4099
4093
|
|
|
4100
4094
|
The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during
|
|
4101
4095
|
a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name
|
|
@@ -4127,7 +4121,7 @@ Check the status of a sandbox creation, and log in to it if it's ready.
|
|
|
4127
4121
|
|
|
4128
4122
|
```
|
|
4129
4123
|
USAGE
|
|
4130
|
-
$ sf org resume sandbox [--json] [--flags-dir <value>] [-w <
|
|
4124
|
+
$ sf org resume sandbox [--json] [--flags-dir <value>] [-w <value>] [-n <value> | -i <value>] [-l] [-o <value>]
|
|
4131
4125
|
|
|
4132
4126
|
FLAGS
|
|
4133
4127
|
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
@@ -5464,7 +5458,7 @@ EXAMPLES
|
|
|
5464
5458
|
$ sf plugins discover
|
|
5465
5459
|
```
|
|
5466
5460
|
|
|
5467
|
-
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.2.
|
|
5461
|
+
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.2.10/src/commands/plugins/discover.ts)_
|
|
5468
5462
|
|
|
5469
5463
|
## `sf plugins:inspect PLUGIN...`
|
|
5470
5464
|
|
|
@@ -5668,8 +5662,8 @@ Convert metadata retrieved via Metadata API into the source format used in Sales
|
|
|
5668
5662
|
|
|
5669
5663
|
```
|
|
5670
5664
|
USAGE
|
|
5671
|
-
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value
|
|
5672
|
-
|
|
5665
|
+
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value> |
|
|
5666
|
+
-x <value> | -m <value>]
|
|
5673
5667
|
|
|
5674
5668
|
FLAGS
|
|
5675
5669
|
-d, --output-dir=<value> Directory to store your files in after they’re converted to source format; can be an
|
|
@@ -5732,7 +5726,7 @@ Convert source-formatted files into metadata that you can deploy using Metadata
|
|
|
5732
5726
|
```
|
|
5733
5727
|
USAGE
|
|
5734
5728
|
$ sf project convert source [--json] [--flags-dir <value>] [--api-version <value>] [-r <value>] [-d <value>] [-n <value>]
|
|
5735
|
-
[-p <value
|
|
5729
|
+
[-p <value> | -x <value> | -m <value>]
|
|
5736
5730
|
|
|
5737
5731
|
FLAGS
|
|
5738
5732
|
-d, --output-dir=<value> [default: metadataPackage_1717296698220] Output directory to store the Metadata
|
|
@@ -5862,8 +5856,8 @@ Delete source from your project and from a non-source-tracked org.
|
|
|
5862
5856
|
```
|
|
5863
5857
|
USAGE
|
|
5864
5858
|
$ sf project delete source -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>] [--tests
|
|
5865
|
-
<value
|
|
5866
|
-
|
|
5859
|
+
<value>] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>] [-p <value>] [-f [-t |
|
|
5860
|
+
-c]] [--verbose]
|
|
5867
5861
|
|
|
5868
5862
|
FLAGS
|
|
5869
5863
|
-c, --check-only Validate delete command but don't delete anything from the org or the local project.
|
|
@@ -6038,7 +6032,7 @@ Cancel a deploy operation.
|
|
|
6038
6032
|
|
|
6039
6033
|
```
|
|
6040
6034
|
USAGE
|
|
6041
|
-
$ sf project deploy cancel [--json] [--flags-dir <value>] [-o <value>] [--async | -w <
|
|
6035
|
+
$ sf project deploy cancel [--json] [--flags-dir <value>] [-o <value>] [--async | -w <value>] [-i <value>] [-r]
|
|
6042
6036
|
|
|
6043
6037
|
FLAGS
|
|
6044
6038
|
-i, --job-id=<value> Job ID of the deploy operation you want to cancel.
|
|
@@ -6110,7 +6104,7 @@ Preview a deployment to see what will deploy to the org, the potential conflicts
|
|
|
6110
6104
|
|
|
6111
6105
|
```
|
|
6112
6106
|
USAGE
|
|
6113
|
-
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value
|
|
6107
|
+
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value> | -m <value>]
|
|
6114
6108
|
[--concise]
|
|
6115
6109
|
|
|
6116
6110
|
FLAGS
|
|
@@ -6193,8 +6187,8 @@ Quickly deploy a validated deployment to an org.
|
|
|
6193
6187
|
|
|
6194
6188
|
```
|
|
6195
6189
|
USAGE
|
|
6196
|
-
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <
|
|
6197
|
-
|
|
6190
|
+
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <value>] [--concise | --verbose] [-i <value>] [-o
|
|
6191
|
+
<value>] [-r] [-a <value>]
|
|
6198
6192
|
|
|
6199
6193
|
FLAGS
|
|
6200
6194
|
-a, --api-version=<value> Target API version for the deploy.
|
|
@@ -6287,8 +6281,8 @@ Check or poll for the status of a deploy operation.
|
|
|
6287
6281
|
```
|
|
6288
6282
|
USAGE
|
|
6289
6283
|
$ sf project deploy report [--json] [--flags-dir <value>] [-o <value>] [-i <value>] [-r] [--coverage-formatters
|
|
6290
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary
|
|
6291
|
-
|
|
6284
|
+
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir
|
|
6285
|
+
<value>] [-w <value>]
|
|
6292
6286
|
|
|
6293
6287
|
FLAGS
|
|
6294
6288
|
-i, --job-id=<value> Job ID of the deploy operation you want to check the status of.
|
|
@@ -6378,8 +6372,8 @@ Resume watching a deploy operation and update source tracking when the deploy co
|
|
|
6378
6372
|
|
|
6379
6373
|
```
|
|
6380
6374
|
USAGE
|
|
6381
|
-
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <
|
|
6382
|
-
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary
|
|
6375
|
+
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <value>]
|
|
6376
|
+
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6383
6377
|
[--junit] [--results-dir <value>]
|
|
6384
6378
|
|
|
6385
6379
|
FLAGS
|
|
@@ -6475,11 +6469,11 @@ Deploy metadata to an org from your local project.
|
|
|
6475
6469
|
|
|
6476
6470
|
```
|
|
6477
6471
|
USAGE
|
|
6478
|
-
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <
|
|
6479
|
-
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value
|
|
6480
|
-
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value
|
|
6481
|
-
|
|
6482
|
-
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary
|
|
6472
|
+
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <value>] [--concise |
|
|
6473
|
+
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value>] [-l
|
|
6474
|
+
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value> | -m <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]
|
|
6483
6477
|
[--junit] [--results-dir <value>]
|
|
6484
6478
|
|
|
6485
6479
|
FLAGS
|
|
@@ -6719,11 +6713,10 @@ Validate a metadata deployment without actually executing it.
|
|
|
6719
6713
|
```
|
|
6720
6714
|
USAGE
|
|
6721
6715
|
$ sf project deploy validate -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [--concise | --verbose] [-m
|
|
6722
|
-
<value
|
|
6723
|
-
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <
|
|
6724
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary
|
|
6725
|
-
|
|
6726
|
-
[--post-destructive-changes <value> ]
|
|
6716
|
+
<value>] [-d <value>] [--single-package --metadata-dir <value>] [-t <value>] [-l
|
|
6717
|
+
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <value>] [-g] [--coverage-formatters
|
|
6718
|
+
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir
|
|
6719
|
+
<value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6727
6720
|
|
|
6728
6721
|
FLAGS
|
|
6729
6722
|
-a, --api-version=<value> Target API version for the validation.
|
|
@@ -7013,8 +7006,8 @@ Create a project manifest that lists the metadata components you want to deploy
|
|
|
7013
7006
|
|
|
7014
7007
|
```
|
|
7015
7008
|
USAGE
|
|
7016
|
-
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value
|
|
7017
|
-
|
|
7009
|
+
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>] [-p <value>] [-n <value> |
|
|
7010
|
+
-t pre|post|destroy|package] [-c managed|unlocked --from-org <value>] [-d <value>]
|
|
7018
7011
|
|
|
7019
7012
|
FLAGS
|
|
7020
7013
|
-c, --include-packages=<option>... Package types (managed, unlocked) whose metadata is included in the manifest; by
|
|
@@ -7235,9 +7228,8 @@ Retrieve metadata from an org to your local project.
|
|
|
7235
7228
|
|
|
7236
7229
|
```
|
|
7237
7230
|
USAGE
|
|
7238
|
-
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value
|
|
7239
|
-
<value
|
|
7240
|
-
<value> ]
|
|
7231
|
+
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value> | -d
|
|
7232
|
+
<value>] [-r <value> | -n <value> | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name <value> ]
|
|
7241
7233
|
|
|
7242
7234
|
FLAGS
|
|
7243
7235
|
-a, --api-version=<value> Target API version for the retrieve.
|
|
@@ -7375,9 +7367,7 @@ FLAG DESCRIPTIONS
|
|
|
7375
7367
|
If the target directory matches one of the package directories in your sfdx-project.json file, the command fails.
|
|
7376
7368
|
Running the command multiple times with the same target adds new files and overwrites existing files.
|
|
7377
7369
|
|
|
7378
|
-
-w, --wait=<value>
|
|
7379
|
-
|
|
7380
|
-
Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
7370
|
+
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
7381
7371
|
|
|
7382
7372
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
7383
7373
|
|
package/bin/dev.js
CHANGED
|
@@ -1,11 +1,9 @@
|
|
|
1
1
|
#!/usr/bin/env ts-node
|
|
2
2
|
|
|
3
3
|
async function main() {
|
|
4
|
-
const
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
settings.performanceEnabled = true;
|
|
8
|
-
await execute({ development: true, dir: import.meta.url });
|
|
4
|
+
const oclif = await import('@oclif/core');
|
|
5
|
+
oclif.settings.performanceEnabled = true;
|
|
6
|
+
await oclif.execute({ development: true, dir: import.meta.url });
|
|
9
7
|
}
|
|
10
8
|
|
|
11
9
|
await main();
|
package/bin/run.js
CHANGED
|
@@ -3,13 +3,30 @@
|
|
|
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
|
-
|
|
9
|
-
process.setMaxListeners(parseInt(process.env.SF_MAX_EVENT_LISTENERS, 10) || 1000);
|
|
10
|
-
|
|
11
|
-
// Don't let other plugins override the CLI specified max listener count
|
|
12
|
-
process.setMaxListeners = () => {};
|
|
6
|
+
const oclif = await import('@oclif/core');
|
|
7
|
+
const { createRequire } = await import('module');
|
|
8
|
+
const pjson = createRequire(import.meta.url)('../package.json');
|
|
13
9
|
|
|
14
10
|
const cli = await import('../dist/cli.js');
|
|
15
|
-
|
|
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 = () => {};
|
|
20
|
+
|
|
21
|
+
cli
|
|
22
|
+
.create({ version: pjson.version, bin: pjson.oclif.bin, channel: 'stable' })
|
|
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();
|
package/dist/cli.js
CHANGED
|
@@ -7,10 +7,11 @@
|
|
|
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 {
|
|
10
|
+
import { Config, run as oclifRun, settings } from '@oclif/core';
|
|
11
|
+
import { set } from '@salesforce/kit';
|
|
12
|
+
import Debug from 'debug';
|
|
13
|
+
import { default as nodeEnv, Env } from './util/env.js';
|
|
14
|
+
const debug = Debug('sf');
|
|
14
15
|
const envVars = [
|
|
15
16
|
...new Set([
|
|
16
17
|
...Object.keys(process.env).filter((e) => e.startsWith('SF_') || e.startsWith('SFDX_')),
|
|
@@ -31,6 +32,13 @@ export const UPDATE_DISABLED_INSTALLER = 'Manual and automatic CLI updates have
|
|
|
31
32
|
export const UPDATE_DISABLED_NPM = 'Use "npm update --global @salesforce/cli" to update npm-based installations.';
|
|
32
33
|
export const UPDATE_DISABLED_DEMO = 'Manual and automatic CLI updates have been disabled in DEMO mode. ' +
|
|
33
34
|
'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
|
+
}
|
|
34
42
|
export function configureAutoUpdate(envars) {
|
|
35
43
|
if (envars.isDemoMode()) {
|
|
36
44
|
// Disable autoupdates in demo mode
|
|
@@ -54,12 +62,11 @@ export function configureAutoUpdate(envars) {
|
|
|
54
62
|
envars.setUpdateInstructions(UPDATE_DISABLED_NPM);
|
|
55
63
|
}
|
|
56
64
|
}
|
|
57
|
-
function debugCliInfo(env, config) {
|
|
65
|
+
function debugCliInfo(version, channel, env, config) {
|
|
58
66
|
function debugSection(section, items) {
|
|
59
67
|
const pad = 25;
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
items.forEach(([name, value]) => logger.debug('%s: %s', name.padStart(pad), value));
|
|
68
|
+
debug('%s:', section.padStart(pad));
|
|
69
|
+
items.forEach(([name, value]) => debug('%s: %s', name.padStart(pad), value));
|
|
63
70
|
}
|
|
64
71
|
debugSection('OS', [
|
|
65
72
|
['platform', platform()],
|
|
@@ -69,8 +76,8 @@ function debugCliInfo(env, config) {
|
|
|
69
76
|
]);
|
|
70
77
|
debugSection('NODE', [['version', process.versions.node]]);
|
|
71
78
|
debugSection('CLI', [
|
|
72
|
-
['version',
|
|
73
|
-
['channel',
|
|
79
|
+
['version', version],
|
|
80
|
+
['channel', channel],
|
|
74
81
|
['bin', config.bin],
|
|
75
82
|
['data', config.dataDir],
|
|
76
83
|
['cache', config.cacheDir],
|
|
@@ -79,16 +86,26 @@ function debugCliInfo(env, config) {
|
|
|
79
86
|
debugSection('ENV', [...envVars].map((key) => [key, env.getString(key, '<not set>')]));
|
|
80
87
|
debugSection('ARGS', process.argv.map((arg, i) => [i.toString(), arg]));
|
|
81
88
|
}
|
|
82
|
-
export
|
|
83
|
-
|
|
84
|
-
const
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
89
|
+
export function create({ version, bin, channel, run, env }) {
|
|
90
|
+
settings.performanceEnabled = true;
|
|
91
|
+
const root = resolve(fileURLToPath(import.meta.url), '..');
|
|
92
|
+
const args = process.argv.slice(2);
|
|
93
|
+
const environment = env ?? nodeEnv;
|
|
94
|
+
return {
|
|
95
|
+
async run() {
|
|
96
|
+
const config = new Config({
|
|
97
|
+
name: bin,
|
|
98
|
+
root,
|
|
99
|
+
version,
|
|
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
|
+
};
|
|
93
110
|
}
|
|
94
111
|
//# 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';
|
|
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,11 +4,10 @@
|
|
|
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 } from '@oclif/core
|
|
8
|
-
import
|
|
9
|
-
import
|
|
7
|
+
import { Help, toConfiguredId } from '@oclif/core';
|
|
8
|
+
import stripAnsi from 'strip-ansi';
|
|
9
|
+
import chalk from 'chalk';
|
|
10
10
|
import { SfCommandHelp } from './sfCommandHelp.js';
|
|
11
|
-
const ansis = new Ansis();
|
|
12
11
|
export default class SfHelp extends Help {
|
|
13
12
|
constructor(config, opts) {
|
|
14
13
|
super(config, opts);
|
|
@@ -55,9 +54,9 @@ export default class SfHelp extends Help {
|
|
|
55
54
|
log(...args) {
|
|
56
55
|
const formatted = args.map((arg) => {
|
|
57
56
|
let formattedArg = arg.slice();
|
|
58
|
-
const matches =
|
|
57
|
+
const matches = stripAnsi(formattedArg).match(this.commandIdRegex) ?? [];
|
|
59
58
|
for (const match of matches) {
|
|
60
|
-
formattedArg = formattedArg.replaceAll(match,
|
|
59
|
+
formattedArg = formattedArg.replaceAll(match, chalk.dim(match));
|
|
61
60
|
}
|
|
62
61
|
return formattedArg;
|
|
63
62
|
});
|
|
@@ -1,4 +1,10 @@
|
|
|
1
|
-
|
|
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';
|
|
2
8
|
export const hook = async function ({ config }) {
|
|
3
9
|
if (process.env.SF_HIDE_RELEASE_NOTES === 'true')
|
|
4
10
|
return;
|
|
@@ -7,9 +13,9 @@ export const hook = async function ({ config }) {
|
|
|
7
13
|
}
|
|
8
14
|
catch (err) {
|
|
9
15
|
const error = err;
|
|
10
|
-
ux.
|
|
11
|
-
ux.
|
|
12
|
-
ux.
|
|
16
|
+
ux.log('NOTE: This error can be ignored in CI and may be silenced in the future');
|
|
17
|
+
ux.log('- Set the SF_HIDE_RELEASE_NOTES env var to "true" to skip this script\n');
|
|
18
|
+
ux.log(error.message);
|
|
13
19
|
}
|
|
14
20
|
};
|
|
15
21
|
export default hook;
|
package/dist/hooks/incomplete.js
CHANGED
|
@@ -4,9 +4,8 @@
|
|
|
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 os from 'node:os';
|
|
8
|
-
import { toConfiguredId, toStandardizedId } from '@oclif/core
|
|
9
|
-
import { loadHelpClass } from '@oclif/core/help';
|
|
7
|
+
import * as os from 'node:os';
|
|
8
|
+
import { toConfiguredId, toStandardizedId, loadHelpClass } from '@oclif/core';
|
|
10
9
|
function buildChoices(matches, config) {
|
|
11
10
|
const configuredIds = matches.map((p) => toConfiguredId(p.id, config));
|
|
12
11
|
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 { Errors } from '@oclif/core';
|
|
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 handle(pluginTrustFailure.error);
|
|
12
|
+
await Errors.handle(pluginTrustFailure.error);
|
|
13
13
|
}
|
|
14
14
|
};
|
|
15
15
|
export default hook;
|
package/dist/hooks/prerun.js
CHANGED
|
@@ -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 ux from '@oclif/core
|
|
7
|
+
import { ux } from '@oclif/core';
|
|
8
8
|
// eslint-disable-next-line @typescript-eslint/require-await
|
|
9
9
|
const hook = async function ({ Command, config }) {
|
|
10
10
|
if (process.argv.includes('--json'))
|