@salesforce/cli 2.27.5 → 2.28.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 +44 -33
- package/npm-shrinkwrap.json +1190 -286
- package/oclif.manifest.json +1 -1
- package/package.json +8 -8
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.
|
|
27
|
+
@salesforce/cli/2.28.0 linux-x64 node-v20.11.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -819,7 +819,7 @@ EXAMPLES
|
|
|
819
819
|
$ sf autocomplete --refresh-cache
|
|
820
820
|
```
|
|
821
821
|
|
|
822
|
-
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/3.0.
|
|
822
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/3.0.6/src/commands/autocomplete/index.ts)_
|
|
823
823
|
|
|
824
824
|
## `sf commands`
|
|
825
825
|
|
|
@@ -2275,7 +2275,7 @@ EXAMPLES
|
|
|
2275
2275
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
2276
2276
|
```
|
|
2277
2277
|
|
|
2278
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.
|
|
2278
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.6/src/commands/org/assign/permset.ts)_
|
|
2279
2279
|
|
|
2280
2280
|
## `sf org assign permsetlicense`
|
|
2281
2281
|
|
|
@@ -2319,7 +2319,7 @@ EXAMPLES
|
|
|
2319
2319
|
user3
|
|
2320
2320
|
```
|
|
2321
2321
|
|
|
2322
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.
|
|
2322
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.6/src/commands/org/assign/permsetlicense.ts)_
|
|
2323
2323
|
|
|
2324
2324
|
## `sf org create sandbox`
|
|
2325
2325
|
|
|
@@ -2626,6 +2626,13 @@ DESCRIPTION
|
|
|
2626
2626
|
When this command completes, it displays the new username and user ID. Run the "org display user" command to get more
|
|
2627
2627
|
information about the new user.
|
|
2628
2628
|
|
|
2629
|
+
After the new user has been created, Salesforce CLI automatically authenticates it to the scratch org so the new user
|
|
2630
|
+
can immediately start using the scratch org. The CLI uses the same authentication method that was used on the
|
|
2631
|
+
associated Dev Hub org. Due to Hyperforce limitations, the scratch org user creation fails if the Dev Hub
|
|
2632
|
+
authentication used the JWT flow and the scratch org is on Hyperforce. For this reason, if you plan to create scratch
|
|
2633
|
+
org users, authenticate to the Dev Hub org with either the "org login web" or "org login sfdx-url" command, and not
|
|
2634
|
+
"org login jwt".
|
|
2635
|
+
|
|
2629
2636
|
For more information about user limits, defaults, and other considerations when creating a new scratch org user, see
|
|
2630
2637
|
https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_users.htm.
|
|
2631
2638
|
|
|
@@ -2676,7 +2683,7 @@ FLAG DESCRIPTIONS
|
|
|
2676
2683
|
might be different than what you specify in the definition file.
|
|
2677
2684
|
```
|
|
2678
2685
|
|
|
2679
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.
|
|
2686
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.6/src/commands/org/create/user.ts)_
|
|
2680
2687
|
|
|
2681
2688
|
## `sf org delete sandbox`
|
|
2682
2689
|
|
|
@@ -2882,7 +2889,7 @@ EXAMPLES
|
|
|
2882
2889
|
$ sf org display user --target-org me@my.org --json
|
|
2883
2890
|
```
|
|
2884
2891
|
|
|
2885
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.
|
|
2892
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.6/src/commands/org/display/user.ts)_
|
|
2886
2893
|
|
|
2887
2894
|
## `sf org enable tracking`
|
|
2888
2895
|
|
|
@@ -2988,7 +2995,7 @@ EXAMPLES
|
|
|
2988
2995
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
2989
2996
|
```
|
|
2990
2997
|
|
|
2991
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.
|
|
2998
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.6/src/commands/org/generate/password.ts)_
|
|
2992
2999
|
|
|
2993
3000
|
## `sf org list`
|
|
2994
3001
|
|
|
@@ -3297,7 +3304,7 @@ EXAMPLES
|
|
|
3297
3304
|
$ sf org list users --target-org me@my.org
|
|
3298
3305
|
```
|
|
3299
3306
|
|
|
3300
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.
|
|
3307
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.6/src/commands/org/list/users.ts)_
|
|
3301
3308
|
|
|
3302
3309
|
## `sf org login access-token`
|
|
3303
3310
|
|
|
@@ -5085,7 +5092,7 @@ EXAMPLES
|
|
|
5085
5092
|
$ sf plugins
|
|
5086
5093
|
```
|
|
5087
5094
|
|
|
5088
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1
|
|
5095
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.1/src/commands/plugins/index.ts)_
|
|
5089
5096
|
|
|
5090
5097
|
## `sf plugins discover`
|
|
5091
5098
|
|
|
@@ -5129,7 +5136,7 @@ EXAMPLES
|
|
|
5129
5136
|
$ sf plugins inspect myplugin
|
|
5130
5137
|
```
|
|
5131
5138
|
|
|
5132
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1
|
|
5139
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.1/src/commands/plugins/inspect.ts)_
|
|
5133
5140
|
|
|
5134
5141
|
## `sf plugins:install PLUGIN...`
|
|
5135
5142
|
|
|
@@ -5173,7 +5180,7 @@ EXAMPLES
|
|
|
5173
5180
|
$ sf plugins install someuser/someplugin
|
|
5174
5181
|
```
|
|
5175
5182
|
|
|
5176
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1
|
|
5183
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.1/src/commands/plugins/install.ts)_
|
|
5177
5184
|
|
|
5178
5185
|
## `sf plugins:link PLUGIN`
|
|
5179
5186
|
|
|
@@ -5203,7 +5210,7 @@ EXAMPLES
|
|
|
5203
5210
|
$ sf plugins link myplugin
|
|
5204
5211
|
```
|
|
5205
5212
|
|
|
5206
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1
|
|
5213
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.1/src/commands/plugins/link.ts)_
|
|
5207
5214
|
|
|
5208
5215
|
## `sf plugins reset`
|
|
5209
5216
|
|
|
@@ -5211,10 +5218,14 @@ Remove all user-installed and linked plugins.
|
|
|
5211
5218
|
|
|
5212
5219
|
```
|
|
5213
5220
|
USAGE
|
|
5214
|
-
$ sf plugins reset
|
|
5221
|
+
$ sf plugins reset [--hard] [--reinstall]
|
|
5222
|
+
|
|
5223
|
+
FLAGS
|
|
5224
|
+
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
|
|
5225
|
+
--reinstall Reinstall all plugins after uninstalling.
|
|
5215
5226
|
```
|
|
5216
5227
|
|
|
5217
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1
|
|
5228
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.1/src/commands/plugins/reset.ts)_
|
|
5218
5229
|
|
|
5219
5230
|
## `sf plugins trust verify`
|
|
5220
5231
|
|
|
@@ -5270,7 +5281,7 @@ EXAMPLES
|
|
|
5270
5281
|
$ sf plugins uninstall myplugin
|
|
5271
5282
|
```
|
|
5272
5283
|
|
|
5273
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1
|
|
5284
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.1/src/commands/plugins/uninstall.ts)_
|
|
5274
5285
|
|
|
5275
5286
|
## `sf plugins update`
|
|
5276
5287
|
|
|
@@ -5288,7 +5299,7 @@ DESCRIPTION
|
|
|
5288
5299
|
Update installed plugins.
|
|
5289
5300
|
```
|
|
5290
5301
|
|
|
5291
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1
|
|
5302
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.2.1/src/commands/plugins/update.ts)_
|
|
5292
5303
|
|
|
5293
5304
|
## `sf project convert mdapi`
|
|
5294
5305
|
|
|
@@ -5350,7 +5361,7 @@ FLAG DESCRIPTIONS
|
|
|
5350
5361
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5351
5362
|
```
|
|
5352
5363
|
|
|
5353
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5364
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/convert/mdapi.ts)_
|
|
5354
5365
|
|
|
5355
5366
|
## `sf project convert source`
|
|
5356
5367
|
|
|
@@ -5362,7 +5373,7 @@ USAGE
|
|
|
5362
5373
|
<value> | -m <value>]
|
|
5363
5374
|
|
|
5364
5375
|
FLAGS
|
|
5365
|
-
-d, --output-dir=<value> [default:
|
|
5376
|
+
-d, --output-dir=<value> [default: metadataPackage_1706639901301] Output directory to store the Metadata
|
|
5366
5377
|
API–formatted files in.
|
|
5367
5378
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
5368
5379
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -5422,7 +5433,7 @@ FLAG DESCRIPTIONS
|
|
|
5422
5433
|
Override the api version used for api requests made by this command
|
|
5423
5434
|
```
|
|
5424
5435
|
|
|
5425
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5436
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/convert/source.ts)_
|
|
5426
5437
|
|
|
5427
5438
|
## `sf project delete source`
|
|
5428
5439
|
|
|
@@ -5561,7 +5572,7 @@ FLAG DESCRIPTIONS
|
|
|
5561
5572
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
5562
5573
|
```
|
|
5563
5574
|
|
|
5564
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5575
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/delete/source.ts)_
|
|
5565
5576
|
|
|
5566
5577
|
## `sf project delete tracking`
|
|
5567
5578
|
|
|
@@ -5597,7 +5608,7 @@ EXAMPLES
|
|
|
5597
5608
|
$ sf project delete tracking --target-org my-scratch
|
|
5598
5609
|
```
|
|
5599
5610
|
|
|
5600
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5611
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/delete/tracking.ts)_
|
|
5601
5612
|
|
|
5602
5613
|
## `sf project deploy cancel`
|
|
5603
5614
|
|
|
@@ -5667,7 +5678,7 @@ FLAG DESCRIPTIONS
|
|
|
5667
5678
|
project deploy report".
|
|
5668
5679
|
```
|
|
5669
5680
|
|
|
5670
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5681
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/deploy/cancel.ts)_
|
|
5671
5682
|
|
|
5672
5683
|
## `sf project deploy preview`
|
|
5673
5684
|
|
|
@@ -5751,7 +5762,7 @@ FLAG DESCRIPTIONS
|
|
|
5751
5762
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
5752
5763
|
```
|
|
5753
5764
|
|
|
5754
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5765
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/deploy/preview.ts)_
|
|
5755
5766
|
|
|
5756
5767
|
## `sf project deploy quick`
|
|
5757
5768
|
|
|
@@ -5844,7 +5855,7 @@ ERROR CODES
|
|
|
5844
5855
|
Canceling (69) The deploy is being canceled.
|
|
5845
5856
|
```
|
|
5846
5857
|
|
|
5847
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5858
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/deploy/quick.ts)_
|
|
5848
5859
|
|
|
5849
5860
|
## `sf project deploy report`
|
|
5850
5861
|
|
|
@@ -5939,7 +5950,7 @@ FLAG DESCRIPTIONS
|
|
|
5939
5950
|
--coverage-formatters lcov --coverage-formatters clover
|
|
5940
5951
|
```
|
|
5941
5952
|
|
|
5942
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5953
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/deploy/report.ts)_
|
|
5943
5954
|
|
|
5944
5955
|
## `sf project deploy resume`
|
|
5945
5956
|
|
|
@@ -6035,7 +6046,7 @@ ERROR CODES
|
|
|
6035
6046
|
Canceling (69) The deploy is being canceled.
|
|
6036
6047
|
```
|
|
6037
6048
|
|
|
6038
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6049
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/deploy/resume.ts)_
|
|
6039
6050
|
|
|
6040
6051
|
## `sf project deploy start`
|
|
6041
6052
|
|
|
@@ -6264,7 +6275,7 @@ ERROR CODES
|
|
|
6264
6275
|
Canceling (69) The deploy is being canceled.
|
|
6265
6276
|
```
|
|
6266
6277
|
|
|
6267
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6278
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/deploy/start.ts)_
|
|
6268
6279
|
|
|
6269
6280
|
## `sf project deploy validate`
|
|
6270
6281
|
|
|
@@ -6443,7 +6454,7 @@ ERROR CODES
|
|
|
6443
6454
|
Canceling (69) The deploy is being canceled.
|
|
6444
6455
|
```
|
|
6445
6456
|
|
|
6446
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6457
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/deploy/validate.ts)_
|
|
6447
6458
|
|
|
6448
6459
|
## `sf project generate`
|
|
6449
6460
|
|
|
@@ -6622,7 +6633,7 @@ EXAMPLES
|
|
|
6622
6633
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
6623
6634
|
```
|
|
6624
6635
|
|
|
6625
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6636
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/generate/manifest.ts)_
|
|
6626
6637
|
|
|
6627
6638
|
## `sf project list ignored`
|
|
6628
6639
|
|
|
@@ -6663,7 +6674,7 @@ EXAMPLES
|
|
|
6663
6674
|
$ sf project list ignored --source-dir package.xml
|
|
6664
6675
|
```
|
|
6665
6676
|
|
|
6666
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6677
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/list/ignored.ts)_
|
|
6667
6678
|
|
|
6668
6679
|
## `sf project reset tracking`
|
|
6669
6680
|
|
|
@@ -6711,7 +6722,7 @@ EXAMPLES
|
|
|
6711
6722
|
$ sf project reset tracking --revision 30
|
|
6712
6723
|
```
|
|
6713
6724
|
|
|
6714
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6725
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/reset/tracking.ts)_
|
|
6715
6726
|
|
|
6716
6727
|
## `sf project retrieve preview`
|
|
6717
6728
|
|
|
@@ -6767,7 +6778,7 @@ FLAG DESCRIPTIONS
|
|
|
6767
6778
|
Overrides your default org.
|
|
6768
6779
|
```
|
|
6769
6780
|
|
|
6770
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6781
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/retrieve/preview.ts)_
|
|
6771
6782
|
|
|
6772
6783
|
## `sf project retrieve start`
|
|
6773
6784
|
|
|
@@ -6921,7 +6932,7 @@ ENVIRONMENT VARIABLES
|
|
|
6921
6932
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
6922
6933
|
```
|
|
6923
6934
|
|
|
6924
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6935
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.9/src/commands/project/retrieve/start.ts)_
|
|
6925
6936
|
|
|
6926
6937
|
## `sf schema generate field`
|
|
6927
6938
|
|