@salesforce/cli 2.123.1 → 2.124.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +161 -78
- package/npm-shrinkwrap.json +77 -107
- package/oclif.lock +78 -90
- package/oclif.manifest.json +1 -1
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli
|
|
|
25
25
|
$ sf COMMAND
|
|
26
26
|
running command...
|
|
27
27
|
$ sf (--version|-v)
|
|
28
|
-
@salesforce/cli/2.
|
|
28
|
+
@salesforce/cli/2.124.1 linux-x64 node-v22.22.0
|
|
29
29
|
$ sf --help [COMMAND]
|
|
30
30
|
USAGE
|
|
31
31
|
$ sf COMMAND
|
|
@@ -203,6 +203,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
203
203
|
- [`sf template generate apex class`](#sf-template-generate-apex-class)
|
|
204
204
|
- [`sf template generate apex trigger`](#sf-template-generate-apex-trigger)
|
|
205
205
|
- [`sf template generate digital-experience site`](#sf-template-generate-digital-experience-site)
|
|
206
|
+
- [`sf template generate flexipage`](#sf-template-generate-flexipage)
|
|
206
207
|
- [`sf template generate lightning app`](#sf-template-generate-lightning-app)
|
|
207
208
|
- [`sf template generate lightning component`](#sf-template-generate-lightning-component)
|
|
208
209
|
- [`sf template generate lightning event`](#sf-template-generate-lightning-event)
|
|
@@ -1354,7 +1355,7 @@ EXAMPLES
|
|
|
1354
1355
|
$ sf alias list
|
|
1355
1356
|
```
|
|
1356
1357
|
|
|
1357
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
1358
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/alias/list.ts)_
|
|
1358
1359
|
|
|
1359
1360
|
## `sf alias set`
|
|
1360
1361
|
|
|
@@ -1403,7 +1404,7 @@ EXAMPLES
|
|
|
1403
1404
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
1404
1405
|
```
|
|
1405
1406
|
|
|
1406
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
1407
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/alias/set.ts)_
|
|
1407
1408
|
|
|
1408
1409
|
## `sf alias unset`
|
|
1409
1410
|
|
|
@@ -1443,7 +1444,7 @@ EXAMPLES
|
|
|
1443
1444
|
$ sf alias unset --all [--no-prompt]
|
|
1444
1445
|
```
|
|
1445
1446
|
|
|
1446
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
1447
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/alias/unset.ts)_
|
|
1447
1448
|
|
|
1448
1449
|
## `sf apex get log`
|
|
1449
1450
|
|
|
@@ -1499,7 +1500,7 @@ FLAG DESCRIPTIONS
|
|
|
1499
1500
|
directory.
|
|
1500
1501
|
```
|
|
1501
1502
|
|
|
1502
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
1503
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/get/log.ts)_
|
|
1503
1504
|
|
|
1504
1505
|
## `sf apex get test`
|
|
1505
1506
|
|
|
@@ -1559,7 +1560,7 @@ EXAMPLES
|
|
|
1559
1560
|
me@myorg'
|
|
1560
1561
|
```
|
|
1561
1562
|
|
|
1562
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
1563
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/get/test.ts)_
|
|
1563
1564
|
|
|
1564
1565
|
## `sf apex list log`
|
|
1565
1566
|
|
|
@@ -1599,7 +1600,7 @@ EXAMPLES
|
|
|
1599
1600
|
$ sf apex list log --target-org me@my.org
|
|
1600
1601
|
```
|
|
1601
1602
|
|
|
1602
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
1603
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/list/log.ts)_
|
|
1603
1604
|
|
|
1604
1605
|
## `sf apex run`
|
|
1605
1606
|
|
|
@@ -1646,7 +1647,7 @@ EXAMPLES
|
|
|
1646
1647
|
$ sf apex run
|
|
1647
1648
|
```
|
|
1648
1649
|
|
|
1649
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
1650
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/run.ts)_
|
|
1650
1651
|
|
|
1651
1652
|
## `sf apex run test`
|
|
1652
1653
|
|
|
@@ -1793,7 +1794,7 @@ FLAG DESCRIPTIONS
|
|
|
1793
1794
|
--tests Test1 --tests Test2
|
|
1794
1795
|
```
|
|
1795
1796
|
|
|
1796
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
1797
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/run/test.ts)_
|
|
1797
1798
|
|
|
1798
1799
|
## `sf apex tail log`
|
|
1799
1800
|
|
|
@@ -1836,7 +1837,7 @@ EXAMPLES
|
|
|
1836
1837
|
$ sf apex tail log --color --skip-trace-flag
|
|
1837
1838
|
```
|
|
1838
1839
|
|
|
1839
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
1840
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/tail/log.ts)_
|
|
1840
1841
|
|
|
1841
1842
|
## `sf api request graphql`
|
|
1842
1843
|
|
|
@@ -1889,7 +1890,7 @@ EXAMPLES
|
|
|
1889
1890
|
$ sf api request graphql --body example.txt --stream-to-file output.txt --include
|
|
1890
1891
|
```
|
|
1891
1892
|
|
|
1892
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
1893
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.10/src/commands/api/request/graphql.ts)_
|
|
1893
1894
|
|
|
1894
1895
|
## `sf api request rest [URL]`
|
|
1895
1896
|
|
|
@@ -1998,7 +1999,7 @@ FLAG DESCRIPTIONS
|
|
|
1998
1999
|
https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
|
|
1999
2000
|
```
|
|
2000
2001
|
|
|
2001
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
2002
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.10/src/commands/api/request/rest.ts)_
|
|
2002
2003
|
|
|
2003
2004
|
## `sf autocomplete [SHELL]`
|
|
2004
2005
|
|
|
@@ -2107,7 +2108,7 @@ CONFIGURATION VARIABLES
|
|
|
2107
2108
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
2108
2109
|
```
|
|
2109
2110
|
|
|
2110
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2111
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/config/get.ts)_
|
|
2111
2112
|
|
|
2112
2113
|
## `sf config list`
|
|
2113
2114
|
|
|
@@ -2147,7 +2148,7 @@ EXAMPLES
|
|
|
2147
2148
|
$ sf config list
|
|
2148
2149
|
```
|
|
2149
2150
|
|
|
2150
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2151
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/config/list.ts)_
|
|
2151
2152
|
|
|
2152
2153
|
## `sf config set`
|
|
2153
2154
|
|
|
@@ -2216,7 +2217,7 @@ CONFIGURATION VARIABLES
|
|
|
2216
2217
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
2217
2218
|
```
|
|
2218
2219
|
|
|
2219
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2220
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/config/set.ts)_
|
|
2220
2221
|
|
|
2221
2222
|
## `sf config unset`
|
|
2222
2223
|
|
|
@@ -2266,7 +2267,7 @@ CONFIGURATION VARIABLES
|
|
|
2266
2267
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
2267
2268
|
```
|
|
2268
2269
|
|
|
2269
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2270
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/config/unset.ts)_
|
|
2270
2271
|
|
|
2271
2272
|
## `sf data bulk results`
|
|
2272
2273
|
|
|
@@ -2311,7 +2312,7 @@ EXAMPLES
|
|
|
2311
2312
|
$ sf data bulk results --job-id 7507i000fake341G --target-org my-scratch
|
|
2312
2313
|
```
|
|
2313
2314
|
|
|
2314
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2315
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/bulk/results.ts)_
|
|
2315
2316
|
|
|
2316
2317
|
## `sf data create file`
|
|
2317
2318
|
|
|
@@ -2360,7 +2361,7 @@ EXAMPLES
|
|
|
2360
2361
|
$ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
|
|
2361
2362
|
```
|
|
2362
2363
|
|
|
2363
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2364
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/create/file.ts)_
|
|
2364
2365
|
|
|
2365
2366
|
## `sf data create record`
|
|
2366
2367
|
|
|
@@ -2416,7 +2417,7 @@ EXAMPLES
|
|
|
2416
2417
|
TracedEntityId=01p17000000R6bLAAS"
|
|
2417
2418
|
```
|
|
2418
2419
|
|
|
2419
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2420
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/create/record.ts)_
|
|
2420
2421
|
|
|
2421
2422
|
## `sf data delete bulk`
|
|
2422
2423
|
|
|
@@ -2475,7 +2476,7 @@ FLAG DESCRIPTIONS
|
|
|
2475
2476
|
and can be enabled only by a system administrator.
|
|
2476
2477
|
```
|
|
2477
2478
|
|
|
2478
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2479
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/delete/bulk.ts)_
|
|
2479
2480
|
|
|
2480
2481
|
## `sf data delete record`
|
|
2481
2482
|
|
|
@@ -2536,7 +2537,7 @@ EXAMPLES
|
|
|
2536
2537
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
2537
2538
|
```
|
|
2538
2539
|
|
|
2539
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2540
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/delete/record.ts)_
|
|
2540
2541
|
|
|
2541
2542
|
## `sf data delete resume`
|
|
2542
2543
|
|
|
@@ -2575,7 +2576,7 @@ EXAMPLES
|
|
|
2575
2576
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
2576
2577
|
```
|
|
2577
2578
|
|
|
2578
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2579
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/delete/resume.ts)_
|
|
2579
2580
|
|
|
2580
2581
|
## `sf data export bulk`
|
|
2581
2582
|
|
|
@@ -2642,7 +2643,7 @@ EXAMPLES
|
|
|
2642
2643
|
--result-format json --wait 10 --all-rows
|
|
2643
2644
|
```
|
|
2644
2645
|
|
|
2645
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2646
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/export/bulk.ts)_
|
|
2646
2647
|
|
|
2647
2648
|
## `sf data export resume`
|
|
2648
2649
|
|
|
@@ -2681,7 +2682,7 @@ EXAMPLES
|
|
|
2681
2682
|
$ sf data export resume --use-most-recent
|
|
2682
2683
|
```
|
|
2683
2684
|
|
|
2684
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2685
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/export/resume.ts)_
|
|
2685
2686
|
|
|
2686
2687
|
## `sf data export tree`
|
|
2687
2688
|
|
|
@@ -2741,7 +2742,7 @@ EXAMPLES
|
|
|
2741
2742
|
my-scratch
|
|
2742
2743
|
```
|
|
2743
2744
|
|
|
2744
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2745
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/export/tree.ts)_
|
|
2745
2746
|
|
|
2746
2747
|
## `sf data get record`
|
|
2747
2748
|
|
|
@@ -2805,7 +2806,7 @@ EXAMPLES
|
|
|
2805
2806
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
2806
2807
|
```
|
|
2807
2808
|
|
|
2808
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2809
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/get/record.ts)_
|
|
2809
2810
|
|
|
2810
2811
|
## `sf data import bulk`
|
|
2811
2812
|
|
|
@@ -2857,7 +2858,7 @@ EXAMPLES
|
|
|
2857
2858
|
$ sf data import bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
|
|
2858
2859
|
```
|
|
2859
2860
|
|
|
2860
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2861
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/import/bulk.ts)_
|
|
2861
2862
|
|
|
2862
2863
|
## `sf data import resume`
|
|
2863
2864
|
|
|
@@ -2893,7 +2894,7 @@ EXAMPLES
|
|
|
2893
2894
|
$ sf data import resume --use-most-recent --target-org my-scratch
|
|
2894
2895
|
```
|
|
2895
2896
|
|
|
2896
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2897
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/import/resume.ts)_
|
|
2897
2898
|
|
|
2898
2899
|
## `sf data import tree`
|
|
2899
2900
|
|
|
@@ -2957,7 +2958,7 @@ FLAG DESCRIPTIONS
|
|
|
2957
2958
|
- files(array) - Files: An array of files paths to load
|
|
2958
2959
|
```
|
|
2959
2960
|
|
|
2960
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2961
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/import/tree.ts)_
|
|
2961
2962
|
|
|
2962
2963
|
## `sf data query`
|
|
2963
2964
|
|
|
@@ -3010,7 +3011,7 @@ EXAMPLES
|
|
|
3010
3011
|
$ sf data query --query "SELECT Name FROM ApexTrigger" --use-tooling-api
|
|
3011
3012
|
```
|
|
3012
3013
|
|
|
3013
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3014
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/query.ts)_
|
|
3014
3015
|
|
|
3015
3016
|
## `sf data resume`
|
|
3016
3017
|
|
|
@@ -3047,7 +3048,7 @@ EXAMPLES
|
|
|
3047
3048
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
3048
3049
|
```
|
|
3049
3050
|
|
|
3050
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3051
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/resume.ts)_
|
|
3051
3052
|
|
|
3052
3053
|
## `sf data search`
|
|
3053
3054
|
|
|
@@ -3097,7 +3098,7 @@ EXAMPLES
|
|
|
3097
3098
|
$ sf data search --file query.txt --target-org my-scratch --result-format csv
|
|
3098
3099
|
```
|
|
3099
3100
|
|
|
3100
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3101
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/search.ts)_
|
|
3101
3102
|
|
|
3102
3103
|
## `sf data update bulk`
|
|
3103
3104
|
|
|
@@ -3152,7 +3153,7 @@ EXAMPLES
|
|
|
3152
3153
|
$ sf data update bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
|
|
3153
3154
|
```
|
|
3154
3155
|
|
|
3155
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3156
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/update/bulk.ts)_
|
|
3156
3157
|
|
|
3157
3158
|
## `sf data update record`
|
|
3158
3159
|
|
|
@@ -3214,7 +3215,7 @@ EXAMPLES
|
|
|
3214
3215
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
3215
3216
|
```
|
|
3216
3217
|
|
|
3217
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3218
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/update/record.ts)_
|
|
3218
3219
|
|
|
3219
3220
|
## `sf data update resume`
|
|
3220
3221
|
|
|
@@ -3253,7 +3254,7 @@ EXAMPLES
|
|
|
3253
3254
|
$ sf data update resume --use-most-recent
|
|
3254
3255
|
```
|
|
3255
3256
|
|
|
3256
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3257
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/update/resume.ts)_
|
|
3257
3258
|
|
|
3258
3259
|
## `sf data upsert bulk`
|
|
3259
3260
|
|
|
@@ -3309,7 +3310,7 @@ EXAMPLES
|
|
|
3309
3310
|
my-scratch
|
|
3310
3311
|
```
|
|
3311
3312
|
|
|
3312
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3313
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/upsert/bulk.ts)_
|
|
3313
3314
|
|
|
3314
3315
|
## `sf data upsert resume`
|
|
3315
3316
|
|
|
@@ -3348,7 +3349,7 @@ EXAMPLES
|
|
|
3348
3349
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
3349
3350
|
```
|
|
3350
3351
|
|
|
3351
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3352
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/upsert/resume.ts)_
|
|
3352
3353
|
|
|
3353
3354
|
## `sf doctor`
|
|
3354
3355
|
|
|
@@ -3396,7 +3397,7 @@ EXAMPLES
|
|
|
3396
3397
|
$ sf doctor --plugin @salesforce/plugin-source
|
|
3397
3398
|
```
|
|
3398
3399
|
|
|
3399
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.
|
|
3400
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.103/src/commands/doctor.ts)_
|
|
3400
3401
|
|
|
3401
3402
|
## `sf force data bulk delete`
|
|
3402
3403
|
|
|
@@ -3443,7 +3444,7 @@ EXAMPLES
|
|
|
3443
3444
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
3444
3445
|
```
|
|
3445
3446
|
|
|
3446
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3447
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/force/data/bulk/delete.ts)_
|
|
3447
3448
|
|
|
3448
3449
|
## `sf force data bulk status`
|
|
3449
3450
|
|
|
@@ -3480,7 +3481,7 @@ EXAMPLES
|
|
|
3480
3481
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
3481
3482
|
```
|
|
3482
3483
|
|
|
3483
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3484
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/force/data/bulk/status.ts)_
|
|
3484
3485
|
|
|
3485
3486
|
## `sf force data bulk upsert`
|
|
3486
3487
|
|
|
@@ -3538,7 +3539,7 @@ EXAMPLES
|
|
|
3538
3539
|
--target-org my-scratch
|
|
3539
3540
|
```
|
|
3540
3541
|
|
|
3541
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3542
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/force/data/bulk/upsert.ts)_
|
|
3542
3543
|
|
|
3543
3544
|
## `sf help [COMMAND]`
|
|
3544
3545
|
|
|
@@ -3598,7 +3599,7 @@ EXAMPLES
|
|
|
3598
3599
|
$ sf info releasenotes display --version latest
|
|
3599
3600
|
```
|
|
3600
3601
|
|
|
3601
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.
|
|
3602
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.103/src/commands/info/releasenotes/display.ts)_
|
|
3602
3603
|
|
|
3603
3604
|
## `sf logic get test`
|
|
3604
3605
|
|
|
@@ -3646,7 +3647,7 @@ EXAMPLES
|
|
|
3646
3647
|
$ sf logic get test --test-run-id <test run id> --result-format junit --target-org my-scratch
|
|
3647
3648
|
```
|
|
3648
3649
|
|
|
3649
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
3650
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/logic/get/test.ts)_
|
|
3650
3651
|
|
|
3651
3652
|
## `sf logic run test`
|
|
3652
3653
|
|
|
@@ -3768,7 +3769,7 @@ FLAG DESCRIPTIONS
|
|
|
3768
3769
|
--tests Test1 --tests Test2
|
|
3769
3770
|
```
|
|
3770
3771
|
|
|
3771
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
3772
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/logic/run/test.ts)_
|
|
3772
3773
|
|
|
3773
3774
|
## `sf org assign permset`
|
|
3774
3775
|
|
|
@@ -4718,7 +4719,7 @@ EXAMPLES
|
|
|
4718
4719
|
$ sf org list limits --target-org my-scratch-org
|
|
4719
4720
|
```
|
|
4720
4721
|
|
|
4721
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.
|
|
4722
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.76/src/commands/org/list/limits.ts)_
|
|
4722
4723
|
|
|
4723
4724
|
## `sf org list metadata`
|
|
4724
4725
|
|
|
@@ -4886,7 +4887,7 @@ EXAMPLES
|
|
|
4886
4887
|
$ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
|
|
4887
4888
|
```
|
|
4888
4889
|
|
|
4889
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.
|
|
4890
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.76/src/commands/org/list/sobject/record-counts.ts)_
|
|
4890
4891
|
|
|
4891
4892
|
## `sf org list users`
|
|
4892
4893
|
|
|
@@ -7673,7 +7674,7 @@ FLAG DESCRIPTIONS
|
|
|
7673
7674
|
If you specify this flag, don’t specify --metadata or --source-dir.
|
|
7674
7675
|
```
|
|
7675
7676
|
|
|
7676
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7677
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/convert/mdapi.ts)_
|
|
7677
7678
|
|
|
7678
7679
|
## `sf project convert source`
|
|
7679
7680
|
|
|
@@ -7746,7 +7747,7 @@ FLAG DESCRIPTIONS
|
|
|
7746
7747
|
Override the api version used for api requests made by this command
|
|
7747
7748
|
```
|
|
7748
7749
|
|
|
7749
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7750
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/convert/source.ts)_
|
|
7750
7751
|
|
|
7751
7752
|
## `sf project convert source-behavior`
|
|
7752
7753
|
|
|
@@ -7805,7 +7806,7 @@ EXAMPLES
|
|
|
7805
7806
|
$ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
|
|
7806
7807
|
```
|
|
7807
7808
|
|
|
7808
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7809
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/convert/source-behavior.ts)_
|
|
7809
7810
|
|
|
7810
7811
|
## `sf project delete source`
|
|
7811
7812
|
|
|
@@ -7958,7 +7959,7 @@ FLAG DESCRIPTIONS
|
|
|
7958
7959
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
7959
7960
|
```
|
|
7960
7961
|
|
|
7961
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7962
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/delete/source.ts)_
|
|
7962
7963
|
|
|
7963
7964
|
## `sf project delete tracking`
|
|
7964
7965
|
|
|
@@ -7995,7 +7996,7 @@ EXAMPLES
|
|
|
7995
7996
|
$ sf project delete tracking --target-org my-scratch
|
|
7996
7997
|
```
|
|
7997
7998
|
|
|
7998
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7999
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/delete/tracking.ts)_
|
|
7999
8000
|
|
|
8000
8001
|
## `sf project deploy cancel`
|
|
8001
8002
|
|
|
@@ -8067,7 +8068,7 @@ FLAG DESCRIPTIONS
|
|
|
8067
8068
|
project deploy report".
|
|
8068
8069
|
```
|
|
8069
8070
|
|
|
8070
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8071
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/cancel.ts)_
|
|
8071
8072
|
|
|
8072
8073
|
## `sf project deploy preview`
|
|
8073
8074
|
|
|
@@ -8150,7 +8151,7 @@ FLAG DESCRIPTIONS
|
|
|
8150
8151
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
8151
8152
|
```
|
|
8152
8153
|
|
|
8153
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8154
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/preview.ts)_
|
|
8154
8155
|
|
|
8155
8156
|
## `sf project deploy quick`
|
|
8156
8157
|
|
|
@@ -8243,7 +8244,7 @@ ERROR CODES
|
|
|
8243
8244
|
Canceling (69) The deploy is being canceled.
|
|
8244
8245
|
```
|
|
8245
8246
|
|
|
8246
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8247
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/quick.ts)_
|
|
8247
8248
|
|
|
8248
8249
|
## `sf project deploy report`
|
|
8249
8250
|
|
|
@@ -8335,7 +8336,7 @@ FLAG DESCRIPTIONS
|
|
|
8335
8336
|
--coverage-formatters lcov --coverage-formatters clover
|
|
8336
8337
|
```
|
|
8337
8338
|
|
|
8338
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8339
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/report.ts)_
|
|
8339
8340
|
|
|
8340
8341
|
## `sf project deploy resume`
|
|
8341
8342
|
|
|
@@ -8432,7 +8433,7 @@ ERROR CODES
|
|
|
8432
8433
|
Canceling (69) The deploy is being canceled.
|
|
8433
8434
|
```
|
|
8434
8435
|
|
|
8435
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8436
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/resume.ts)_
|
|
8436
8437
|
|
|
8437
8438
|
## `sf project deploy start`
|
|
8438
8439
|
|
|
@@ -8698,7 +8699,7 @@ ERROR CODES
|
|
|
8698
8699
|
Canceling (69) The deploy is being canceled.
|
|
8699
8700
|
```
|
|
8700
8701
|
|
|
8701
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8702
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/start.ts)_
|
|
8702
8703
|
|
|
8703
8704
|
## `sf project deploy validate`
|
|
8704
8705
|
|
|
@@ -8902,7 +8903,7 @@ ERROR CODES
|
|
|
8902
8903
|
Canceling (69) The deploy is being canceled.
|
|
8903
8904
|
```
|
|
8904
8905
|
|
|
8905
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8906
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/validate.ts)_
|
|
8906
8907
|
|
|
8907
8908
|
## `sf project generate manifest`
|
|
8908
8909
|
|
|
@@ -8998,7 +8999,7 @@ EXAMPLES
|
|
|
8998
8999
|
$ sf project generate manifest --from-org test@myorg.com --excluded-metadata StandardValueSet
|
|
8999
9000
|
```
|
|
9000
9001
|
|
|
9001
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9002
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/generate/manifest.ts)_
|
|
9002
9003
|
|
|
9003
9004
|
## `sf project list ignored`
|
|
9004
9005
|
|
|
@@ -9040,7 +9041,7 @@ EXAMPLES
|
|
|
9040
9041
|
$ sf project list ignored --source-dir package.xml
|
|
9041
9042
|
```
|
|
9042
9043
|
|
|
9043
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9044
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/list/ignored.ts)_
|
|
9044
9045
|
|
|
9045
9046
|
## `sf project reset tracking`
|
|
9046
9047
|
|
|
@@ -9089,7 +9090,7 @@ EXAMPLES
|
|
|
9089
9090
|
$ sf project reset tracking --revision 30
|
|
9090
9091
|
```
|
|
9091
9092
|
|
|
9092
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9093
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/reset/tracking.ts)_
|
|
9093
9094
|
|
|
9094
9095
|
## `sf project retrieve preview`
|
|
9095
9096
|
|
|
@@ -9143,7 +9144,7 @@ FLAG DESCRIPTIONS
|
|
|
9143
9144
|
production orgs.
|
|
9144
9145
|
```
|
|
9145
9146
|
|
|
9146
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9147
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/retrieve/preview.ts)_
|
|
9147
9148
|
|
|
9148
9149
|
## `sf project retrieve start`
|
|
9149
9150
|
|
|
@@ -9324,7 +9325,7 @@ ENVIRONMENT VARIABLES
|
|
|
9324
9325
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
9325
9326
|
```
|
|
9326
9327
|
|
|
9327
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9328
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/retrieve/start.ts)_
|
|
9328
9329
|
|
|
9329
9330
|
## `sf schema generate field`
|
|
9330
9331
|
|
|
@@ -9578,7 +9579,7 @@ EXAMPLES
|
|
|
9578
9579
|
$ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
|
|
9579
9580
|
```
|
|
9580
9581
|
|
|
9581
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.
|
|
9582
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.92/src/commands/sobject/describe.ts)_
|
|
9582
9583
|
|
|
9583
9584
|
## `sf sobject list`
|
|
9584
9585
|
|
|
@@ -9617,7 +9618,7 @@ EXAMPLES
|
|
|
9617
9618
|
$ sf sobject list --sobject custom --target-org my-scratch-org
|
|
9618
9619
|
```
|
|
9619
9620
|
|
|
9620
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.
|
|
9621
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.92/src/commands/sobject/list.ts)_
|
|
9621
9622
|
|
|
9622
9623
|
## `sf template generate analytics template`
|
|
9623
9624
|
|
|
@@ -9661,7 +9662,7 @@ FLAG DESCRIPTIONS
|
|
|
9661
9662
|
directory.
|
|
9662
9663
|
```
|
|
9663
9664
|
|
|
9664
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
9665
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/analytics/template.ts)_
|
|
9665
9666
|
|
|
9666
9667
|
## `sf template generate apex class`
|
|
9667
9668
|
|
|
@@ -9721,7 +9722,7 @@ FLAG DESCRIPTIONS
|
|
|
9721
9722
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
9722
9723
|
```
|
|
9723
9724
|
|
|
9724
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
9725
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/apex/class.ts)_
|
|
9725
9726
|
|
|
9726
9727
|
## `sf template generate apex trigger`
|
|
9727
9728
|
|
|
@@ -9791,7 +9792,7 @@ FLAG DESCRIPTIONS
|
|
|
9791
9792
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
9792
9793
|
```
|
|
9793
9794
|
|
|
9794
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
9795
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/apex/trigger.ts)_
|
|
9795
9796
|
|
|
9796
9797
|
## `sf template generate digital-experience site`
|
|
9797
9798
|
|
|
@@ -9841,7 +9842,89 @@ FLAG DESCRIPTIONS
|
|
|
9841
9842
|
project, defaults to the current directory.
|
|
9842
9843
|
```
|
|
9843
9844
|
|
|
9844
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
9845
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/digital-experience/site.ts)_
|
|
9846
|
+
|
|
9847
|
+
## `sf template generate flexipage`
|
|
9848
|
+
|
|
9849
|
+
Generate a FlexiPage, also known as a Lightning page.
|
|
9850
|
+
|
|
9851
|
+
```
|
|
9852
|
+
USAGE
|
|
9853
|
+
$ sf template generate flexipage -n <value> -t RecordPage|AppPage|HomePage [--json] [--flags-dir <value>] [-d <value>]
|
|
9854
|
+
[--api-version <value>] [--label <value>] [--description <value>] [-s <value>] [--primary-field <value>]
|
|
9855
|
+
[--secondary-fields <value>...] [--detail-fields <value>...]
|
|
9856
|
+
|
|
9857
|
+
FLAGS
|
|
9858
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
9859
|
+
-n, --name=<value> (required) Name of the FlexiPage.
|
|
9860
|
+
-s, --sobject=<value> API name of the Salesforce object; required when creating a RecordPage.
|
|
9861
|
+
-t, --template=<option> (required) Template type for the FlexiPage.
|
|
9862
|
+
<options: RecordPage|AppPage|HomePage>
|
|
9863
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
9864
|
+
--description=<value> Description for the FlexiPage, which provides context about its purpose.
|
|
9865
|
+
--detail-fields=<value>... Fields to display in the Details tab. Specify multiple fields separated by commas.
|
|
9866
|
+
Fields are split into two columns. Used only with RecordPage.
|
|
9867
|
+
--label=<value> Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.
|
|
9868
|
+
--primary-field=<value> Primary field for the dynamic highlights header; typically 'Name'. Used only with
|
|
9869
|
+
RecordPage.
|
|
9870
|
+
--secondary-fields=<value>... Secondary fields shown in the dynamic highlights header. Specify multiple fields
|
|
9871
|
+
separated by commas. Maximum of 11 fields. Used only with RecordPage.
|
|
9872
|
+
|
|
9873
|
+
GLOBAL FLAGS
|
|
9874
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
9875
|
+
--json Format output as json.
|
|
9876
|
+
|
|
9877
|
+
DESCRIPTION
|
|
9878
|
+
Generate a FlexiPage, also known as a Lightning page.
|
|
9879
|
+
|
|
9880
|
+
FlexiPages are the metadata types associated with a Lightning page. A Lightning page represents a customizable screen
|
|
9881
|
+
made up of regions containing Lightning components.
|
|
9882
|
+
|
|
9883
|
+
You can use this command to generate these types of FlexiPages; specify the type with the --template flag:
|
|
9884
|
+
|
|
9885
|
+
- AppPage: A Lightning page used as the home page for a custom app or a standalone application page.
|
|
9886
|
+
- HomePage: A Lightning page used to override the Home page in Lightning Experience.
|
|
9887
|
+
- RecordPage: A Lightning page used to override an object record page in Lightning Experience. Requires that you
|
|
9888
|
+
specify the object name with the --sobject flag.
|
|
9889
|
+
|
|
9890
|
+
EXAMPLES
|
|
9891
|
+
Generate a RecordPage FlexiPage for the Account object in the current directory:
|
|
9892
|
+
|
|
9893
|
+
$ sf template generate flexipage --name Account_Record_Page --template RecordPage --sobject Account
|
|
9894
|
+
|
|
9895
|
+
Generate an AppPage FlexiPage in the "force-app/main/default/flexipages" directory:
|
|
9896
|
+
|
|
9897
|
+
$ sf template generate flexipage --name Sales_Dashboard --template AppPage --output-dir \
|
|
9898
|
+
force-app/main/default/flexipages
|
|
9899
|
+
|
|
9900
|
+
Generate a HomePage FlexiPage with a custom label:
|
|
9901
|
+
|
|
9902
|
+
$ sf template generate flexipage --name Custom_Home --template HomePage --label "Sales Home Page"
|
|
9903
|
+
|
|
9904
|
+
Generate a RecordPage with dynamic highlights and detail fields:
|
|
9905
|
+
|
|
9906
|
+
$ sf template generate flexipage --name Property_Page --template RecordPage --sobject Rental_Property__c \
|
|
9907
|
+
--primary-field Name --secondary-fields Property_Address__c,City__c --detail-fields \
|
|
9908
|
+
Name,Property_Address__c,City__c,Monthly_Rent__c,Bedrooms__c
|
|
9909
|
+
|
|
9910
|
+
FLAG DESCRIPTIONS
|
|
9911
|
+
-d, --output-dir=<value> Directory for saving the created files.
|
|
9912
|
+
|
|
9913
|
+
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
9914
|
+
directory.
|
|
9915
|
+
|
|
9916
|
+
-n, --name=<value> Name of the FlexiPage.
|
|
9917
|
+
|
|
9918
|
+
The name can contain only alphanumeric characters, must start with a letter, and can't end with an underscore or
|
|
9919
|
+
contain two consecutive underscores.
|
|
9920
|
+
|
|
9921
|
+
-s, --sobject=<value> API name of the Salesforce object; required when creating a RecordPage.
|
|
9922
|
+
|
|
9923
|
+
For RecordPage FlexiPages, you must specify the associated object API name, such as 'Account', 'Opportunity', or
|
|
9924
|
+
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
|
|
9925
|
+
```
|
|
9926
|
+
|
|
9927
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/flexipage/index.ts)_
|
|
9845
9928
|
|
|
9846
9929
|
## `sf template generate lightning app`
|
|
9847
9930
|
|
|
@@ -9897,7 +9980,7 @@ FLAG DESCRIPTIONS
|
|
|
9897
9980
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
9898
9981
|
```
|
|
9899
9982
|
|
|
9900
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
9983
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/app.ts)_
|
|
9901
9984
|
|
|
9902
9985
|
## `sf template generate lightning component`
|
|
9903
9986
|
|
|
@@ -9967,7 +10050,7 @@ FLAG DESCRIPTIONS
|
|
|
9967
10050
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
9968
10051
|
```
|
|
9969
10052
|
|
|
9970
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10053
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/component.ts)_
|
|
9971
10054
|
|
|
9972
10055
|
## `sf template generate lightning event`
|
|
9973
10056
|
|
|
@@ -10023,7 +10106,7 @@ FLAG DESCRIPTIONS
|
|
|
10023
10106
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
10024
10107
|
```
|
|
10025
10108
|
|
|
10026
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10109
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/event.ts)_
|
|
10027
10110
|
|
|
10028
10111
|
## `sf template generate lightning interface`
|
|
10029
10112
|
|
|
@@ -10079,7 +10162,7 @@ FLAG DESCRIPTIONS
|
|
|
10079
10162
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
10080
10163
|
```
|
|
10081
10164
|
|
|
10082
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10165
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/interface.ts)_
|
|
10083
10166
|
|
|
10084
10167
|
## `sf template generate lightning test`
|
|
10085
10168
|
|
|
@@ -10135,7 +10218,7 @@ FLAG DESCRIPTIONS
|
|
|
10135
10218
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
10136
10219
|
```
|
|
10137
10220
|
|
|
10138
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10221
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/test.ts)_
|
|
10139
10222
|
|
|
10140
10223
|
## `sf template generate project`
|
|
10141
10224
|
|
|
@@ -10241,7 +10324,7 @@ FLAG DESCRIPTIONS
|
|
|
10241
10324
|
Override the api version used for api requests made by this command
|
|
10242
10325
|
```
|
|
10243
10326
|
|
|
10244
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10327
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/project/index.ts)_
|
|
10245
10328
|
|
|
10246
10329
|
## `sf template generate static-resource`
|
|
10247
10330
|
|
|
@@ -10304,7 +10387,7 @@ FLAG DESCRIPTIONS
|
|
|
10304
10387
|
etc.
|
|
10305
10388
|
```
|
|
10306
10389
|
|
|
10307
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10390
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/static-resource/index.ts)_
|
|
10308
10391
|
|
|
10309
10392
|
## `sf template generate visualforce component`
|
|
10310
10393
|
|
|
@@ -10361,7 +10444,7 @@ FLAG DESCRIPTIONS
|
|
|
10361
10444
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
10362
10445
|
```
|
|
10363
10446
|
|
|
10364
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10447
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/visualforce/component.ts)_
|
|
10365
10448
|
|
|
10366
10449
|
## `sf template generate visualforce page`
|
|
10367
10450
|
|
|
@@ -10412,7 +10495,7 @@ FLAG DESCRIPTIONS
|
|
|
10412
10495
|
The name can be up to 40 characters and must start with a letter.
|
|
10413
10496
|
```
|
|
10414
10497
|
|
|
10415
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10498
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/visualforce/page.ts)_
|
|
10416
10499
|
|
|
10417
10500
|
## `sf update [CHANNEL]`
|
|
10418
10501
|
|