@salesforce/cli 2.45.6 → 2.46.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 +163 -153
- package/bin/dev.js +5 -3
- package/bin/run.js +8 -25
- package/dist/cli.js +21 -38
- package/dist/help/sfCommandHelp.js +1 -1
- package/dist/help/sfHelp.js +6 -5
- package/dist/hooks/display-release-notes.js +4 -10
- package/dist/hooks/incomplete.js +3 -2
- package/dist/hooks/pluginsPreinstall.js +2 -2
- package/dist/hooks/prerun.js +1 -1
- package/dist/logger.js +23 -0
- package/dist/util/env.js +0 -6
- package/npm-shrinkwrap.json +2414 -2489
- package/oclif.lock +390 -236
- package/oclif.manifest.json +1 -1
- package/package.json +19 -21
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
|
|
|
24
24
|
$ sf COMMAND
|
|
25
25
|
running command...
|
|
26
26
|
$ sf (--version|-v)
|
|
27
|
-
@salesforce/cli/2.
|
|
27
|
+
@salesforce/cli/2.46.1 linux-x64 node-v20.14.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -204,7 +204,7 @@ EXAMPLES
|
|
|
204
204
|
$ sf alias list
|
|
205
205
|
```
|
|
206
206
|
|
|
207
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
207
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.1/src/commands/alias/list.ts)_
|
|
208
208
|
|
|
209
209
|
## `sf alias set`
|
|
210
210
|
|
|
@@ -253,7 +253,7 @@ EXAMPLES
|
|
|
253
253
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
254
254
|
```
|
|
255
255
|
|
|
256
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
256
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.1/src/commands/alias/set.ts)_
|
|
257
257
|
|
|
258
258
|
## `sf alias unset`
|
|
259
259
|
|
|
@@ -293,7 +293,7 @@ EXAMPLES
|
|
|
293
293
|
$ sf alias unset --all [--no-prompt]
|
|
294
294
|
```
|
|
295
295
|
|
|
296
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
296
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.1/src/commands/alias/unset.ts)_
|
|
297
297
|
|
|
298
298
|
## `sf analytics generate template`
|
|
299
299
|
|
|
@@ -404,7 +404,7 @@ Generate an Apex trigger.
|
|
|
404
404
|
USAGE
|
|
405
405
|
$ sf apex generate trigger -n <value> [--json] [--flags-dir <value>] [-t ApexTrigger] [-d <value>] [--api-version
|
|
406
406
|
<value>] [-s <value>] [-e before insert|before update|before delete|after insert|after update|after delete|after
|
|
407
|
-
undelete]
|
|
407
|
+
undelete...]
|
|
408
408
|
|
|
409
409
|
FLAGS
|
|
410
410
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
@@ -519,7 +519,7 @@ FLAG DESCRIPTIONS
|
|
|
519
519
|
directory.
|
|
520
520
|
```
|
|
521
521
|
|
|
522
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.
|
|
522
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.15/src/commands/apex/get/log.ts)_
|
|
523
523
|
|
|
524
524
|
## `sf apex get test`
|
|
525
525
|
|
|
@@ -573,7 +573,7 @@ EXAMPLES
|
|
|
573
573
|
me@myorg',
|
|
574
574
|
```
|
|
575
575
|
|
|
576
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.
|
|
576
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.15/src/commands/apex/get/test.ts)_
|
|
577
577
|
|
|
578
578
|
## `sf apex list log`
|
|
579
579
|
|
|
@@ -613,7 +613,7 @@ EXAMPLES
|
|
|
613
613
|
$ sf apex list log --target-org me@my.org
|
|
614
614
|
```
|
|
615
615
|
|
|
616
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.
|
|
616
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.15/src/commands/apex/list/log.ts)_
|
|
617
617
|
|
|
618
618
|
## `sf apex run`
|
|
619
619
|
|
|
@@ -660,7 +660,7 @@ EXAMPLES
|
|
|
660
660
|
$ sf apex run
|
|
661
661
|
```
|
|
662
662
|
|
|
663
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.
|
|
663
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.15/src/commands/apex/run.ts)_
|
|
664
664
|
|
|
665
665
|
## `sf apex run test`
|
|
666
666
|
|
|
@@ -669,8 +669,8 @@ Invoke Apex tests in an org.
|
|
|
669
669
|
```
|
|
670
670
|
USAGE
|
|
671
671
|
$ sf apex run test -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-l
|
|
672
|
-
RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value
|
|
673
|
-
[-w <value>] [-y] [-v -c]
|
|
672
|
+
RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value>... | -s <value>... | -t <value>...] [-r
|
|
673
|
+
human|tap|junit|json] [-w <value>] [-y] [-v -c]
|
|
674
674
|
|
|
675
675
|
FLAGS
|
|
676
676
|
-c, --code-coverage Retrieve code coverage results.
|
|
@@ -761,14 +761,16 @@ FLAG DESCRIPTIONS
|
|
|
761
761
|
For multiple suites, repeat the flag for each.
|
|
762
762
|
--suite-names Suite1 --suite-names Suite2
|
|
763
763
|
|
|
764
|
-
-t, --tests=<value>...
|
|
764
|
+
-t, --tests=<value>...
|
|
765
|
+
|
|
766
|
+
Apex test class names or IDs and, if applicable, test methods to run; default is all tests.
|
|
765
767
|
|
|
766
768
|
If you specify --tests, you can't specify --class-names or --suite-names
|
|
767
769
|
For multiple tests, repeat the flag for each.
|
|
768
770
|
--tests Test1 --tests Test2
|
|
769
771
|
```
|
|
770
772
|
|
|
771
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.
|
|
773
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.15/src/commands/apex/run/test.ts)_
|
|
772
774
|
|
|
773
775
|
## `sf apex tail log`
|
|
774
776
|
|
|
@@ -811,7 +813,7 @@ EXAMPLES
|
|
|
811
813
|
$ sf apex tail log --color --skip-trace-flag
|
|
812
814
|
```
|
|
813
815
|
|
|
814
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.
|
|
816
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.1.15/src/commands/apex/tail/log.ts)_
|
|
815
817
|
|
|
816
818
|
## `sf autocomplete [SHELL]`
|
|
817
819
|
|
|
@@ -850,8 +852,8 @@ List all sf commands.
|
|
|
850
852
|
|
|
851
853
|
```
|
|
852
854
|
USAGE
|
|
853
|
-
$ sf commands [--json] [-c id|plugin|summary|type | --tree] [--deprecated] [-x | ] [--hidden]
|
|
854
|
-
| ] [--sort id|plugin|summary|type | ]
|
|
855
|
+
$ sf commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
|
|
856
|
+
[--no-truncate | ] [--sort id|plugin|summary|type | ]
|
|
855
857
|
|
|
856
858
|
FLAGS
|
|
857
859
|
-c, --columns=<option>... Only show provided columns (comma-separated).
|
|
@@ -920,7 +922,7 @@ CONFIGURATION VARIABLES
|
|
|
920
922
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
921
923
|
```
|
|
922
924
|
|
|
923
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
925
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.1/src/commands/config/get.ts)_
|
|
924
926
|
|
|
925
927
|
## `sf config list`
|
|
926
928
|
|
|
@@ -960,7 +962,7 @@ EXAMPLES
|
|
|
960
962
|
$ sf config list
|
|
961
963
|
```
|
|
962
964
|
|
|
963
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
965
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.1/src/commands/config/list.ts)_
|
|
964
966
|
|
|
965
967
|
## `sf config set`
|
|
966
968
|
|
|
@@ -1029,7 +1031,7 @@ CONFIGURATION VARIABLES
|
|
|
1029
1031
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1030
1032
|
```
|
|
1031
1033
|
|
|
1032
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
1034
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.1/src/commands/config/set.ts)_
|
|
1033
1035
|
|
|
1034
1036
|
## `sf config unset`
|
|
1035
1037
|
|
|
@@ -1079,7 +1081,7 @@ CONFIGURATION VARIABLES
|
|
|
1079
1081
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1080
1082
|
```
|
|
1081
1083
|
|
|
1082
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
1084
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.1/src/commands/config/unset.ts)_
|
|
1083
1085
|
|
|
1084
1086
|
## `sf data create file`
|
|
1085
1087
|
|
|
@@ -1128,7 +1130,7 @@ EXAMPLES
|
|
|
1128
1130
|
$ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
|
|
1129
1131
|
```
|
|
1130
1132
|
|
|
1131
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1133
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/create/file.ts)_
|
|
1132
1134
|
|
|
1133
1135
|
## `sf data create record`
|
|
1134
1136
|
|
|
@@ -1184,7 +1186,7 @@ EXAMPLES
|
|
|
1184
1186
|
TracedEntityId=01p17000000R6bLAAS"
|
|
1185
1187
|
```
|
|
1186
1188
|
|
|
1187
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1189
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/create/record.ts)_
|
|
1188
1190
|
|
|
1189
1191
|
## `sf data delete bulk`
|
|
1190
1192
|
|
|
@@ -1231,7 +1233,7 @@ EXAMPLES
|
|
|
1231
1233
|
$ sf data delete bulk --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1232
1234
|
```
|
|
1233
1235
|
|
|
1234
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1236
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/delete/bulk.ts)_
|
|
1235
1237
|
|
|
1236
1238
|
## `sf data delete record`
|
|
1237
1239
|
|
|
@@ -1292,7 +1294,7 @@ EXAMPLES
|
|
|
1292
1294
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1293
1295
|
```
|
|
1294
1296
|
|
|
1295
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1297
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/delete/record.ts)_
|
|
1296
1298
|
|
|
1297
1299
|
## `sf data delete resume`
|
|
1298
1300
|
|
|
@@ -1331,7 +1333,7 @@ EXAMPLES
|
|
|
1331
1333
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
1332
1334
|
```
|
|
1333
1335
|
|
|
1334
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1336
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/delete/resume.ts)_
|
|
1335
1337
|
|
|
1336
1338
|
## `sf data export beta tree`
|
|
1337
1339
|
|
|
@@ -1389,7 +1391,7 @@ EXAMPLES
|
|
|
1389
1391
|
my-scratch
|
|
1390
1392
|
```
|
|
1391
1393
|
|
|
1392
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1394
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/export/beta/tree.ts)_
|
|
1393
1395
|
|
|
1394
1396
|
## `sf data export tree`
|
|
1395
1397
|
|
|
@@ -1449,7 +1451,7 @@ EXAMPLES
|
|
|
1449
1451
|
my-scratch
|
|
1450
1452
|
```
|
|
1451
1453
|
|
|
1452
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1454
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/export/tree.ts)_
|
|
1453
1455
|
|
|
1454
1456
|
## `sf data get record`
|
|
1455
1457
|
|
|
@@ -1513,7 +1515,7 @@ EXAMPLES
|
|
|
1513
1515
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1514
1516
|
```
|
|
1515
1517
|
|
|
1516
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1518
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/get/record.ts)_
|
|
1517
1519
|
|
|
1518
1520
|
## `sf data import beta tree`
|
|
1519
1521
|
|
|
@@ -1521,7 +1523,8 @@ Import data from one or more JSON files into an org.
|
|
|
1521
1523
|
|
|
1522
1524
|
```
|
|
1523
1525
|
USAGE
|
|
1524
|
-
$ sf data import beta tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value
|
|
1526
|
+
$ sf data import beta tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>...] [-p
|
|
1527
|
+
<value>]
|
|
1525
1528
|
|
|
1526
1529
|
FLAGS
|
|
1527
1530
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -1556,7 +1559,7 @@ EXAMPLES
|
|
|
1556
1559
|
$ sf data import beta tree --plan Account-Contact-plan.json
|
|
1557
1560
|
```
|
|
1558
1561
|
|
|
1559
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1562
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/import/beta/tree.ts)_
|
|
1560
1563
|
|
|
1561
1564
|
## `sf data import tree`
|
|
1562
1565
|
|
|
@@ -1564,7 +1567,7 @@ Import data from one or more JSON files into an org.
|
|
|
1564
1567
|
|
|
1565
1568
|
```
|
|
1566
1569
|
USAGE
|
|
1567
|
-
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value
|
|
1570
|
+
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>... | -p <value>]
|
|
1568
1571
|
|
|
1569
1572
|
FLAGS
|
|
1570
1573
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -1606,7 +1609,7 @@ EXAMPLES
|
|
|
1606
1609
|
$ sf data import tree --plan Account-Contact-plan.json
|
|
1607
1610
|
```
|
|
1608
1611
|
|
|
1609
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1612
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/import/tree.ts)_
|
|
1610
1613
|
|
|
1611
1614
|
## `sf data query`
|
|
1612
1615
|
|
|
@@ -1670,7 +1673,7 @@ EXAMPLES
|
|
|
1670
1673
|
$ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
|
|
1671
1674
|
```
|
|
1672
1675
|
|
|
1673
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1676
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/query.ts)_
|
|
1674
1677
|
|
|
1675
1678
|
## `sf data query resume`
|
|
1676
1679
|
|
|
@@ -1708,7 +1711,7 @@ EXAMPLES
|
|
|
1708
1711
|
$ sf data query resume --bulk-query-id 7500x000005BdFzXXX
|
|
1709
1712
|
```
|
|
1710
1713
|
|
|
1711
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1714
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/query/resume.ts)_
|
|
1712
1715
|
|
|
1713
1716
|
## `sf data resume`
|
|
1714
1717
|
|
|
@@ -1745,7 +1748,7 @@ EXAMPLES
|
|
|
1745
1748
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
1746
1749
|
```
|
|
1747
1750
|
|
|
1748
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1751
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/resume.ts)_
|
|
1749
1752
|
|
|
1750
1753
|
## `sf data update record`
|
|
1751
1754
|
|
|
@@ -1807,7 +1810,7 @@ EXAMPLES
|
|
|
1807
1810
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
1808
1811
|
```
|
|
1809
1812
|
|
|
1810
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1813
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/update/record.ts)_
|
|
1811
1814
|
|
|
1812
1815
|
## `sf data upsert bulk`
|
|
1813
1816
|
|
|
@@ -1860,7 +1863,7 @@ EXAMPLES
|
|
|
1860
1863
|
my-scratch
|
|
1861
1864
|
```
|
|
1862
1865
|
|
|
1863
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1866
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/upsert/bulk.ts)_
|
|
1864
1867
|
|
|
1865
1868
|
## `sf data upsert resume`
|
|
1866
1869
|
|
|
@@ -1899,7 +1902,7 @@ EXAMPLES
|
|
|
1899
1902
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
1900
1903
|
```
|
|
1901
1904
|
|
|
1902
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
1905
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/data/upsert/resume.ts)_
|
|
1903
1906
|
|
|
1904
1907
|
## `sf doctor`
|
|
1905
1908
|
|
|
@@ -1947,7 +1950,7 @@ EXAMPLES
|
|
|
1947
1950
|
$ sf doctor --plugin @salesforce/plugin-source
|
|
1948
1951
|
```
|
|
1949
1952
|
|
|
1950
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.3.
|
|
1953
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.3.5/src/commands/doctor.ts)_
|
|
1951
1954
|
|
|
1952
1955
|
## `sf force data bulk delete`
|
|
1953
1956
|
|
|
@@ -1994,7 +1997,7 @@ EXAMPLES
|
|
|
1994
1997
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1995
1998
|
```
|
|
1996
1999
|
|
|
1997
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
2000
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/force/data/bulk/delete.ts)_
|
|
1998
2001
|
|
|
1999
2002
|
## `sf force data bulk status`
|
|
2000
2003
|
|
|
@@ -2031,7 +2034,7 @@ EXAMPLES
|
|
|
2031
2034
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
2032
2035
|
```
|
|
2033
2036
|
|
|
2034
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
2037
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/force/data/bulk/status.ts)_
|
|
2035
2038
|
|
|
2036
2039
|
## `sf force data bulk upsert`
|
|
2037
2040
|
|
|
@@ -2089,7 +2092,7 @@ EXAMPLES
|
|
|
2089
2092
|
--target-org my-scratch
|
|
2090
2093
|
```
|
|
2091
2094
|
|
|
2092
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.
|
|
2095
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.4.4/src/commands/force/data/bulk/upsert.ts)_
|
|
2093
2096
|
|
|
2094
2097
|
## `sf help [COMMAND]`
|
|
2095
2098
|
|
|
@@ -2109,7 +2112,7 @@ DESCRIPTION
|
|
|
2109
2112
|
Display help for sf.
|
|
2110
2113
|
```
|
|
2111
2114
|
|
|
2112
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.
|
|
2115
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.0/src/commands/help.ts)_
|
|
2113
2116
|
|
|
2114
2117
|
## `sf info releasenotes display`
|
|
2115
2118
|
|
|
@@ -2149,7 +2152,7 @@ EXAMPLES
|
|
|
2149
2152
|
$ sf info releasenotes display --version latest
|
|
2150
2153
|
```
|
|
2151
2154
|
|
|
2152
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.3.
|
|
2155
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.3.5/src/commands/info/releasenotes/display.ts)_
|
|
2153
2156
|
|
|
2154
2157
|
## `sf lightning generate app`
|
|
2155
2158
|
|
|
@@ -2446,7 +2449,8 @@ Assign a permission set to one or more users of a scratch org.
|
|
|
2446
2449
|
|
|
2447
2450
|
```
|
|
2448
2451
|
USAGE
|
|
2449
|
-
$ sf org assign permset -n <value
|
|
2452
|
+
$ sf org assign permset -n <value>... -o <value> [--json] [--flags-dir <value>] [-b <value>...] [--api-version
|
|
2453
|
+
<value>]
|
|
2450
2454
|
|
|
2451
2455
|
FLAGS
|
|
2452
2456
|
-b, --on-behalf-of=<value>... Username or alias to assign the permission set to.
|
|
@@ -2490,7 +2494,7 @@ Assign a permission set license to one or more users of a scratch org.
|
|
|
2490
2494
|
|
|
2491
2495
|
```
|
|
2492
2496
|
USAGE
|
|
2493
|
-
$ sf org assign permsetlicense -n <value
|
|
2497
|
+
$ sf org assign permsetlicense -n <value>... -o <value> [--json] [--flags-dir <value>] [-b <value>...] [--api-version
|
|
2494
2498
|
<value>]
|
|
2495
2499
|
|
|
2496
2500
|
FLAGS
|
|
@@ -2536,8 +2540,8 @@ Create a sandbox org.
|
|
|
2536
2540
|
|
|
2537
2541
|
```
|
|
2538
2542
|
USAGE
|
|
2539
|
-
$ sf org create sandbox -o <value> [--json] [--flags-dir <value>] [-f <value>] [-s] [-a <value>] [-w <
|
|
2540
|
-
--async] [-i <
|
|
2543
|
+
$ sf org create sandbox -o <value> [--json] [--flags-dir <value>] [-f <value>] [-s] [-a <value>] [-w <minutes> |
|
|
2544
|
+
--async] [-i <seconds> | ] [-n <value>] [-c <value> | -l Developer|Developer_Pro|Partial|Full] [--no-prompt]
|
|
2541
2545
|
[--no-track-source]
|
|
2542
2546
|
|
|
2543
2547
|
FLAGS
|
|
@@ -2645,7 +2649,7 @@ FLAG DESCRIPTIONS
|
|
|
2645
2649
|
sandbox.
|
|
2646
2650
|
```
|
|
2647
2651
|
|
|
2648
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
2652
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/create/sandbox.ts)_
|
|
2649
2653
|
|
|
2650
2654
|
## `sf org create scratch`
|
|
2651
2655
|
|
|
@@ -2655,7 +2659,7 @@ Create a scratch org.
|
|
|
2655
2659
|
USAGE
|
|
2656
2660
|
$ sf org create scratch -v <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [-d] [-f <value>] [-c] [-e
|
|
2657
2661
|
developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional]
|
|
2658
|
-
[-m] [-y <
|
|
2662
|
+
[-m] [-y <days>] [-w <minutes>] [--api-version <value>] [-i <value>] [-t] [--username <value>] [--description
|
|
2659
2663
|
<value>] [--name <value>] [--release preview|previous] [--admin-email <value>] [--source-org <value>]
|
|
2660
2664
|
|
|
2661
2665
|
FLAGS
|
|
@@ -2799,7 +2803,7 @@ FLAG DESCRIPTIONS
|
|
|
2799
2803
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
2800
2804
|
```
|
|
2801
2805
|
|
|
2802
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
2806
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/create/scratch.ts)_
|
|
2803
2807
|
|
|
2804
2808
|
## `sf org create user`
|
|
2805
2809
|
|
|
@@ -2953,7 +2957,7 @@ EXAMPLES
|
|
|
2953
2957
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
2954
2958
|
```
|
|
2955
2959
|
|
|
2956
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
2960
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/delete/sandbox.ts)_
|
|
2957
2961
|
|
|
2958
2962
|
## `sf org delete scratch`
|
|
2959
2963
|
|
|
@@ -2997,7 +3001,7 @@ EXAMPLES
|
|
|
2997
3001
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
2998
3002
|
```
|
|
2999
3003
|
|
|
3000
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3004
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/delete/scratch.ts)_
|
|
3001
3005
|
|
|
3002
3006
|
## `sf org disable tracking`
|
|
3003
3007
|
|
|
@@ -3036,7 +3040,7 @@ EXAMPLES
|
|
|
3036
3040
|
$ sf org disable tracking
|
|
3037
3041
|
```
|
|
3038
3042
|
|
|
3039
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3043
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/disable/tracking.ts)_
|
|
3040
3044
|
|
|
3041
3045
|
## `sf org display`
|
|
3042
3046
|
|
|
@@ -3081,7 +3085,7 @@ EXAMPLES
|
|
|
3081
3085
|
$ sf org display --target-org TestOrg1 --verbose
|
|
3082
3086
|
```
|
|
3083
3087
|
|
|
3084
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3088
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/display.ts)_
|
|
3085
3089
|
|
|
3086
3090
|
## `sf org display user`
|
|
3087
3091
|
|
|
@@ -3162,7 +3166,7 @@ EXAMPLES
|
|
|
3162
3166
|
$ sf org enable tracking
|
|
3163
3167
|
```
|
|
3164
3168
|
|
|
3165
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3169
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/enable/tracking.ts)_
|
|
3166
3170
|
|
|
3167
3171
|
## `sf org generate password`
|
|
3168
3172
|
|
|
@@ -3170,7 +3174,7 @@ Generate a random password for scratch org users.
|
|
|
3170
3174
|
|
|
3171
3175
|
```
|
|
3172
3176
|
USAGE
|
|
3173
|
-
$ sf org generate password -o <value> [--json] [--flags-dir <value>] [-b <value
|
|
3177
|
+
$ sf org generate password -o <value> [--json] [--flags-dir <value>] [-b <value>...] [-l <value>] [-c <value>]
|
|
3174
3178
|
[--api-version <value>]
|
|
3175
3179
|
|
|
3176
3180
|
FLAGS
|
|
@@ -3268,7 +3272,7 @@ EXAMPLES
|
|
|
3268
3272
|
$ sf org list --clean
|
|
3269
3273
|
```
|
|
3270
3274
|
|
|
3271
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3275
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/list.ts)_
|
|
3272
3276
|
|
|
3273
3277
|
## `sf org list auth`
|
|
3274
3278
|
|
|
@@ -3300,7 +3304,7 @@ EXAMPLES
|
|
|
3300
3304
|
$ sf org list auth
|
|
3301
3305
|
```
|
|
3302
3306
|
|
|
3303
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3307
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.18/src/commands/org/list/auth.ts)_
|
|
3304
3308
|
|
|
3305
3309
|
## `sf org list limits`
|
|
3306
3310
|
|
|
@@ -3407,7 +3411,7 @@ FLAG DESCRIPTIONS
|
|
|
3407
3411
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
3408
3412
|
```
|
|
3409
3413
|
|
|
3410
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3414
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/list/metadata.ts)_
|
|
3411
3415
|
|
|
3412
3416
|
## `sf org list metadata-types`
|
|
3413
3417
|
|
|
@@ -3462,7 +3466,7 @@ FLAG DESCRIPTIONS
|
|
|
3462
3466
|
Override the api version used for api requests made by this command
|
|
3463
3467
|
```
|
|
3464
3468
|
|
|
3465
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3469
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/list/metadata-types.ts)_
|
|
3466
3470
|
|
|
3467
3471
|
## `sf org list sobject record-counts`
|
|
3468
3472
|
|
|
@@ -3470,7 +3474,7 @@ Display record counts for the specified standard or custom objects.
|
|
|
3470
3474
|
|
|
3471
3475
|
```
|
|
3472
3476
|
USAGE
|
|
3473
|
-
$ sf org list sobject record-counts -o <value> [--json] [--flags-dir <value>] [-s <value
|
|
3477
|
+
$ sf org list sobject record-counts -o <value> [--json] [--flags-dir <value>] [-s <value>...] [--api-version <value>]
|
|
3474
3478
|
|
|
3475
3479
|
FLAGS
|
|
3476
3480
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -3600,7 +3604,7 @@ FLAG DESCRIPTIONS
|
|
|
3600
3604
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3601
3605
|
```
|
|
3602
3606
|
|
|
3603
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3607
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.18/src/commands/org/login/access-token.ts)_
|
|
3604
3608
|
|
|
3605
3609
|
## `sf org login device`
|
|
3606
3610
|
|
|
@@ -3660,7 +3664,7 @@ FLAG DESCRIPTIONS
|
|
|
3660
3664
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3661
3665
|
```
|
|
3662
3666
|
|
|
3663
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3667
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.18/src/commands/org/login/device.ts)_
|
|
3664
3668
|
|
|
3665
3669
|
## `sf org login jwt`
|
|
3666
3670
|
|
|
@@ -3751,7 +3755,7 @@ FLAG DESCRIPTIONS
|
|
|
3751
3755
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3752
3756
|
```
|
|
3753
3757
|
|
|
3754
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3758
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.18/src/commands/org/login/jwt.ts)_
|
|
3755
3759
|
|
|
3756
3760
|
## `sf org login sfdx-url`
|
|
3757
3761
|
|
|
@@ -3816,7 +3820,7 @@ EXAMPLES
|
|
|
3816
3820
|
$ echo url | sf org login sfdx-url --sfdx-url-stdin
|
|
3817
3821
|
```
|
|
3818
3822
|
|
|
3819
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3823
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.18/src/commands/org/login/sfdx-url.ts)_
|
|
3820
3824
|
|
|
3821
3825
|
## `sf org login web`
|
|
3822
3826
|
|
|
@@ -3903,7 +3907,7 @@ FLAG DESCRIPTIONS
|
|
|
3903
3907
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3904
3908
|
```
|
|
3905
3909
|
|
|
3906
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3910
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.18/src/commands/org/login/web.ts)_
|
|
3907
3911
|
|
|
3908
3912
|
## `sf org logout`
|
|
3909
3913
|
|
|
@@ -3964,7 +3968,7 @@ FLAG DESCRIPTIONS
|
|
|
3964
3968
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
3965
3969
|
```
|
|
3966
3970
|
|
|
3967
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3971
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.18/src/commands/org/logout.ts)_
|
|
3968
3972
|
|
|
3969
3973
|
## `sf org open`
|
|
3970
3974
|
|
|
@@ -4036,7 +4040,7 @@ EXAMPLES
|
|
|
4036
4040
|
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
4037
4041
|
```
|
|
4038
4042
|
|
|
4039
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
4043
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/open.ts)_
|
|
4040
4044
|
|
|
4041
4045
|
## `sf org refresh sandbox`
|
|
4042
4046
|
|
|
@@ -4044,8 +4048,8 @@ Refresh a sandbox org using the sandbox name.
|
|
|
4044
4048
|
|
|
4045
4049
|
```
|
|
4046
4050
|
USAGE
|
|
4047
|
-
$ sf org refresh sandbox -o <value> [--json] [--flags-dir <value>] [--no-auto-activate] [-w <
|
|
4048
|
-
<
|
|
4051
|
+
$ sf org refresh sandbox -o <value> [--json] [--flags-dir <value>] [--no-auto-activate] [-w <minutes> | --async] [-i
|
|
4052
|
+
<seconds> | ] [-n <value>] [-f <value>] [--no-prompt]
|
|
4049
4053
|
|
|
4050
4054
|
FLAGS
|
|
4051
4055
|
-f, --definition-file=<value> Path to a sandbox definition file for overriding its configuration when you refresh it.
|
|
@@ -4089,7 +4093,9 @@ EXAMPLES
|
|
|
4089
4093
|
$ sf org refresh sandbox --definition-file devSbx3-config.json --target-org prodOrg
|
|
4090
4094
|
|
|
4091
4095
|
FLAG DESCRIPTIONS
|
|
4092
|
-
-f, --definition-file=<value>
|
|
4096
|
+
-f, --definition-file=<value>
|
|
4097
|
+
|
|
4098
|
+
Path to a sandbox definition file for overriding its configuration when you refresh it.
|
|
4093
4099
|
|
|
4094
4100
|
The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during
|
|
4095
4101
|
a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name
|
|
@@ -4113,7 +4119,7 @@ FLAG DESCRIPTIONS
|
|
|
4113
4119
|
By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.
|
|
4114
4120
|
```
|
|
4115
4121
|
|
|
4116
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
4122
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/refresh/sandbox.ts)_
|
|
4117
4123
|
|
|
4118
4124
|
## `sf org resume sandbox`
|
|
4119
4125
|
|
|
@@ -4121,7 +4127,7 @@ Check the status of a sandbox creation, and log in to it if it's ready.
|
|
|
4121
4127
|
|
|
4122
4128
|
```
|
|
4123
4129
|
USAGE
|
|
4124
|
-
$ sf org resume sandbox [--json] [--flags-dir <value>] [-w <
|
|
4130
|
+
$ sf org resume sandbox [--json] [--flags-dir <value>] [-w <minutes>] [-n <value> | -i <value>] [-l] [-o <value>]
|
|
4125
4131
|
|
|
4126
4132
|
FLAGS
|
|
4127
4133
|
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
@@ -4176,7 +4182,7 @@ FLAG DESCRIPTIONS
|
|
|
4176
4182
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
4177
4183
|
```
|
|
4178
4184
|
|
|
4179
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
4185
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/resume/sandbox.ts)_
|
|
4180
4186
|
|
|
4181
4187
|
## `sf org resume scratch`
|
|
4182
4188
|
|
|
@@ -4223,7 +4229,7 @@ FLAG DESCRIPTIONS
|
|
|
4223
4229
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
4224
4230
|
```
|
|
4225
4231
|
|
|
4226
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
4232
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.2.0/src/commands/org/resume/scratch.ts)_
|
|
4227
4233
|
|
|
4228
4234
|
## `sf package create`
|
|
4229
4235
|
|
|
@@ -4302,7 +4308,7 @@ FLAG DESCRIPTIONS
|
|
|
4302
4308
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
4303
4309
|
```
|
|
4304
4310
|
|
|
4305
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4311
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/create.ts)_
|
|
4306
4312
|
|
|
4307
4313
|
## `sf package delete`
|
|
4308
4314
|
|
|
@@ -4344,7 +4350,7 @@ EXAMPLES
|
|
|
4344
4350
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
4345
4351
|
```
|
|
4346
4352
|
|
|
4347
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4353
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/delete.ts)_
|
|
4348
4354
|
|
|
4349
4355
|
## `sf package install`
|
|
4350
4356
|
|
|
@@ -4442,7 +4448,7 @@ FLAG DESCRIPTIONS
|
|
|
4442
4448
|
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
4443
4449
|
```
|
|
4444
4450
|
|
|
4445
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4451
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/install.ts)_
|
|
4446
4452
|
|
|
4447
4453
|
## `sf package install report`
|
|
4448
4454
|
|
|
@@ -4475,7 +4481,7 @@ EXAMPLES
|
|
|
4475
4481
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
4476
4482
|
```
|
|
4477
4483
|
|
|
4478
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4484
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/install/report.ts)_
|
|
4479
4485
|
|
|
4480
4486
|
## `sf package installed list`
|
|
4481
4487
|
|
|
@@ -4507,7 +4513,7 @@ EXAMPLES
|
|
|
4507
4513
|
$ sf package installed list --target-org me@example.com
|
|
4508
4514
|
```
|
|
4509
4515
|
|
|
4510
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4516
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/installed/list.ts)_
|
|
4511
4517
|
|
|
4512
4518
|
## `sf package list`
|
|
4513
4519
|
|
|
@@ -4545,7 +4551,7 @@ EXAMPLES
|
|
|
4545
4551
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
4546
4552
|
```
|
|
4547
4553
|
|
|
4548
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4554
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/list.ts)_
|
|
4549
4555
|
|
|
4550
4556
|
## `sf package uninstall`
|
|
4551
4557
|
|
|
@@ -4593,7 +4599,7 @@ EXAMPLES
|
|
|
4593
4599
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
4594
4600
|
```
|
|
4595
4601
|
|
|
4596
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4602
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/uninstall.ts)_
|
|
4597
4603
|
|
|
4598
4604
|
## `sf package uninstall report`
|
|
4599
4605
|
|
|
@@ -4626,7 +4632,7 @@ EXAMPLES
|
|
|
4626
4632
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
4627
4633
|
```
|
|
4628
4634
|
|
|
4629
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4635
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/uninstall/report.ts)_
|
|
4630
4636
|
|
|
4631
4637
|
## `sf package update`
|
|
4632
4638
|
|
|
@@ -4681,7 +4687,7 @@ FLAG DESCRIPTIONS
|
|
|
4681
4687
|
associated with your package.
|
|
4682
4688
|
```
|
|
4683
4689
|
|
|
4684
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4690
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/update.ts)_
|
|
4685
4691
|
|
|
4686
4692
|
## `sf package version create`
|
|
4687
4693
|
|
|
@@ -4836,7 +4842,7 @@ FLAG DESCRIPTIONS
|
|
|
4836
4842
|
periods of no output from commands.
|
|
4837
4843
|
```
|
|
4838
4844
|
|
|
4839
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4845
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/version/create.ts)_
|
|
4840
4846
|
|
|
4841
4847
|
## `sf package version create list`
|
|
4842
4848
|
|
|
@@ -4897,7 +4903,7 @@ EXAMPLES
|
|
|
4897
4903
|
$ sf package version create list --created-last-days 0 --status Success
|
|
4898
4904
|
```
|
|
4899
4905
|
|
|
4900
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4906
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/version/create/list.ts)_
|
|
4901
4907
|
|
|
4902
4908
|
## `sf package version create report`
|
|
4903
4909
|
|
|
@@ -4940,7 +4946,7 @@ EXAMPLES
|
|
|
4940
4946
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
4941
4947
|
```
|
|
4942
4948
|
|
|
4943
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4949
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/version/create/report.ts)_
|
|
4944
4950
|
|
|
4945
4951
|
## `sf package version delete`
|
|
4946
4952
|
|
|
@@ -4979,7 +4985,7 @@ EXAMPLES
|
|
|
4979
4985
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
4980
4986
|
```
|
|
4981
4987
|
|
|
4982
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
4988
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/version/delete.ts)_
|
|
4983
4989
|
|
|
4984
4990
|
## `sf package version displayancestry`
|
|
4985
4991
|
|
|
@@ -5039,7 +5045,7 @@ FLAG DESCRIPTIONS
|
|
|
5039
5045
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
5040
5046
|
```
|
|
5041
5047
|
|
|
5042
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5048
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/version/displayancestry.ts)_
|
|
5043
5049
|
|
|
5044
5050
|
## `sf package version list`
|
|
5045
5051
|
|
|
@@ -5108,7 +5114,7 @@ EXAMPLES
|
|
|
5108
5114
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
5109
5115
|
```
|
|
5110
5116
|
|
|
5111
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5117
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/version/list.ts)_
|
|
5112
5118
|
|
|
5113
5119
|
## `sf package version promote`
|
|
5114
5120
|
|
|
@@ -5152,7 +5158,7 @@ EXAMPLES
|
|
|
5152
5158
|
$ sf package version promote --package "Awesome Package Alias"
|
|
5153
5159
|
```
|
|
5154
5160
|
|
|
5155
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5161
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/version/promote.ts)_
|
|
5156
5162
|
|
|
5157
5163
|
## `sf package version report`
|
|
5158
5164
|
|
|
@@ -5192,7 +5198,7 @@ EXAMPLES
|
|
|
5192
5198
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
5193
5199
|
```
|
|
5194
5200
|
|
|
5195
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5201
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/version/report.ts)_
|
|
5196
5202
|
|
|
5197
5203
|
## `sf package version update`
|
|
5198
5204
|
|
|
@@ -5245,7 +5251,7 @@ EXAMPLES
|
|
|
5245
5251
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
5246
5252
|
```
|
|
5247
5253
|
|
|
5248
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5254
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package/version/update.ts)_
|
|
5249
5255
|
|
|
5250
5256
|
## `sf package1 version create`
|
|
5251
5257
|
|
|
@@ -5312,7 +5318,7 @@ FLAG DESCRIPTIONS
|
|
|
5312
5318
|
subscribers.
|
|
5313
5319
|
```
|
|
5314
5320
|
|
|
5315
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5321
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package1/version/create.ts)_
|
|
5316
5322
|
|
|
5317
5323
|
## `sf package1 version create get`
|
|
5318
5324
|
|
|
@@ -5345,7 +5351,7 @@ EXAMPLES
|
|
|
5345
5351
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
5346
5352
|
```
|
|
5347
5353
|
|
|
5348
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5354
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package1/version/create/get.ts)_
|
|
5349
5355
|
|
|
5350
5356
|
## `sf package1 version display`
|
|
5351
5357
|
|
|
@@ -5379,7 +5385,7 @@ EXAMPLES
|
|
|
5379
5385
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
5380
5386
|
```
|
|
5381
5387
|
|
|
5382
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5388
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package1/version/display.ts)_
|
|
5383
5389
|
|
|
5384
5390
|
## `sf package1 version list`
|
|
5385
5391
|
|
|
@@ -5417,7 +5423,7 @@ FLAG DESCRIPTIONS
|
|
|
5417
5423
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
5418
5424
|
```
|
|
5419
5425
|
|
|
5420
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.
|
|
5426
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.4.6/src/commands/package1/version/list.ts)_
|
|
5421
5427
|
|
|
5422
5428
|
## `sf plugins`
|
|
5423
5429
|
|
|
@@ -5440,7 +5446,7 @@ EXAMPLES
|
|
|
5440
5446
|
$ sf plugins
|
|
5441
5447
|
```
|
|
5442
5448
|
|
|
5443
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5449
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.3/src/commands/plugins/index.ts)_
|
|
5444
5450
|
|
|
5445
5451
|
## `sf plugins discover`
|
|
5446
5452
|
|
|
@@ -5485,7 +5491,7 @@ EXAMPLES
|
|
|
5485
5491
|
$ sf plugins inspect @salesforce/plugin-packaging
|
|
5486
5492
|
```
|
|
5487
5493
|
|
|
5488
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5494
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.3/src/commands/plugins/inspect.ts)_
|
|
5489
5495
|
|
|
5490
5496
|
## `sf plugins install PLUGIN`
|
|
5491
5497
|
|
|
@@ -5510,7 +5516,7 @@ GLOBAL FLAGS
|
|
|
5510
5516
|
DESCRIPTION
|
|
5511
5517
|
Installs a plugin into sf.
|
|
5512
5518
|
|
|
5513
|
-
Uses
|
|
5519
|
+
Uses npm to install plugins.
|
|
5514
5520
|
|
|
5515
5521
|
Installation of a user-installed plugin will override a core plugin.
|
|
5516
5522
|
|
|
@@ -5534,7 +5540,7 @@ EXAMPLES
|
|
|
5534
5540
|
$ sf plugins install someuser/someplugin
|
|
5535
5541
|
```
|
|
5536
5542
|
|
|
5537
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5543
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.3/src/commands/plugins/install.ts)_
|
|
5538
5544
|
|
|
5539
5545
|
## `sf plugins link PATH`
|
|
5540
5546
|
|
|
@@ -5564,7 +5570,7 @@ EXAMPLES
|
|
|
5564
5570
|
$ sf plugins link @salesforce/plugin-packaging
|
|
5565
5571
|
```
|
|
5566
5572
|
|
|
5567
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5573
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.3/src/commands/plugins/link.ts)_
|
|
5568
5574
|
|
|
5569
5575
|
## `sf plugins reset`
|
|
5570
5576
|
|
|
@@ -5579,7 +5585,7 @@ FLAGS
|
|
|
5579
5585
|
--reinstall Reinstall all plugins after uninstalling.
|
|
5580
5586
|
```
|
|
5581
5587
|
|
|
5582
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5588
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.3/src/commands/plugins/reset.ts)_
|
|
5583
5589
|
|
|
5584
5590
|
## `sf plugins trust verify`
|
|
5585
5591
|
|
|
@@ -5608,7 +5614,7 @@ EXAMPLES
|
|
|
5608
5614
|
$ sf plugins trust verify --npm @scope/npmName
|
|
5609
5615
|
```
|
|
5610
5616
|
|
|
5611
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.7.
|
|
5617
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.7.5/src/commands/plugins/trust/verify.ts)_
|
|
5612
5618
|
|
|
5613
5619
|
## `sf plugins uninstall [PLUGIN]`
|
|
5614
5620
|
|
|
@@ -5636,7 +5642,7 @@ EXAMPLES
|
|
|
5636
5642
|
$ sf plugins uninstall @salesforce/plugin-packaging
|
|
5637
5643
|
```
|
|
5638
5644
|
|
|
5639
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5645
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.3/src/commands/plugins/uninstall.ts)_
|
|
5640
5646
|
|
|
5641
5647
|
## `sf plugins update`
|
|
5642
5648
|
|
|
@@ -5654,7 +5660,7 @@ DESCRIPTION
|
|
|
5654
5660
|
Update installed plugins.
|
|
5655
5661
|
```
|
|
5656
5662
|
|
|
5657
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.
|
|
5663
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.2.3/src/commands/plugins/update.ts)_
|
|
5658
5664
|
|
|
5659
5665
|
## `sf project convert mdapi`
|
|
5660
5666
|
|
|
@@ -5662,8 +5668,8 @@ Convert metadata retrieved via Metadata API into the source format used in Sales
|
|
|
5662
5668
|
|
|
5663
5669
|
```
|
|
5664
5670
|
USAGE
|
|
5665
|
-
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value
|
|
5666
|
-
-x <value> | -m <value
|
|
5671
|
+
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value>...
|
|
5672
|
+
| -x <value> | -m <value>...]
|
|
5667
5673
|
|
|
5668
5674
|
FLAGS
|
|
5669
5675
|
-d, --output-dir=<value> Directory to store your files in after they’re converted to source format; can be an
|
|
@@ -5717,7 +5723,7 @@ FLAG DESCRIPTIONS
|
|
|
5717
5723
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5718
5724
|
```
|
|
5719
5725
|
|
|
5720
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5726
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/convert/mdapi.ts)_
|
|
5721
5727
|
|
|
5722
5728
|
## `sf project convert source`
|
|
5723
5729
|
|
|
@@ -5726,10 +5732,10 @@ Convert source-formatted files into metadata that you can deploy using Metadata
|
|
|
5726
5732
|
```
|
|
5727
5733
|
USAGE
|
|
5728
5734
|
$ sf project convert source [--json] [--flags-dir <value>] [--api-version <value>] [-r <value>] [-d <value>] [-n <value>]
|
|
5729
|
-
[-p <value
|
|
5735
|
+
[-p <value>... | -x <value> | -m <value>...]
|
|
5730
5736
|
|
|
5731
5737
|
FLAGS
|
|
5732
|
-
-d, --output-dir=<value> [default:
|
|
5738
|
+
-d, --output-dir=<value> [default: metadataPackage_1717649514619] Output directory to store the Metadata
|
|
5733
5739
|
API–formatted files in.
|
|
5734
5740
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
5735
5741
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -5790,7 +5796,7 @@ FLAG DESCRIPTIONS
|
|
|
5790
5796
|
Override the api version used for api requests made by this command
|
|
5791
5797
|
```
|
|
5792
5798
|
|
|
5793
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5799
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/convert/source.ts)_
|
|
5794
5800
|
|
|
5795
5801
|
## `sf project convert source-behavior`
|
|
5796
5802
|
|
|
@@ -5847,7 +5853,7 @@ EXAMPLES
|
|
|
5847
5853
|
$ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run --preserve-temp-dir
|
|
5848
5854
|
```
|
|
5849
5855
|
|
|
5850
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5856
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/convert/source-behavior.ts)_
|
|
5851
5857
|
|
|
5852
5858
|
## `sf project delete source`
|
|
5853
5859
|
|
|
@@ -5856,8 +5862,8 @@ Delete source from your project and from a non-source-tracked org.
|
|
|
5856
5862
|
```
|
|
5857
5863
|
USAGE
|
|
5858
5864
|
$ sf project delete source -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>] [--tests
|
|
5859
|
-
<value
|
|
5860
|
-
-c]] [--verbose]
|
|
5865
|
+
<value>...] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>...] [-p <value>...] [-f
|
|
5866
|
+
[-t | -c]] [--verbose]
|
|
5861
5867
|
|
|
5862
5868
|
FLAGS
|
|
5863
5869
|
-c, --check-only Validate delete command but don't delete anything from the org or the local project.
|
|
@@ -5987,7 +5993,7 @@ FLAG DESCRIPTIONS
|
|
|
5987
5993
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
5988
5994
|
```
|
|
5989
5995
|
|
|
5990
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5996
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/delete/source.ts)_
|
|
5991
5997
|
|
|
5992
5998
|
## `sf project delete tracking`
|
|
5993
5999
|
|
|
@@ -6024,7 +6030,7 @@ EXAMPLES
|
|
|
6024
6030
|
$ sf project delete tracking --target-org my-scratch
|
|
6025
6031
|
```
|
|
6026
6032
|
|
|
6027
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6033
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/delete/tracking.ts)_
|
|
6028
6034
|
|
|
6029
6035
|
## `sf project deploy cancel`
|
|
6030
6036
|
|
|
@@ -6032,7 +6038,7 @@ Cancel a deploy operation.
|
|
|
6032
6038
|
|
|
6033
6039
|
```
|
|
6034
6040
|
USAGE
|
|
6035
|
-
$ sf project deploy cancel [--json] [--flags-dir <value>] [-o <value>] [--async | -w <
|
|
6041
|
+
$ sf project deploy cancel [--json] [--flags-dir <value>] [-o <value>] [--async | -w <minutes>] [-i <value>] [-r]
|
|
6036
6042
|
|
|
6037
6043
|
FLAGS
|
|
6038
6044
|
-i, --job-id=<value> Job ID of the deploy operation you want to cancel.
|
|
@@ -6096,7 +6102,7 @@ FLAG DESCRIPTIONS
|
|
|
6096
6102
|
project deploy report".
|
|
6097
6103
|
```
|
|
6098
6104
|
|
|
6099
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6105
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/cancel.ts)_
|
|
6100
6106
|
|
|
6101
6107
|
## `sf project deploy preview`
|
|
6102
6108
|
|
|
@@ -6104,7 +6110,7 @@ Preview a deployment to see what will deploy to the org, the potential conflicts
|
|
|
6104
6110
|
|
|
6105
6111
|
```
|
|
6106
6112
|
USAGE
|
|
6107
|
-
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value
|
|
6113
|
+
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value>... | -m <value>...]
|
|
6108
6114
|
[--concise]
|
|
6109
6115
|
|
|
6110
6116
|
FLAGS
|
|
@@ -6179,7 +6185,7 @@ FLAG DESCRIPTIONS
|
|
|
6179
6185
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
6180
6186
|
```
|
|
6181
6187
|
|
|
6182
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6188
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/preview.ts)_
|
|
6183
6189
|
|
|
6184
6190
|
## `sf project deploy quick`
|
|
6185
6191
|
|
|
@@ -6187,8 +6193,8 @@ Quickly deploy a validated deployment to an org.
|
|
|
6187
6193
|
|
|
6188
6194
|
```
|
|
6189
6195
|
USAGE
|
|
6190
|
-
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <
|
|
6191
|
-
<value>] [-r] [-a <value>]
|
|
6196
|
+
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <minutes>] [--concise | --verbose] [-i <value>]
|
|
6197
|
+
[-o <value>] [-r] [-a <value>]
|
|
6192
6198
|
|
|
6193
6199
|
FLAGS
|
|
6194
6200
|
-a, --api-version=<value> Target API version for the deploy.
|
|
@@ -6221,7 +6227,7 @@ DESCRIPTION
|
|
|
6221
6227
|
This command doesn’t attempt to merge your source with the versions in your org.
|
|
6222
6228
|
|
|
6223
6229
|
Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default,
|
|
6224
|
-
sandboxes don't run tests during a deploy. Use
|
|
6230
|
+
sandboxes don't run tests during a deploy. Use "sf project deploy start" instead.
|
|
6225
6231
|
|
|
6226
6232
|
ALIASES
|
|
6227
6233
|
$ sf deploy metadata quick
|
|
@@ -6272,7 +6278,7 @@ ERROR CODES
|
|
|
6272
6278
|
Canceling (69) The deploy is being canceled.
|
|
6273
6279
|
```
|
|
6274
6280
|
|
|
6275
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6281
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/quick.ts)_
|
|
6276
6282
|
|
|
6277
6283
|
## `sf project deploy report`
|
|
6278
6284
|
|
|
@@ -6281,8 +6287,8 @@ Check or poll for the status of a deploy operation.
|
|
|
6281
6287
|
```
|
|
6282
6288
|
USAGE
|
|
6283
6289
|
$ sf project deploy report [--json] [--flags-dir <value>] [-o <value>] [-i <value>] [-r] [--coverage-formatters
|
|
6284
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
6285
|
-
<value>] [-w <
|
|
6290
|
+
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...] [--junit]
|
|
6291
|
+
[--results-dir <value>] [-w <minutes>]
|
|
6286
6292
|
|
|
6287
6293
|
FLAGS
|
|
6288
6294
|
-i, --job-id=<value> Job ID of the deploy operation you want to check the status of.
|
|
@@ -6364,7 +6370,7 @@ FLAG DESCRIPTIONS
|
|
|
6364
6370
|
--coverage-formatters lcov --coverage-formatters clover
|
|
6365
6371
|
```
|
|
6366
6372
|
|
|
6367
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6373
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/report.ts)_
|
|
6368
6374
|
|
|
6369
6375
|
## `sf project deploy resume`
|
|
6370
6376
|
|
|
@@ -6372,8 +6378,8 @@ Resume watching a deploy operation and update source tracking when the deploy co
|
|
|
6372
6378
|
|
|
6373
6379
|
```
|
|
6374
6380
|
USAGE
|
|
6375
|
-
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <
|
|
6376
|
-
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6381
|
+
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <minutes>]
|
|
6382
|
+
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...]
|
|
6377
6383
|
[--junit] [--results-dir <value>]
|
|
6378
6384
|
|
|
6379
6385
|
FLAGS
|
|
@@ -6461,7 +6467,7 @@ ERROR CODES
|
|
|
6461
6467
|
Canceling (69) The deploy is being canceled.
|
|
6462
6468
|
```
|
|
6463
6469
|
|
|
6464
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6470
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/resume.ts)_
|
|
6465
6471
|
|
|
6466
6472
|
## `sf project deploy start`
|
|
6467
6473
|
|
|
@@ -6469,11 +6475,11 @@ Deploy metadata to an org from your local project.
|
|
|
6469
6475
|
|
|
6470
6476
|
```
|
|
6471
6477
|
USAGE
|
|
6472
|
-
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <
|
|
6473
|
-
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value
|
|
6474
|
-
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value
|
|
6475
|
-
| --metadata-dir <value>]] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6476
|
-
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6478
|
+
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <minutes>] [--concise |
|
|
6479
|
+
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value>...] [-l
|
|
6480
|
+
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value>... | -m
|
|
6481
|
+
<value>... | --metadata-dir <value>]] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6482
|
+
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...]
|
|
6477
6483
|
[--junit] [--results-dir <value>]
|
|
6478
6484
|
|
|
6479
6485
|
FLAGS
|
|
@@ -6704,7 +6710,7 @@ ERROR CODES
|
|
|
6704
6710
|
Canceling (69) The deploy is being canceled.
|
|
6705
6711
|
```
|
|
6706
6712
|
|
|
6707
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6713
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/start.ts)_
|
|
6708
6714
|
|
|
6709
6715
|
## `sf project deploy validate`
|
|
6710
6716
|
|
|
@@ -6713,10 +6719,11 @@ Validate a metadata deployment without actually executing it.
|
|
|
6713
6719
|
```
|
|
6714
6720
|
USAGE
|
|
6715
6721
|
$ sf project deploy validate -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [--concise | --verbose] [-m
|
|
6716
|
-
<value
|
|
6717
|
-
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <
|
|
6718
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
6719
|
-
<value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ]
|
|
6722
|
+
<value>...] [-d <value>...] [--single-package --metadata-dir <value>] [-t <value>...] [-l
|
|
6723
|
+
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <minutes>] [-g] [--coverage-formatters
|
|
6724
|
+
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...] [--junit]
|
|
6725
|
+
[--results-dir <value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ]
|
|
6726
|
+
[--post-destructive-changes <value> ]
|
|
6720
6727
|
|
|
6721
6728
|
FLAGS
|
|
6722
6729
|
-a, --api-version=<value> Target API version for the validation.
|
|
@@ -6893,7 +6900,7 @@ ERROR CODES
|
|
|
6893
6900
|
Canceling (69) The deploy is being canceled.
|
|
6894
6901
|
```
|
|
6895
6902
|
|
|
6896
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6903
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/validate.ts)_
|
|
6897
6904
|
|
|
6898
6905
|
## `sf project generate`
|
|
6899
6906
|
|
|
@@ -7006,8 +7013,8 @@ Create a project manifest that lists the metadata components you want to deploy
|
|
|
7006
7013
|
|
|
7007
7014
|
```
|
|
7008
7015
|
USAGE
|
|
7009
|
-
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value
|
|
7010
|
-
-t pre|post|destroy|package] [-c managed|unlocked --from-org <value>] [-d <value>]
|
|
7016
|
+
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>...] [-p <value>...] [-n
|
|
7017
|
+
<value> | -t pre|post|destroy|package] [-c managed|unlocked... --from-org <value>] [-d <value>]
|
|
7011
7018
|
|
|
7012
7019
|
FLAGS
|
|
7013
7020
|
-c, --include-packages=<option>... Package types (managed, unlocked) whose metadata is included in the manifest; by
|
|
@@ -7075,7 +7082,7 @@ EXAMPLES
|
|
|
7075
7082
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
7076
7083
|
```
|
|
7077
7084
|
|
|
7078
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7085
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/generate/manifest.ts)_
|
|
7079
7086
|
|
|
7080
7087
|
## `sf project list ignored`
|
|
7081
7088
|
|
|
@@ -7117,7 +7124,7 @@ EXAMPLES
|
|
|
7117
7124
|
$ sf project list ignored --source-dir package.xml
|
|
7118
7125
|
```
|
|
7119
7126
|
|
|
7120
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7127
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/list/ignored.ts)_
|
|
7121
7128
|
|
|
7122
7129
|
## `sf project reset tracking`
|
|
7123
7130
|
|
|
@@ -7166,7 +7173,7 @@ EXAMPLES
|
|
|
7166
7173
|
$ sf project reset tracking --revision 30
|
|
7167
7174
|
```
|
|
7168
7175
|
|
|
7169
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7176
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/reset/tracking.ts)_
|
|
7170
7177
|
|
|
7171
7178
|
## `sf project retrieve preview`
|
|
7172
7179
|
|
|
@@ -7220,7 +7227,7 @@ FLAG DESCRIPTIONS
|
|
|
7220
7227
|
production orgs.
|
|
7221
7228
|
```
|
|
7222
7229
|
|
|
7223
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7230
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/retrieve/preview.ts)_
|
|
7224
7231
|
|
|
7225
7232
|
## `sf project retrieve start`
|
|
7226
7233
|
|
|
@@ -7228,8 +7235,9 @@ Retrieve metadata from an org to your local project.
|
|
|
7228
7235
|
|
|
7229
7236
|
```
|
|
7230
7237
|
USAGE
|
|
7231
|
-
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value
|
|
7232
|
-
<value
|
|
7238
|
+
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value>... | -d
|
|
7239
|
+
<value>...] [-r <value> | -n <value>... | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name
|
|
7240
|
+
<value> ]
|
|
7233
7241
|
|
|
7234
7242
|
FLAGS
|
|
7235
7243
|
-a, --api-version=<value> Target API version for the retrieve.
|
|
@@ -7367,7 +7375,9 @@ FLAG DESCRIPTIONS
|
|
|
7367
7375
|
If the target directory matches one of the package directories in your sfdx-project.json file, the command fails.
|
|
7368
7376
|
Running the command multiple times with the same target adds new files and overwrites existing files.
|
|
7369
7377
|
|
|
7370
|
-
-w, --wait=<value>
|
|
7378
|
+
-w, --wait=<value>
|
|
7379
|
+
|
|
7380
|
+
Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
7371
7381
|
|
|
7372
7382
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
7373
7383
|
|
|
@@ -7384,7 +7394,7 @@ ENVIRONMENT VARIABLES
|
|
|
7384
7394
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
7385
7395
|
```
|
|
7386
7396
|
|
|
7387
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7397
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/retrieve/start.ts)_
|
|
7388
7398
|
|
|
7389
7399
|
## `sf schema generate field`
|
|
7390
7400
|
|