@salesforce/cli 2.35.5-qa.0 → 2.35.5
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 +435 -322
- package/npm-shrinkwrap.json +262 -546
- package/oclif.manifest.json +469 -275
- package/package.json +28 -28
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.35.5
|
|
27
|
+
@salesforce/cli/2.35.5 linux-x64 node-v20.11.1
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -182,10 +182,11 @@ List all aliases currently set on your local computer.
|
|
|
182
182
|
|
|
183
183
|
```
|
|
184
184
|
USAGE
|
|
185
|
-
$ sf alias list [--json]
|
|
185
|
+
$ sf alias list [--json] [--flags-dir <value>]
|
|
186
186
|
|
|
187
187
|
GLOBAL FLAGS
|
|
188
|
-
--
|
|
188
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
189
|
+
--json Format output as json.
|
|
189
190
|
|
|
190
191
|
DESCRIPTION
|
|
191
192
|
List all aliases currently set on your local computer.
|
|
@@ -201,7 +202,7 @@ EXAMPLES
|
|
|
201
202
|
$ sf alias list
|
|
202
203
|
```
|
|
203
204
|
|
|
204
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0
|
|
205
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.1.0/src/commands/alias/list.ts)_
|
|
205
206
|
|
|
206
207
|
## `sf alias set`
|
|
207
208
|
|
|
@@ -209,10 +210,11 @@ Set one or more aliases on your local computer.
|
|
|
209
210
|
|
|
210
211
|
```
|
|
211
212
|
USAGE
|
|
212
|
-
$ sf alias set [--json]
|
|
213
|
+
$ sf alias set [--json] [--flags-dir <value>]
|
|
213
214
|
|
|
214
215
|
GLOBAL FLAGS
|
|
215
|
-
--
|
|
216
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
217
|
+
--json Format output as json.
|
|
216
218
|
|
|
217
219
|
DESCRIPTION
|
|
218
220
|
Set one or more aliases on your local computer.
|
|
@@ -249,7 +251,7 @@ EXAMPLES
|
|
|
249
251
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
250
252
|
```
|
|
251
253
|
|
|
252
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0
|
|
254
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.1.0/src/commands/alias/set.ts)_
|
|
253
255
|
|
|
254
256
|
## `sf alias unset`
|
|
255
257
|
|
|
@@ -257,14 +259,15 @@ Unset one or more aliases that are currently set on your local computer.
|
|
|
257
259
|
|
|
258
260
|
```
|
|
259
261
|
USAGE
|
|
260
|
-
$ sf alias unset [--json] [-a] [-p]
|
|
262
|
+
$ sf alias unset [--json] [--flags-dir <value>] [-a] [-p]
|
|
261
263
|
|
|
262
264
|
FLAGS
|
|
263
265
|
-a, --all Unset all currently set aliases.
|
|
264
266
|
-p, --no-prompt Don't prompt the user for confirmation when unsetting all aliases.
|
|
265
267
|
|
|
266
268
|
GLOBAL FLAGS
|
|
267
|
-
--
|
|
269
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
270
|
+
--json Format output as json.
|
|
268
271
|
|
|
269
272
|
DESCRIPTION
|
|
270
273
|
Unset one or more aliases that are currently set on your local computer.
|
|
@@ -288,7 +291,7 @@ EXAMPLES
|
|
|
288
291
|
$ sf alias unset --all [--no-prompt]
|
|
289
292
|
```
|
|
290
293
|
|
|
291
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0
|
|
294
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.1.0/src/commands/alias/unset.ts)_
|
|
292
295
|
|
|
293
296
|
## `sf analytics generate template`
|
|
294
297
|
|
|
@@ -296,7 +299,7 @@ Generate a simple Analytics template.
|
|
|
296
299
|
|
|
297
300
|
```
|
|
298
301
|
USAGE
|
|
299
|
-
$ sf analytics generate template -n <value> [--json] [-d <value>] [--api-version <value>]
|
|
302
|
+
$ sf analytics generate template -n <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version <value>]
|
|
300
303
|
|
|
301
304
|
FLAGS
|
|
302
305
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -304,7 +307,8 @@ FLAGS
|
|
|
304
307
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
305
308
|
|
|
306
309
|
GLOBAL FLAGS
|
|
307
|
-
--
|
|
310
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
311
|
+
--json Format output as json.
|
|
308
312
|
|
|
309
313
|
DESCRIPTION
|
|
310
314
|
Generate a simple Analytics template.
|
|
@@ -329,7 +333,7 @@ FLAG DESCRIPTIONS
|
|
|
329
333
|
directory.
|
|
330
334
|
```
|
|
331
335
|
|
|
332
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
336
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/analytics/generate/template.ts)_
|
|
333
337
|
|
|
334
338
|
## `sf apex generate class`
|
|
335
339
|
|
|
@@ -337,8 +341,8 @@ Generate an Apex class.
|
|
|
337
341
|
|
|
338
342
|
```
|
|
339
343
|
USAGE
|
|
340
|
-
$ sf apex generate class -n <value> [--json] [-
|
|
341
|
-
<value>] [--api-version <value>]
|
|
344
|
+
$ sf apex generate class -n <value> [--json] [--flags-dir <value>] [-t
|
|
345
|
+
ApexException|ApexUnitTest|DefaultApexClass|InboundEmailService] [-d <value>] [--api-version <value>]
|
|
342
346
|
|
|
343
347
|
FLAGS
|
|
344
348
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -348,7 +352,8 @@ FLAGS
|
|
|
348
352
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
349
353
|
|
|
350
354
|
GLOBAL FLAGS
|
|
351
|
-
--
|
|
355
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
356
|
+
--json Format output as json.
|
|
352
357
|
|
|
353
358
|
DESCRIPTION
|
|
354
359
|
Generate an Apex class.
|
|
@@ -385,7 +390,7 @@ FLAG DESCRIPTIONS
|
|
|
385
390
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
386
391
|
```
|
|
387
392
|
|
|
388
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
393
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/apex/generate/class.ts)_
|
|
389
394
|
|
|
390
395
|
## `sf apex generate trigger`
|
|
391
396
|
|
|
@@ -393,8 +398,9 @@ Generate an Apex trigger.
|
|
|
393
398
|
|
|
394
399
|
```
|
|
395
400
|
USAGE
|
|
396
|
-
$ sf apex generate trigger -n <value> [--json] [-
|
|
397
|
-
before insert|before update|before delete|after insert|after update|after delete|after
|
|
401
|
+
$ sf apex generate trigger -n <value> [--json] [--flags-dir <value>] [-t ApexTrigger] [-d <value>] [--api-version
|
|
402
|
+
<value>] [-s <value>] [-e before insert|before update|before delete|after insert|after update|after delete|after
|
|
403
|
+
undelete]
|
|
398
404
|
|
|
399
405
|
FLAGS
|
|
400
406
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -408,7 +414,8 @@ FLAGS
|
|
|
408
414
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
409
415
|
|
|
410
416
|
GLOBAL FLAGS
|
|
411
|
-
--
|
|
417
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
418
|
+
--json Format output as json.
|
|
412
419
|
|
|
413
420
|
DESCRIPTION
|
|
414
421
|
Generate an Apex trigger.
|
|
@@ -452,7 +459,7 @@ FLAG DESCRIPTIONS
|
|
|
452
459
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
453
460
|
```
|
|
454
461
|
|
|
455
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
462
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/apex/generate/trigger.ts)_
|
|
456
463
|
|
|
457
464
|
## `sf apex get log`
|
|
458
465
|
|
|
@@ -460,7 +467,8 @@ Fetch the specified log or given number of most recent logs from the org.
|
|
|
460
467
|
|
|
461
468
|
```
|
|
462
469
|
USAGE
|
|
463
|
-
$ sf apex get log -o <value> [--json] [--
|
|
470
|
+
$ sf apex get log -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-n <value>]
|
|
471
|
+
[-d <value>]
|
|
464
472
|
|
|
465
473
|
FLAGS
|
|
466
474
|
-d, --output-dir=<value> Directory for saving the log files.
|
|
@@ -471,7 +479,8 @@ FLAGS
|
|
|
471
479
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
472
480
|
|
|
473
481
|
GLOBAL FLAGS
|
|
474
|
-
--
|
|
482
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
483
|
+
--json Format output as json.
|
|
475
484
|
|
|
476
485
|
DESCRIPTION
|
|
477
486
|
Fetch the specified log or given number of most recent logs from the org.
|
|
@@ -506,7 +515,7 @@ FLAG DESCRIPTIONS
|
|
|
506
515
|
directory.
|
|
507
516
|
```
|
|
508
517
|
|
|
509
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0
|
|
518
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.0/src/commands/apex/get/log.ts)_
|
|
510
519
|
|
|
511
520
|
## `sf apex get test`
|
|
512
521
|
|
|
@@ -514,8 +523,8 @@ Display test results for a specific asynchronous test run.
|
|
|
514
523
|
|
|
515
524
|
```
|
|
516
525
|
USAGE
|
|
517
|
-
$ sf apex get test -o <value> -i <value> [--json] [--api-version <value>] [-c] [-d <value>]
|
|
518
|
-
human|tap|junit|json]
|
|
526
|
+
$ sf apex get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-c] [-d <value>]
|
|
527
|
+
[-r human|tap|junit|json]
|
|
519
528
|
|
|
520
529
|
FLAGS
|
|
521
530
|
-c, --code-coverage Retrieve code coverage results.
|
|
@@ -528,7 +537,8 @@ FLAGS
|
|
|
528
537
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
529
538
|
|
|
530
539
|
GLOBAL FLAGS
|
|
531
|
-
--
|
|
540
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
541
|
+
--json Format output as json.
|
|
532
542
|
|
|
533
543
|
DESCRIPTION
|
|
534
544
|
Display test results for a specific asynchronous test run.
|
|
@@ -559,7 +569,7 @@ EXAMPLES
|
|
|
559
569
|
me@myorg',
|
|
560
570
|
```
|
|
561
571
|
|
|
562
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0
|
|
572
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.0/src/commands/apex/get/test.ts)_
|
|
563
573
|
|
|
564
574
|
## `sf apex list log`
|
|
565
575
|
|
|
@@ -567,7 +577,7 @@ Display a list of IDs and general information about debug logs.
|
|
|
567
577
|
|
|
568
578
|
```
|
|
569
579
|
USAGE
|
|
570
|
-
$ sf apex list log -o <value> [--json] [--api-version <value>]
|
|
580
|
+
$ sf apex list log -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
571
581
|
|
|
572
582
|
FLAGS
|
|
573
583
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -575,7 +585,8 @@ FLAGS
|
|
|
575
585
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
576
586
|
|
|
577
587
|
GLOBAL FLAGS
|
|
578
|
-
--
|
|
588
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
589
|
+
--json Format output as json.
|
|
579
590
|
|
|
580
591
|
DESCRIPTION
|
|
581
592
|
Display a list of IDs and general information about debug logs.
|
|
@@ -598,7 +609,7 @@ EXAMPLES
|
|
|
598
609
|
$ sf apex list log --target-org me@my.org
|
|
599
610
|
```
|
|
600
611
|
|
|
601
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0
|
|
612
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.0/src/commands/apex/list/log.ts)_
|
|
602
613
|
|
|
603
614
|
## `sf apex run`
|
|
604
615
|
|
|
@@ -606,7 +617,7 @@ Execute anonymous Apex code entered on the command line or from a local file.
|
|
|
606
617
|
|
|
607
618
|
```
|
|
608
619
|
USAGE
|
|
609
|
-
$ sf apex run -o <value> [--json] [--api-version <value>] [-f <value>]
|
|
620
|
+
$ sf apex run -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>]
|
|
610
621
|
|
|
611
622
|
FLAGS
|
|
612
623
|
-f, --file=<value> Path to a local file that contains Apex code.
|
|
@@ -615,7 +626,8 @@ FLAGS
|
|
|
615
626
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
616
627
|
|
|
617
628
|
GLOBAL FLAGS
|
|
618
|
-
--
|
|
629
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
630
|
+
--json Format output as json.
|
|
619
631
|
|
|
620
632
|
DESCRIPTION
|
|
621
633
|
Execute anonymous Apex code entered on the command line or from a local file.
|
|
@@ -644,7 +656,7 @@ EXAMPLES
|
|
|
644
656
|
$ sf apex run
|
|
645
657
|
```
|
|
646
658
|
|
|
647
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0
|
|
659
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.0/src/commands/apex/run.ts)_
|
|
648
660
|
|
|
649
661
|
## `sf apex run test`
|
|
650
662
|
|
|
@@ -652,7 +664,7 @@ Invoke Apex tests in an org.
|
|
|
652
664
|
|
|
653
665
|
```
|
|
654
666
|
USAGE
|
|
655
|
-
$ sf apex run test -o <value> [--json] [--api-version <value>] [-d <value>] [-l
|
|
667
|
+
$ sf apex run test -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-l
|
|
656
668
|
RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value> | -s <value> | -t <value>] [-r human|tap|junit|json]
|
|
657
669
|
[-w <value>] [-y] [-v -c]
|
|
658
670
|
|
|
@@ -677,7 +689,8 @@ FLAGS
|
|
|
677
689
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
678
690
|
|
|
679
691
|
GLOBAL FLAGS
|
|
680
|
-
--
|
|
692
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
693
|
+
--json Format output as json.
|
|
681
694
|
|
|
682
695
|
DESCRIPTION
|
|
683
696
|
Invoke Apex tests in an org.
|
|
@@ -751,7 +764,7 @@ FLAG DESCRIPTIONS
|
|
|
751
764
|
--tests Test1 --tests Test2
|
|
752
765
|
```
|
|
753
766
|
|
|
754
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0
|
|
767
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.0/src/commands/apex/run/test.ts)_
|
|
755
768
|
|
|
756
769
|
## `sf apex tail log`
|
|
757
770
|
|
|
@@ -759,7 +772,7 @@ Activate debug logging and display logs in the terminal.
|
|
|
759
772
|
|
|
760
773
|
```
|
|
761
774
|
USAGE
|
|
762
|
-
$ sf apex tail log -o <value> [--api-version <value>] [-c] [-d <value> | -s]
|
|
775
|
+
$ sf apex tail log -o <value> [--flags-dir <value>] [--api-version <value>] [-c] [-d <value> | -s]
|
|
763
776
|
|
|
764
777
|
FLAGS
|
|
765
778
|
-c, --color Apply default colors to noteworthy log lines.
|
|
@@ -769,6 +782,9 @@ FLAGS
|
|
|
769
782
|
-s, --skip-trace-flag Skip trace flag setup. Assumes that a trace flag and debug level are fully set up.
|
|
770
783
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
771
784
|
|
|
785
|
+
GLOBAL FLAGS
|
|
786
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
787
|
+
|
|
772
788
|
DESCRIPTION
|
|
773
789
|
Activate debug logging and display logs in the terminal.
|
|
774
790
|
|
|
@@ -791,7 +807,7 @@ EXAMPLES
|
|
|
791
807
|
$ sf apex tail log --color --skip-trace-flag
|
|
792
808
|
```
|
|
793
809
|
|
|
794
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0
|
|
810
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.0/src/commands/apex/tail/log.ts)_
|
|
795
811
|
|
|
796
812
|
## `sf autocomplete [SHELL]`
|
|
797
813
|
|
|
@@ -855,7 +871,7 @@ DESCRIPTION
|
|
|
855
871
|
list all the commands
|
|
856
872
|
```
|
|
857
873
|
|
|
858
|
-
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/3.2.
|
|
874
|
+
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/3.2.2/src/commands/commands.ts)_
|
|
859
875
|
|
|
860
876
|
## `sf config get`
|
|
861
877
|
|
|
@@ -863,13 +879,14 @@ Get the value of a configuration variable.
|
|
|
863
879
|
|
|
864
880
|
```
|
|
865
881
|
USAGE
|
|
866
|
-
$ sf config get [--json] [--verbose]
|
|
882
|
+
$ sf config get [--json] [--flags-dir <value>] [--verbose]
|
|
867
883
|
|
|
868
884
|
FLAGS
|
|
869
885
|
--verbose Display whether the configuration variables are set locally or globally.
|
|
870
886
|
|
|
871
887
|
GLOBAL FLAGS
|
|
872
|
-
--
|
|
888
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
889
|
+
--json Format output as json.
|
|
873
890
|
|
|
874
891
|
DESCRIPTION
|
|
875
892
|
Get the value of a configuration variable.
|
|
@@ -903,7 +920,7 @@ CONFIGURATION VARIABLES
|
|
|
903
920
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
904
921
|
```
|
|
905
922
|
|
|
906
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0
|
|
923
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.1.0/src/commands/config/get.ts)_
|
|
907
924
|
|
|
908
925
|
## `sf config list`
|
|
909
926
|
|
|
@@ -911,10 +928,11 @@ List the configuration variables that you've previously set.
|
|
|
911
928
|
|
|
912
929
|
```
|
|
913
930
|
USAGE
|
|
914
|
-
$ sf config list [--json]
|
|
931
|
+
$ sf config list [--json] [--flags-dir <value>]
|
|
915
932
|
|
|
916
933
|
GLOBAL FLAGS
|
|
917
|
-
--
|
|
934
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
935
|
+
--json Format output as json.
|
|
918
936
|
|
|
919
937
|
DESCRIPTION
|
|
920
938
|
List the configuration variables that you've previously set.
|
|
@@ -942,7 +960,7 @@ EXAMPLES
|
|
|
942
960
|
$ sf config list
|
|
943
961
|
```
|
|
944
962
|
|
|
945
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0
|
|
963
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.1.0/src/commands/config/list.ts)_
|
|
946
964
|
|
|
947
965
|
## `sf config set`
|
|
948
966
|
|
|
@@ -950,13 +968,14 @@ Set one or more configuration variables, such as your default org.
|
|
|
950
968
|
|
|
951
969
|
```
|
|
952
970
|
USAGE
|
|
953
|
-
$ sf config set [--json] [-g]
|
|
971
|
+
$ sf config set [--json] [--flags-dir <value>] [-g]
|
|
954
972
|
|
|
955
973
|
FLAGS
|
|
956
974
|
-g, --global Set the configuration variables globally, so they can be used from any Salesforce DX project.
|
|
957
975
|
|
|
958
976
|
GLOBAL FLAGS
|
|
959
|
-
--
|
|
977
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
978
|
+
--json Format output as json.
|
|
960
979
|
|
|
961
980
|
DESCRIPTION
|
|
962
981
|
Set one or more configuration variables, such as your default org.
|
|
@@ -1010,7 +1029,7 @@ CONFIGURATION VARIABLES
|
|
|
1010
1029
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1011
1030
|
```
|
|
1012
1031
|
|
|
1013
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0
|
|
1032
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.1.0/src/commands/config/set.ts)_
|
|
1014
1033
|
|
|
1015
1034
|
## `sf config unset`
|
|
1016
1035
|
|
|
@@ -1018,13 +1037,14 @@ Unset local or global configuration variables.
|
|
|
1018
1037
|
|
|
1019
1038
|
```
|
|
1020
1039
|
USAGE
|
|
1021
|
-
$ sf config unset [--json] [-g]
|
|
1040
|
+
$ sf config unset [--json] [--flags-dir <value>] [-g]
|
|
1022
1041
|
|
|
1023
1042
|
FLAGS
|
|
1024
1043
|
-g, --global Unset the configuration variables globally.
|
|
1025
1044
|
|
|
1026
1045
|
GLOBAL FLAGS
|
|
1027
|
-
--
|
|
1046
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1047
|
+
--json Format output as json.
|
|
1028
1048
|
|
|
1029
1049
|
DESCRIPTION
|
|
1030
1050
|
Unset local or global configuration variables.
|
|
@@ -1059,7 +1079,7 @@ CONFIGURATION VARIABLES
|
|
|
1059
1079
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1060
1080
|
```
|
|
1061
1081
|
|
|
1062
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0
|
|
1082
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.1.0/src/commands/config/unset.ts)_
|
|
1063
1083
|
|
|
1064
1084
|
## `sf data create record`
|
|
1065
1085
|
|
|
@@ -1835,7 +1855,7 @@ Gather CLI configuration data and run diagnostic tests to discover and report po
|
|
|
1835
1855
|
|
|
1836
1856
|
```
|
|
1837
1857
|
USAGE
|
|
1838
|
-
$ sf doctor [--json] [-c <value>] [-p <value>] [-d <value>] [-i]
|
|
1858
|
+
$ sf doctor [--json] [--flags-dir <value>] [-c <value>] [-p <value>] [-d <value>] [-i]
|
|
1839
1859
|
|
|
1840
1860
|
FLAGS
|
|
1841
1861
|
-c, --command=<value> Command to run in debug mode; results are written to a log file.
|
|
@@ -1844,7 +1864,8 @@ FLAGS
|
|
|
1844
1864
|
-p, --plugin=<value> Specific plugin on which to run diagnostics.
|
|
1845
1865
|
|
|
1846
1866
|
GLOBAL FLAGS
|
|
1847
|
-
--
|
|
1867
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1868
|
+
--json Format output as json.
|
|
1848
1869
|
|
|
1849
1870
|
DESCRIPTION
|
|
1850
1871
|
Gather CLI configuration data and run diagnostic tests to discover and report potential problems in your environment.
|
|
@@ -1874,7 +1895,7 @@ EXAMPLES
|
|
|
1874
1895
|
$ sf doctor --plugin @salesforce/plugin-source
|
|
1875
1896
|
```
|
|
1876
1897
|
|
|
1877
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0
|
|
1898
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.1.0/src/commands/doctor.ts)_
|
|
1878
1899
|
|
|
1879
1900
|
## `sf force data bulk delete`
|
|
1880
1901
|
|
|
@@ -2036,7 +2057,7 @@ DESCRIPTION
|
|
|
2036
2057
|
Display help for sf.
|
|
2037
2058
|
```
|
|
2038
2059
|
|
|
2039
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.0.
|
|
2060
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.0.20/src/commands/help.ts)_
|
|
2040
2061
|
|
|
2041
2062
|
## `sf info releasenotes display`
|
|
2042
2063
|
|
|
@@ -2044,13 +2065,14 @@ Display Salesforce CLI release notes on the command line.
|
|
|
2044
2065
|
|
|
2045
2066
|
```
|
|
2046
2067
|
USAGE
|
|
2047
|
-
$ sf info releasenotes display [--json] [-v <value>]
|
|
2068
|
+
$ sf info releasenotes display [--json] [--flags-dir <value>] [-v <value>]
|
|
2048
2069
|
|
|
2049
2070
|
FLAGS
|
|
2050
2071
|
-v, --version=<value> CLI version or tag for which to display release notes.
|
|
2051
2072
|
|
|
2052
2073
|
GLOBAL FLAGS
|
|
2053
|
-
--
|
|
2074
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2075
|
+
--json Format output as json.
|
|
2054
2076
|
|
|
2055
2077
|
DESCRIPTION
|
|
2056
2078
|
Display Salesforce CLI release notes on the command line.
|
|
@@ -2075,7 +2097,7 @@ EXAMPLES
|
|
|
2075
2097
|
$ sf info releasenotes display --version latest
|
|
2076
2098
|
```
|
|
2077
2099
|
|
|
2078
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0
|
|
2100
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.1.0/src/commands/info/releasenotes/display.ts)_
|
|
2079
2101
|
|
|
2080
2102
|
## `sf lightning generate app`
|
|
2081
2103
|
|
|
@@ -2083,7 +2105,8 @@ Generate a Lightning App.
|
|
|
2083
2105
|
|
|
2084
2106
|
```
|
|
2085
2107
|
USAGE
|
|
2086
|
-
$ sf lightning generate app -n <value> [--json] [-t DefaultLightningApp] [-d <value>] [--api-version
|
|
2108
|
+
$ sf lightning generate app -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningApp] [-d <value>] [--api-version
|
|
2109
|
+
<value>]
|
|
2087
2110
|
|
|
2088
2111
|
FLAGS
|
|
2089
2112
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -2093,7 +2116,8 @@ FLAGS
|
|
|
2093
2116
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2094
2117
|
|
|
2095
2118
|
GLOBAL FLAGS
|
|
2096
|
-
--
|
|
2119
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2120
|
+
--json Format output as json.
|
|
2097
2121
|
|
|
2098
2122
|
DESCRIPTION
|
|
2099
2123
|
Generate a Lightning App.
|
|
@@ -2128,7 +2152,7 @@ FLAG DESCRIPTIONS
|
|
|
2128
2152
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2129
2153
|
```
|
|
2130
2154
|
|
|
2131
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
2155
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/lightning/generate/app.ts)_
|
|
2132
2156
|
|
|
2133
2157
|
## `sf lightning generate component`
|
|
2134
2158
|
|
|
@@ -2136,8 +2160,8 @@ Generate a bundle for an Aura component or a Lightning web component.
|
|
|
2136
2160
|
|
|
2137
2161
|
```
|
|
2138
2162
|
USAGE
|
|
2139
|
-
$ sf lightning generate component -n <value> [--json] [-
|
|
2140
|
-
[--api-version <value>] [--type aura|lwc]
|
|
2163
|
+
$ sf lightning generate component -n <value> [--json] [--flags-dir <value>] [-t
|
|
2164
|
+
default|analyticsDashboard|analyticsDashboardWithStep] [-d <value>] [--api-version <value>] [--type aura|lwc]
|
|
2141
2165
|
|
|
2142
2166
|
FLAGS
|
|
2143
2167
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -2149,7 +2173,8 @@ FLAGS
|
|
|
2149
2173
|
<options: aura|lwc>
|
|
2150
2174
|
|
|
2151
2175
|
GLOBAL FLAGS
|
|
2152
|
-
--
|
|
2176
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2177
|
+
--json Format output as json.
|
|
2153
2178
|
|
|
2154
2179
|
DESCRIPTION
|
|
2155
2180
|
Generate a bundle for an Aura component or a Lightning web component.
|
|
@@ -2196,7 +2221,7 @@ FLAG DESCRIPTIONS
|
|
|
2196
2221
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2197
2222
|
```
|
|
2198
2223
|
|
|
2199
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
2224
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/lightning/generate/component.ts)_
|
|
2200
2225
|
|
|
2201
2226
|
## `sf lightning generate event`
|
|
2202
2227
|
|
|
@@ -2204,7 +2229,8 @@ Generate a Lightning Event.
|
|
|
2204
2229
|
|
|
2205
2230
|
```
|
|
2206
2231
|
USAGE
|
|
2207
|
-
$ sf lightning generate event -n <value> [--json] [-t DefaultLightningEvt] [-d <value>] [--api-version
|
|
2232
|
+
$ sf lightning generate event -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningEvt] [-d <value>] [--api-version
|
|
2233
|
+
<value>]
|
|
2208
2234
|
|
|
2209
2235
|
FLAGS
|
|
2210
2236
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -2214,7 +2240,8 @@ FLAGS
|
|
|
2214
2240
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2215
2241
|
|
|
2216
2242
|
GLOBAL FLAGS
|
|
2217
|
-
--
|
|
2243
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2244
|
+
--json Format output as json.
|
|
2218
2245
|
|
|
2219
2246
|
DESCRIPTION
|
|
2220
2247
|
Generate a Lightning Event.
|
|
@@ -2249,7 +2276,7 @@ FLAG DESCRIPTIONS
|
|
|
2249
2276
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2250
2277
|
```
|
|
2251
2278
|
|
|
2252
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
2279
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/lightning/generate/event.ts)_
|
|
2253
2280
|
|
|
2254
2281
|
## `sf lightning generate interface`
|
|
2255
2282
|
|
|
@@ -2257,7 +2284,8 @@ Generate a Lightning Interface.
|
|
|
2257
2284
|
|
|
2258
2285
|
```
|
|
2259
2286
|
USAGE
|
|
2260
|
-
$ sf lightning generate interface -n <value> [--json] [-
|
|
2287
|
+
$ sf lightning generate interface -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningIntf] [-d <value>]
|
|
2288
|
+
[--api-version <value>]
|
|
2261
2289
|
|
|
2262
2290
|
FLAGS
|
|
2263
2291
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -2267,7 +2295,8 @@ FLAGS
|
|
|
2267
2295
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2268
2296
|
|
|
2269
2297
|
GLOBAL FLAGS
|
|
2270
|
-
--
|
|
2298
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2299
|
+
--json Format output as json.
|
|
2271
2300
|
|
|
2272
2301
|
DESCRIPTION
|
|
2273
2302
|
Generate a Lightning Interface.
|
|
@@ -2302,7 +2331,7 @@ FLAG DESCRIPTIONS
|
|
|
2302
2331
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2303
2332
|
```
|
|
2304
2333
|
|
|
2305
|
-
_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.1.0/src/commands/lightning/generate/interface.ts)_
|
|
2306
2335
|
|
|
2307
2336
|
## `sf lightning generate test`
|
|
2308
2337
|
|
|
@@ -2310,7 +2339,8 @@ Generate a Lightning test.
|
|
|
2310
2339
|
|
|
2311
2340
|
```
|
|
2312
2341
|
USAGE
|
|
2313
|
-
$ sf lightning generate test -n <value> [--json] [-
|
|
2342
|
+
$ sf lightning generate test -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningTest] [-d <value>]
|
|
2343
|
+
[--api-version <value>]
|
|
2314
2344
|
|
|
2315
2345
|
FLAGS
|
|
2316
2346
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -2320,7 +2350,8 @@ FLAGS
|
|
|
2320
2350
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2321
2351
|
|
|
2322
2352
|
GLOBAL FLAGS
|
|
2323
|
-
--
|
|
2353
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2354
|
+
--json Format output as json.
|
|
2324
2355
|
|
|
2325
2356
|
DESCRIPTION
|
|
2326
2357
|
Generate a Lightning test.
|
|
@@ -2355,7 +2386,7 @@ FLAG DESCRIPTIONS
|
|
|
2355
2386
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2356
2387
|
```
|
|
2357
2388
|
|
|
2358
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
2389
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/lightning/generate/test.ts)_
|
|
2359
2390
|
|
|
2360
2391
|
## `sf org assign permset`
|
|
2361
2392
|
|
|
@@ -2363,7 +2394,7 @@ Assign a permission set to one or more users of a scratch org.
|
|
|
2363
2394
|
|
|
2364
2395
|
```
|
|
2365
2396
|
USAGE
|
|
2366
|
-
$ sf org assign permset -n <value> -o <value> [--json] [-b <value>] [--api-version <value>]
|
|
2397
|
+
$ sf org assign permset -n <value> -o <value> [--json] [--flags-dir <value>] [-b <value>] [--api-version <value>]
|
|
2367
2398
|
|
|
2368
2399
|
FLAGS
|
|
2369
2400
|
-b, --on-behalf-of=<value>... Username or alias to assign the permission set to.
|
|
@@ -2372,7 +2403,8 @@ FLAGS
|
|
|
2372
2403
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2373
2404
|
|
|
2374
2405
|
GLOBAL FLAGS
|
|
2375
|
-
--
|
|
2406
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2407
|
+
--json Format output as json.
|
|
2376
2408
|
|
|
2377
2409
|
DESCRIPTION
|
|
2378
2410
|
Assign a permission set to one or more users of a scratch org.
|
|
@@ -2398,7 +2430,7 @@ EXAMPLES
|
|
|
2398
2430
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
2399
2431
|
```
|
|
2400
2432
|
|
|
2401
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
2433
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.4.0/src/commands/org/assign/permset.ts)_
|
|
2402
2434
|
|
|
2403
2435
|
## `sf org assign permsetlicense`
|
|
2404
2436
|
|
|
@@ -2406,7 +2438,8 @@ Assign a permission set license to one or more users of a scratch org.
|
|
|
2406
2438
|
|
|
2407
2439
|
```
|
|
2408
2440
|
USAGE
|
|
2409
|
-
$ sf org assign permsetlicense -n <value> -o <value> [--json] [-
|
|
2441
|
+
$ sf org assign permsetlicense -n <value> -o <value> [--json] [--flags-dir <value>] [-b <value>] [--api-version
|
|
2442
|
+
<value>]
|
|
2410
2443
|
|
|
2411
2444
|
FLAGS
|
|
2412
2445
|
-b, --on-behalf-of=<value>... Usernames or alias to assign the permission set license to.
|
|
@@ -2415,7 +2448,8 @@ FLAGS
|
|
|
2415
2448
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2416
2449
|
|
|
2417
2450
|
GLOBAL FLAGS
|
|
2418
|
-
--
|
|
2451
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2452
|
+
--json Format output as json.
|
|
2419
2453
|
|
|
2420
2454
|
DESCRIPTION
|
|
2421
2455
|
Assign a permission set license to one or more users of a scratch org.
|
|
@@ -2442,7 +2476,7 @@ EXAMPLES
|
|
|
2442
2476
|
user3
|
|
2443
2477
|
```
|
|
2444
2478
|
|
|
2445
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
2479
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.4.0/src/commands/org/assign/permsetlicense.ts)_
|
|
2446
2480
|
|
|
2447
2481
|
## `sf org create sandbox`
|
|
2448
2482
|
|
|
@@ -2450,26 +2484,28 @@ Create a sandbox org.
|
|
|
2450
2484
|
|
|
2451
2485
|
```
|
|
2452
2486
|
USAGE
|
|
2453
|
-
$ sf org create sandbox -o <value> [--json] [-f <value>] [-s] [-a <value>] [-w <value> |
|
|
2454
|
-
<value>] [-c <value> | -l Developer|Developer_Pro|Partial|Full] [--no-prompt]
|
|
2487
|
+
$ sf org create sandbox -o <value> [--json] [--flags-dir <value>] [-f <value>] [-s] [-a <value>] [-w <value> |
|
|
2488
|
+
--async] [-i <value> | ] [-n <value>] [-c <value> | -l Developer|Developer_Pro|Partial|Full] [--no-prompt]
|
|
2489
|
+
[--no-track-source]
|
|
2455
2490
|
|
|
2456
2491
|
FLAGS
|
|
2457
2492
|
-a, --alias=<value> Alias for the sandbox org.
|
|
2458
2493
|
-c, --clone=<value> Name of the sandbox org to clone.
|
|
2459
2494
|
-f, --definition-file=<value> Path to a sandbox definition file.
|
|
2460
|
-
-i, --poll-interval=<seconds>
|
|
2495
|
+
-i, --poll-interval=<seconds> Number of seconds to wait between retries.
|
|
2461
2496
|
-l, --license-type=<option> Type of sandbox license.
|
|
2462
2497
|
<options: Developer|Developer_Pro|Partial|Full>
|
|
2463
2498
|
-n, --name=<value> Name of the sandbox org.
|
|
2464
2499
|
-o, --target-org=<value> (required) Username or alias of the production org that contains the sandbox license.
|
|
2465
2500
|
-s, --set-default Set the sandbox org as your default org.
|
|
2466
|
-
-w, --wait=<minutes>
|
|
2501
|
+
-w, --wait=<minutes> Number of minutes to wait for the sandbox org to be ready.
|
|
2467
2502
|
--async Request the sandbox creation, but don't wait for it to complete.
|
|
2468
2503
|
--no-prompt Don't prompt for confirmation about the sandbox configuration.
|
|
2469
2504
|
--no-track-source Do not use source tracking for this sandbox.
|
|
2470
2505
|
|
|
2471
2506
|
GLOBAL FLAGS
|
|
2472
|
-
--
|
|
2507
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2508
|
+
--json Format output as json.
|
|
2473
2509
|
|
|
2474
2510
|
DESCRIPTION
|
|
2475
2511
|
Create a sandbox org.
|
|
@@ -2557,7 +2593,7 @@ FLAG DESCRIPTIONS
|
|
|
2557
2593
|
sandbox.
|
|
2558
2594
|
```
|
|
2559
2595
|
|
|
2560
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2596
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/create/sandbox.ts)_
|
|
2561
2597
|
|
|
2562
2598
|
## `sf org create scratch`
|
|
2563
2599
|
|
|
@@ -2565,7 +2601,7 @@ Create a scratch org.
|
|
|
2565
2601
|
|
|
2566
2602
|
```
|
|
2567
2603
|
USAGE
|
|
2568
|
-
$ sf org create scratch -v <value> [--json] [-a <value>] [--async] [-d] [-f <value>] [-c] [-e
|
|
2604
|
+
$ sf org create scratch -v <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [-d] [-f <value>] [-c] [-e
|
|
2569
2605
|
developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional]
|
|
2570
2606
|
[-m] [-y <value>] [-w <value>] [--api-version <value>] [-i <value>] [-t] [--username <value>] [--description
|
|
2571
2607
|
<value>] [--name <value>] [--release preview|previous] [--admin-email <value>] [--source-org <value>]
|
|
@@ -2578,8 +2614,8 @@ FLAGS
|
|
|
2578
2614
|
-t, --[no-]track-source Use source tracking for this scratch org. Set --no-track-source to disable source
|
|
2579
2615
|
tracking.
|
|
2580
2616
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
2581
|
-
-w, --wait=<minutes>
|
|
2582
|
-
-y, --duration-days=<days>
|
|
2617
|
+
-w, --wait=<minutes> Number of minutes to wait for the scratch org to be ready.
|
|
2618
|
+
-y, --duration-days=<days> Number of days before the org expires.
|
|
2583
2619
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2584
2620
|
--async Request the org, but don't wait for it to complete.
|
|
2585
2621
|
|
|
@@ -2606,7 +2642,8 @@ DEFINITION FILE OVERRIDE FLAGS
|
|
|
2606
2642
|
definition file, if set.
|
|
2607
2643
|
|
|
2608
2644
|
GLOBAL FLAGS
|
|
2609
|
-
--
|
|
2645
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2646
|
+
--json Format output as json.
|
|
2610
2647
|
|
|
2611
2648
|
DESCRIPTION
|
|
2612
2649
|
Create a scratch org.
|
|
@@ -2710,7 +2747,7 @@ FLAG DESCRIPTIONS
|
|
|
2710
2747
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
2711
2748
|
```
|
|
2712
2749
|
|
|
2713
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2750
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/create/scratch.ts)_
|
|
2714
2751
|
|
|
2715
2752
|
## `sf org create user`
|
|
2716
2753
|
|
|
@@ -2718,7 +2755,8 @@ Create a user for a scratch org.
|
|
|
2718
2755
|
|
|
2719
2756
|
```
|
|
2720
2757
|
USAGE
|
|
2721
|
-
$ sf org create user -o <value> [--json] [-a <value>] [-f <value>] [-s] [--api-version
|
|
2758
|
+
$ sf org create user -o <value> [--json] [--flags-dir <value>] [-a <value>] [-f <value>] [-s] [--api-version
|
|
2759
|
+
<value>]
|
|
2722
2760
|
|
|
2723
2761
|
FLAGS
|
|
2724
2762
|
-a, --set-alias=<value> Set an alias for the created username to reference in other CLI commands.
|
|
@@ -2730,7 +2768,8 @@ FLAGS
|
|
|
2730
2768
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2731
2769
|
|
|
2732
2770
|
GLOBAL FLAGS
|
|
2733
|
-
--
|
|
2771
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2772
|
+
--json Format output as json.
|
|
2734
2773
|
|
|
2735
2774
|
DESCRIPTION
|
|
2736
2775
|
Create a user for a scratch org.
|
|
@@ -2816,7 +2855,7 @@ FLAG DESCRIPTIONS
|
|
|
2816
2855
|
might be different than what you specify in the definition file.
|
|
2817
2856
|
```
|
|
2818
2857
|
|
|
2819
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
2858
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.4.0/src/commands/org/create/user.ts)_
|
|
2820
2859
|
|
|
2821
2860
|
## `sf org delete sandbox`
|
|
2822
2861
|
|
|
@@ -2824,14 +2863,15 @@ Delete a sandbox.
|
|
|
2824
2863
|
|
|
2825
2864
|
```
|
|
2826
2865
|
USAGE
|
|
2827
|
-
$ sf org delete sandbox -o <value> [--json] [-p]
|
|
2866
|
+
$ sf org delete sandbox -o <value> [--json] [--flags-dir <value>] [-p]
|
|
2828
2867
|
|
|
2829
2868
|
FLAGS
|
|
2830
2869
|
-o, --target-org=<value> (required) Sandbox alias or login user.
|
|
2831
2870
|
-p, --no-prompt Don't prompt the user to confirm the deletion.
|
|
2832
2871
|
|
|
2833
2872
|
GLOBAL FLAGS
|
|
2834
|
-
--
|
|
2873
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2874
|
+
--json Format output as json.
|
|
2835
2875
|
|
|
2836
2876
|
DESCRIPTION
|
|
2837
2877
|
Delete a sandbox.
|
|
@@ -2860,7 +2900,7 @@ EXAMPLES
|
|
|
2860
2900
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
2861
2901
|
```
|
|
2862
2902
|
|
|
2863
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2903
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/delete/sandbox.ts)_
|
|
2864
2904
|
|
|
2865
2905
|
## `sf org delete scratch`
|
|
2866
2906
|
|
|
@@ -2868,14 +2908,15 @@ Delete a scratch org.
|
|
|
2868
2908
|
|
|
2869
2909
|
```
|
|
2870
2910
|
USAGE
|
|
2871
|
-
$ sf org delete scratch -o <value> [--json] [-p]
|
|
2911
|
+
$ sf org delete scratch -o <value> [--json] [--flags-dir <value>] [-p]
|
|
2872
2912
|
|
|
2873
2913
|
FLAGS
|
|
2874
2914
|
-o, --target-org=<value> (required) Scratch org alias or login user.
|
|
2875
2915
|
-p, --no-prompt Don't prompt the user to confirm the deletion.
|
|
2876
2916
|
|
|
2877
2917
|
GLOBAL FLAGS
|
|
2878
|
-
--
|
|
2918
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2919
|
+
--json Format output as json.
|
|
2879
2920
|
|
|
2880
2921
|
DESCRIPTION
|
|
2881
2922
|
Delete a scratch org.
|
|
@@ -2902,7 +2943,7 @@ EXAMPLES
|
|
|
2902
2943
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
2903
2944
|
```
|
|
2904
2945
|
|
|
2905
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2946
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/delete/scratch.ts)_
|
|
2906
2947
|
|
|
2907
2948
|
## `sf org disable tracking`
|
|
2908
2949
|
|
|
@@ -2910,14 +2951,15 @@ Prevent Salesforce CLI from tracking changes in your source files between your p
|
|
|
2910
2951
|
|
|
2911
2952
|
```
|
|
2912
2953
|
USAGE
|
|
2913
|
-
$ sf org disable tracking -o <value> [--json]
|
|
2954
|
+
$ sf org disable tracking -o <value> [--json] [--flags-dir <value>]
|
|
2914
2955
|
|
|
2915
2956
|
FLAGS
|
|
2916
2957
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2917
2958
|
configuration variable is already set.
|
|
2918
2959
|
|
|
2919
2960
|
GLOBAL FLAGS
|
|
2920
|
-
--
|
|
2961
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
2962
|
+
--json Format output as json.
|
|
2921
2963
|
|
|
2922
2964
|
DESCRIPTION
|
|
2923
2965
|
Prevent Salesforce CLI from tracking changes in your source files between your project and an org.
|
|
@@ -2940,7 +2982,7 @@ EXAMPLES
|
|
|
2940
2982
|
$ sf org disable tracking
|
|
2941
2983
|
```
|
|
2942
2984
|
|
|
2943
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2985
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/disable/tracking.ts)_
|
|
2944
2986
|
|
|
2945
2987
|
## `sf org display`
|
|
2946
2988
|
|
|
@@ -2948,7 +2990,7 @@ Display information about an org.
|
|
|
2948
2990
|
|
|
2949
2991
|
```
|
|
2950
2992
|
USAGE
|
|
2951
|
-
$ sf org display -o <value> [--json] [--api-version <value>] [--verbose]
|
|
2993
|
+
$ sf org display -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--verbose]
|
|
2952
2994
|
|
|
2953
2995
|
FLAGS
|
|
2954
2996
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -2957,7 +2999,8 @@ FLAGS
|
|
|
2957
2999
|
--verbose Display the sfdxAuthUrl property.
|
|
2958
3000
|
|
|
2959
3001
|
GLOBAL FLAGS
|
|
2960
|
-
--
|
|
3002
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3003
|
+
--json Format output as json.
|
|
2961
3004
|
|
|
2962
3005
|
DESCRIPTION
|
|
2963
3006
|
Display information about an org.
|
|
@@ -2984,7 +3027,7 @@ EXAMPLES
|
|
|
2984
3027
|
$ sf org display --target-org TestOrg1 --verbose
|
|
2985
3028
|
```
|
|
2986
3029
|
|
|
2987
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3030
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/display.ts)_
|
|
2988
3031
|
|
|
2989
3032
|
## `sf org display user`
|
|
2990
3033
|
|
|
@@ -2992,7 +3035,7 @@ Display information about a Salesforce user.
|
|
|
2992
3035
|
|
|
2993
3036
|
```
|
|
2994
3037
|
USAGE
|
|
2995
|
-
$ sf org display user -o <value> [--json] [--api-version <value>]
|
|
3038
|
+
$ sf org display user -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
2996
3039
|
|
|
2997
3040
|
FLAGS
|
|
2998
3041
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -3000,7 +3043,8 @@ FLAGS
|
|
|
3000
3043
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
3001
3044
|
|
|
3002
3045
|
GLOBAL FLAGS
|
|
3003
|
-
--
|
|
3046
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3047
|
+
--json Format output as json.
|
|
3004
3048
|
|
|
3005
3049
|
DESCRIPTION
|
|
3006
3050
|
Display information about a Salesforce user.
|
|
@@ -3022,7 +3066,7 @@ EXAMPLES
|
|
|
3022
3066
|
$ sf org display user --target-org me@my.org --json
|
|
3023
3067
|
```
|
|
3024
3068
|
|
|
3025
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
3069
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.4.0/src/commands/org/display/user.ts)_
|
|
3026
3070
|
|
|
3027
3071
|
## `sf org enable tracking`
|
|
3028
3072
|
|
|
@@ -3030,14 +3074,15 @@ Allow Salesforce CLI to track changes in your source files between your project
|
|
|
3030
3074
|
|
|
3031
3075
|
```
|
|
3032
3076
|
USAGE
|
|
3033
|
-
$ sf org enable tracking -o <value> [--json]
|
|
3077
|
+
$ sf org enable tracking -o <value> [--json] [--flags-dir <value>]
|
|
3034
3078
|
|
|
3035
3079
|
FLAGS
|
|
3036
3080
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
3037
3081
|
configuration variable is already set.
|
|
3038
3082
|
|
|
3039
3083
|
GLOBAL FLAGS
|
|
3040
|
-
--
|
|
3084
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3085
|
+
--json Format output as json.
|
|
3041
3086
|
|
|
3042
3087
|
DESCRIPTION
|
|
3043
3088
|
Allow Salesforce CLI to track changes in your source files between your project and an org.
|
|
@@ -3063,7 +3108,7 @@ EXAMPLES
|
|
|
3063
3108
|
$ sf org enable tracking
|
|
3064
3109
|
```
|
|
3065
3110
|
|
|
3066
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3111
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/enable/tracking.ts)_
|
|
3067
3112
|
|
|
3068
3113
|
## `sf org generate password`
|
|
3069
3114
|
|
|
@@ -3071,7 +3116,8 @@ Generate a random password for scratch org users.
|
|
|
3071
3116
|
|
|
3072
3117
|
```
|
|
3073
3118
|
USAGE
|
|
3074
|
-
$ sf org generate password -o <value> [--json] [-
|
|
3119
|
+
$ sf org generate password -o <value> [--json] [--flags-dir <value>] [-b <value>] [-l <value>] [-c <value>]
|
|
3120
|
+
[--api-version <value>]
|
|
3075
3121
|
|
|
3076
3122
|
FLAGS
|
|
3077
3123
|
-b, --on-behalf-of=<value>... Comma-separated list of usernames or aliases to assign the password to; must have been
|
|
@@ -3085,7 +3131,8 @@ FLAGS
|
|
|
3085
3131
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
3086
3132
|
|
|
3087
3133
|
GLOBAL FLAGS
|
|
3088
|
-
--
|
|
3134
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3135
|
+
--json Format output as json.
|
|
3089
3136
|
|
|
3090
3137
|
DESCRIPTION
|
|
3091
3138
|
Generate a random password for scratch org users.
|
|
@@ -3128,7 +3175,7 @@ EXAMPLES
|
|
|
3128
3175
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
3129
3176
|
```
|
|
3130
3177
|
|
|
3131
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
3178
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.4.0/src/commands/org/generate/password.ts)_
|
|
3132
3179
|
|
|
3133
3180
|
## `sf org list`
|
|
3134
3181
|
|
|
@@ -3136,7 +3183,7 @@ List all orgs you’ve created or authenticated to.
|
|
|
3136
3183
|
|
|
3137
3184
|
```
|
|
3138
3185
|
USAGE
|
|
3139
|
-
$ sf org list [--json] [--verbose] [--all] [-p --clean] [--skip-connection-status]
|
|
3186
|
+
$ sf org list [--json] [--flags-dir <value>] [--verbose] [--all] [-p --clean] [--skip-connection-status]
|
|
3140
3187
|
|
|
3141
3188
|
FLAGS
|
|
3142
3189
|
-p, --no-prompt Don't prompt for confirmation.
|
|
@@ -3147,7 +3194,8 @@ FLAGS
|
|
|
3147
3194
|
--verbose List more information about each org.
|
|
3148
3195
|
|
|
3149
3196
|
GLOBAL FLAGS
|
|
3150
|
-
--
|
|
3197
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3198
|
+
--json Format output as json.
|
|
3151
3199
|
|
|
3152
3200
|
ALIASES
|
|
3153
3201
|
$ sf force org list
|
|
@@ -3166,7 +3214,7 @@ EXAMPLES
|
|
|
3166
3214
|
$ sf org list --clean
|
|
3167
3215
|
```
|
|
3168
3216
|
|
|
3169
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3217
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/list.ts)_
|
|
3170
3218
|
|
|
3171
3219
|
## `sf org list auth`
|
|
3172
3220
|
|
|
@@ -3174,10 +3222,11 @@ List authorization information about the orgs you created or logged into.
|
|
|
3174
3222
|
|
|
3175
3223
|
```
|
|
3176
3224
|
USAGE
|
|
3177
|
-
$ sf org list auth [--json]
|
|
3225
|
+
$ sf org list auth [--json] [--flags-dir <value>]
|
|
3178
3226
|
|
|
3179
3227
|
GLOBAL FLAGS
|
|
3180
|
-
--
|
|
3228
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3229
|
+
--json Format output as json.
|
|
3181
3230
|
|
|
3182
3231
|
DESCRIPTION
|
|
3183
3232
|
List authorization information about the orgs you created or logged into.
|
|
@@ -3197,7 +3246,7 @@ EXAMPLES
|
|
|
3197
3246
|
$ sf org list auth
|
|
3198
3247
|
```
|
|
3199
3248
|
|
|
3200
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.
|
|
3249
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.5.0/src/commands/org/list/auth.ts)_
|
|
3201
3250
|
|
|
3202
3251
|
## `sf org list limits`
|
|
3203
3252
|
|
|
@@ -3205,7 +3254,7 @@ Display information about limits in your org.
|
|
|
3205
3254
|
|
|
3206
3255
|
```
|
|
3207
3256
|
USAGE
|
|
3208
|
-
$ sf org list limits -o <value> [--json] [--api-version <value>]
|
|
3257
|
+
$ sf org list limits -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
3209
3258
|
|
|
3210
3259
|
FLAGS
|
|
3211
3260
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -3213,7 +3262,8 @@ FLAGS
|
|
|
3213
3262
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
3214
3263
|
|
|
3215
3264
|
GLOBAL FLAGS
|
|
3216
|
-
--
|
|
3265
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3266
|
+
--json Format output as json.
|
|
3217
3267
|
|
|
3218
3268
|
DESCRIPTION
|
|
3219
3269
|
Display information about limits in your org.
|
|
@@ -3236,7 +3286,7 @@ EXAMPLES
|
|
|
3236
3286
|
$ sf org list limits --target-org my-scratch-org
|
|
3237
3287
|
```
|
|
3238
3288
|
|
|
3239
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.
|
|
3289
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.2.0/src/commands/org/list/limits.ts)_
|
|
3240
3290
|
|
|
3241
3291
|
## `sf org list metadata`
|
|
3242
3292
|
|
|
@@ -3244,7 +3294,8 @@ List the metadata components and properties of a specified type.
|
|
|
3244
3294
|
|
|
3245
3295
|
```
|
|
3246
3296
|
USAGE
|
|
3247
|
-
$ sf org list metadata -o <value> -m <value> [--json] [--
|
|
3297
|
+
$ sf org list metadata -o <value> -m <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>]
|
|
3298
|
+
[--folder <value>]
|
|
3248
3299
|
|
|
3249
3300
|
FLAGS
|
|
3250
3301
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
@@ -3257,7 +3308,8 @@ FLAGS
|
|
|
3257
3308
|
names are case-sensitive.
|
|
3258
3309
|
|
|
3259
3310
|
GLOBAL FLAGS
|
|
3260
|
-
--
|
|
3311
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3312
|
+
--json Format output as json.
|
|
3261
3313
|
|
|
3262
3314
|
DESCRIPTION
|
|
3263
3315
|
List the metadata components and properties of a specified type.
|
|
@@ -3301,7 +3353,7 @@ FLAG DESCRIPTIONS
|
|
|
3301
3353
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
3302
3354
|
```
|
|
3303
3355
|
|
|
3304
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3356
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/list/metadata.ts)_
|
|
3305
3357
|
|
|
3306
3358
|
## `sf org list metadata-types`
|
|
3307
3359
|
|
|
@@ -3309,7 +3361,7 @@ Display details about the metadata types that are enabled for your org.
|
|
|
3309
3361
|
|
|
3310
3362
|
```
|
|
3311
3363
|
USAGE
|
|
3312
|
-
$ sf org list metadata-types -o <value> [--json] [--api-version <value>] [-f <value>]
|
|
3364
|
+
$ sf org list metadata-types -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>]
|
|
3313
3365
|
|
|
3314
3366
|
FLAGS
|
|
3315
3367
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
@@ -3318,7 +3370,8 @@ FLAGS
|
|
|
3318
3370
|
--api-version=<value> API version to use; default is the most recent API version.
|
|
3319
3371
|
|
|
3320
3372
|
GLOBAL FLAGS
|
|
3321
|
-
--
|
|
3373
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3374
|
+
--json Format output as json.
|
|
3322
3375
|
|
|
3323
3376
|
DESCRIPTION
|
|
3324
3377
|
Display details about the metadata types that are enabled for your org.
|
|
@@ -3355,7 +3408,7 @@ FLAG DESCRIPTIONS
|
|
|
3355
3408
|
Override the api version used for api requests made by this command
|
|
3356
3409
|
```
|
|
3357
3410
|
|
|
3358
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3411
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/list/metadata-types.ts)_
|
|
3359
3412
|
|
|
3360
3413
|
## `sf org list sobject record-counts`
|
|
3361
3414
|
|
|
@@ -3363,7 +3416,7 @@ Display record counts for the specified standard or custom objects.
|
|
|
3363
3416
|
|
|
3364
3417
|
```
|
|
3365
3418
|
USAGE
|
|
3366
|
-
$ sf org list sobject record-counts -o <value> [--json] [-s <value>] [--api-version <value>]
|
|
3419
|
+
$ sf org list sobject record-counts -o <value> [--json] [--flags-dir <value>] [-s <value>] [--api-version <value>]
|
|
3367
3420
|
|
|
3368
3421
|
FLAGS
|
|
3369
3422
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -3372,7 +3425,8 @@ FLAGS
|
|
|
3372
3425
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
3373
3426
|
|
|
3374
3427
|
GLOBAL FLAGS
|
|
3375
|
-
--
|
|
3428
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3429
|
+
--json Format output as json.
|
|
3376
3430
|
|
|
3377
3431
|
DESCRIPTION
|
|
3378
3432
|
Display record counts for the specified standard or custom objects.
|
|
@@ -3400,7 +3454,7 @@ EXAMPLES
|
|
|
3400
3454
|
$ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
|
|
3401
3455
|
```
|
|
3402
3456
|
|
|
3403
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.
|
|
3457
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.2.0/src/commands/org/list/sobject/record-counts.ts)_
|
|
3404
3458
|
|
|
3405
3459
|
## `sf org list users`
|
|
3406
3460
|
|
|
@@ -3408,7 +3462,7 @@ List all locally-authenticated users of an org.
|
|
|
3408
3462
|
|
|
3409
3463
|
```
|
|
3410
3464
|
USAGE
|
|
3411
|
-
$ sf org list users -o <value> [--json] [--api-version <value>]
|
|
3465
|
+
$ sf org list users -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
3412
3466
|
|
|
3413
3467
|
FLAGS
|
|
3414
3468
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -3416,7 +3470,8 @@ FLAGS
|
|
|
3416
3470
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
3417
3471
|
|
|
3418
3472
|
GLOBAL FLAGS
|
|
3419
|
-
--
|
|
3473
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3474
|
+
--json Format output as json.
|
|
3420
3475
|
|
|
3421
3476
|
DESCRIPTION
|
|
3422
3477
|
List all locally-authenticated users of an org.
|
|
@@ -3437,7 +3492,7 @@ EXAMPLES
|
|
|
3437
3492
|
$ sf org list users --target-org me@my.org
|
|
3438
3493
|
```
|
|
3439
3494
|
|
|
3440
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
3495
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.4.0/src/commands/org/list/users.ts)_
|
|
3441
3496
|
|
|
3442
3497
|
## `sf org login access-token`
|
|
3443
3498
|
|
|
@@ -3445,7 +3500,7 @@ Authorize an org using an existing Salesforce access token.
|
|
|
3445
3500
|
|
|
3446
3501
|
```
|
|
3447
3502
|
USAGE
|
|
3448
|
-
$ sf org login access-token -r <value> [--json] [-d] [-s] [-a <value>] [-p]
|
|
3503
|
+
$ sf org login access-token -r <value> [--json] [--flags-dir <value>] [-d] [-s] [-a <value>] [-p]
|
|
3449
3504
|
|
|
3450
3505
|
FLAGS
|
|
3451
3506
|
-a, --alias=<value> Alias for the org.
|
|
@@ -3455,7 +3510,8 @@ FLAGS
|
|
|
3455
3510
|
-s, --set-default Set the authenticated org as the default that all org-related commands run against.
|
|
3456
3511
|
|
|
3457
3512
|
GLOBAL FLAGS
|
|
3458
|
-
--
|
|
3513
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3514
|
+
--json Format output as json.
|
|
3459
3515
|
|
|
3460
3516
|
DESCRIPTION
|
|
3461
3517
|
Authorize an org using an existing Salesforce access token.
|
|
@@ -3490,7 +3546,7 @@ FLAG DESCRIPTIONS
|
|
|
3490
3546
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3491
3547
|
```
|
|
3492
3548
|
|
|
3493
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.
|
|
3549
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.5.0/src/commands/org/login/access-token.ts)_
|
|
3494
3550
|
|
|
3495
3551
|
## `sf org login device`
|
|
3496
3552
|
|
|
@@ -3498,7 +3554,7 @@ Authorize an org using a device code.
|
|
|
3498
3554
|
|
|
3499
3555
|
```
|
|
3500
3556
|
USAGE
|
|
3501
|
-
$ sf org login device [--json] [-i <value>] [-r <value>] [-d] [-s] [-a <value>]
|
|
3557
|
+
$ sf org login device [--json] [--flags-dir <value>] [-i <value>] [-r <value>] [-d] [-s] [-a <value>]
|
|
3502
3558
|
|
|
3503
3559
|
FLAGS
|
|
3504
3560
|
-a, --alias=<value> Alias for the org.
|
|
@@ -3508,7 +3564,8 @@ FLAGS
|
|
|
3508
3564
|
-s, --set-default Set the authenticated org as the default that all org-related commands run against.
|
|
3509
3565
|
|
|
3510
3566
|
GLOBAL FLAGS
|
|
3511
|
-
--
|
|
3567
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3568
|
+
--json Format output as json.
|
|
3512
3569
|
|
|
3513
3570
|
DESCRIPTION
|
|
3514
3571
|
Authorize an org using a device code.
|
|
@@ -3549,7 +3606,7 @@ FLAG DESCRIPTIONS
|
|
|
3549
3606
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3550
3607
|
```
|
|
3551
3608
|
|
|
3552
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.
|
|
3609
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.5.0/src/commands/org/login/device.ts)_
|
|
3553
3610
|
|
|
3554
3611
|
## `sf org login jwt`
|
|
3555
3612
|
|
|
@@ -3557,7 +3614,8 @@ Log in to a Salesforce org using a JSON web token (JWT).
|
|
|
3557
3614
|
|
|
3558
3615
|
```
|
|
3559
3616
|
USAGE
|
|
3560
|
-
$ sf org login jwt -o <value> -f <value> -i <value> [--json] [-r <value>] [-d] [-s] [-a
|
|
3617
|
+
$ sf org login jwt -o <value> -f <value> -i <value> [--json] [--flags-dir <value>] [-r <value>] [-d] [-s] [-a
|
|
3618
|
+
<value>]
|
|
3561
3619
|
|
|
3562
3620
|
FLAGS
|
|
3563
3621
|
-a, --alias=<value> Alias for the org.
|
|
@@ -3569,7 +3627,8 @@ FLAGS
|
|
|
3569
3627
|
-s, --set-default Set the authenticated org as the default that all org-related commands run against.
|
|
3570
3628
|
|
|
3571
3629
|
GLOBAL FLAGS
|
|
3572
|
-
--
|
|
3630
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3631
|
+
--json Format output as json.
|
|
3573
3632
|
|
|
3574
3633
|
DESCRIPTION
|
|
3575
3634
|
Log in to a Salesforce org using a JSON web token (JWT).
|
|
@@ -3638,7 +3697,7 @@ FLAG DESCRIPTIONS
|
|
|
3638
3697
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3639
3698
|
```
|
|
3640
3699
|
|
|
3641
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.
|
|
3700
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.5.0/src/commands/org/login/jwt.ts)_
|
|
3642
3701
|
|
|
3643
3702
|
## `sf org login sfdx-url`
|
|
3644
3703
|
|
|
@@ -3646,7 +3705,7 @@ Authorize an org using a Salesforce DX authorization URL stored in a file or thr
|
|
|
3646
3705
|
|
|
3647
3706
|
```
|
|
3648
3707
|
USAGE
|
|
3649
|
-
$ sf org login sfdx-url [--json] [-f <value>] [-u <value>] [-d] [-s] [-a <value>]
|
|
3708
|
+
$ sf org login sfdx-url [--json] [--flags-dir <value>] [-f <value>] [-u <value>] [-d] [-s] [-a <value>]
|
|
3650
3709
|
|
|
3651
3710
|
FLAGS
|
|
3652
3711
|
-a, --alias=<value> Alias for the org.
|
|
@@ -3656,7 +3715,8 @@ FLAGS
|
|
|
3656
3715
|
-u, --sfdx-url-stdin=<value> Pipe the Salesforce DX authorization URL through standard input (stdin).
|
|
3657
3716
|
|
|
3658
3717
|
GLOBAL FLAGS
|
|
3659
|
-
--
|
|
3718
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3719
|
+
--json Format output as json.
|
|
3660
3720
|
|
|
3661
3721
|
DESCRIPTION
|
|
3662
3722
|
Authorize an org using a Salesforce DX authorization URL stored in a file or through standard input (stdin).
|
|
@@ -3703,7 +3763,7 @@ EXAMPLES
|
|
|
3703
3763
|
$ echo url | sf org login sfdx-url --sfdx-url-stdin
|
|
3704
3764
|
```
|
|
3705
3765
|
|
|
3706
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.
|
|
3766
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.5.0/src/commands/org/login/sfdx-url.ts)_
|
|
3707
3767
|
|
|
3708
3768
|
## `sf org login web`
|
|
3709
3769
|
|
|
@@ -3711,7 +3771,8 @@ Log in to a Salesforce org using the web server flow.
|
|
|
3711
3771
|
|
|
3712
3772
|
```
|
|
3713
3773
|
USAGE
|
|
3714
|
-
$ sf org login web [--json] [-b chrome|edge|firefox] [-i <value>] [-r <value>] [-d] [-s]
|
|
3774
|
+
$ sf org login web [--json] [--flags-dir <value>] [-b chrome|edge|firefox] [-i <value>] [-r <value>] [-d] [-s]
|
|
3775
|
+
[-a <value>]
|
|
3715
3776
|
|
|
3716
3777
|
FLAGS
|
|
3717
3778
|
-a, --alias=<value> Alias for the org.
|
|
@@ -3723,7 +3784,8 @@ FLAGS
|
|
|
3723
3784
|
-s, --set-default Set the authenticated org as the default that all org-related commands run against.
|
|
3724
3785
|
|
|
3725
3786
|
GLOBAL FLAGS
|
|
3726
|
-
--
|
|
3787
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3788
|
+
--json Format output as json.
|
|
3727
3789
|
|
|
3728
3790
|
DESCRIPTION
|
|
3729
3791
|
Log in to a Salesforce org using the web server flow.
|
|
@@ -3788,7 +3850,7 @@ FLAG DESCRIPTIONS
|
|
|
3788
3850
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3789
3851
|
```
|
|
3790
3852
|
|
|
3791
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.
|
|
3853
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.5.0/src/commands/org/login/web.ts)_
|
|
3792
3854
|
|
|
3793
3855
|
## `sf org logout`
|
|
3794
3856
|
|
|
@@ -3796,7 +3858,7 @@ Log out of a Salesforce org.
|
|
|
3796
3858
|
|
|
3797
3859
|
```
|
|
3798
3860
|
USAGE
|
|
3799
|
-
$ sf org logout [--json] [-a | -o <value>] [-p]
|
|
3861
|
+
$ sf org logout [--json] [--flags-dir <value>] [-a | -o <value>] [-p]
|
|
3800
3862
|
|
|
3801
3863
|
FLAGS
|
|
3802
3864
|
-a, --all Include all authenticated orgs.
|
|
@@ -3804,7 +3866,8 @@ FLAGS
|
|
|
3804
3866
|
-p, --no-prompt Don't prompt for confirmation.
|
|
3805
3867
|
|
|
3806
3868
|
GLOBAL FLAGS
|
|
3807
|
-
--
|
|
3869
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3870
|
+
--json Format output as json.
|
|
3808
3871
|
|
|
3809
3872
|
DESCRIPTION
|
|
3810
3873
|
Log out of a Salesforce org.
|
|
@@ -3848,7 +3911,7 @@ FLAG DESCRIPTIONS
|
|
|
3848
3911
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
3849
3912
|
```
|
|
3850
3913
|
|
|
3851
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.
|
|
3914
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.5.0/src/commands/org/logout.ts)_
|
|
3852
3915
|
|
|
3853
3916
|
## `sf org open`
|
|
3854
3917
|
|
|
@@ -3856,8 +3919,8 @@ Open your default scratch org, or another specified org, in a browser.
|
|
|
3856
3919
|
|
|
3857
3920
|
```
|
|
3858
3921
|
USAGE
|
|
3859
|
-
$ sf org open -o <value> [--json] [--api-version <value>] [--private | -r | -b
|
|
3860
|
-
<value> | -f <value>]
|
|
3922
|
+
$ sf org open -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--private | -r | -b
|
|
3923
|
+
chrome|edge|firefox] [-p <value> | -f <value>]
|
|
3861
3924
|
|
|
3862
3925
|
FLAGS
|
|
3863
3926
|
-b, --browser=<option> Browser where the org opens.
|
|
@@ -3871,7 +3934,8 @@ FLAGS
|
|
|
3871
3934
|
--private Open the org in the default browser using private (incognito) mode.
|
|
3872
3935
|
|
|
3873
3936
|
GLOBAL FLAGS
|
|
3874
|
-
--
|
|
3937
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
3938
|
+
--json Format output as json.
|
|
3875
3939
|
|
|
3876
3940
|
DESCRIPTION
|
|
3877
3941
|
Open your default scratch org, or another specified org, in a browser.
|
|
@@ -3919,7 +3983,7 @@ EXAMPLES
|
|
|
3919
3983
|
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
3920
3984
|
```
|
|
3921
3985
|
|
|
3922
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3986
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/open.ts)_
|
|
3923
3987
|
|
|
3924
3988
|
## `sf org refresh sandbox`
|
|
3925
3989
|
|
|
@@ -3927,21 +3991,22 @@ Refresh a sandbox org using the sandbox name.
|
|
|
3927
3991
|
|
|
3928
3992
|
```
|
|
3929
3993
|
USAGE
|
|
3930
|
-
$ sf org refresh sandbox -o <value> [--json] [--no-auto-activate] [-w <value> | --async] [-i
|
|
3931
|
-
[-f <value>] [--no-prompt]
|
|
3994
|
+
$ sf org refresh sandbox -o <value> [--json] [--flags-dir <value>] [--no-auto-activate] [-w <value> | --async] [-i
|
|
3995
|
+
<value> | ] [-n <value>] [-f <value>] [--no-prompt]
|
|
3932
3996
|
|
|
3933
3997
|
FLAGS
|
|
3934
3998
|
-f, --definition-file=<value> Path to a sandbox definition file for overriding its configuration when you refresh it.
|
|
3935
|
-
-i, --poll-interval=<seconds>
|
|
3999
|
+
-i, --poll-interval=<seconds> Number of seconds to wait between status polling requests.
|
|
3936
4000
|
-n, --name=<value> Name of the existing sandbox org in your production org that you want to refresh.
|
|
3937
4001
|
-o, --target-org=<value> (required) Username or alias of the production org that contains the sandbox license.
|
|
3938
|
-
-w, --wait=<minutes>
|
|
4002
|
+
-w, --wait=<minutes> Number of minutes to poll for sandbox refresh status.
|
|
3939
4003
|
--async Request the sandbox refresh, but don't wait for it to complete.
|
|
3940
4004
|
--no-auto-activate Disable auto-activation of the sandbox after a successful refresh.
|
|
3941
4005
|
--no-prompt Don't prompt for confirmation about the sandbox refresh.
|
|
3942
4006
|
|
|
3943
4007
|
GLOBAL FLAGS
|
|
3944
|
-
--
|
|
4008
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4009
|
+
--json Format output as json.
|
|
3945
4010
|
|
|
3946
4011
|
DESCRIPTION
|
|
3947
4012
|
Refresh a sandbox org using the sandbox name.
|
|
@@ -3995,7 +4060,7 @@ FLAG DESCRIPTIONS
|
|
|
3995
4060
|
By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.
|
|
3996
4061
|
```
|
|
3997
4062
|
|
|
3998
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
4063
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/refresh/sandbox.ts)_
|
|
3999
4064
|
|
|
4000
4065
|
## `sf org resume sandbox`
|
|
4001
4066
|
|
|
@@ -4003,17 +4068,18 @@ Check the status of a sandbox creation, and log in to it if it's ready.
|
|
|
4003
4068
|
|
|
4004
4069
|
```
|
|
4005
4070
|
USAGE
|
|
4006
|
-
$ sf org resume sandbox [--json] [-w <value>] [-n <value> | -i <value>] [-l] [-o <value>]
|
|
4071
|
+
$ sf org resume sandbox [--json] [--flags-dir <value>] [-w <value>] [-n <value> | -i <value>] [-l] [-o <value>]
|
|
4007
4072
|
|
|
4008
4073
|
FLAGS
|
|
4009
4074
|
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
4010
4075
|
-l, --use-most-recent Use the most recent sandbox create request.
|
|
4011
4076
|
-n, --name=<value> Name of the sandbox org.
|
|
4012
4077
|
-o, --target-org=<value> Username or alias of the production org that contains the sandbox license.
|
|
4013
|
-
-w, --wait=<minutes> [default:
|
|
4078
|
+
-w, --wait=<minutes> [default: 0 minutes] Number of minutes to wait for the sandbox org to be ready.
|
|
4014
4079
|
|
|
4015
4080
|
GLOBAL FLAGS
|
|
4016
|
-
--
|
|
4081
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4082
|
+
--json Format output as json.
|
|
4017
4083
|
|
|
4018
4084
|
DESCRIPTION
|
|
4019
4085
|
Check the status of a sandbox creation, and log in to it if it's ready.
|
|
@@ -4057,7 +4123,7 @@ FLAG DESCRIPTIONS
|
|
|
4057
4123
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
4058
4124
|
```
|
|
4059
4125
|
|
|
4060
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
4126
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/resume/sandbox.ts)_
|
|
4061
4127
|
|
|
4062
4128
|
## `sf org resume scratch`
|
|
4063
4129
|
|
|
@@ -4065,14 +4131,15 @@ Resume the creation of an incomplete scratch org.
|
|
|
4065
4131
|
|
|
4066
4132
|
```
|
|
4067
4133
|
USAGE
|
|
4068
|
-
$ sf org resume scratch [--json] [-i <value>] [-r]
|
|
4134
|
+
$ sf org resume scratch [--json] [--flags-dir <value>] [-i <value>] [-r]
|
|
4069
4135
|
|
|
4070
4136
|
FLAGS
|
|
4071
4137
|
-i, --job-id=<value> Job ID of the incomplete scratch org create that you want to resume.
|
|
4072
4138
|
-r, --use-most-recent Use the job ID of the most recent incomplete scratch org.
|
|
4073
4139
|
|
|
4074
4140
|
GLOBAL FLAGS
|
|
4075
|
-
--
|
|
4141
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4142
|
+
--json Format output as json.
|
|
4076
4143
|
|
|
4077
4144
|
DESCRIPTION
|
|
4078
4145
|
Resume the creation of an incomplete scratch org.
|
|
@@ -4103,7 +4170,7 @@ FLAG DESCRIPTIONS
|
|
|
4103
4170
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
4104
4171
|
```
|
|
4105
4172
|
|
|
4106
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
4173
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.6.0/src/commands/org/resume/scratch.ts)_
|
|
4107
4174
|
|
|
4108
4175
|
## `sf package1 version create`
|
|
4109
4176
|
|
|
@@ -4111,8 +4178,8 @@ Create a first-generation package version in the release org.
|
|
|
4111
4178
|
|
|
4112
4179
|
```
|
|
4113
4180
|
USAGE
|
|
4114
|
-
$ sf package1 version create -o <value> -i <value> -n <value> [--json] [--
|
|
4115
|
-
[-m] [-r <value>] [-p <value>] [-k <value>] [-w <value>]
|
|
4181
|
+
$ sf package1 version create -o <value> -i <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d
|
|
4182
|
+
<value>] [-v <value>] [-m] [-r <value>] [-p <value>] [-k <value>] [-w <value>]
|
|
4116
4183
|
|
|
4117
4184
|
FLAGS
|
|
4118
4185
|
-d, --description=<value> Package version description.
|
|
@@ -4130,7 +4197,8 @@ FLAGS
|
|
|
4130
4197
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4131
4198
|
|
|
4132
4199
|
GLOBAL FLAGS
|
|
4133
|
-
--
|
|
4200
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4201
|
+
--json Format output as json.
|
|
4134
4202
|
|
|
4135
4203
|
DESCRIPTION
|
|
4136
4204
|
Create a first-generation package version in the release org.
|
|
@@ -4169,7 +4237,7 @@ FLAG DESCRIPTIONS
|
|
|
4169
4237
|
subscribers.
|
|
4170
4238
|
```
|
|
4171
4239
|
|
|
4172
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4240
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package1/version/create.ts)_
|
|
4173
4241
|
|
|
4174
4242
|
## `sf package1 version create get`
|
|
4175
4243
|
|
|
@@ -4177,7 +4245,7 @@ Retrieve the status of a package version creation request.
|
|
|
4177
4245
|
|
|
4178
4246
|
```
|
|
4179
4247
|
USAGE
|
|
4180
|
-
$ sf package1 version create get -o <value> -i <value> [--json] [--api-version <value>]
|
|
4248
|
+
$ sf package1 version create get -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
4181
4249
|
|
|
4182
4250
|
FLAGS
|
|
4183
4251
|
-i, --request-id=<value> (required) ID of the PackageUploadRequest (starts with 0HD).
|
|
@@ -4186,7 +4254,8 @@ FLAGS
|
|
|
4186
4254
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4187
4255
|
|
|
4188
4256
|
GLOBAL FLAGS
|
|
4189
|
-
--
|
|
4257
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4258
|
+
--json Format output as json.
|
|
4190
4259
|
|
|
4191
4260
|
ALIASES
|
|
4192
4261
|
$ sf force package1 version create get
|
|
@@ -4201,7 +4270,7 @@ EXAMPLES
|
|
|
4201
4270
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
4202
4271
|
```
|
|
4203
4272
|
|
|
4204
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4273
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package1/version/create/get.ts)_
|
|
4205
4274
|
|
|
4206
4275
|
## `sf package1 version display`
|
|
4207
4276
|
|
|
@@ -4209,7 +4278,7 @@ Display details about a first-generation package version.
|
|
|
4209
4278
|
|
|
4210
4279
|
```
|
|
4211
4280
|
USAGE
|
|
4212
|
-
$ sf package1 version display -o <value> -i <value> [--json] [--api-version <value>]
|
|
4281
|
+
$ sf package1 version display -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
4213
4282
|
|
|
4214
4283
|
FLAGS
|
|
4215
4284
|
-i, --package-version-id=<value> (required) ID (starts with 04t) of the metadata package version whose details you
|
|
@@ -4219,7 +4288,8 @@ FLAGS
|
|
|
4219
4288
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4220
4289
|
|
|
4221
4290
|
GLOBAL FLAGS
|
|
4222
|
-
--
|
|
4291
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4292
|
+
--json Format output as json.
|
|
4223
4293
|
|
|
4224
4294
|
ALIASES
|
|
4225
4295
|
$ sf force package1 version display
|
|
@@ -4234,7 +4304,7 @@ EXAMPLES
|
|
|
4234
4304
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
4235
4305
|
```
|
|
4236
4306
|
|
|
4237
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4307
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package1/version/display.ts)_
|
|
4238
4308
|
|
|
4239
4309
|
## `sf package1 version list`
|
|
4240
4310
|
|
|
@@ -4242,7 +4312,7 @@ List package versions for the specified first-generation package or for the org.
|
|
|
4242
4312
|
|
|
4243
4313
|
```
|
|
4244
4314
|
USAGE
|
|
4245
|
-
$ sf package1 version list -o <value> [--json] [--api-version <value>] [-i <value>]
|
|
4315
|
+
$ sf package1 version list -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>]
|
|
4246
4316
|
|
|
4247
4317
|
FLAGS
|
|
4248
4318
|
-i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
|
|
@@ -4251,7 +4321,8 @@ FLAGS
|
|
|
4251
4321
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4252
4322
|
|
|
4253
4323
|
GLOBAL FLAGS
|
|
4254
|
-
--
|
|
4324
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4325
|
+
--json Format output as json.
|
|
4255
4326
|
|
|
4256
4327
|
ALIASES
|
|
4257
4328
|
$ sf force package1 version list
|
|
@@ -4271,7 +4342,7 @@ FLAG DESCRIPTIONS
|
|
|
4271
4342
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
4272
4343
|
```
|
|
4273
4344
|
|
|
4274
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4345
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package1/version/list.ts)_
|
|
4275
4346
|
|
|
4276
4347
|
## `sf package create`
|
|
4277
4348
|
|
|
@@ -4279,8 +4350,8 @@ Create a package.
|
|
|
4279
4350
|
|
|
4280
4351
|
```
|
|
4281
4352
|
USAGE
|
|
4282
|
-
$ sf package create -v <value> -n <value> -t Managed|Unlocked -r <value> [--json] [--
|
|
4283
|
-
<value>] [-e] [--org-dependent] [-o <value>]
|
|
4353
|
+
$ sf package create -v <value> -n <value> -t Managed|Unlocked -r <value> [--json] [--flags-dir <value>]
|
|
4354
|
+
[--api-version <value>] [-d <value>] [-e] [--org-dependent] [-o <value>]
|
|
4284
4355
|
|
|
4285
4356
|
FLAGS
|
|
4286
4357
|
-d, --description=<value> Description of the package.
|
|
@@ -4298,7 +4369,8 @@ FLAGS
|
|
|
4298
4369
|
packages only.
|
|
4299
4370
|
|
|
4300
4371
|
GLOBAL FLAGS
|
|
4301
|
-
--
|
|
4372
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4373
|
+
--json Format output as json.
|
|
4302
4374
|
|
|
4303
4375
|
DESCRIPTION
|
|
4304
4376
|
Create a package.
|
|
@@ -4349,7 +4421,7 @@ FLAG DESCRIPTIONS
|
|
|
4349
4421
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
4350
4422
|
```
|
|
4351
4423
|
|
|
4352
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4424
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/create.ts)_
|
|
4353
4425
|
|
|
4354
4426
|
## `sf package delete`
|
|
4355
4427
|
|
|
@@ -4357,7 +4429,7 @@ Delete a package.
|
|
|
4357
4429
|
|
|
4358
4430
|
```
|
|
4359
4431
|
USAGE
|
|
4360
|
-
$ sf package delete -v <value> -p <value> [--json] [--api-version <value>] [-n]
|
|
4432
|
+
$ sf package delete -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n]
|
|
4361
4433
|
|
|
4362
4434
|
FLAGS
|
|
4363
4435
|
-n, --no-prompt Don’t prompt before deleting the package.
|
|
@@ -4367,7 +4439,8 @@ FLAGS
|
|
|
4367
4439
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4368
4440
|
|
|
4369
4441
|
GLOBAL FLAGS
|
|
4370
|
-
--
|
|
4442
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4443
|
+
--json Format output as json.
|
|
4371
4444
|
|
|
4372
4445
|
DESCRIPTION
|
|
4373
4446
|
Delete a package.
|
|
@@ -4390,7 +4463,7 @@ EXAMPLES
|
|
|
4390
4463
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
4391
4464
|
```
|
|
4392
4465
|
|
|
4393
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4466
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/delete.ts)_
|
|
4394
4467
|
|
|
4395
4468
|
## `sf package install`
|
|
4396
4469
|
|
|
@@ -4398,16 +4471,15 @@ Install a version of a package in the target org.
|
|
|
4398
4471
|
|
|
4399
4472
|
```
|
|
4400
4473
|
USAGE
|
|
4401
|
-
$ sf package install -o <value> -p <value> [--json] [--
|
|
4402
|
-
[-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete]
|
|
4474
|
+
$ sf package install -o <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>] [-k
|
|
4475
|
+
<value>] [-b <value>] [-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete]
|
|
4403
4476
|
|
|
4404
4477
|
FLAGS
|
|
4405
4478
|
-a, --apex-compile=<option> [default: all] Compile all Apex in the org and package, or only Apex in the package;
|
|
4406
4479
|
unlocked packages only.
|
|
4407
4480
|
<options: all|package>
|
|
4408
|
-
-b, --publish-wait=<value>
|
|
4409
|
-
|
|
4410
|
-
request.
|
|
4481
|
+
-b, --publish-wait=<value> Maximum number of minutes to wait for the Subscriber Package Version ID to become
|
|
4482
|
+
available in the target org before canceling the install request.
|
|
4411
4483
|
-k, --installation-key=<value> Installation key for key-protected package (default: null).
|
|
4412
4484
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4413
4485
|
configuration variable is already set.
|
|
@@ -4420,11 +4492,12 @@ FLAGS
|
|
|
4420
4492
|
-t, --upgrade-type=<option> [default: Mixed] Upgrade type for the package installation; available only for
|
|
4421
4493
|
unlocked packages.
|
|
4422
4494
|
<options: DeprecateOnly|Mixed|Delete>
|
|
4423
|
-
-w, --wait=<value>
|
|
4495
|
+
-w, --wait=<value> Number of minutes to wait for installation status.
|
|
4424
4496
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4425
4497
|
|
|
4426
4498
|
GLOBAL FLAGS
|
|
4427
|
-
--
|
|
4499
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4500
|
+
--json Format output as json.
|
|
4428
4501
|
|
|
4429
4502
|
DESCRIPTION
|
|
4430
4503
|
Install a version of a package in the target org.
|
|
@@ -4488,7 +4561,7 @@ FLAG DESCRIPTIONS
|
|
|
4488
4561
|
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
4489
4562
|
```
|
|
4490
4563
|
|
|
4491
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4564
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/install.ts)_
|
|
4492
4565
|
|
|
4493
4566
|
## `sf package install report`
|
|
4494
4567
|
|
|
@@ -4496,7 +4569,7 @@ Retrieve the status of a package installation request.
|
|
|
4496
4569
|
|
|
4497
4570
|
```
|
|
4498
4571
|
USAGE
|
|
4499
|
-
$ sf package install report -o <value> -i <value> [--json] [--api-version <value>]
|
|
4572
|
+
$ sf package install report -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
4500
4573
|
|
|
4501
4574
|
FLAGS
|
|
4502
4575
|
-i, --request-id=<value> (required) ID of the package install request you want to check; starts with 0Hf.
|
|
@@ -4505,7 +4578,8 @@ FLAGS
|
|
|
4505
4578
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4506
4579
|
|
|
4507
4580
|
GLOBAL FLAGS
|
|
4508
|
-
--
|
|
4581
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4582
|
+
--json Format output as json.
|
|
4509
4583
|
|
|
4510
4584
|
ALIASES
|
|
4511
4585
|
$ sf force package install report
|
|
@@ -4520,7 +4594,7 @@ EXAMPLES
|
|
|
4520
4594
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
4521
4595
|
```
|
|
4522
4596
|
|
|
4523
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4597
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/install/report.ts)_
|
|
4524
4598
|
|
|
4525
4599
|
## `sf package installed list`
|
|
4526
4600
|
|
|
@@ -4528,7 +4602,7 @@ List the org’s installed packages.
|
|
|
4528
4602
|
|
|
4529
4603
|
```
|
|
4530
4604
|
USAGE
|
|
4531
|
-
$ sf package installed list -o <value> [--json] [--api-version <value>]
|
|
4605
|
+
$ sf package installed list -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
4532
4606
|
|
|
4533
4607
|
FLAGS
|
|
4534
4608
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -4536,7 +4610,8 @@ FLAGS
|
|
|
4536
4610
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4537
4611
|
|
|
4538
4612
|
GLOBAL FLAGS
|
|
4539
|
-
--
|
|
4613
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4614
|
+
--json Format output as json.
|
|
4540
4615
|
|
|
4541
4616
|
ALIASES
|
|
4542
4617
|
$ sf force package installed list
|
|
@@ -4551,7 +4626,7 @@ EXAMPLES
|
|
|
4551
4626
|
$ sf package installed list --target-org me@example.com
|
|
4552
4627
|
```
|
|
4553
4628
|
|
|
4554
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4629
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/installed/list.ts)_
|
|
4555
4630
|
|
|
4556
4631
|
## `sf package list`
|
|
4557
4632
|
|
|
@@ -4559,7 +4634,7 @@ List all packages in the Dev Hub org.
|
|
|
4559
4634
|
|
|
4560
4635
|
```
|
|
4561
4636
|
USAGE
|
|
4562
|
-
$ sf package list -v <value> [--json] [--api-version <value>] [--verbose]
|
|
4637
|
+
$ sf package list -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [--verbose]
|
|
4563
4638
|
|
|
4564
4639
|
FLAGS
|
|
4565
4640
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
@@ -4568,7 +4643,8 @@ FLAGS
|
|
|
4568
4643
|
--verbose Display extended package detail.
|
|
4569
4644
|
|
|
4570
4645
|
GLOBAL FLAGS
|
|
4571
|
-
--
|
|
4646
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4647
|
+
--json Format output as json.
|
|
4572
4648
|
|
|
4573
4649
|
DESCRIPTION
|
|
4574
4650
|
List all packages in the Dev Hub org.
|
|
@@ -4588,7 +4664,7 @@ EXAMPLES
|
|
|
4588
4664
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
4589
4665
|
```
|
|
4590
4666
|
|
|
4591
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4667
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/list.ts)_
|
|
4592
4668
|
|
|
4593
4669
|
## `sf package uninstall`
|
|
4594
4670
|
|
|
@@ -4596,17 +4672,18 @@ Uninstall a second-generation package from the target org.
|
|
|
4596
4672
|
|
|
4597
4673
|
```
|
|
4598
4674
|
USAGE
|
|
4599
|
-
$ sf package uninstall -o <value> -p <value> [--json] [--api-version <value>] [-w <value>]
|
|
4675
|
+
$ sf package uninstall -o <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>]
|
|
4600
4676
|
|
|
4601
4677
|
FLAGS
|
|
4602
4678
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4603
4679
|
configuration variable is already set.
|
|
4604
4680
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to uninstall.
|
|
4605
|
-
-w, --wait=<value>
|
|
4681
|
+
-w, --wait=<value> Number of minutes to wait for uninstall status.
|
|
4606
4682
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4607
4683
|
|
|
4608
4684
|
GLOBAL FLAGS
|
|
4609
|
-
--
|
|
4685
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4686
|
+
--json Format output as json.
|
|
4610
4687
|
|
|
4611
4688
|
DESCRIPTION
|
|
4612
4689
|
Uninstall a second-generation package from the target org.
|
|
@@ -4635,7 +4712,7 @@ EXAMPLES
|
|
|
4635
4712
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
4636
4713
|
```
|
|
4637
4714
|
|
|
4638
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4715
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/uninstall.ts)_
|
|
4639
4716
|
|
|
4640
4717
|
## `sf package uninstall report`
|
|
4641
4718
|
|
|
@@ -4643,7 +4720,7 @@ Retrieve the status of a package uninstall request.
|
|
|
4643
4720
|
|
|
4644
4721
|
```
|
|
4645
4722
|
USAGE
|
|
4646
|
-
$ sf package uninstall report -o <value> -i <value> [--json] [--api-version <value>]
|
|
4723
|
+
$ sf package uninstall report -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
4647
4724
|
|
|
4648
4725
|
FLAGS
|
|
4649
4726
|
-i, --request-id=<value> (required) ID of the package uninstall request you want to check; starts with 06y.
|
|
@@ -4652,7 +4729,8 @@ FLAGS
|
|
|
4652
4729
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4653
4730
|
|
|
4654
4731
|
GLOBAL FLAGS
|
|
4655
|
-
--
|
|
4732
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4733
|
+
--json Format output as json.
|
|
4656
4734
|
|
|
4657
4735
|
ALIASES
|
|
4658
4736
|
$ sf force package uninstall report
|
|
@@ -4667,7 +4745,7 @@ EXAMPLES
|
|
|
4667
4745
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
4668
4746
|
```
|
|
4669
4747
|
|
|
4670
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4748
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/uninstall/report.ts)_
|
|
4671
4749
|
|
|
4672
4750
|
## `sf package update`
|
|
4673
4751
|
|
|
@@ -4675,8 +4753,8 @@ Update package details.
|
|
|
4675
4753
|
|
|
4676
4754
|
```
|
|
4677
4755
|
USAGE
|
|
4678
|
-
$ sf package update -v <value> -p <value> [--json] [--
|
|
4679
|
-
[--enable-app-analytics]
|
|
4756
|
+
$ sf package update -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>] [-d
|
|
4757
|
+
<value>] [-o <value>] [--enable-app-analytics]
|
|
4680
4758
|
|
|
4681
4759
|
FLAGS
|
|
4682
4760
|
-d, --description=<value> New description of the package.
|
|
@@ -4691,7 +4769,8 @@ FLAGS
|
|
|
4691
4769
|
package and its components.
|
|
4692
4770
|
|
|
4693
4771
|
GLOBAL FLAGS
|
|
4694
|
-
--
|
|
4772
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4773
|
+
--json Format output as json.
|
|
4695
4774
|
|
|
4696
4775
|
DESCRIPTION
|
|
4697
4776
|
Update package details.
|
|
@@ -4721,7 +4800,7 @@ FLAG DESCRIPTIONS
|
|
|
4721
4800
|
associated with your package.
|
|
4722
4801
|
```
|
|
4723
4802
|
|
|
4724
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4803
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/update.ts)_
|
|
4725
4804
|
|
|
4726
4805
|
## `sf package version create`
|
|
4727
4806
|
|
|
@@ -4729,10 +4808,10 @@ Create a package version in the Dev Hub org.
|
|
|
4729
4808
|
|
|
4730
4809
|
```
|
|
4731
4810
|
USAGE
|
|
4732
|
-
$ sf package version create -v <value> [--json] [--api-version <value>] [-b <value>] [-c |
|
|
4733
|
-
[-k <value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>]
|
|
4734
|
-
[--releasenotes-url <value>] [--skip-ancestor-check] [-t <value>] [--uninstall-script
|
|
4735
|
-
<value>] [-n <value>] [-w <value>] [--language <value>] [--verbose]
|
|
4811
|
+
$ sf package version create -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-b <value>] [-c |
|
|
4812
|
+
--skip-validation] [-f <value>] [-k <value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>]
|
|
4813
|
+
[--post-install-url <value>] [--releasenotes-url <value>] [--skip-ancestor-check] [-t <value>] [--uninstall-script
|
|
4814
|
+
<value>] [-e <value>] [-a <value>] [-n <value>] [-w <value>] [--language <value>] [--verbose]
|
|
4736
4815
|
|
|
4737
4816
|
FLAGS
|
|
4738
4817
|
-a, --version-name=<value> Name of the package version to be created; overrides the sfdx-project.json value.
|
|
@@ -4754,8 +4833,7 @@ FLAGS
|
|
|
4754
4833
|
-t, --tag=<value> Package version’s tag.
|
|
4755
4834
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
4756
4835
|
`target-dev-hub` configuration variable is already set.
|
|
4757
|
-
-w, --wait=<value>
|
|
4758
|
-
created.
|
|
4836
|
+
-w, --wait=<value> Number of minutes to wait for the package version to be created.
|
|
4759
4837
|
-x, --installation-key-bypass Bypass the installation key requirement. (either --installation-key or
|
|
4760
4838
|
--installation-key-bypass is required)
|
|
4761
4839
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
@@ -4771,7 +4849,8 @@ FLAGS
|
|
|
4771
4849
|
--verbose Display verbose command output.
|
|
4772
4850
|
|
|
4773
4851
|
GLOBAL FLAGS
|
|
4774
|
-
--
|
|
4852
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4853
|
+
--json Format output as json.
|
|
4775
4854
|
|
|
4776
4855
|
DESCRIPTION
|
|
4777
4856
|
Create a package version in the Dev Hub org.
|
|
@@ -4876,7 +4955,7 @@ FLAG DESCRIPTIONS
|
|
|
4876
4955
|
periods of no output from commands.
|
|
4877
4956
|
```
|
|
4878
4957
|
|
|
4879
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
4958
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/version/create.ts)_
|
|
4880
4959
|
|
|
4881
4960
|
## `sf package version create list`
|
|
4882
4961
|
|
|
@@ -4884,8 +4963,8 @@ List package version creation requests.
|
|
|
4884
4963
|
|
|
4885
4964
|
```
|
|
4886
4965
|
USAGE
|
|
4887
|
-
$ sf package version create list -v <value> [--json] [--api-version <value>] [-c <value>] [-s
|
|
4888
|
-
[--show-conversions-only] [--verbose]
|
|
4966
|
+
$ sf package version create list -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-c <value>] [-s
|
|
4967
|
+
Queued|InProgress|Success|Error] [--show-conversions-only] [--verbose]
|
|
4889
4968
|
|
|
4890
4969
|
FLAGS
|
|
4891
4970
|
-c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
|
|
@@ -4900,7 +4979,8 @@ FLAGS
|
|
|
4900
4979
|
name and number for each package version create request.
|
|
4901
4980
|
|
|
4902
4981
|
GLOBAL FLAGS
|
|
4903
|
-
--
|
|
4982
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
4983
|
+
--json Format output as json.
|
|
4904
4984
|
|
|
4905
4985
|
DESCRIPTION
|
|
4906
4986
|
List package version creation requests.
|
|
@@ -4936,7 +5016,7 @@ EXAMPLES
|
|
|
4936
5016
|
$ sf package version create list --created-last-days 0 --status Success
|
|
4937
5017
|
```
|
|
4938
5018
|
|
|
4939
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5019
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/version/create/list.ts)_
|
|
4940
5020
|
|
|
4941
5021
|
## `sf package version create report`
|
|
4942
5022
|
|
|
@@ -4944,7 +5024,7 @@ Retrieve details about a package version creation request.
|
|
|
4944
5024
|
|
|
4945
5025
|
```
|
|
4946
5026
|
USAGE
|
|
4947
|
-
$ sf package version create report -v <value> -i <value> [--json] [--api-version <value>]
|
|
5027
|
+
$ sf package version create report -v <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
4948
5028
|
|
|
4949
5029
|
FLAGS
|
|
4950
5030
|
-i, --package-create-request-id=<value> (required) ID (starts with 08c) of the package version creation request you
|
|
@@ -4954,7 +5034,8 @@ FLAGS
|
|
|
4954
5034
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4955
5035
|
|
|
4956
5036
|
GLOBAL FLAGS
|
|
4957
|
-
--
|
|
5037
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5038
|
+
--json Format output as json.
|
|
4958
5039
|
|
|
4959
5040
|
DESCRIPTION
|
|
4960
5041
|
Retrieve details about a package version creation request.
|
|
@@ -4978,7 +5059,7 @@ EXAMPLES
|
|
|
4978
5059
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
4979
5060
|
```
|
|
4980
5061
|
|
|
4981
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5062
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/version/create/report.ts)_
|
|
4982
5063
|
|
|
4983
5064
|
## `sf package version delete`
|
|
4984
5065
|
|
|
@@ -4986,7 +5067,7 @@ Delete a package version.
|
|
|
4986
5067
|
|
|
4987
5068
|
```
|
|
4988
5069
|
USAGE
|
|
4989
|
-
$ sf package version delete -v <value> -p <value> [--json] [--api-version <value>] [-n]
|
|
5070
|
+
$ sf package version delete -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n]
|
|
4990
5071
|
|
|
4991
5072
|
FLAGS
|
|
4992
5073
|
-n, --no-prompt Don’t prompt before deleting the package version.
|
|
@@ -4996,7 +5077,8 @@ FLAGS
|
|
|
4996
5077
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4997
5078
|
|
|
4998
5079
|
GLOBAL FLAGS
|
|
4999
|
-
--
|
|
5080
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5081
|
+
--json Format output as json.
|
|
5000
5082
|
|
|
5001
5083
|
DESCRIPTION
|
|
5002
5084
|
Delete a package version.
|
|
@@ -5016,7 +5098,7 @@ EXAMPLES
|
|
|
5016
5098
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
5017
5099
|
```
|
|
5018
5100
|
|
|
5019
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5101
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/version/delete.ts)_
|
|
5020
5102
|
|
|
5021
5103
|
## `sf package version displayancestry`
|
|
5022
5104
|
|
|
@@ -5024,7 +5106,8 @@ Display the ancestry tree for a 2GP managed package version.
|
|
|
5024
5106
|
|
|
5025
5107
|
```
|
|
5026
5108
|
USAGE
|
|
5027
|
-
$ sf package version displayancestry -v <value> -p <value> [--json] [--api-version <value>] [--dot-code]
|
|
5109
|
+
$ sf package version displayancestry -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [--dot-code]
|
|
5110
|
+
[--verbose]
|
|
5028
5111
|
|
|
5029
5112
|
FLAGS
|
|
5030
5113
|
-p, --package=<value> (required) ID or alias of the package (starts with 0Ho) or package version (starts with
|
|
@@ -5037,7 +5120,8 @@ FLAGS
|
|
|
5037
5120
|
(major.minor.patch.build) in the ancestry tree.
|
|
5038
5121
|
|
|
5039
5122
|
GLOBAL FLAGS
|
|
5040
|
-
--
|
|
5123
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5124
|
+
--json Format output as json.
|
|
5041
5125
|
|
|
5042
5126
|
ALIASES
|
|
5043
5127
|
$ sf force package version displayancestry
|
|
@@ -5074,7 +5158,7 @@ FLAG DESCRIPTIONS
|
|
|
5074
5158
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
5075
5159
|
```
|
|
5076
5160
|
|
|
5077
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5161
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/version/displayancestry.ts)_
|
|
5078
5162
|
|
|
5079
5163
|
## `sf package version list`
|
|
5080
5164
|
|
|
@@ -5082,8 +5166,8 @@ List all package versions in the Dev Hub org.
|
|
|
5082
5166
|
|
|
5083
5167
|
```
|
|
5084
5168
|
USAGE
|
|
5085
|
-
$ sf package version list -v <value> [--json] [--api-version <value>] [-c <value>] [--concise]
|
|
5086
|
-
[-m <value>] [-p <value>] [-r] [-o <value>] [--verbose]
|
|
5169
|
+
$ sf package version list -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-c <value>] [--concise]
|
|
5170
|
+
[--show-conversions-only] [-m <value>] [-p <value>] [-r] [-o <value>] [--verbose]
|
|
5087
5171
|
|
|
5088
5172
|
FLAGS
|
|
5089
5173
|
-c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
|
|
@@ -5101,7 +5185,8 @@ FLAGS
|
|
|
5101
5185
|
--verbose Display extended package version details.
|
|
5102
5186
|
|
|
5103
5187
|
GLOBAL FLAGS
|
|
5104
|
-
--
|
|
5188
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5189
|
+
--json Format output as json.
|
|
5105
5190
|
|
|
5106
5191
|
DESCRIPTION
|
|
5107
5192
|
List all package versions in the Dev Hub org.
|
|
@@ -5142,7 +5227,7 @@ EXAMPLES
|
|
|
5142
5227
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
5143
5228
|
```
|
|
5144
5229
|
|
|
5145
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5230
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/version/list.ts)_
|
|
5146
5231
|
|
|
5147
5232
|
## `sf package version promote`
|
|
5148
5233
|
|
|
@@ -5150,7 +5235,7 @@ Promote a package version to released.
|
|
|
5150
5235
|
|
|
5151
5236
|
```
|
|
5152
5237
|
USAGE
|
|
5153
|
-
$ sf package version promote -v <value> -p <value> [--json] [--api-version <value>] [-n]
|
|
5238
|
+
$ sf package version promote -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n]
|
|
5154
5239
|
|
|
5155
5240
|
FLAGS
|
|
5156
5241
|
-n, --no-prompt Don't prompt to confirm setting the package version as released.
|
|
@@ -5160,7 +5245,8 @@ FLAGS
|
|
|
5160
5245
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
5161
5246
|
|
|
5162
5247
|
GLOBAL FLAGS
|
|
5163
|
-
--
|
|
5248
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5249
|
+
--json Format output as json.
|
|
5164
5250
|
|
|
5165
5251
|
DESCRIPTION
|
|
5166
5252
|
Promote a package version to released.
|
|
@@ -5185,7 +5271,7 @@ EXAMPLES
|
|
|
5185
5271
|
$ sf package version promote --package "Awesome Package Alias"
|
|
5186
5272
|
```
|
|
5187
5273
|
|
|
5188
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5274
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/version/promote.ts)_
|
|
5189
5275
|
|
|
5190
5276
|
## `sf package version report`
|
|
5191
5277
|
|
|
@@ -5193,7 +5279,7 @@ Retrieve details about a package version in the Dev Hub org.
|
|
|
5193
5279
|
|
|
5194
5280
|
```
|
|
5195
5281
|
USAGE
|
|
5196
|
-
$ sf package version report -v <value> -p <value> [--json] [--api-version <value>] [--verbose]
|
|
5282
|
+
$ sf package version report -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [--verbose]
|
|
5197
5283
|
|
|
5198
5284
|
FLAGS
|
|
5199
5285
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package to retrieve details for.
|
|
@@ -5203,7 +5289,8 @@ FLAGS
|
|
|
5203
5289
|
--verbose Display extended package version details.
|
|
5204
5290
|
|
|
5205
5291
|
GLOBAL FLAGS
|
|
5206
|
-
--
|
|
5292
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5293
|
+
--json Format output as json.
|
|
5207
5294
|
|
|
5208
5295
|
DESCRIPTION
|
|
5209
5296
|
Retrieve details about a package version in the Dev Hub org.
|
|
@@ -5224,7 +5311,7 @@ EXAMPLES
|
|
|
5224
5311
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
5225
5312
|
```
|
|
5226
5313
|
|
|
5227
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5314
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/version/report.ts)_
|
|
5228
5315
|
|
|
5229
5316
|
## `sf package version update`
|
|
5230
5317
|
|
|
@@ -5232,8 +5319,8 @@ Update a package version.
|
|
|
5232
5319
|
|
|
5233
5320
|
```
|
|
5234
5321
|
USAGE
|
|
5235
|
-
$ sf package version update -v <value> -p <value> [--json] [--
|
|
5236
|
-
[-t <value>] [-k <value>]
|
|
5322
|
+
$ sf package version update -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-a <value>] [-e
|
|
5323
|
+
<value>] [-b <value>] [-t <value>] [-k <value>]
|
|
5237
5324
|
|
|
5238
5325
|
FLAGS
|
|
5239
5326
|
-a, --version-name=<value> New package version name.
|
|
@@ -5247,7 +5334,8 @@ FLAGS
|
|
|
5247
5334
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
5248
5335
|
|
|
5249
5336
|
GLOBAL FLAGS
|
|
5250
|
-
--
|
|
5337
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5338
|
+
--json Format output as json.
|
|
5251
5339
|
|
|
5252
5340
|
DESCRIPTION
|
|
5253
5341
|
Update a package version.
|
|
@@ -5276,7 +5364,7 @@ EXAMPLES
|
|
|
5276
5364
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
5277
5365
|
```
|
|
5278
5366
|
|
|
5279
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5367
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.2.0/src/commands/package/version/update.ts)_
|
|
5280
5368
|
|
|
5281
5369
|
## `sf plugins`
|
|
5282
5370
|
|
|
@@ -5299,7 +5387,7 @@ EXAMPLES
|
|
|
5299
5387
|
$ sf plugins
|
|
5300
5388
|
```
|
|
5301
5389
|
|
|
5302
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0
|
|
5390
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0/src/commands/plugins/index.ts)_
|
|
5303
5391
|
|
|
5304
5392
|
## `sf plugins discover`
|
|
5305
5393
|
|
|
@@ -5307,16 +5395,17 @@ See a list of 3rd-party sf plugins you can install.
|
|
|
5307
5395
|
|
|
5308
5396
|
```
|
|
5309
5397
|
USAGE
|
|
5310
|
-
$ sf plugins discover [--json]
|
|
5398
|
+
$ sf plugins discover [--json] [--flags-dir <value>]
|
|
5311
5399
|
|
|
5312
5400
|
GLOBAL FLAGS
|
|
5313
|
-
--
|
|
5401
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5402
|
+
--json Format output as json.
|
|
5314
5403
|
|
|
5315
5404
|
EXAMPLES
|
|
5316
5405
|
$ sf plugins discover
|
|
5317
5406
|
```
|
|
5318
5407
|
|
|
5319
|
-
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.0
|
|
5408
|
+
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.1.0/src/commands/plugins/discover.ts)_
|
|
5320
5409
|
|
|
5321
5410
|
## `sf plugins:inspect PLUGIN...`
|
|
5322
5411
|
|
|
@@ -5343,7 +5432,7 @@ EXAMPLES
|
|
|
5343
5432
|
$ sf plugins inspect @salesforce/plugin-packaging
|
|
5344
5433
|
```
|
|
5345
5434
|
|
|
5346
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0
|
|
5435
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0/src/commands/plugins/inspect.ts)_
|
|
5347
5436
|
|
|
5348
5437
|
## `sf plugins install PLUGIN`
|
|
5349
5438
|
|
|
@@ -5392,7 +5481,7 @@ EXAMPLES
|
|
|
5392
5481
|
$ sf plugins install someuser/someplugin
|
|
5393
5482
|
```
|
|
5394
5483
|
|
|
5395
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0
|
|
5484
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0/src/commands/plugins/install.ts)_
|
|
5396
5485
|
|
|
5397
5486
|
## `sf plugins link PATH`
|
|
5398
5487
|
|
|
@@ -5422,7 +5511,7 @@ EXAMPLES
|
|
|
5422
5511
|
$ sf plugins link @salesforce/plugin-packaging
|
|
5423
5512
|
```
|
|
5424
5513
|
|
|
5425
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0
|
|
5514
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0/src/commands/plugins/link.ts)_
|
|
5426
5515
|
|
|
5427
5516
|
## `sf plugins reset`
|
|
5428
5517
|
|
|
@@ -5437,7 +5526,7 @@ FLAGS
|
|
|
5437
5526
|
--reinstall Reinstall all plugins after uninstalling.
|
|
5438
5527
|
```
|
|
5439
5528
|
|
|
5440
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0
|
|
5529
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0/src/commands/plugins/reset.ts)_
|
|
5441
5530
|
|
|
5442
5531
|
## `sf plugins trust verify`
|
|
5443
5532
|
|
|
@@ -5445,14 +5534,15 @@ Validate a digital signature.
|
|
|
5445
5534
|
|
|
5446
5535
|
```
|
|
5447
5536
|
USAGE
|
|
5448
|
-
$ sf plugins trust verify -n <value> [--json] [-r <value>]
|
|
5537
|
+
$ sf plugins trust verify -n <value> [--json] [--flags-dir <value>] [-r <value>]
|
|
5449
5538
|
|
|
5450
5539
|
FLAGS
|
|
5451
5540
|
-n, --npm=<value> (required) Specify the npm name. This can include a tag/version.
|
|
5452
5541
|
-r, --registry=<value> The registry name. The behavior is the same as npm.
|
|
5453
5542
|
|
|
5454
5543
|
GLOBAL FLAGS
|
|
5455
|
-
--
|
|
5544
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5545
|
+
--json Format output as json.
|
|
5456
5546
|
|
|
5457
5547
|
DESCRIPTION
|
|
5458
5548
|
Validate a digital signature.
|
|
@@ -5465,7 +5555,7 @@ EXAMPLES
|
|
|
5465
5555
|
$ sf plugins trust verify --npm @scope/npmName
|
|
5466
5556
|
```
|
|
5467
5557
|
|
|
5468
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.
|
|
5558
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.4.0/src/commands/plugins/trust/verify.ts)_
|
|
5469
5559
|
|
|
5470
5560
|
## `sf plugins uninstall [PLUGIN]`
|
|
5471
5561
|
|
|
@@ -5493,7 +5583,7 @@ EXAMPLES
|
|
|
5493
5583
|
$ sf plugins uninstall @salesforce/plugin-packaging
|
|
5494
5584
|
```
|
|
5495
5585
|
|
|
5496
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0
|
|
5586
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0/src/commands/plugins/uninstall.ts)_
|
|
5497
5587
|
|
|
5498
5588
|
## `sf plugins update`
|
|
5499
5589
|
|
|
@@ -5511,7 +5601,7 @@ DESCRIPTION
|
|
|
5511
5601
|
Update installed plugins.
|
|
5512
5602
|
```
|
|
5513
5603
|
|
|
5514
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0
|
|
5604
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.0.0/src/commands/plugins/update.ts)_
|
|
5515
5605
|
|
|
5516
5606
|
## `sf project convert mdapi`
|
|
5517
5607
|
|
|
@@ -5574,7 +5664,7 @@ FLAG DESCRIPTIONS
|
|
|
5574
5664
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5575
5665
|
```
|
|
5576
5666
|
|
|
5577
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5667
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/convert/mdapi.ts)_
|
|
5578
5668
|
|
|
5579
5669
|
## `sf project convert source`
|
|
5580
5670
|
|
|
@@ -5586,7 +5676,7 @@ USAGE
|
|
|
5586
5676
|
[-p <value> | -x <value> | -m <value>]
|
|
5587
5677
|
|
|
5588
5678
|
FLAGS
|
|
5589
|
-
-d, --output-dir=<value> [default:
|
|
5679
|
+
-d, --output-dir=<value> [default: metadataPackage_1711394913178] Output directory to store the Metadata
|
|
5590
5680
|
API–formatted files in.
|
|
5591
5681
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
5592
5682
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -5647,7 +5737,7 @@ FLAG DESCRIPTIONS
|
|
|
5647
5737
|
Override the api version used for api requests made by this command
|
|
5648
5738
|
```
|
|
5649
5739
|
|
|
5650
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5740
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/convert/source.ts)_
|
|
5651
5741
|
|
|
5652
5742
|
## `sf project delete source`
|
|
5653
5743
|
|
|
@@ -5787,7 +5877,7 @@ FLAG DESCRIPTIONS
|
|
|
5787
5877
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
5788
5878
|
```
|
|
5789
5879
|
|
|
5790
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5880
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/delete/source.ts)_
|
|
5791
5881
|
|
|
5792
5882
|
## `sf project delete tracking`
|
|
5793
5883
|
|
|
@@ -5824,7 +5914,7 @@ EXAMPLES
|
|
|
5824
5914
|
$ sf project delete tracking --target-org my-scratch
|
|
5825
5915
|
```
|
|
5826
5916
|
|
|
5827
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5917
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/delete/tracking.ts)_
|
|
5828
5918
|
|
|
5829
5919
|
## `sf project deploy cancel`
|
|
5830
5920
|
|
|
@@ -5832,13 +5922,14 @@ Cancel a deploy operation.
|
|
|
5832
5922
|
|
|
5833
5923
|
```
|
|
5834
5924
|
USAGE
|
|
5835
|
-
$ sf project deploy cancel [--json] [--flags-dir <value>] [--async | -w <value>] [-i <value>] [-r]
|
|
5925
|
+
$ sf project deploy cancel [--json] [--flags-dir <value>] [-o <value>] [--async | -w <value>] [-i <value>] [-r]
|
|
5836
5926
|
|
|
5837
5927
|
FLAGS
|
|
5838
|
-
-i, --job-id=<value>
|
|
5839
|
-
-
|
|
5840
|
-
-
|
|
5841
|
-
|
|
5928
|
+
-i, --job-id=<value> Job ID of the deploy operation you want to cancel.
|
|
5929
|
+
-o, --target-org=<value> Login username or alias for the target org.
|
|
5930
|
+
-r, --use-most-recent Use the job ID of the most recent deploy operation.
|
|
5931
|
+
-w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
|
|
5932
|
+
--async Run the command asynchronously.
|
|
5842
5933
|
|
|
5843
5934
|
GLOBAL FLAGS
|
|
5844
5935
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -5877,6 +5968,10 @@ FLAG DESCRIPTIONS
|
|
|
5877
5968
|
|
|
5878
5969
|
The job ID is valid for 10 days from when you started the deploy operation.
|
|
5879
5970
|
|
|
5971
|
+
-o, --target-org=<value> Login username or alias for the target org.
|
|
5972
|
+
|
|
5973
|
+
Overrides your default org.
|
|
5974
|
+
|
|
5880
5975
|
-r, --use-most-recent Use the job ID of the most recent deploy operation.
|
|
5881
5976
|
|
|
5882
5977
|
For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
|
|
@@ -5895,7 +5990,7 @@ FLAG DESCRIPTIONS
|
|
|
5895
5990
|
project deploy report".
|
|
5896
5991
|
```
|
|
5897
5992
|
|
|
5898
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5993
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/deploy/cancel.ts)_
|
|
5899
5994
|
|
|
5900
5995
|
## `sf project deploy preview`
|
|
5901
5996
|
|
|
@@ -5981,7 +6076,7 @@ FLAG DESCRIPTIONS
|
|
|
5981
6076
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
5982
6077
|
```
|
|
5983
6078
|
|
|
5984
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6079
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/deploy/preview.ts)_
|
|
5985
6080
|
|
|
5986
6081
|
## `sf project deploy quick`
|
|
5987
6082
|
|
|
@@ -6078,7 +6173,7 @@ ERROR CODES
|
|
|
6078
6173
|
Canceling (69) The deploy is being canceled.
|
|
6079
6174
|
```
|
|
6080
6175
|
|
|
6081
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6176
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/deploy/quick.ts)_
|
|
6082
6177
|
|
|
6083
6178
|
## `sf project deploy report`
|
|
6084
6179
|
|
|
@@ -6174,7 +6269,7 @@ FLAG DESCRIPTIONS
|
|
|
6174
6269
|
--coverage-formatters lcov --coverage-formatters clover
|
|
6175
6270
|
```
|
|
6176
6271
|
|
|
6177
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6272
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/deploy/report.ts)_
|
|
6178
6273
|
|
|
6179
6274
|
## `sf project deploy resume`
|
|
6180
6275
|
|
|
@@ -6271,7 +6366,7 @@ ERROR CODES
|
|
|
6271
6366
|
Canceling (69) The deploy is being canceled.
|
|
6272
6367
|
```
|
|
6273
6368
|
|
|
6274
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6369
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/deploy/resume.ts)_
|
|
6275
6370
|
|
|
6276
6371
|
## `sf project deploy start`
|
|
6277
6372
|
|
|
@@ -6509,7 +6604,7 @@ ERROR CODES
|
|
|
6509
6604
|
Canceling (69) The deploy is being canceled.
|
|
6510
6605
|
```
|
|
6511
6606
|
|
|
6512
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6607
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/deploy/start.ts)_
|
|
6513
6608
|
|
|
6514
6609
|
## `sf project deploy validate`
|
|
6515
6610
|
|
|
@@ -6701,7 +6796,7 @@ ERROR CODES
|
|
|
6701
6796
|
Canceling (69) The deploy is being canceled.
|
|
6702
6797
|
```
|
|
6703
6798
|
|
|
6704
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6799
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/deploy/validate.ts)_
|
|
6705
6800
|
|
|
6706
6801
|
## `sf project generate`
|
|
6707
6802
|
|
|
@@ -6709,8 +6804,8 @@ Generate a Salesforce DX project.
|
|
|
6709
6804
|
|
|
6710
6805
|
```
|
|
6711
6806
|
USAGE
|
|
6712
|
-
$ sf project generate -n <value> [--json] [-t standard|empty|analytics] [-d <value>] [-s
|
|
6713
|
-
[--api-version <value>]
|
|
6807
|
+
$ sf project generate -n <value> [--json] [--flags-dir <value>] [-t standard|empty|analytics] [-d <value>] [-s
|
|
6808
|
+
<value>] [-p <value>] [-x] [--api-version <value>]
|
|
6714
6809
|
|
|
6715
6810
|
FLAGS
|
|
6716
6811
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -6723,7 +6818,8 @@ FLAGS
|
|
|
6723
6818
|
--api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
|
|
6724
6819
|
|
|
6725
6820
|
GLOBAL FLAGS
|
|
6726
|
-
--
|
|
6821
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6822
|
+
--json Format output as json.
|
|
6727
6823
|
|
|
6728
6824
|
DESCRIPTION
|
|
6729
6825
|
Generate a Salesforce DX project.
|
|
@@ -6805,7 +6901,7 @@ FLAG DESCRIPTIONS
|
|
|
6805
6901
|
Override the api version used for api requests made by this command
|
|
6806
6902
|
```
|
|
6807
6903
|
|
|
6808
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
6904
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/project/generate.ts)_
|
|
6809
6905
|
|
|
6810
6906
|
## `sf project generate manifest`
|
|
6811
6907
|
|
|
@@ -6881,7 +6977,7 @@ EXAMPLES
|
|
|
6881
6977
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
6882
6978
|
```
|
|
6883
6979
|
|
|
6884
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6980
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/generate/manifest.ts)_
|
|
6885
6981
|
|
|
6886
6982
|
## `sf project list ignored`
|
|
6887
6983
|
|
|
@@ -6923,7 +7019,7 @@ EXAMPLES
|
|
|
6923
7019
|
$ sf project list ignored --source-dir package.xml
|
|
6924
7020
|
```
|
|
6925
7021
|
|
|
6926
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7022
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/list/ignored.ts)_
|
|
6927
7023
|
|
|
6928
7024
|
## `sf project reset tracking`
|
|
6929
7025
|
|
|
@@ -6972,7 +7068,7 @@ EXAMPLES
|
|
|
6972
7068
|
$ sf project reset tracking --revision 30
|
|
6973
7069
|
```
|
|
6974
7070
|
|
|
6975
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7071
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/reset/tracking.ts)_
|
|
6976
7072
|
|
|
6977
7073
|
## `sf project retrieve preview`
|
|
6978
7074
|
|
|
@@ -7029,7 +7125,7 @@ FLAG DESCRIPTIONS
|
|
|
7029
7125
|
Overrides your default org.
|
|
7030
7126
|
```
|
|
7031
7127
|
|
|
7032
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7128
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/retrieve/preview.ts)_
|
|
7033
7129
|
|
|
7034
7130
|
## `sf project retrieve start`
|
|
7035
7131
|
|
|
@@ -7188,7 +7284,7 @@ ENVIRONMENT VARIABLES
|
|
|
7188
7284
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
7189
7285
|
```
|
|
7190
7286
|
|
|
7191
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7287
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.4.0/src/commands/project/retrieve/start.ts)_
|
|
7192
7288
|
|
|
7193
7289
|
## `sf schema generate field`
|
|
7194
7290
|
|
|
@@ -7196,12 +7292,15 @@ Generate metadata source files for a new custom field on a specified object.
|
|
|
7196
7292
|
|
|
7197
7293
|
```
|
|
7198
7294
|
USAGE
|
|
7199
|
-
$ sf schema generate field -l <value> [-o <value>]
|
|
7295
|
+
$ sf schema generate field -l <value> [--flags-dir <value>] [-o <value>]
|
|
7200
7296
|
|
|
7201
7297
|
FLAGS
|
|
7202
7298
|
-l, --label=<value> (required) The field's label.
|
|
7203
7299
|
-o, --object=<value> The directory that contains the object's source files.
|
|
7204
7300
|
|
|
7301
|
+
GLOBAL FLAGS
|
|
7302
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7303
|
+
|
|
7205
7304
|
DESCRIPTION
|
|
7206
7305
|
Generate metadata source files for a new custom field on a specified object.
|
|
7207
7306
|
|
|
@@ -7239,7 +7338,7 @@ FLAG DESCRIPTIONS
|
|
|
7239
7338
|
If you don't specify this flag, the command prompts you to choose from your local objects.
|
|
7240
7339
|
```
|
|
7241
7340
|
|
|
7242
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.
|
|
7341
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.2.0/src/commands/schema/generate/field.ts)_
|
|
7243
7342
|
|
|
7244
7343
|
## `sf schema generate platformevent`
|
|
7245
7344
|
|
|
@@ -7247,11 +7346,14 @@ Generate metadata source files for a new platform event.
|
|
|
7247
7346
|
|
|
7248
7347
|
```
|
|
7249
7348
|
USAGE
|
|
7250
|
-
$ sf schema generate platformevent -l <value>
|
|
7349
|
+
$ sf schema generate platformevent -l <value> [--flags-dir <value>]
|
|
7251
7350
|
|
|
7252
7351
|
FLAGS
|
|
7253
7352
|
-l, --label=<value> (required) The platform event's label.
|
|
7254
7353
|
|
|
7354
|
+
GLOBAL FLAGS
|
|
7355
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7356
|
+
|
|
7255
7357
|
DESCRIPTION
|
|
7256
7358
|
Generate metadata source files for a new platform event.
|
|
7257
7359
|
|
|
@@ -7268,7 +7370,7 @@ EXAMPLES
|
|
|
7268
7370
|
$ sf schema generate platformevent --label "My Platform Event"
|
|
7269
7371
|
```
|
|
7270
7372
|
|
|
7271
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.
|
|
7373
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.2.0/src/commands/schema/generate/platformevent.ts)_
|
|
7272
7374
|
|
|
7273
7375
|
## `sf schema generate sobject`
|
|
7274
7376
|
|
|
@@ -7276,12 +7378,15 @@ Generate metadata source files for a new custom object.
|
|
|
7276
7378
|
|
|
7277
7379
|
```
|
|
7278
7380
|
USAGE
|
|
7279
|
-
$ sf schema generate sobject -l <value> [-f]
|
|
7381
|
+
$ sf schema generate sobject -l <value> [--flags-dir <value>] [-f]
|
|
7280
7382
|
|
|
7281
7383
|
FLAGS
|
|
7282
7384
|
-f, --use-default-features Enable all optional features without prompting.
|
|
7283
7385
|
-l, --label=<value> (required) The custom object's label.
|
|
7284
7386
|
|
|
7387
|
+
GLOBAL FLAGS
|
|
7388
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7389
|
+
|
|
7285
7390
|
DESCRIPTION
|
|
7286
7391
|
Generate metadata source files for a new custom object.
|
|
7287
7392
|
|
|
@@ -7322,7 +7427,7 @@ FLAG DESCRIPTIONS
|
|
|
7322
7427
|
- Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
|
|
7323
7428
|
```
|
|
7324
7429
|
|
|
7325
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.
|
|
7430
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.2.0/src/commands/schema/generate/sobject.ts)_
|
|
7326
7431
|
|
|
7327
7432
|
## `sf schema generate tab`
|
|
7328
7433
|
|
|
@@ -7330,7 +7435,7 @@ Generate the metadata source files for a new custom tab on a custom object.
|
|
|
7330
7435
|
|
|
7331
7436
|
```
|
|
7332
7437
|
USAGE
|
|
7333
|
-
$ sf schema generate tab -o <value> -d <value> -i <value> [--json]
|
|
7438
|
+
$ sf schema generate tab -o <value> -d <value> -i <value> [--json] [--flags-dir <value>]
|
|
7334
7439
|
|
|
7335
7440
|
FLAGS
|
|
7336
7441
|
-d, --directory=<value> (required) Path to a "tabs" directory that will contain the source files for your new tab.
|
|
@@ -7339,7 +7444,8 @@ FLAGS
|
|
|
7339
7444
|
-o, --object=<value> (required) API name of the custom object you're generating a tab for.
|
|
7340
7445
|
|
|
7341
7446
|
GLOBAL FLAGS
|
|
7342
|
-
--
|
|
7447
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7448
|
+
--json Format output as json.
|
|
7343
7449
|
|
|
7344
7450
|
DESCRIPTION
|
|
7345
7451
|
Generate the metadata source files for a new custom tab on a custom object.
|
|
@@ -7369,7 +7475,7 @@ FLAG DESCRIPTIONS
|
|
|
7369
7475
|
The API name for a custom object always ends in `__c`, such as `MyObject__c`.
|
|
7370
7476
|
```
|
|
7371
7477
|
|
|
7372
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.
|
|
7478
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.2.0/src/commands/schema/generate/tab.ts)_
|
|
7373
7479
|
|
|
7374
7480
|
## `sf search`
|
|
7375
7481
|
|
|
@@ -7393,7 +7499,7 @@ Display the metadata for a standard or custom object or a Tooling API object.
|
|
|
7393
7499
|
|
|
7394
7500
|
```
|
|
7395
7501
|
USAGE
|
|
7396
|
-
$ sf sobject describe -o <value> -s <value> [--json] [--api-version <value>] [-t]
|
|
7502
|
+
$ sf sobject describe -o <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t]
|
|
7397
7503
|
|
|
7398
7504
|
FLAGS
|
|
7399
7505
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -7403,7 +7509,8 @@ FLAGS
|
|
|
7403
7509
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
7404
7510
|
|
|
7405
7511
|
GLOBAL FLAGS
|
|
7406
|
-
--
|
|
7512
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7513
|
+
--json Format output as json.
|
|
7407
7514
|
|
|
7408
7515
|
DESCRIPTION
|
|
7409
7516
|
Display the metadata for a standard or custom object or a Tooling API object.
|
|
@@ -7431,7 +7538,7 @@ EXAMPLES
|
|
|
7431
7538
|
$ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
|
|
7432
7539
|
```
|
|
7433
7540
|
|
|
7434
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.
|
|
7541
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.2.0/src/commands/sobject/describe.ts)_
|
|
7435
7542
|
|
|
7436
7543
|
## `sf sobject list`
|
|
7437
7544
|
|
|
@@ -7439,7 +7546,7 @@ List all Salesforce objects of a specified category.
|
|
|
7439
7546
|
|
|
7440
7547
|
```
|
|
7441
7548
|
USAGE
|
|
7442
|
-
$ sf sobject list -o <value> [--json] [--api-version <value>] [-s <value>]
|
|
7549
|
+
$ sf sobject list -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-s <value>]
|
|
7443
7550
|
|
|
7444
7551
|
FLAGS
|
|
7445
7552
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -7448,7 +7555,8 @@ FLAGS
|
|
|
7448
7555
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
7449
7556
|
|
|
7450
7557
|
GLOBAL FLAGS
|
|
7451
|
-
--
|
|
7558
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7559
|
+
--json Format output as json.
|
|
7452
7560
|
|
|
7453
7561
|
DESCRIPTION
|
|
7454
7562
|
List all Salesforce objects of a specified category.
|
|
@@ -7469,7 +7577,7 @@ EXAMPLES
|
|
|
7469
7577
|
$ sf sobject list --sobject custom --target-org my-scratch-org
|
|
7470
7578
|
```
|
|
7471
7579
|
|
|
7472
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.
|
|
7580
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.2.0/src/commands/sobject/list.ts)_
|
|
7473
7581
|
|
|
7474
7582
|
## `sf static-resource generate`
|
|
7475
7583
|
|
|
@@ -7477,7 +7585,8 @@ Generate a static resource.
|
|
|
7477
7585
|
|
|
7478
7586
|
```
|
|
7479
7587
|
USAGE
|
|
7480
|
-
$ sf static-resource generate -n <value> [--json] [--type <value>] [-d <value>] [--api-version
|
|
7588
|
+
$ sf static-resource generate -n <value> [--json] [--flags-dir <value>] [--type <value>] [-d <value>] [--api-version
|
|
7589
|
+
<value>]
|
|
7481
7590
|
|
|
7482
7591
|
FLAGS
|
|
7483
7592
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -7486,7 +7595,8 @@ FLAGS
|
|
|
7486
7595
|
--type=<value> [default: application/zip] Content type (mime type) of the generated static resource.
|
|
7487
7596
|
|
|
7488
7597
|
GLOBAL FLAGS
|
|
7489
|
-
--
|
|
7598
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7599
|
+
--json Format output as json.
|
|
7490
7600
|
|
|
7491
7601
|
DESCRIPTION
|
|
7492
7602
|
Generate a static resource.
|
|
@@ -7529,7 +7639,7 @@ FLAG DESCRIPTIONS
|
|
|
7529
7639
|
etc.
|
|
7530
7640
|
```
|
|
7531
7641
|
|
|
7532
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
7642
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/static-resource/generate.ts)_
|
|
7533
7643
|
|
|
7534
7644
|
## `sf update [CHANNEL]`
|
|
7535
7645
|
|
|
@@ -7566,7 +7676,7 @@ EXAMPLES
|
|
|
7566
7676
|
$ sf update --available
|
|
7567
7677
|
```
|
|
7568
7678
|
|
|
7569
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.2.
|
|
7679
|
+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.2.2/src/commands/update.ts)_
|
|
7570
7680
|
|
|
7571
7681
|
## `sf version`
|
|
7572
7682
|
|
|
@@ -7586,7 +7696,7 @@ FLAG DESCRIPTIONS
|
|
|
7586
7696
|
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
|
|
7587
7697
|
```
|
|
7588
7698
|
|
|
7589
|
-
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.0.
|
|
7699
|
+
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.0.16/src/commands/version.ts)_
|
|
7590
7700
|
|
|
7591
7701
|
## `sf visualforce generate component`
|
|
7592
7702
|
|
|
@@ -7594,8 +7704,8 @@ Generate a Visualforce Component.
|
|
|
7594
7704
|
|
|
7595
7705
|
```
|
|
7596
7706
|
USAGE
|
|
7597
|
-
$ sf visualforce generate component -n <value> -l <value> [--json] [-t DefaultVFComponent] [-d <value>]
|
|
7598
|
-
|
|
7707
|
+
$ sf visualforce generate component -n <value> -l <value> [--json] [--flags-dir <value>] [-t DefaultVFComponent] [-d <value>]
|
|
7708
|
+
[--api-version <value>]
|
|
7599
7709
|
|
|
7600
7710
|
FLAGS
|
|
7601
7711
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -7606,7 +7716,8 @@ FLAGS
|
|
|
7606
7716
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
7607
7717
|
|
|
7608
7718
|
GLOBAL FLAGS
|
|
7609
|
-
--
|
|
7719
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7720
|
+
--json Format output as json.
|
|
7610
7721
|
|
|
7611
7722
|
DESCRIPTION
|
|
7612
7723
|
Generate a Visualforce Component.
|
|
@@ -7641,7 +7752,7 @@ FLAG DESCRIPTIONS
|
|
|
7641
7752
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
7642
7753
|
```
|
|
7643
7754
|
|
|
7644
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
7755
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/visualforce/generate/component.ts)_
|
|
7645
7756
|
|
|
7646
7757
|
## `sf visualforce generate page`
|
|
7647
7758
|
|
|
@@ -7649,7 +7760,8 @@ Generate a Visualforce Page.
|
|
|
7649
7760
|
|
|
7650
7761
|
```
|
|
7651
7762
|
USAGE
|
|
7652
|
-
$ sf visualforce generate page -n <value> -l <value> [--json] [-
|
|
7763
|
+
$ sf visualforce generate page -n <value> -l <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version
|
|
7764
|
+
<value>]
|
|
7653
7765
|
|
|
7654
7766
|
FLAGS
|
|
7655
7767
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -7658,7 +7770,8 @@ FLAGS
|
|
|
7658
7770
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
7659
7771
|
|
|
7660
7772
|
GLOBAL FLAGS
|
|
7661
|
-
--
|
|
7773
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7774
|
+
--json Format output as json.
|
|
7662
7775
|
|
|
7663
7776
|
DESCRIPTION
|
|
7664
7777
|
Generate a Visualforce Page.
|
|
@@ -7689,7 +7802,7 @@ FLAG DESCRIPTIONS
|
|
|
7689
7802
|
The name can be up to 40 characters and must start with a letter.
|
|
7690
7803
|
```
|
|
7691
7804
|
|
|
7692
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0
|
|
7805
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.1.0/src/commands/visualforce/generate/page.ts)_
|
|
7693
7806
|
|
|
7694
7807
|
## `sf which`
|
|
7695
7808
|
|
|
@@ -7711,6 +7824,6 @@ EXAMPLES
|
|
|
7711
7824
|
$ sf which help
|
|
7712
7825
|
```
|
|
7713
7826
|
|
|
7714
|
-
_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.1.
|
|
7827
|
+
_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.1.7/src/commands/which.ts)_
|
|
7715
7828
|
|
|
7716
7829
|
<!-- commandsstop -->
|