@salesforce/cli 2.17.10 → 2.18.1
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 +77 -69
- package/npm-shrinkwrap.json +441 -485
- package/oclif.manifest.json +1 -1
- package/package.json +13 -13
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.18.1 linux-x64 node-v20.9.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -193,7 +193,7 @@ EXAMPLES
|
|
|
193
193
|
$ sf alias list
|
|
194
194
|
```
|
|
195
195
|
|
|
196
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
196
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.3/src/commands/alias/list.ts)_
|
|
197
197
|
|
|
198
198
|
## `sf alias set`
|
|
199
199
|
|
|
@@ -241,7 +241,7 @@ EXAMPLES
|
|
|
241
241
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
242
242
|
```
|
|
243
243
|
|
|
244
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
244
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.3/src/commands/alias/set.ts)_
|
|
245
245
|
|
|
246
246
|
## `sf alias unset`
|
|
247
247
|
|
|
@@ -280,7 +280,7 @@ EXAMPLES
|
|
|
280
280
|
$ sf alias unset --all [--no-prompt]
|
|
281
281
|
```
|
|
282
282
|
|
|
283
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
283
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.3/src/commands/alias/unset.ts)_
|
|
284
284
|
|
|
285
285
|
## `sf analytics generate template`
|
|
286
286
|
|
|
@@ -497,7 +497,7 @@ FLAG DESCRIPTIONS
|
|
|
497
497
|
directory.
|
|
498
498
|
```
|
|
499
499
|
|
|
500
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/
|
|
500
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.1/src/commands/apex/get/log.ts)_
|
|
501
501
|
|
|
502
502
|
## `sf apex get test`
|
|
503
503
|
|
|
@@ -549,7 +549,7 @@ EXAMPLES
|
|
|
549
549
|
me@myorg',
|
|
550
550
|
```
|
|
551
551
|
|
|
552
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/
|
|
552
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.1/src/commands/apex/get/test.ts)_
|
|
553
553
|
|
|
554
554
|
## `sf apex list log`
|
|
555
555
|
|
|
@@ -587,7 +587,7 @@ EXAMPLES
|
|
|
587
587
|
$ sf apex list log --target-org me@my.org
|
|
588
588
|
```
|
|
589
589
|
|
|
590
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/
|
|
590
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.1/src/commands/apex/list/log.ts)_
|
|
591
591
|
|
|
592
592
|
## `sf apex run`
|
|
593
593
|
|
|
@@ -632,7 +632,7 @@ EXAMPLES
|
|
|
632
632
|
$ sf apex run
|
|
633
633
|
```
|
|
634
634
|
|
|
635
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/
|
|
635
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.1/src/commands/apex/run.ts)_
|
|
636
636
|
|
|
637
637
|
## `sf apex run test`
|
|
638
638
|
|
|
@@ -738,7 +738,7 @@ FLAG DESCRIPTIONS
|
|
|
738
738
|
--tests Test1 --tests Test2
|
|
739
739
|
```
|
|
740
740
|
|
|
741
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/
|
|
741
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.1/src/commands/apex/run/test.ts)_
|
|
742
742
|
|
|
743
743
|
## `sf apex tail log`
|
|
744
744
|
|
|
@@ -780,7 +780,7 @@ EXAMPLES
|
|
|
780
780
|
$ sf apex tail log --color --skip-trace-flag
|
|
781
781
|
```
|
|
782
782
|
|
|
783
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/
|
|
783
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.1/src/commands/apex/tail/log.ts)_
|
|
784
784
|
|
|
785
785
|
## `sf autocomplete [SHELL]`
|
|
786
786
|
|
|
@@ -890,7 +890,7 @@ CONFIGURATION VARIABLES
|
|
|
890
890
|
org-max-query-limit Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
|
|
891
891
|
```
|
|
892
892
|
|
|
893
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
893
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.3/src/commands/config/get.ts)_
|
|
894
894
|
|
|
895
895
|
## `sf config list`
|
|
896
896
|
|
|
@@ -929,7 +929,7 @@ EXAMPLES
|
|
|
929
929
|
$ sf config list
|
|
930
930
|
```
|
|
931
931
|
|
|
932
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
932
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.3/src/commands/config/list.ts)_
|
|
933
933
|
|
|
934
934
|
## `sf config set`
|
|
935
935
|
|
|
@@ -996,7 +996,7 @@ CONFIGURATION VARIABLES
|
|
|
996
996
|
org-max-query-limit Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
|
|
997
997
|
```
|
|
998
998
|
|
|
999
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
999
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.3/src/commands/config/set.ts)_
|
|
1000
1000
|
|
|
1001
1001
|
## `sf config unset`
|
|
1002
1002
|
|
|
@@ -1044,7 +1044,7 @@ CONFIGURATION VARIABLES
|
|
|
1044
1044
|
org-max-query-limit Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
|
|
1045
1045
|
```
|
|
1046
1046
|
|
|
1047
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
1047
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.3/src/commands/config/unset.ts)_
|
|
1048
1048
|
|
|
1049
1049
|
## `sf data create record`
|
|
1050
1050
|
|
|
@@ -2347,7 +2347,7 @@ FLAG DESCRIPTIONS
|
|
|
2347
2347
|
for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
|
|
2348
2348
|
```
|
|
2349
2349
|
|
|
2350
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
2350
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/force/org/clone.ts)_
|
|
2351
2351
|
|
|
2352
2352
|
## `sf force org create`
|
|
2353
2353
|
|
|
@@ -2395,7 +2395,7 @@ EXAMPLES
|
|
|
2395
2395
|
$ sf force org create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
|
|
2396
2396
|
```
|
|
2397
2397
|
|
|
2398
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
2398
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/force/org/create.ts)_
|
|
2399
2399
|
|
|
2400
2400
|
## `sf force org delete`
|
|
2401
2401
|
|
|
@@ -2427,7 +2427,7 @@ EXAMPLES
|
|
|
2427
2427
|
$ sf force org delete -u MyOrgAlias -p
|
|
2428
2428
|
```
|
|
2429
2429
|
|
|
2430
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
2430
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/force/org/delete.ts)_
|
|
2431
2431
|
|
|
2432
2432
|
## `sf force org status`
|
|
2433
2433
|
|
|
@@ -2465,7 +2465,7 @@ EXAMPLES
|
|
|
2465
2465
|
$ sf force org status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
|
|
2466
2466
|
```
|
|
2467
2467
|
|
|
2468
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
2468
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/force/org/status.ts)_
|
|
2469
2469
|
|
|
2470
2470
|
## `sf force source deploy`
|
|
2471
2471
|
|
|
@@ -3147,7 +3147,7 @@ EXAMPLES
|
|
|
3147
3147
|
user3@my.org
|
|
3148
3148
|
```
|
|
3149
3149
|
|
|
3150
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/
|
|
3150
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.1/src/commands/force/user/password/generate.ts)_
|
|
3151
3151
|
|
|
3152
3152
|
## `sf help [COMMANDS]`
|
|
3153
3153
|
|
|
@@ -3586,7 +3586,7 @@ EXAMPLES
|
|
|
3586
3586
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
3587
3587
|
```
|
|
3588
3588
|
|
|
3589
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/
|
|
3589
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.1/src/commands/org/assign/permset.ts)_
|
|
3590
3590
|
|
|
3591
3591
|
## `sf org assign permsetlicense`
|
|
3592
3592
|
|
|
@@ -3630,7 +3630,7 @@ EXAMPLES
|
|
|
3630
3630
|
user3
|
|
3631
3631
|
```
|
|
3632
3632
|
|
|
3633
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/
|
|
3633
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.1/src/commands/org/assign/permsetlicense.ts)_
|
|
3634
3634
|
|
|
3635
3635
|
## `sf org create sandbox`
|
|
3636
3636
|
|
|
@@ -3735,7 +3735,7 @@ FLAG DESCRIPTIONS
|
|
|
3735
3735
|
sandbox.
|
|
3736
3736
|
```
|
|
3737
3737
|
|
|
3738
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
3738
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/create/sandbox.ts)_
|
|
3739
3739
|
|
|
3740
3740
|
## `sf org create scratch`
|
|
3741
3741
|
|
|
@@ -3888,7 +3888,7 @@ FLAG DESCRIPTIONS
|
|
|
3888
3888
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
3889
3889
|
```
|
|
3890
3890
|
|
|
3891
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
3891
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/create/scratch.ts)_
|
|
3892
3892
|
|
|
3893
3893
|
## `sf org create user`
|
|
3894
3894
|
|
|
@@ -3986,7 +3986,7 @@ FLAG DESCRIPTIONS
|
|
|
3986
3986
|
might be different than what you specify in the definition file.
|
|
3987
3987
|
```
|
|
3988
3988
|
|
|
3989
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/
|
|
3989
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.1/src/commands/org/create/user.ts)_
|
|
3990
3990
|
|
|
3991
3991
|
## `sf org delete sandbox`
|
|
3992
3992
|
|
|
@@ -4010,6 +4010,8 @@ DESCRIPTION
|
|
|
4010
4010
|
all local references to the org from your computer.
|
|
4011
4011
|
Specify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when
|
|
4012
4012
|
you created it. Run "sf org list" to view all your orgs, including sandboxes, and their aliases.
|
|
4013
|
+
Both the sandbox and the associated production org must already be authenticated with the CLI to successfully delete
|
|
4014
|
+
the sandbox.
|
|
4013
4015
|
|
|
4014
4016
|
ALIASES
|
|
4015
4017
|
$ sf env delete sandbox
|
|
@@ -4023,12 +4025,12 @@ EXAMPLES
|
|
|
4023
4025
|
|
|
4024
4026
|
$ sf org delete sandbox --target-org myusername@example.com.qa
|
|
4025
4027
|
|
|
4026
|
-
Delete the sandbox without prompting to confirm
|
|
4028
|
+
Delete the sandbox without prompting to confirm:
|
|
4027
4029
|
|
|
4028
4030
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
4029
4031
|
```
|
|
4030
4032
|
|
|
4031
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
4033
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/delete/sandbox.ts)_
|
|
4032
4034
|
|
|
4033
4035
|
## `sf org delete scratch`
|
|
4034
4036
|
|
|
@@ -4070,7 +4072,7 @@ EXAMPLES
|
|
|
4070
4072
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
4071
4073
|
```
|
|
4072
4074
|
|
|
4073
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
4075
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/delete/scratch.ts)_
|
|
4074
4076
|
|
|
4075
4077
|
## `sf org display`
|
|
4076
4078
|
|
|
@@ -4113,7 +4115,7 @@ EXAMPLES
|
|
|
4113
4115
|
$ sf org display --target-org TestOrg1 --verbose
|
|
4114
4116
|
```
|
|
4115
4117
|
|
|
4116
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
4118
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/display.ts)_
|
|
4117
4119
|
|
|
4118
4120
|
## `sf org display user`
|
|
4119
4121
|
|
|
@@ -4150,7 +4152,7 @@ EXAMPLES
|
|
|
4150
4152
|
$ sf org display user --target-org me@my.org --json
|
|
4151
4153
|
```
|
|
4152
4154
|
|
|
4153
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/
|
|
4155
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.1/src/commands/org/display/user.ts)_
|
|
4154
4156
|
|
|
4155
4157
|
## `sf org generate password`
|
|
4156
4158
|
|
|
@@ -4214,7 +4216,7 @@ EXAMPLES
|
|
|
4214
4216
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
4215
4217
|
```
|
|
4216
4218
|
|
|
4217
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/
|
|
4219
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.1/src/commands/org/generate/password.ts)_
|
|
4218
4220
|
|
|
4219
4221
|
## `sf org list`
|
|
4220
4222
|
|
|
@@ -4252,7 +4254,7 @@ EXAMPLES
|
|
|
4252
4254
|
$ sf org list --clean
|
|
4253
4255
|
```
|
|
4254
4256
|
|
|
4255
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
4257
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/list.ts)_
|
|
4256
4258
|
|
|
4257
4259
|
## `sf org list auth`
|
|
4258
4260
|
|
|
@@ -4283,7 +4285,7 @@ EXAMPLES
|
|
|
4283
4285
|
$ sf org list auth
|
|
4284
4286
|
```
|
|
4285
4287
|
|
|
4286
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/
|
|
4288
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.1/src/commands/org/list/auth.ts)_
|
|
4287
4289
|
|
|
4288
4290
|
## `sf org list limits`
|
|
4289
4291
|
|
|
@@ -4385,7 +4387,7 @@ FLAG DESCRIPTIONS
|
|
|
4385
4387
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
4386
4388
|
```
|
|
4387
4389
|
|
|
4388
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
4390
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/list/metadata.ts)_
|
|
4389
4391
|
|
|
4390
4392
|
## `sf org list metadata-types`
|
|
4391
4393
|
|
|
@@ -4438,7 +4440,7 @@ FLAG DESCRIPTIONS
|
|
|
4438
4440
|
Override the api version used for api requests made by this command
|
|
4439
4441
|
```
|
|
4440
4442
|
|
|
4441
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
4443
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/list/metadata-types.ts)_
|
|
4442
4444
|
|
|
4443
4445
|
## `sf org list sobject record-counts`
|
|
4444
4446
|
|
|
@@ -4518,7 +4520,7 @@ EXAMPLES
|
|
|
4518
4520
|
$ sf org list users --target-org me@my.org
|
|
4519
4521
|
```
|
|
4520
4522
|
|
|
4521
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/
|
|
4523
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.1/src/commands/org/list/users.ts)_
|
|
4522
4524
|
|
|
4523
4525
|
## `sf org login access-token`
|
|
4524
4526
|
|
|
@@ -4571,7 +4573,7 @@ FLAG DESCRIPTIONS
|
|
|
4571
4573
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4572
4574
|
```
|
|
4573
4575
|
|
|
4574
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/
|
|
4576
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.1/src/commands/org/login/access-token.ts)_
|
|
4575
4577
|
|
|
4576
4578
|
## `sf org login device`
|
|
4577
4579
|
|
|
@@ -4630,7 +4632,7 @@ FLAG DESCRIPTIONS
|
|
|
4630
4632
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4631
4633
|
```
|
|
4632
4634
|
|
|
4633
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/
|
|
4635
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.1/src/commands/org/login/device.ts)_
|
|
4634
4636
|
|
|
4635
4637
|
## `sf org login jwt`
|
|
4636
4638
|
|
|
@@ -4719,7 +4721,7 @@ FLAG DESCRIPTIONS
|
|
|
4719
4721
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4720
4722
|
```
|
|
4721
4723
|
|
|
4722
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/
|
|
4724
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.1/src/commands/org/login/jwt.ts)_
|
|
4723
4725
|
|
|
4724
4726
|
## `sf org login sfdx-url`
|
|
4725
4727
|
|
|
@@ -4777,7 +4779,7 @@ EXAMPLES
|
|
|
4777
4779
|
$ sf org login sfdx-url --sfdx-url-file files/authFile.json --set-default --alias MyDefaultOrg
|
|
4778
4780
|
```
|
|
4779
4781
|
|
|
4780
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/
|
|
4782
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.1/src/commands/org/login/sfdx-url.ts)_
|
|
4781
4783
|
|
|
4782
4784
|
## `sf org login web`
|
|
4783
4785
|
|
|
@@ -4862,7 +4864,7 @@ FLAG DESCRIPTIONS
|
|
|
4862
4864
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4863
4865
|
```
|
|
4864
4866
|
|
|
4865
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/
|
|
4867
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.1/src/commands/org/login/web.ts)_
|
|
4866
4868
|
|
|
4867
4869
|
## `sf org logout`
|
|
4868
4870
|
|
|
@@ -4922,7 +4924,7 @@ FLAG DESCRIPTIONS
|
|
|
4922
4924
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
4923
4925
|
```
|
|
4924
4926
|
|
|
4925
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/
|
|
4927
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.1/src/commands/org/logout.ts)_
|
|
4926
4928
|
|
|
4927
4929
|
## `sf org open`
|
|
4928
4930
|
|
|
@@ -4987,7 +4989,7 @@ EXAMPLES
|
|
|
4987
4989
|
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
4988
4990
|
```
|
|
4989
4991
|
|
|
4990
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
4992
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/open.ts)_
|
|
4991
4993
|
|
|
4992
4994
|
## `sf org resume sandbox`
|
|
4993
4995
|
|
|
@@ -5049,7 +5051,7 @@ FLAG DESCRIPTIONS
|
|
|
5049
5051
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
5050
5052
|
```
|
|
5051
5053
|
|
|
5052
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
5054
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/resume/sandbox.ts)_
|
|
5053
5055
|
|
|
5054
5056
|
## `sf org resume scratch`
|
|
5055
5057
|
|
|
@@ -5095,7 +5097,7 @@ FLAG DESCRIPTIONS
|
|
|
5095
5097
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
5096
5098
|
```
|
|
5097
5099
|
|
|
5098
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/
|
|
5100
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/resume/scratch.ts)_
|
|
5099
5101
|
|
|
5100
5102
|
## `sf plugins`
|
|
5101
5103
|
|
|
@@ -5118,7 +5120,7 @@ EXAMPLES
|
|
|
5118
5120
|
$ sf plugins
|
|
5119
5121
|
```
|
|
5120
5122
|
|
|
5121
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5123
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.2/src/commands/plugins/index.ts)_
|
|
5122
5124
|
|
|
5123
5125
|
## `sf plugins discover`
|
|
5124
5126
|
|
|
@@ -5162,7 +5164,7 @@ EXAMPLES
|
|
|
5162
5164
|
$ sf plugins:inspect myplugin
|
|
5163
5165
|
```
|
|
5164
5166
|
|
|
5165
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5167
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.2/src/commands/plugins/inspect.ts)_
|
|
5166
5168
|
|
|
5167
5169
|
## `sf plugins:install PLUGIN...`
|
|
5168
5170
|
|
|
@@ -5203,7 +5205,7 @@ EXAMPLES
|
|
|
5203
5205
|
$ sf plugins:install someuser/someplugin
|
|
5204
5206
|
```
|
|
5205
5207
|
|
|
5206
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5208
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.2/src/commands/plugins/install.ts)_
|
|
5207
5209
|
|
|
5208
5210
|
## `sf plugins:link PLUGIN`
|
|
5209
5211
|
|
|
@@ -5233,7 +5235,7 @@ EXAMPLES
|
|
|
5233
5235
|
$ sf plugins:link myplugin
|
|
5234
5236
|
```
|
|
5235
5237
|
|
|
5236
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5238
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.2/src/commands/plugins/link.ts)_
|
|
5237
5239
|
|
|
5238
5240
|
## `sf plugins reset`
|
|
5239
5241
|
|
|
@@ -5244,7 +5246,7 @@ USAGE
|
|
|
5244
5246
|
$ sf plugins reset
|
|
5245
5247
|
```
|
|
5246
5248
|
|
|
5247
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5249
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.2/src/commands/plugins/reset.ts)_
|
|
5248
5250
|
|
|
5249
5251
|
## `sf plugins trust verify`
|
|
5250
5252
|
|
|
@@ -5297,7 +5299,7 @@ ALIASES
|
|
|
5297
5299
|
$ sf plugins remove
|
|
5298
5300
|
```
|
|
5299
5301
|
|
|
5300
|
-
_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.1.2/src/commands/plugins/uninstall.ts)_
|
|
5301
5303
|
|
|
5302
5304
|
## `sf plugins update`
|
|
5303
5305
|
|
|
@@ -5315,7 +5317,7 @@ DESCRIPTION
|
|
|
5315
5317
|
Update installed plugins.
|
|
5316
5318
|
```
|
|
5317
5319
|
|
|
5318
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5320
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.2/src/commands/plugins/update.ts)_
|
|
5319
5321
|
|
|
5320
5322
|
## `sf project convert mdapi`
|
|
5321
5323
|
|
|
@@ -5377,7 +5379,7 @@ FLAG DESCRIPTIONS
|
|
|
5377
5379
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5378
5380
|
```
|
|
5379
5381
|
|
|
5380
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
5382
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/convert/mdapi.ts)_
|
|
5381
5383
|
|
|
5382
5384
|
## `sf project convert source`
|
|
5383
5385
|
|
|
@@ -5389,7 +5391,7 @@ USAGE
|
|
|
5389
5391
|
<value> | -m <value>]
|
|
5390
5392
|
|
|
5391
5393
|
FLAGS
|
|
5392
|
-
-d, --output-dir=<value> [default:
|
|
5394
|
+
-d, --output-dir=<value> [default: metadataPackage_1699478462777] Output directory to store the Metadata
|
|
5393
5395
|
API–formatted files in.
|
|
5394
5396
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
5395
5397
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -5449,7 +5451,7 @@ FLAG DESCRIPTIONS
|
|
|
5449
5451
|
Override the api version used for api requests made by this command
|
|
5450
5452
|
```
|
|
5451
5453
|
|
|
5452
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
5454
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/convert/source.ts)_
|
|
5453
5455
|
|
|
5454
5456
|
## `sf project delete source`
|
|
5455
5457
|
|
|
@@ -5587,7 +5589,7 @@ FLAG DESCRIPTIONS
|
|
|
5587
5589
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
5588
5590
|
```
|
|
5589
5591
|
|
|
5590
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
5592
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/delete/source.ts)_
|
|
5591
5593
|
|
|
5592
5594
|
## `sf project delete tracking`
|
|
5593
5595
|
|
|
@@ -5622,7 +5624,7 @@ EXAMPLES
|
|
|
5622
5624
|
$ sf project delete tracking --target-org my-scratch
|
|
5623
5625
|
```
|
|
5624
5626
|
|
|
5625
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
5627
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/delete/tracking.ts)_
|
|
5626
5628
|
|
|
5627
5629
|
## `sf project deploy cancel`
|
|
5628
5630
|
|
|
@@ -5692,7 +5694,7 @@ FLAG DESCRIPTIONS
|
|
|
5692
5694
|
project deploy report".
|
|
5693
5695
|
```
|
|
5694
5696
|
|
|
5695
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
5697
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/deploy/cancel.ts)_
|
|
5696
5698
|
|
|
5697
5699
|
## `sf project deploy preview`
|
|
5698
5700
|
|
|
@@ -5775,7 +5777,7 @@ FLAG DESCRIPTIONS
|
|
|
5775
5777
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
5776
5778
|
```
|
|
5777
5779
|
|
|
5778
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
5780
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/deploy/preview.ts)_
|
|
5779
5781
|
|
|
5780
5782
|
## `sf project deploy quick`
|
|
5781
5783
|
|
|
@@ -5868,7 +5870,7 @@ ERROR CODES
|
|
|
5868
5870
|
Canceling (69) The deploy is being canceled.
|
|
5869
5871
|
```
|
|
5870
5872
|
|
|
5871
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
5873
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/deploy/quick.ts)_
|
|
5872
5874
|
|
|
5873
5875
|
## `sf project deploy report`
|
|
5874
5876
|
|
|
@@ -5963,7 +5965,7 @@ FLAG DESCRIPTIONS
|
|
|
5963
5965
|
--coverage-formatters lcov --coverage-formatters clover
|
|
5964
5966
|
```
|
|
5965
5967
|
|
|
5966
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
5968
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/deploy/report.ts)_
|
|
5967
5969
|
|
|
5968
5970
|
## `sf project deploy resume`
|
|
5969
5971
|
|
|
@@ -6059,7 +6061,7 @@ ERROR CODES
|
|
|
6059
6061
|
Canceling (69) The deploy is being canceled.
|
|
6060
6062
|
```
|
|
6061
6063
|
|
|
6062
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
6064
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/deploy/resume.ts)_
|
|
6063
6065
|
|
|
6064
6066
|
## `sf project deploy start`
|
|
6065
6067
|
|
|
@@ -6287,7 +6289,7 @@ ERROR CODES
|
|
|
6287
6289
|
Canceling (69) The deploy is being canceled.
|
|
6288
6290
|
```
|
|
6289
6291
|
|
|
6290
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
6292
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/deploy/start.ts)_
|
|
6291
6293
|
|
|
6292
6294
|
## `sf project deploy validate`
|
|
6293
6295
|
|
|
@@ -6297,12 +6299,13 @@ Validate a metadata deployment without actually executing it.
|
|
|
6297
6299
|
USAGE
|
|
6298
6300
|
$ sf project deploy validate -o <value> [--json] [-a <value>] [--async] [--concise | --verbose] [-m <value>] [-d <value>]
|
|
6299
6301
|
[--single-package --metadata-dir <value>] [-t <value> -l RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w
|
|
6300
|
-
<value>] [--coverage-formatters
|
|
6302
|
+
<value>] [-g] [--coverage-formatters
|
|
6301
6303
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir
|
|
6302
6304
|
<value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6303
6305
|
|
|
6304
6306
|
FLAGS
|
|
6305
6307
|
-a, --api-version=<value> Target API version for the validation.
|
|
6308
|
+
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
6306
6309
|
-o, --target-org=<value> (required) Login username or alias for the target org.
|
|
6307
6310
|
-w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
6308
6311
|
display results.
|
|
@@ -6392,6 +6395,11 @@ FLAG DESCRIPTIONS
|
|
|
6392
6395
|
|
|
6393
6396
|
If you specify this flag, don’t specify --metadata or --manifest.
|
|
6394
6397
|
|
|
6398
|
+
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
6399
|
+
|
|
6400
|
+
If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this
|
|
6401
|
+
flag is set to false, success is set to false, and the warning is treated like an error.
|
|
6402
|
+
|
|
6395
6403
|
-l, --test-level=RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests Deployment Apex testing level.
|
|
6396
6404
|
|
|
6397
6405
|
Valid values are:
|
|
@@ -6459,7 +6467,7 @@ ERROR CODES
|
|
|
6459
6467
|
Canceling (69) The deploy is being canceled.
|
|
6460
6468
|
```
|
|
6461
6469
|
|
|
6462
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
6470
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/deploy/validate.ts)_
|
|
6463
6471
|
|
|
6464
6472
|
## `sf project generate`
|
|
6465
6473
|
|
|
@@ -6638,7 +6646,7 @@ EXAMPLES
|
|
|
6638
6646
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
6639
6647
|
```
|
|
6640
6648
|
|
|
6641
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
6649
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/generate/manifest.ts)_
|
|
6642
6650
|
|
|
6643
6651
|
## `sf project list ignored`
|
|
6644
6652
|
|
|
@@ -6679,7 +6687,7 @@ EXAMPLES
|
|
|
6679
6687
|
$ sf project list ignored --source-dir package.xml
|
|
6680
6688
|
```
|
|
6681
6689
|
|
|
6682
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
6690
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/list/ignored.ts)_
|
|
6683
6691
|
|
|
6684
6692
|
## `sf project reset tracking`
|
|
6685
6693
|
|
|
@@ -6726,7 +6734,7 @@ EXAMPLES
|
|
|
6726
6734
|
$ sf project reset tracking --revision 30
|
|
6727
6735
|
```
|
|
6728
6736
|
|
|
6729
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
6737
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/reset/tracking.ts)_
|
|
6730
6738
|
|
|
6731
6739
|
## `sf project retrieve preview`
|
|
6732
6740
|
|
|
@@ -6781,7 +6789,7 @@ FLAG DESCRIPTIONS
|
|
|
6781
6789
|
Overrides your default org.
|
|
6782
6790
|
```
|
|
6783
6791
|
|
|
6784
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
6792
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/retrieve/preview.ts)_
|
|
6785
6793
|
|
|
6786
6794
|
## `sf project retrieve start`
|
|
6787
6795
|
|
|
@@ -6935,7 +6943,7 @@ ENVIRONMENT VARIABLES
|
|
|
6935
6943
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
6936
6944
|
```
|
|
6937
6945
|
|
|
6938
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.
|
|
6946
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.20.2/src/commands/project/retrieve/start.ts)_
|
|
6939
6947
|
|
|
6940
6948
|
## `sf schema generate field`
|
|
6941
6949
|
|