@salesforce/cli 2.32.4 → 2.32.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 +121 -92
- package/npm-shrinkwrap.json +1431 -1330
- package/oclif.manifest.json +293 -211
- package/package.json +14 -14
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.32.
|
|
27
|
+
@salesforce/cli/2.32.6 linux-x64 node-v20.11.1
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -329,7 +329,7 @@ FLAG DESCRIPTIONS
|
|
|
329
329
|
directory.
|
|
330
330
|
```
|
|
331
331
|
|
|
332
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
332
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/analytics/generate/template.ts)_
|
|
333
333
|
|
|
334
334
|
## `sf apex generate class`
|
|
335
335
|
|
|
@@ -385,7 +385,7 @@ FLAG DESCRIPTIONS
|
|
|
385
385
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
386
386
|
```
|
|
387
387
|
|
|
388
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
388
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/apex/generate/class.ts)_
|
|
389
389
|
|
|
390
390
|
## `sf apex generate trigger`
|
|
391
391
|
|
|
@@ -452,7 +452,7 @@ FLAG DESCRIPTIONS
|
|
|
452
452
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
453
453
|
```
|
|
454
454
|
|
|
455
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
455
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/apex/generate/trigger.ts)_
|
|
456
456
|
|
|
457
457
|
## `sf apex get log`
|
|
458
458
|
|
|
@@ -2104,7 +2104,7 @@ FLAG DESCRIPTIONS
|
|
|
2104
2104
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2105
2105
|
```
|
|
2106
2106
|
|
|
2107
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
2107
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/app.ts)_
|
|
2108
2108
|
|
|
2109
2109
|
## `sf lightning generate component`
|
|
2110
2110
|
|
|
@@ -2172,7 +2172,7 @@ FLAG DESCRIPTIONS
|
|
|
2172
2172
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2173
2173
|
```
|
|
2174
2174
|
|
|
2175
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
2175
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/component.ts)_
|
|
2176
2176
|
|
|
2177
2177
|
## `sf lightning generate event`
|
|
2178
2178
|
|
|
@@ -2225,7 +2225,7 @@ FLAG DESCRIPTIONS
|
|
|
2225
2225
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2226
2226
|
```
|
|
2227
2227
|
|
|
2228
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
2228
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/event.ts)_
|
|
2229
2229
|
|
|
2230
2230
|
## `sf lightning generate interface`
|
|
2231
2231
|
|
|
@@ -2278,7 +2278,7 @@ FLAG DESCRIPTIONS
|
|
|
2278
2278
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2279
2279
|
```
|
|
2280
2280
|
|
|
2281
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
2281
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/interface.ts)_
|
|
2282
2282
|
|
|
2283
2283
|
## `sf lightning generate test`
|
|
2284
2284
|
|
|
@@ -2331,7 +2331,7 @@ FLAG DESCRIPTIONS
|
|
|
2331
2331
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2332
2332
|
```
|
|
2333
2333
|
|
|
2334
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
2334
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/lightning/generate/test.ts)_
|
|
2335
2335
|
|
|
2336
2336
|
## `sf org assign permset`
|
|
2337
2337
|
|
|
@@ -3173,7 +3173,7 @@ EXAMPLES
|
|
|
3173
3173
|
$ sf org list auth
|
|
3174
3174
|
```
|
|
3175
3175
|
|
|
3176
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3176
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.21/src/commands/org/list/auth.ts)_
|
|
3177
3177
|
|
|
3178
3178
|
## `sf org list limits`
|
|
3179
3179
|
|
|
@@ -3461,12 +3461,12 @@ FLAG DESCRIPTIONS
|
|
|
3461
3461
|
|
|
3462
3462
|
If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.
|
|
3463
3463
|
|
|
3464
|
-
To specify a My Domain URL, use the format https
|
|
3464
|
+
To specify a My Domain URL, use the format "https://<MyDomainName>.my.salesforce.com".
|
|
3465
3465
|
|
|
3466
|
-
To specify a sandbox, set --instance-url to https
|
|
3466
|
+
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3467
3467
|
```
|
|
3468
3468
|
|
|
3469
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3469
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.21/src/commands/org/login/access-token.ts)_
|
|
3470
3470
|
|
|
3471
3471
|
## `sf org login device`
|
|
3472
3472
|
|
|
@@ -3520,12 +3520,12 @@ FLAG DESCRIPTIONS
|
|
|
3520
3520
|
|
|
3521
3521
|
If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.
|
|
3522
3522
|
|
|
3523
|
-
To specify a My Domain URL, use the format https
|
|
3523
|
+
To specify a My Domain URL, use the format "https://<MyDomainName>.my.salesforce.com".
|
|
3524
3524
|
|
|
3525
|
-
To specify a sandbox, set --instance-url to https
|
|
3525
|
+
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3526
3526
|
```
|
|
3527
3527
|
|
|
3528
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3528
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.21/src/commands/org/login/device.ts)_
|
|
3529
3529
|
|
|
3530
3530
|
## `sf org login jwt`
|
|
3531
3531
|
|
|
@@ -3609,12 +3609,12 @@ FLAG DESCRIPTIONS
|
|
|
3609
3609
|
|
|
3610
3610
|
If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.
|
|
3611
3611
|
|
|
3612
|
-
To specify a My Domain URL, use the format https
|
|
3612
|
+
To specify a My Domain URL, use the format "https://<MyDomainName>.my.salesforce.com".
|
|
3613
3613
|
|
|
3614
|
-
To specify a sandbox, set --instance-url to https
|
|
3614
|
+
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3615
3615
|
```
|
|
3616
3616
|
|
|
3617
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3617
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.21/src/commands/org/login/jwt.ts)_
|
|
3618
3618
|
|
|
3619
3619
|
## `sf org login sfdx-url`
|
|
3620
3620
|
|
|
@@ -3679,7 +3679,7 @@ EXAMPLES
|
|
|
3679
3679
|
$ echo url | sf org login sfdx-url --sfdx-url-stdin
|
|
3680
3680
|
```
|
|
3681
3681
|
|
|
3682
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3682
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.21/src/commands/org/login/sfdx-url.ts)_
|
|
3683
3683
|
|
|
3684
3684
|
## `sf org login web`
|
|
3685
3685
|
|
|
@@ -3759,12 +3759,12 @@ FLAG DESCRIPTIONS
|
|
|
3759
3759
|
|
|
3760
3760
|
If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.
|
|
3761
3761
|
|
|
3762
|
-
To specify a My Domain URL, use the format https
|
|
3762
|
+
To specify a My Domain URL, use the format "https://<MyDomainName>.my.salesforce.com".
|
|
3763
3763
|
|
|
3764
|
-
To specify a sandbox, set --instance-url to https
|
|
3764
|
+
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3765
3765
|
```
|
|
3766
3766
|
|
|
3767
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3767
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.21/src/commands/org/login/web.ts)_
|
|
3768
3768
|
|
|
3769
3769
|
## `sf org logout`
|
|
3770
3770
|
|
|
@@ -3824,7 +3824,7 @@ FLAG DESCRIPTIONS
|
|
|
3824
3824
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
3825
3825
|
```
|
|
3826
3826
|
|
|
3827
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3827
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.21/src/commands/org/logout.ts)_
|
|
3828
3828
|
|
|
3829
3829
|
## `sf org open`
|
|
3830
3830
|
|
|
@@ -5271,7 +5271,7 @@ EXAMPLES
|
|
|
5271
5271
|
$ sf plugins
|
|
5272
5272
|
```
|
|
5273
5273
|
|
|
5274
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.
|
|
5274
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.1/src/commands/plugins/index.ts)_
|
|
5275
5275
|
|
|
5276
5276
|
## `sf plugins discover`
|
|
5277
5277
|
|
|
@@ -5315,7 +5315,7 @@ EXAMPLES
|
|
|
5315
5315
|
$ sf plugins inspect myplugin
|
|
5316
5316
|
```
|
|
5317
5317
|
|
|
5318
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.
|
|
5318
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.1/src/commands/plugins/inspect.ts)_
|
|
5319
5319
|
|
|
5320
5320
|
## `sf plugins:install PLUGIN...`
|
|
5321
5321
|
|
|
@@ -5359,7 +5359,7 @@ EXAMPLES
|
|
|
5359
5359
|
$ sf plugins install someuser/someplugin
|
|
5360
5360
|
```
|
|
5361
5361
|
|
|
5362
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.
|
|
5362
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.1/src/commands/plugins/install.ts)_
|
|
5363
5363
|
|
|
5364
5364
|
## `sf plugins:link PLUGIN`
|
|
5365
5365
|
|
|
@@ -5389,7 +5389,7 @@ EXAMPLES
|
|
|
5389
5389
|
$ sf plugins link myplugin
|
|
5390
5390
|
```
|
|
5391
5391
|
|
|
5392
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.
|
|
5392
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.1/src/commands/plugins/link.ts)_
|
|
5393
5393
|
|
|
5394
5394
|
## `sf plugins reset`
|
|
5395
5395
|
|
|
@@ -5404,7 +5404,7 @@ FLAGS
|
|
|
5404
5404
|
--reinstall Reinstall all plugins after uninstalling.
|
|
5405
5405
|
```
|
|
5406
5406
|
|
|
5407
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.
|
|
5407
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.1/src/commands/plugins/reset.ts)_
|
|
5408
5408
|
|
|
5409
5409
|
## `sf plugins trust verify`
|
|
5410
5410
|
|
|
@@ -5460,7 +5460,7 @@ EXAMPLES
|
|
|
5460
5460
|
$ sf plugins uninstall myplugin
|
|
5461
5461
|
```
|
|
5462
5462
|
|
|
5463
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.
|
|
5463
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.1/src/commands/plugins/uninstall.ts)_
|
|
5464
5464
|
|
|
5465
5465
|
## `sf plugins update`
|
|
5466
5466
|
|
|
@@ -5478,7 +5478,7 @@ DESCRIPTION
|
|
|
5478
5478
|
Update installed plugins.
|
|
5479
5479
|
```
|
|
5480
5480
|
|
|
5481
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.
|
|
5481
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.1/src/commands/plugins/update.ts)_
|
|
5482
5482
|
|
|
5483
5483
|
## `sf project convert mdapi`
|
|
5484
5484
|
|
|
@@ -5540,7 +5540,7 @@ FLAG DESCRIPTIONS
|
|
|
5540
5540
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5541
5541
|
```
|
|
5542
5542
|
|
|
5543
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5543
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/convert/mdapi.ts)_
|
|
5544
5544
|
|
|
5545
5545
|
## `sf project convert source`
|
|
5546
5546
|
|
|
@@ -5552,7 +5552,7 @@ USAGE
|
|
|
5552
5552
|
<value> | -m <value>]
|
|
5553
5553
|
|
|
5554
5554
|
FLAGS
|
|
5555
|
-
-d, --output-dir=<value> [default:
|
|
5555
|
+
-d, --output-dir=<value> [default: metadataPackage_1709665275547] Output directory to store the Metadata
|
|
5556
5556
|
API–formatted files in.
|
|
5557
5557
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
5558
5558
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -5612,7 +5612,7 @@ FLAG DESCRIPTIONS
|
|
|
5612
5612
|
Override the api version used for api requests made by this command
|
|
5613
5613
|
```
|
|
5614
5614
|
|
|
5615
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5615
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/convert/source.ts)_
|
|
5616
5616
|
|
|
5617
5617
|
## `sf project delete source`
|
|
5618
5618
|
|
|
@@ -5751,7 +5751,7 @@ FLAG DESCRIPTIONS
|
|
|
5751
5751
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
5752
5752
|
```
|
|
5753
5753
|
|
|
5754
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5754
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/delete/source.ts)_
|
|
5755
5755
|
|
|
5756
5756
|
## `sf project delete tracking`
|
|
5757
5757
|
|
|
@@ -5787,7 +5787,7 @@ EXAMPLES
|
|
|
5787
5787
|
$ sf project delete tracking --target-org my-scratch
|
|
5788
5788
|
```
|
|
5789
5789
|
|
|
5790
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5790
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/delete/tracking.ts)_
|
|
5791
5791
|
|
|
5792
5792
|
## `sf project deploy cancel`
|
|
5793
5793
|
|
|
@@ -5857,7 +5857,7 @@ FLAG DESCRIPTIONS
|
|
|
5857
5857
|
project deploy report".
|
|
5858
5858
|
```
|
|
5859
5859
|
|
|
5860
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5860
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/deploy/cancel.ts)_
|
|
5861
5861
|
|
|
5862
5862
|
## `sf project deploy preview`
|
|
5863
5863
|
|
|
@@ -5941,7 +5941,7 @@ FLAG DESCRIPTIONS
|
|
|
5941
5941
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
5942
5942
|
```
|
|
5943
5943
|
|
|
5944
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
5944
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/deploy/preview.ts)_
|
|
5945
5945
|
|
|
5946
5946
|
## `sf project deploy quick`
|
|
5947
5947
|
|
|
@@ -5981,6 +5981,9 @@ DESCRIPTION
|
|
|
5981
5981
|
This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org.
|
|
5982
5982
|
This command doesn’t attempt to merge your source with the versions in your org.
|
|
5983
5983
|
|
|
5984
|
+
Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default,
|
|
5985
|
+
sandboxes don't run tests during a deploy. Use `sf project deploy start` instead.
|
|
5986
|
+
|
|
5984
5987
|
ALIASES
|
|
5985
5988
|
$ sf deploy metadata quick
|
|
5986
5989
|
|
|
@@ -6034,7 +6037,7 @@ ERROR CODES
|
|
|
6034
6037
|
Canceling (69) The deploy is being canceled.
|
|
6035
6038
|
```
|
|
6036
6039
|
|
|
6037
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6040
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/deploy/quick.ts)_
|
|
6038
6041
|
|
|
6039
6042
|
## `sf project deploy report`
|
|
6040
6043
|
|
|
@@ -6129,7 +6132,7 @@ FLAG DESCRIPTIONS
|
|
|
6129
6132
|
--coverage-formatters lcov --coverage-formatters clover
|
|
6130
6133
|
```
|
|
6131
6134
|
|
|
6132
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6135
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/deploy/report.ts)_
|
|
6133
6136
|
|
|
6134
6137
|
## `sf project deploy resume`
|
|
6135
6138
|
|
|
@@ -6225,7 +6228,7 @@ ERROR CODES
|
|
|
6225
6228
|
Canceling (69) The deploy is being canceled.
|
|
6226
6229
|
```
|
|
6227
6230
|
|
|
6228
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6231
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/deploy/resume.ts)_
|
|
6229
6232
|
|
|
6230
6233
|
## `sf project deploy start`
|
|
6231
6234
|
|
|
@@ -6255,8 +6258,8 @@ FLAGS
|
|
|
6255
6258
|
|
|
6256
6259
|
SOURCE FORMAT FLAGS
|
|
6257
6260
|
-d, --source-dir=<value>... Path to the local source files to deploy.
|
|
6258
|
-
-m, --metadata=<value>... Metadata component names to deploy. Wildcards (
|
|
6259
|
-
|
|
6261
|
+
-m, --metadata=<value>... Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes,
|
|
6262
|
+
such as `ApexClass:MyClass*`.
|
|
6260
6263
|
-x, --manifest=<value> Full file path for manifest (package.xml) of components to deploy.
|
|
6261
6264
|
|
|
6262
6265
|
TEST FLAGS
|
|
@@ -6281,7 +6284,7 @@ DELETE FLAGS
|
|
|
6281
6284
|
--post-destructive-changes=<value> File path for a manifest (destructiveChangesPost.xml) of components to delete
|
|
6282
6285
|
after the deploy.
|
|
6283
6286
|
--pre-destructive-changes=<value> File path for a manifest (destructiveChangesPre.xml) of components to delete
|
|
6284
|
-
before the deploy
|
|
6287
|
+
before the deploy.
|
|
6285
6288
|
--purge-on-delete Specify that deleted components in the destructive changes manifest file are
|
|
6286
6289
|
immediately eligible for deletion rather than being stored in the Recycle Bin.
|
|
6287
6290
|
|
|
@@ -6295,7 +6298,7 @@ DESCRIPTION
|
|
|
6295
6298
|
want to deploy.
|
|
6296
6299
|
|
|
6297
6300
|
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
|
|
6298
|
-
|
|
6301
|
+
orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
|
|
6299
6302
|
source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create
|
|
6300
6303
|
scratch|sandbox" commands.
|
|
6301
6304
|
|
|
@@ -6311,29 +6314,34 @@ EXAMPLES
|
|
|
6311
6314
|
|
|
6312
6315
|
$ sf project deploy start
|
|
6313
6316
|
|
|
6314
|
-
Deploy
|
|
6317
|
+
Deploy all source files in the "force-app" directory to an org with alias "my-scratch"; show only concise output, in
|
|
6318
|
+
other words don't print a list of all the source that was deployed:
|
|
6315
6319
|
|
|
6316
|
-
$ sf project deploy start --source-dir
|
|
6320
|
+
$ sf project deploy start --source-dir force-app --target-org my-scratch --concise
|
|
6317
6321
|
|
|
6318
|
-
Deploy
|
|
6322
|
+
Deploy all the Apex classes and custom objects that are in the "force-app" directory. The list views, layouts, etc,
|
|
6323
|
+
that are associated with the custom objects are also deployed. Both examples are equivalent:
|
|
6319
6324
|
|
|
6320
|
-
$ sf project deploy start --source-dir
|
|
6321
|
-
$ sf project deploy start --source-dir
|
|
6325
|
+
$ sf project deploy start --source-dir force-app/main/default/classes force-app/main/default/objects
|
|
6326
|
+
$ sf project deploy start --source-dir force-app/main/default/classes --source-dir \
|
|
6327
|
+
force-app/main/default/objects
|
|
6322
6328
|
|
|
6323
|
-
Deploy all Apex classes:
|
|
6329
|
+
Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
|
|
6324
6330
|
|
|
6325
6331
|
$ sf project deploy start --metadata ApexClass
|
|
6326
6332
|
|
|
6327
|
-
Deploy a specific Apex class
|
|
6333
|
+
Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag,
|
|
6334
|
+
because it will overwrite the Apex class in the org if there are conflicts!):
|
|
6328
6335
|
|
|
6329
|
-
$ sf project deploy start --metadata ApexClass:MyApexClass
|
|
6336
|
+
$ sf project deploy start --metadata ApexClass:MyApexClass --ignore-conflicts
|
|
6330
6337
|
|
|
6331
6338
|
Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the
|
|
6332
|
-
string "MyApex"
|
|
6339
|
+
string "MyApex". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see
|
|
6340
|
+
the warnings):
|
|
6333
6341
|
|
|
6334
|
-
$ sf project deploy start --metadata 'ApexClass:MyApex*'
|
|
6342
|
+
$ sf project deploy start --metadata 'ApexClass:MyApex*' --ignore-warnings
|
|
6335
6343
|
|
|
6336
|
-
Deploy all custom objects and Apex classes (both examples are equivalent):
|
|
6344
|
+
Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
|
|
6337
6345
|
|
|
6338
6346
|
$ sf project deploy start --metadata CustomObject ApexClass
|
|
6339
6347
|
$ sf project deploy start --metadata CustomObject --metadata ApexClass
|
|
@@ -6370,8 +6378,13 @@ FLAG DESCRIPTIONS
|
|
|
6370
6378
|
|
|
6371
6379
|
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
6372
6380
|
|
|
6373
|
-
If
|
|
6374
|
-
flag
|
|
6381
|
+
If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't
|
|
6382
|
+
specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an
|
|
6383
|
+
error.
|
|
6384
|
+
|
|
6385
|
+
This flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a
|
|
6386
|
+
component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a
|
|
6387
|
+
success value of true, specify this flag.
|
|
6375
6388
|
|
|
6376
6389
|
-l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
|
|
6377
6390
|
|
|
@@ -6401,9 +6414,8 @@ FLAG DESCRIPTIONS
|
|
|
6401
6414
|
|
|
6402
6415
|
-r, --ignore-errors Ignore any errors and don’t roll back deployment.
|
|
6403
6416
|
|
|
6404
|
-
|
|
6405
|
-
|
|
6406
|
-
org.
|
|
6417
|
+
Never use this flag when deploying to a production org. If you specify it, components without errors are deployed
|
|
6418
|
+
and components with errors are skipped, and could result in an inconsistent production org.
|
|
6407
6419
|
|
|
6408
6420
|
-t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
6409
6421
|
|
|
@@ -6454,7 +6466,7 @@ ERROR CODES
|
|
|
6454
6466
|
Canceling (69) The deploy is being canceled.
|
|
6455
6467
|
```
|
|
6456
6468
|
|
|
6457
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6469
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/deploy/start.ts)_
|
|
6458
6470
|
|
|
6459
6471
|
## `sf project deploy validate`
|
|
6460
6472
|
|
|
@@ -6528,20 +6540,28 @@ DESCRIPTION
|
|
|
6528
6540
|
--metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double
|
|
6529
6541
|
quotes. The same syntax applies to --manifest and --source-dir.
|
|
6530
6542
|
|
|
6543
|
+
Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default,
|
|
6544
|
+
sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use "sf
|
|
6545
|
+
project deploy start --dry-run --test-level RunLocalTests" instead.
|
|
6546
|
+
|
|
6531
6547
|
ALIASES
|
|
6532
6548
|
$ sf deploy metadata validate
|
|
6533
6549
|
|
|
6534
6550
|
EXAMPLES
|
|
6535
6551
|
NOTE: These examples focus on validating large deployments. See the help for "sf project deploy start" for examples of deploying smaller sets of metadata which you can also use to validate.
|
|
6536
6552
|
|
|
6537
|
-
Validate the deployment of all source files in
|
|
6553
|
+
Validate the deployment of all source files in the "force-app" directory to the default org:
|
|
6554
|
+
|
|
6555
|
+
$ sf project deploy validate --source-dir force-app
|
|
6538
6556
|
|
|
6539
|
-
|
|
6557
|
+
Validate the deployment of all source files in two directories: "force-app" and "force-app-utils":
|
|
6558
|
+
|
|
6559
|
+
$ sf project deploy validate --source-dir force-app --source-dir force-app-utils
|
|
6540
6560
|
|
|
6541
6561
|
Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately
|
|
6542
6562
|
returns the job ID:
|
|
6543
6563
|
|
|
6544
|
-
$ sf project deploy validate --source-dir
|
|
6564
|
+
$ sf project deploy validate --source-dir force-app --async --test-level RunAllTestsInOrg --target-org \
|
|
6545
6565
|
my-prod-org
|
|
6546
6566
|
|
|
6547
6567
|
Validate the deployment of all components listed in a manifest:
|
|
@@ -6563,8 +6583,13 @@ FLAG DESCRIPTIONS
|
|
|
6563
6583
|
|
|
6564
6584
|
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
6565
6585
|
|
|
6566
|
-
If
|
|
6567
|
-
flag
|
|
6586
|
+
If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't
|
|
6587
|
+
specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an
|
|
6588
|
+
error.
|
|
6589
|
+
|
|
6590
|
+
This flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a
|
|
6591
|
+
component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a
|
|
6592
|
+
success value of true, specify this flag.
|
|
6568
6593
|
|
|
6569
6594
|
-l, --test-level=RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests Deployment Apex testing level.
|
|
6570
6595
|
|
|
@@ -6633,7 +6658,7 @@ ERROR CODES
|
|
|
6633
6658
|
Canceling (69) The deploy is being canceled.
|
|
6634
6659
|
```
|
|
6635
6660
|
|
|
6636
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6661
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/deploy/validate.ts)_
|
|
6637
6662
|
|
|
6638
6663
|
## `sf project generate`
|
|
6639
6664
|
|
|
@@ -6737,7 +6762,7 @@ FLAG DESCRIPTIONS
|
|
|
6737
6762
|
Override the api version used for api requests made by this command
|
|
6738
6763
|
```
|
|
6739
6764
|
|
|
6740
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
6765
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/project/generate.ts)_
|
|
6741
6766
|
|
|
6742
6767
|
## `sf project generate manifest`
|
|
6743
6768
|
|
|
@@ -6812,7 +6837,7 @@ EXAMPLES
|
|
|
6812
6837
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
6813
6838
|
```
|
|
6814
6839
|
|
|
6815
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6840
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/generate/manifest.ts)_
|
|
6816
6841
|
|
|
6817
6842
|
## `sf project list ignored`
|
|
6818
6843
|
|
|
@@ -6853,7 +6878,7 @@ EXAMPLES
|
|
|
6853
6878
|
$ sf project list ignored --source-dir package.xml
|
|
6854
6879
|
```
|
|
6855
6880
|
|
|
6856
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6881
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/list/ignored.ts)_
|
|
6857
6882
|
|
|
6858
6883
|
## `sf project reset tracking`
|
|
6859
6884
|
|
|
@@ -6901,7 +6926,7 @@ EXAMPLES
|
|
|
6901
6926
|
$ sf project reset tracking --revision 30
|
|
6902
6927
|
```
|
|
6903
6928
|
|
|
6904
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6929
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/reset/tracking.ts)_
|
|
6905
6930
|
|
|
6906
6931
|
## `sf project retrieve preview`
|
|
6907
6932
|
|
|
@@ -6957,7 +6982,7 @@ FLAG DESCRIPTIONS
|
|
|
6957
6982
|
Overrides your default org.
|
|
6958
6983
|
```
|
|
6959
6984
|
|
|
6960
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
6985
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/retrieve/preview.ts)_
|
|
6961
6986
|
|
|
6962
6987
|
## `sf project retrieve start`
|
|
6963
6988
|
|
|
@@ -6973,8 +6998,8 @@ FLAGS
|
|
|
6973
6998
|
-c, --ignore-conflicts Ignore conflicts and retrieve and save files to your local filesystem, even if they
|
|
6974
6999
|
overwrite your local changes.
|
|
6975
7000
|
-d, --source-dir=<value>... File paths for source to retrieve from the org.
|
|
6976
|
-
-m, --metadata=<value>... Metadata component names to retrieve. Wildcards (
|
|
6977
|
-
quotes, such as `ApexClass:MyClass
|
|
7001
|
+
-m, --metadata=<value>... Metadata component names to retrieve. Wildcards (`*`) supported as long as you use
|
|
7002
|
+
quotes, such as `ApexClass:MyClass*`.
|
|
6978
7003
|
-n, --package-name=<value>... Package names to retrieve.
|
|
6979
7004
|
-o, --target-org=<value> (required) Login username or alias for the target org.
|
|
6980
7005
|
-r, --output-dir=<value> Directory root for the retrieved source files.
|
|
@@ -7000,7 +7025,7 @@ DESCRIPTION
|
|
|
7000
7025
|
--target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.
|
|
7001
7026
|
|
|
7002
7027
|
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
|
|
7003
|
-
|
|
7028
|
+
orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
|
|
7004
7029
|
source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create
|
|
7005
7030
|
scratch|sandbox" commands.
|
|
7006
7031
|
|
|
@@ -7012,33 +7037,37 @@ ALIASES
|
|
|
7012
7037
|
$ sf retrieve metadata
|
|
7013
7038
|
|
|
7014
7039
|
EXAMPLES
|
|
7015
|
-
Retrieve remote changes from your default org:
|
|
7040
|
+
Retrieve all remote changes from your default org:
|
|
7016
7041
|
|
|
7017
7042
|
$ sf project retrieve start
|
|
7018
7043
|
|
|
7019
|
-
Retrieve the source files in
|
|
7044
|
+
Retrieve the source files in the "force-app" directory from an org with alias "my-scratch":
|
|
7020
7045
|
|
|
7021
|
-
$ sf project retrieve start --source-dir
|
|
7046
|
+
$ sf project retrieve start --source-dir force-app --target-org my-scratch
|
|
7022
7047
|
|
|
7023
|
-
Retrieve
|
|
7048
|
+
Retrieve all the Apex classes and custom objects whose source is in the "force-app" directory. The list views,
|
|
7049
|
+
layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:
|
|
7024
7050
|
|
|
7025
|
-
$ sf project retrieve start --source-dir
|
|
7026
|
-
$ sf project retrieve start --source-dir
|
|
7051
|
+
$ sf project retrieve start --source-dir force-app/main/default/classes force-app/main/default/objects
|
|
7052
|
+
$ sf project retrieve start --source-dir force-app/main/default/classes --source-dir \
|
|
7053
|
+
force-app/main/default/objects
|
|
7027
7054
|
|
|
7028
|
-
Retrieve all Apex classes:
|
|
7055
|
+
Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
|
|
7029
7056
|
|
|
7030
7057
|
$ sf project retrieve start --metadata ApexClass
|
|
7031
7058
|
|
|
7032
|
-
Retrieve a specific Apex class
|
|
7059
|
+
Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag,
|
|
7060
|
+
because it will overwrite the Apex class source files in your local project if there are conflicts!):
|
|
7033
7061
|
|
|
7034
|
-
$ sf project retrieve start --metadata ApexClass:MyApexClass
|
|
7062
|
+
$ sf project retrieve start --metadata ApexClass:MyApexClass --ignore-conflicts
|
|
7035
7063
|
|
|
7036
7064
|
Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the
|
|
7037
7065
|
string "MyApex":
|
|
7038
7066
|
|
|
7039
7067
|
$ sf project retrieve start --metadata 'ApexClass:MyApex*'
|
|
7040
7068
|
|
|
7041
|
-
Retrieve all custom objects and Apex classes (both examples are
|
|
7069
|
+
Retrieve all custom objects and Apex classes found in all defined package directories (both examples are
|
|
7070
|
+
equivalent):
|
|
7042
7071
|
|
|
7043
7072
|
$ sf project retrieve start --metadata CustomObject ApexClass
|
|
7044
7073
|
$ sf project retrieve start --metadata CustomObject --metadata ApexClass
|
|
@@ -7111,7 +7140,7 @@ ENVIRONMENT VARIABLES
|
|
|
7111
7140
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
7112
7141
|
```
|
|
7113
7142
|
|
|
7114
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.
|
|
7143
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.27/src/commands/project/retrieve/start.ts)_
|
|
7115
7144
|
|
|
7116
7145
|
## `sf schema generate field`
|
|
7117
7146
|
|
|
@@ -7308,7 +7337,7 @@ DESCRIPTION
|
|
|
7308
7337
|
Once you select a command, hit enter and it will show the help for that command.
|
|
7309
7338
|
```
|
|
7310
7339
|
|
|
7311
|
-
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.0.
|
|
7340
|
+
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.0.19/src/commands/search.ts)_
|
|
7312
7341
|
|
|
7313
7342
|
## `sf sobject describe`
|
|
7314
7343
|
|
|
@@ -7452,7 +7481,7 @@ FLAG DESCRIPTIONS
|
|
|
7452
7481
|
etc.
|
|
7453
7482
|
```
|
|
7454
7483
|
|
|
7455
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
7484
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/static-resource/generate.ts)_
|
|
7456
7485
|
|
|
7457
7486
|
## `sf update [CHANNEL]`
|
|
7458
7487
|
|
|
@@ -7489,7 +7518,7 @@ EXAMPLES
|
|
|
7489
7518
|
$ sf update --available
|
|
7490
7519
|
```
|
|
7491
7520
|
|
|
7492
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.1.
|
|
7521
|
+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.1.16/src/commands/update.ts)_
|
|
7493
7522
|
|
|
7494
7523
|
## `sf version`
|
|
7495
7524
|
|
|
@@ -7564,7 +7593,7 @@ FLAG DESCRIPTIONS
|
|
|
7564
7593
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
7565
7594
|
```
|
|
7566
7595
|
|
|
7567
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
7596
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/visualforce/generate/component.ts)_
|
|
7568
7597
|
|
|
7569
7598
|
## `sf visualforce generate page`
|
|
7570
7599
|
|
|
@@ -7612,7 +7641,7 @@ FLAG DESCRIPTIONS
|
|
|
7612
7641
|
The name can be up to 40 characters and must start with a letter.
|
|
7613
7642
|
```
|
|
7614
7643
|
|
|
7615
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
7644
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.21/src/commands/visualforce/generate/page.ts)_
|
|
7616
7645
|
|
|
7617
7646
|
## `sf which`
|
|
7618
7647
|
|