@salesforce/cli 2.18.7 → 2.19.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 +124 -219
- package/npm-shrinkwrap.json +562 -457
- package/oclif.manifest.json +1 -192
- package/package.json +27 -27
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.19.1 linux-x64 node-v20.9.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -100,8 +100,6 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
100
100
|
- [`sf lightning generate event`](#sf-lightning-generate-event)
|
|
101
101
|
- [`sf lightning generate interface`](#sf-lightning-generate-interface)
|
|
102
102
|
- [`sf lightning generate test`](#sf-lightning-generate-test)
|
|
103
|
-
- [`sf login`](#sf-login)
|
|
104
|
-
- [`sf logout`](#sf-logout)
|
|
105
103
|
- [`sf org assign permset`](#sf-org-assign-permset)
|
|
106
104
|
- [`sf org assign permsetlicense`](#sf-org-assign-permsetlicense)
|
|
107
105
|
- [`sf org create sandbox`](#sf-org-create-sandbox)
|
|
@@ -193,7 +191,7 @@ EXAMPLES
|
|
|
193
191
|
$ sf alias list
|
|
194
192
|
```
|
|
195
193
|
|
|
196
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
194
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.6/src/commands/alias/list.ts)_
|
|
197
195
|
|
|
198
196
|
## `sf alias set`
|
|
199
197
|
|
|
@@ -241,7 +239,7 @@ EXAMPLES
|
|
|
241
239
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
242
240
|
```
|
|
243
241
|
|
|
244
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
242
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.6/src/commands/alias/set.ts)_
|
|
245
243
|
|
|
246
244
|
## `sf alias unset`
|
|
247
245
|
|
|
@@ -280,7 +278,7 @@ EXAMPLES
|
|
|
280
278
|
$ sf alias unset --all [--no-prompt]
|
|
281
279
|
```
|
|
282
280
|
|
|
283
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
281
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.6/src/commands/alias/unset.ts)_
|
|
284
282
|
|
|
285
283
|
## `sf analytics generate template`
|
|
286
284
|
|
|
@@ -890,7 +888,7 @@ CONFIGURATION VARIABLES
|
|
|
890
888
|
org-max-query-limit Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
|
|
891
889
|
```
|
|
892
890
|
|
|
893
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
891
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.6/src/commands/config/get.ts)_
|
|
894
892
|
|
|
895
893
|
## `sf config list`
|
|
896
894
|
|
|
@@ -929,7 +927,7 @@ EXAMPLES
|
|
|
929
927
|
$ sf config list
|
|
930
928
|
```
|
|
931
929
|
|
|
932
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
930
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.6/src/commands/config/list.ts)_
|
|
933
931
|
|
|
934
932
|
## `sf config set`
|
|
935
933
|
|
|
@@ -996,7 +994,7 @@ CONFIGURATION VARIABLES
|
|
|
996
994
|
org-max-query-limit Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
|
|
997
995
|
```
|
|
998
996
|
|
|
999
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
997
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.6/src/commands/config/set.ts)_
|
|
1000
998
|
|
|
1001
999
|
## `sf config unset`
|
|
1002
1000
|
|
|
@@ -1044,7 +1042,7 @@ CONFIGURATION VARIABLES
|
|
|
1044
1042
|
org-max-query-limit Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
|
|
1045
1043
|
```
|
|
1046
1044
|
|
|
1047
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
1045
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.6/src/commands/config/unset.ts)_
|
|
1048
1046
|
|
|
1049
1047
|
## `sf data create record`
|
|
1050
1048
|
|
|
@@ -1098,7 +1096,7 @@ EXAMPLES
|
|
|
1098
1096
|
TracedEntityId=01p17000000R6bLAAS"
|
|
1099
1097
|
```
|
|
1100
1098
|
|
|
1101
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1099
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/create/record.ts)_
|
|
1102
1100
|
|
|
1103
1101
|
## `sf data delete bulk`
|
|
1104
1102
|
|
|
@@ -1142,7 +1140,7 @@ EXAMPLES
|
|
|
1142
1140
|
$ sf data delete bulk --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1143
1141
|
```
|
|
1144
1142
|
|
|
1145
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1143
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/delete/bulk.ts)_
|
|
1146
1144
|
|
|
1147
1145
|
## `sf data delete record`
|
|
1148
1146
|
|
|
@@ -1200,7 +1198,7 @@ EXAMPLES
|
|
|
1200
1198
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1201
1199
|
```
|
|
1202
1200
|
|
|
1203
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1201
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/delete/record.ts)_
|
|
1204
1202
|
|
|
1205
1203
|
## `sf data delete resume`
|
|
1206
1204
|
|
|
@@ -1237,7 +1235,7 @@ EXAMPLES
|
|
|
1237
1235
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
1238
1236
|
```
|
|
1239
1237
|
|
|
1240
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1238
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/delete/resume.ts)_
|
|
1241
1239
|
|
|
1242
1240
|
## `sf data export tree`
|
|
1243
1241
|
|
|
@@ -1294,7 +1292,7 @@ EXAMPLES
|
|
|
1294
1292
|
my-scratch
|
|
1295
1293
|
```
|
|
1296
1294
|
|
|
1297
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1295
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/export/tree.ts)_
|
|
1298
1296
|
|
|
1299
1297
|
## `sf data get record`
|
|
1300
1298
|
|
|
@@ -1355,7 +1353,7 @@ EXAMPLES
|
|
|
1355
1353
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1356
1354
|
```
|
|
1357
1355
|
|
|
1358
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1356
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/get/record.ts)_
|
|
1359
1357
|
|
|
1360
1358
|
## `sf data import tree`
|
|
1361
1359
|
|
|
@@ -1405,7 +1403,7 @@ EXAMPLES
|
|
|
1405
1403
|
$ sf data import tree --plan Account-Contact-plan.json
|
|
1406
1404
|
```
|
|
1407
1405
|
|
|
1408
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1406
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/import/tree.ts)_
|
|
1409
1407
|
|
|
1410
1408
|
## `sf data query`
|
|
1411
1409
|
|
|
@@ -1467,7 +1465,7 @@ EXAMPLES
|
|
|
1467
1465
|
$ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
|
|
1468
1466
|
```
|
|
1469
1467
|
|
|
1470
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1468
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/query.ts)_
|
|
1471
1469
|
|
|
1472
1470
|
## `sf data query resume`
|
|
1473
1471
|
|
|
@@ -1503,7 +1501,7 @@ EXAMPLES
|
|
|
1503
1501
|
$ sf data query resume --bulk-query-id 7500x000005BdFzXXX
|
|
1504
1502
|
```
|
|
1505
1503
|
|
|
1506
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1504
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/query/resume.ts)_
|
|
1507
1505
|
|
|
1508
1506
|
## `sf data resume`
|
|
1509
1507
|
|
|
@@ -1538,7 +1536,7 @@ EXAMPLES
|
|
|
1538
1536
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
1539
1537
|
```
|
|
1540
1538
|
|
|
1541
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1539
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/resume.ts)_
|
|
1542
1540
|
|
|
1543
1541
|
## `sf data update record`
|
|
1544
1542
|
|
|
@@ -1598,7 +1596,7 @@ EXAMPLES
|
|
|
1598
1596
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
1599
1597
|
```
|
|
1600
1598
|
|
|
1601
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1599
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/update/record.ts)_
|
|
1602
1600
|
|
|
1603
1601
|
## `sf data upsert bulk`
|
|
1604
1602
|
|
|
@@ -1649,7 +1647,7 @@ EXAMPLES
|
|
|
1649
1647
|
my-scratch
|
|
1650
1648
|
```
|
|
1651
1649
|
|
|
1652
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1650
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/upsert/bulk.ts)_
|
|
1653
1651
|
|
|
1654
1652
|
## `sf data upsert resume`
|
|
1655
1653
|
|
|
@@ -1686,7 +1684,7 @@ EXAMPLES
|
|
|
1686
1684
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
1687
1685
|
```
|
|
1688
1686
|
|
|
1689
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1687
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/data/upsert/resume.ts)_
|
|
1690
1688
|
|
|
1691
1689
|
## `sf doctor`
|
|
1692
1690
|
|
|
@@ -1733,7 +1731,7 @@ EXAMPLES
|
|
|
1733
1731
|
$ sf doctor --plugin @salesforce/plugin-source
|
|
1734
1732
|
```
|
|
1735
1733
|
|
|
1736
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0.
|
|
1734
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0.3/src/commands/doctor.ts)_
|
|
1737
1735
|
|
|
1738
1736
|
## `sf force data bulk delete`
|
|
1739
1737
|
|
|
@@ -1777,7 +1775,7 @@ EXAMPLES
|
|
|
1777
1775
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1778
1776
|
```
|
|
1779
1777
|
|
|
1780
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1778
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/force/data/bulk/delete.ts)_
|
|
1781
1779
|
|
|
1782
1780
|
## `sf force data bulk status`
|
|
1783
1781
|
|
|
@@ -1812,7 +1810,7 @@ EXAMPLES
|
|
|
1812
1810
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
1813
1811
|
```
|
|
1814
1812
|
|
|
1815
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1813
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/force/data/bulk/status.ts)_
|
|
1816
1814
|
|
|
1817
1815
|
## `sf force data bulk upsert`
|
|
1818
1816
|
|
|
@@ -1868,7 +1866,7 @@ EXAMPLES
|
|
|
1868
1866
|
--target-org my-scratch
|
|
1869
1867
|
```
|
|
1870
1868
|
|
|
1871
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/
|
|
1869
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.1/src/commands/force/data/bulk/upsert.ts)_
|
|
1872
1870
|
|
|
1873
1871
|
## `sf force mdapi deploy`
|
|
1874
1872
|
|
|
@@ -1876,8 +1874,8 @@ Deploy metadata to an org using Metadata API.
|
|
|
1876
1874
|
|
|
1877
1875
|
```
|
|
1878
1876
|
USAGE
|
|
1879
|
-
$ sf force mdapi deploy -u <value> [--
|
|
1880
|
-
|
|
1877
|
+
$ sf force mdapi deploy -u <value> [--api-version <value>] [-d <value>] [-w <value>] [-o] [-g] [-q <value> | -l
|
|
1878
|
+
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <value> | -c] [--verbose] [-f <value>] [-s]
|
|
1881
1879
|
[--soapdeploy] [--purgeondelete] [--concise] [--resultsdir <value>] [--coverageformatters
|
|
1882
1880
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
1883
1881
|
|
|
@@ -1941,9 +1939,6 @@ FLAGS
|
|
|
1941
1939
|
--verbose
|
|
1942
1940
|
Display verbose output of the deploy results.
|
|
1943
1941
|
|
|
1944
|
-
GLOBAL FLAGS
|
|
1945
|
-
--json Format output as json.
|
|
1946
|
-
|
|
1947
1942
|
EXAMPLES
|
|
1948
1943
|
Return a job ID you can use to check the deploy status:
|
|
1949
1944
|
|
|
@@ -2068,7 +2063,7 @@ FLAG DESCRIPTIONS
|
|
|
2068
2063
|
Indicates that you want verbose output from the deploy operation.
|
|
2069
2064
|
```
|
|
2070
2065
|
|
|
2071
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2066
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/mdapi/deploy.ts)_
|
|
2072
2067
|
|
|
2073
2068
|
## `sf force mdapi deploy cancel`
|
|
2074
2069
|
|
|
@@ -2076,7 +2071,7 @@ Cancel a metadata deployment.
|
|
|
2076
2071
|
|
|
2077
2072
|
```
|
|
2078
2073
|
USAGE
|
|
2079
|
-
$ sf force mdapi deploy cancel -o <value> [--
|
|
2074
|
+
$ sf force mdapi deploy cancel -o <value> [--api-version <value>] [-w <value>] [-i <value>]
|
|
2080
2075
|
|
|
2081
2076
|
FLAGS
|
|
2082
2077
|
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment.
|
|
@@ -2085,9 +2080,6 @@ FLAGS
|
|
|
2085
2080
|
results to the terminal window.
|
|
2086
2081
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2087
2082
|
|
|
2088
|
-
GLOBAL FLAGS
|
|
2089
|
-
--json Format output as json.
|
|
2090
|
-
|
|
2091
2083
|
DESCRIPTION
|
|
2092
2084
|
Cancel a metadata deployment.
|
|
2093
2085
|
|
|
@@ -2111,7 +2103,7 @@ FLAG DESCRIPTIONS
|
|
|
2111
2103
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2112
2104
|
```
|
|
2113
2105
|
|
|
2114
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2106
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/mdapi/deploy/cancel.ts)_
|
|
2115
2107
|
|
|
2116
2108
|
## `sf force mdapi deploy report`
|
|
2117
2109
|
|
|
@@ -2119,7 +2111,7 @@ Check the status of a metadata deployment.
|
|
|
2119
2111
|
|
|
2120
2112
|
```
|
|
2121
2113
|
USAGE
|
|
2122
|
-
$ sf force mdapi deploy report -o <value> [--
|
|
2114
|
+
$ sf force mdapi deploy report -o <value> [--api-version <value>] [-w <value>] [-i <value>] [--verbose] [--concise]
|
|
2123
2115
|
[--resultsdir <value>] [--coverageformatters
|
|
2124
2116
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2125
2117
|
|
|
@@ -2152,9 +2144,6 @@ FLAGS
|
|
|
2152
2144
|
--verbose
|
|
2153
2145
|
Verbose output of deploy results.
|
|
2154
2146
|
|
|
2155
|
-
GLOBAL FLAGS
|
|
2156
|
-
--json Format output as json.
|
|
2157
|
-
|
|
2158
2147
|
DESCRIPTION
|
|
2159
2148
|
Check the status of a metadata deployment.
|
|
2160
2149
|
|
|
@@ -2182,7 +2171,7 @@ FLAG DESCRIPTIONS
|
|
|
2182
2171
|
use the ID of the most recent metadata deployment.
|
|
2183
2172
|
```
|
|
2184
2173
|
|
|
2185
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2174
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/mdapi/deploy/report.ts)_
|
|
2186
2175
|
|
|
2187
2176
|
## `sf force mdapi retrieve`
|
|
2188
2177
|
|
|
@@ -2190,8 +2179,8 @@ Retrieve metadata from an org using Metadata API.
|
|
|
2190
2179
|
|
|
2191
2180
|
```
|
|
2192
2181
|
USAGE
|
|
2193
|
-
$ sf force mdapi retrieve -o <value> -r <value> [
|
|
2194
|
-
|
|
2182
|
+
$ sf force mdapi retrieve -o <value> -r <value> [-k <value> | -d <value> | -p <value>] [-s] [-n <value>] [-z] [-w
|
|
2183
|
+
<value>] [-a <value>] [--verbose]
|
|
2195
2184
|
|
|
2196
2185
|
FLAGS
|
|
2197
2186
|
-a, --apiversion=<value> Target API version for the retrieve.
|
|
@@ -2208,9 +2197,6 @@ FLAGS
|
|
|
2208
2197
|
-z, --unzip Extract all files from the retrieved zip file.
|
|
2209
2198
|
--verbose Display verbose output of retrieve result.
|
|
2210
2199
|
|
|
2211
|
-
GLOBAL FLAGS
|
|
2212
|
-
--json Format output as json.
|
|
2213
|
-
|
|
2214
2200
|
DESCRIPTION
|
|
2215
2201
|
Retrieve metadata from an org using Metadata API.
|
|
2216
2202
|
|
|
@@ -2246,7 +2232,7 @@ FLAG DESCRIPTIONS
|
|
|
2246
2232
|
By default, the CLI assumes the directory is structured for a set of packages.
|
|
2247
2233
|
```
|
|
2248
2234
|
|
|
2249
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2235
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/mdapi/retrieve.ts)_
|
|
2250
2236
|
|
|
2251
2237
|
## `sf force mdapi retrieve report`
|
|
2252
2238
|
|
|
@@ -2254,8 +2240,8 @@ Check the status of a metadata retrieval.
|
|
|
2254
2240
|
|
|
2255
2241
|
```
|
|
2256
2242
|
USAGE
|
|
2257
|
-
$ sf force mdapi retrieve report -o <value> [--
|
|
2258
|
-
|
|
2243
|
+
$ sf force mdapi retrieve report -o <value> [--api-version <value>] [-r <value>] [-i <value>] [-n <value>] [-z] [-w <value>]
|
|
2244
|
+
[--verbose]
|
|
2259
2245
|
|
|
2260
2246
|
FLAGS
|
|
2261
2247
|
-i, --jobid=<value> Job ID of the retrieve you want to check; defaults to your most recent CLI retrieval.
|
|
@@ -2268,9 +2254,6 @@ FLAGS
|
|
|
2268
2254
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2269
2255
|
--verbose Display verbose output of retrieve result.
|
|
2270
2256
|
|
|
2271
|
-
GLOBAL FLAGS
|
|
2272
|
-
--json Format output as json.
|
|
2273
|
-
|
|
2274
2257
|
DESCRIPTION
|
|
2275
2258
|
Check the status of a metadata retrieval.
|
|
2276
2259
|
|
|
@@ -2300,7 +2283,7 @@ FLAG DESCRIPTIONS
|
|
|
2300
2283
|
You must specify a --retrievetargetdir. Use with --wait to resume waiting.
|
|
2301
2284
|
```
|
|
2302
2285
|
|
|
2303
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2286
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/mdapi/retrieve/report.ts)_
|
|
2304
2287
|
|
|
2305
2288
|
## `sf force org clone`
|
|
2306
2289
|
|
|
@@ -2347,7 +2330,7 @@ FLAG DESCRIPTIONS
|
|
|
2347
2330
|
for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
|
|
2348
2331
|
```
|
|
2349
2332
|
|
|
2350
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
2333
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/clone.ts)_
|
|
2351
2334
|
|
|
2352
2335
|
## `sf force org create`
|
|
2353
2336
|
|
|
@@ -2395,7 +2378,7 @@ EXAMPLES
|
|
|
2395
2378
|
$ sf force org create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
|
|
2396
2379
|
```
|
|
2397
2380
|
|
|
2398
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
2381
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/create.ts)_
|
|
2399
2382
|
|
|
2400
2383
|
## `sf force org delete`
|
|
2401
2384
|
|
|
@@ -2427,7 +2410,7 @@ EXAMPLES
|
|
|
2427
2410
|
$ sf force org delete -u MyOrgAlias -p
|
|
2428
2411
|
```
|
|
2429
2412
|
|
|
2430
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
2413
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/delete.ts)_
|
|
2431
2414
|
|
|
2432
2415
|
## `sf force org status`
|
|
2433
2416
|
|
|
@@ -2465,7 +2448,7 @@ EXAMPLES
|
|
|
2465
2448
|
$ sf force org status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
|
|
2466
2449
|
```
|
|
2467
2450
|
|
|
2468
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
2451
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/status.ts)_
|
|
2469
2452
|
|
|
2470
2453
|
## `sf force source deploy`
|
|
2471
2454
|
|
|
@@ -2473,10 +2456,10 @@ Deploy source to an org.
|
|
|
2473
2456
|
|
|
2474
2457
|
```
|
|
2475
2458
|
USAGE
|
|
2476
|
-
$ sf force source deploy -u <value> [--
|
|
2477
|
-
|
|
2478
|
-
|
|
2479
|
-
|
|
2459
|
+
$ sf force source deploy -u <value> [--api-version <value>] [--soapdeploy] [-w <value>] [-o] [-g] [--purgeondelete -x
|
|
2460
|
+
<value>] [-q <value> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <value> | -t]
|
|
2461
|
+
[--verbose] [-m <value>] [-p <value>] [--predestructivechanges <value> ] [--postdestructivechanges <value> ] [-f ]
|
|
2462
|
+
[--resultsdir <value>] [--coverageformatters
|
|
2480
2463
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2481
2464
|
|
|
2482
2465
|
FLAGS
|
|
@@ -2548,9 +2531,6 @@ FLAGS
|
|
|
2548
2531
|
--verbose
|
|
2549
2532
|
Specify verbose output about the deploy result.
|
|
2550
2533
|
|
|
2551
|
-
GLOBAL FLAGS
|
|
2552
|
-
--json Format output as json.
|
|
2553
|
-
|
|
2554
2534
|
DESCRIPTION
|
|
2555
2535
|
Deploy source to an org.
|
|
2556
2536
|
|
|
@@ -2731,7 +2711,7 @@ FLAG DESCRIPTIONS
|
|
|
2731
2711
|
If you specify this parameter, don’t specify --metadata or --sourcepath.
|
|
2732
2712
|
```
|
|
2733
2713
|
|
|
2734
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2714
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/source/deploy.ts)_
|
|
2735
2715
|
|
|
2736
2716
|
## `sf force source deploy cancel`
|
|
2737
2717
|
|
|
@@ -2739,7 +2719,7 @@ Cancel a source deployment.
|
|
|
2739
2719
|
|
|
2740
2720
|
```
|
|
2741
2721
|
USAGE
|
|
2742
|
-
$ sf force source deploy cancel -o <value> [--
|
|
2722
|
+
$ sf force source deploy cancel -o <value> [--api-version <value>] [-w <value>] [-i <value>]
|
|
2743
2723
|
|
|
2744
2724
|
FLAGS
|
|
2745
2725
|
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment if
|
|
@@ -2749,9 +2729,6 @@ FLAGS
|
|
|
2749
2729
|
display results.
|
|
2750
2730
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2751
2731
|
|
|
2752
|
-
GLOBAL FLAGS
|
|
2753
|
-
--json Format output as json.
|
|
2754
|
-
|
|
2755
2732
|
DESCRIPTION
|
|
2756
2733
|
Cancel a source deployment.
|
|
2757
2734
|
|
|
@@ -2776,7 +2753,7 @@ FLAG DESCRIPTIONS
|
|
|
2776
2753
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2777
2754
|
```
|
|
2778
2755
|
|
|
2779
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2756
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/source/deploy/cancel.ts)_
|
|
2780
2757
|
|
|
2781
2758
|
## `sf force source deploy report`
|
|
2782
2759
|
|
|
@@ -2784,8 +2761,8 @@ Check the status of a metadata deployment.
|
|
|
2784
2761
|
|
|
2785
2762
|
```
|
|
2786
2763
|
USAGE
|
|
2787
|
-
$ sf force source deploy report -o <value> [--
|
|
2788
|
-
|
|
2764
|
+
$ sf force source deploy report -o <value> [--api-version <value>] [-w <value>] [-i <value>] [--verbose] [--resultsdir
|
|
2765
|
+
<value>] [--coverageformatters
|
|
2789
2766
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2790
2767
|
|
|
2791
2768
|
FLAGS
|
|
@@ -2814,9 +2791,6 @@ FLAGS
|
|
|
2814
2791
|
--verbose
|
|
2815
2792
|
Verbose output of deploy result.
|
|
2816
2793
|
|
|
2817
|
-
GLOBAL FLAGS
|
|
2818
|
-
--json Format output as json.
|
|
2819
|
-
|
|
2820
2794
|
DESCRIPTION
|
|
2821
2795
|
Check the status of a metadata deployment.
|
|
2822
2796
|
|
|
@@ -2839,7 +2813,7 @@ FLAG DESCRIPTIONS
|
|
|
2839
2813
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2840
2814
|
```
|
|
2841
2815
|
|
|
2842
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2816
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/source/deploy/report.ts)_
|
|
2843
2817
|
|
|
2844
2818
|
## `sf force source pull`
|
|
2845
2819
|
|
|
@@ -2847,7 +2821,7 @@ Pull changed source from the org to your project to keep them in sync.
|
|
|
2847
2821
|
|
|
2848
2822
|
```
|
|
2849
2823
|
USAGE
|
|
2850
|
-
$ sf force source pull -o <value> [--
|
|
2824
|
+
$ sf force source pull -o <value> [--verbose] [--api-version <value>] [-f] [-w <value>]
|
|
2851
2825
|
|
|
2852
2826
|
FLAGS
|
|
2853
2827
|
-f, --forceoverwrite Ignore conflict warnings; changes in the org overwrite changes in the project.
|
|
@@ -2857,9 +2831,6 @@ FLAGS
|
|
|
2857
2831
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2858
2832
|
--verbose Display additional details about the command results.
|
|
2859
2833
|
|
|
2860
|
-
GLOBAL FLAGS
|
|
2861
|
-
--json Format output as json.
|
|
2862
|
-
|
|
2863
2834
|
DESCRIPTION
|
|
2864
2835
|
Pull changed source from the org to your project to keep them in sync.
|
|
2865
2836
|
|
|
@@ -2882,7 +2853,7 @@ FLAG DESCRIPTIONS
|
|
|
2882
2853
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2883
2854
|
```
|
|
2884
2855
|
|
|
2885
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2856
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/source/pull.ts)_
|
|
2886
2857
|
|
|
2887
2858
|
## `sf force source push`
|
|
2888
2859
|
|
|
@@ -2890,7 +2861,7 @@ Push changed source from your project to an org to keep them in sync.
|
|
|
2890
2861
|
|
|
2891
2862
|
```
|
|
2892
2863
|
USAGE
|
|
2893
|
-
$ sf force source push -o <value> [--
|
|
2864
|
+
$ sf force source push -o <value> [--api-version <value>] [-f] [-w <value>] [-g] [--quiet]
|
|
2894
2865
|
|
|
2895
2866
|
FLAGS
|
|
2896
2867
|
-f, --forceoverwrite Ignore conflict warnings and push source anyway; changes in the project overwrite changes
|
|
@@ -2902,9 +2873,6 @@ FLAGS
|
|
|
2902
2873
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2903
2874
|
--quiet Minimize JSON and sdtout output on success.
|
|
2904
2875
|
|
|
2905
|
-
GLOBAL FLAGS
|
|
2906
|
-
--json Format output as json.
|
|
2907
|
-
|
|
2908
2876
|
DESCRIPTION
|
|
2909
2877
|
Push changed source from your project to an org to keep them in sync.
|
|
2910
2878
|
|
|
@@ -2927,7 +2895,7 @@ FLAG DESCRIPTIONS
|
|
|
2927
2895
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2928
2896
|
```
|
|
2929
2897
|
|
|
2930
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
2898
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/source/push.ts)_
|
|
2931
2899
|
|
|
2932
2900
|
## `sf force source retrieve`
|
|
2933
2901
|
|
|
@@ -2935,8 +2903,8 @@ Retrieve source from an org.
|
|
|
2935
2903
|
|
|
2936
2904
|
```
|
|
2937
2905
|
USAGE
|
|
2938
|
-
$ sf force source retrieve -o <value> [
|
|
2939
|
-
<value> |
|
|
2906
|
+
$ sf force source retrieve -o <value> [-a <value>] [-r <value> | -n <value> | -p <value>] [-w <value>] [-x <value> | -m
|
|
2907
|
+
<value> | ] [-f -t] [--verbose]
|
|
2940
2908
|
|
|
2941
2909
|
FLAGS
|
|
2942
2910
|
-a, --api-version=<value> Override the api version used for api requests made by this command
|
|
@@ -2954,9 +2922,6 @@ FLAGS
|
|
|
2954
2922
|
retrieve.
|
|
2955
2923
|
--verbose Verbose output of retrieve result.
|
|
2956
2924
|
|
|
2957
|
-
GLOBAL FLAGS
|
|
2958
|
-
--json Format output as json.
|
|
2959
|
-
|
|
2960
2925
|
DESCRIPTION
|
|
2961
2926
|
Retrieve source from an org.
|
|
2962
2927
|
|
|
@@ -3052,7 +3017,7 @@ FLAG DESCRIPTIONS
|
|
|
3052
3017
|
If you specify this parameter, don’t specify --metadata or --sourcepath.
|
|
3053
3018
|
```
|
|
3054
3019
|
|
|
3055
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
3020
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/source/retrieve.ts)_
|
|
3056
3021
|
|
|
3057
3022
|
## `sf force source status`
|
|
3058
3023
|
|
|
@@ -3060,7 +3025,7 @@ List changes that have been made locally, in an org, or both.
|
|
|
3060
3025
|
|
|
3061
3026
|
```
|
|
3062
3027
|
USAGE
|
|
3063
|
-
$ sf force source status -o <value> [--
|
|
3028
|
+
$ sf force source status -o <value> [--api-version <value>] [-l | -r] [--concise]
|
|
3064
3029
|
|
|
3065
3030
|
FLAGS
|
|
3066
3031
|
-l, --local List the changes that have been made locally.
|
|
@@ -3069,9 +3034,6 @@ FLAGS
|
|
|
3069
3034
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
3070
3035
|
--concise Show only the changes that will be pushed or pulled; omits files that are forceignored.
|
|
3071
3036
|
|
|
3072
|
-
GLOBAL FLAGS
|
|
3073
|
-
--json Format output as json.
|
|
3074
|
-
|
|
3075
3037
|
EXAMPLES
|
|
3076
3038
|
List changes that have been made locally but not in the org with alias "myscratch":
|
|
3077
3039
|
|
|
@@ -3082,7 +3044,7 @@ EXAMPLES
|
|
|
3082
3044
|
$ sf force source status --remote
|
|
3083
3045
|
```
|
|
3084
3046
|
|
|
3085
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.
|
|
3047
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/2.11.4/src/commands/force/source/status.ts)_
|
|
3086
3048
|
|
|
3087
3049
|
## `sf force user password generate`
|
|
3088
3050
|
|
|
@@ -3147,7 +3109,7 @@ EXAMPLES
|
|
|
3147
3109
|
user3@my.org
|
|
3148
3110
|
```
|
|
3149
3111
|
|
|
3150
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
3112
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.4/src/commands/force/user/password/generate.ts)_
|
|
3151
3113
|
|
|
3152
3114
|
## `sf help [COMMANDS]`
|
|
3153
3115
|
|
|
@@ -3206,7 +3168,7 @@ EXAMPLES
|
|
|
3206
3168
|
$ sf info releasenotes display --version latest
|
|
3207
3169
|
```
|
|
3208
3170
|
|
|
3209
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0.
|
|
3171
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0.3/src/commands/info/releasenotes/display.ts)_
|
|
3210
3172
|
|
|
3211
3173
|
## `sf lightning generate app`
|
|
3212
3174
|
|
|
@@ -3488,63 +3450,6 @@ FLAG DESCRIPTIONS
|
|
|
3488
3450
|
|
|
3489
3451
|
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.1/src/commands/lightning/generate/test.ts)_
|
|
3490
3452
|
|
|
3491
|
-
## `sf login`
|
|
3492
|
-
|
|
3493
|
-
Log interactively into an environment.
|
|
3494
|
-
|
|
3495
|
-
```
|
|
3496
|
-
USAGE
|
|
3497
|
-
$ sf login
|
|
3498
|
-
|
|
3499
|
-
DESCRIPTION
|
|
3500
|
-
Log interactively into an environment.
|
|
3501
|
-
|
|
3502
|
-
NOTE: This general command is deprecated. Use specific commands instead, such as "org login web" or "org login jwt".
|
|
3503
|
-
|
|
3504
|
-
Logging into an environment authorizes the CLI to run other commands that connect to that environment.
|
|
3505
|
-
|
|
3506
|
-
EXAMPLES
|
|
3507
|
-
Log in interactively:
|
|
3508
|
-
|
|
3509
|
-
$ sf login
|
|
3510
|
-
```
|
|
3511
|
-
|
|
3512
|
-
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/2.0.4/src/commands/login.ts)_
|
|
3513
|
-
|
|
3514
|
-
## `sf logout`
|
|
3515
|
-
|
|
3516
|
-
Log out interactively from environments.
|
|
3517
|
-
|
|
3518
|
-
```
|
|
3519
|
-
USAGE
|
|
3520
|
-
$ sf logout [--json] [--no-prompt]
|
|
3521
|
-
|
|
3522
|
-
FLAGS
|
|
3523
|
-
--no-prompt Don't prompt for confirmation; logs you out of all environments.
|
|
3524
|
-
|
|
3525
|
-
GLOBAL FLAGS
|
|
3526
|
-
--json Format output as json.
|
|
3527
|
-
|
|
3528
|
-
DESCRIPTION
|
|
3529
|
-
Log out interactively from environments.
|
|
3530
|
-
|
|
3531
|
-
NOTE: This general command is deprecated. Use specific commands instead, such as "org login web" or "org login jwt".
|
|
3532
|
-
|
|
3533
|
-
By default, the command prompts you to select which environments you want to log out of. Use --no-prompt to not be
|
|
3534
|
-
prompted and log out of all environments.
|
|
3535
|
-
|
|
3536
|
-
EXAMPLES
|
|
3537
|
-
Interactively select the environments to log out of:
|
|
3538
|
-
|
|
3539
|
-
$ sf logout
|
|
3540
|
-
|
|
3541
|
-
Log out of all environments, without being prompted:
|
|
3542
|
-
|
|
3543
|
-
$ sf logout --no-prompt
|
|
3544
|
-
```
|
|
3545
|
-
|
|
3546
|
-
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/2.0.4/src/commands/logout.ts)_
|
|
3547
|
-
|
|
3548
3453
|
## `sf org assign permset`
|
|
3549
3454
|
|
|
3550
3455
|
Assign a permission set to one or more users of a scratch org.
|
|
@@ -3586,7 +3491,7 @@ EXAMPLES
|
|
|
3586
3491
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
3587
3492
|
```
|
|
3588
3493
|
|
|
3589
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
3494
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.4/src/commands/org/assign/permset.ts)_
|
|
3590
3495
|
|
|
3591
3496
|
## `sf org assign permsetlicense`
|
|
3592
3497
|
|
|
@@ -3630,7 +3535,7 @@ EXAMPLES
|
|
|
3630
3535
|
user3
|
|
3631
3536
|
```
|
|
3632
3537
|
|
|
3633
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
3538
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.4/src/commands/org/assign/permsetlicense.ts)_
|
|
3634
3539
|
|
|
3635
3540
|
## `sf org create sandbox`
|
|
3636
3541
|
|
|
@@ -3735,7 +3640,7 @@ FLAG DESCRIPTIONS
|
|
|
3735
3640
|
sandbox.
|
|
3736
3641
|
```
|
|
3737
3642
|
|
|
3738
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
3643
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/create/sandbox.ts)_
|
|
3739
3644
|
|
|
3740
3645
|
## `sf org create scratch`
|
|
3741
3646
|
|
|
@@ -3888,7 +3793,7 @@ FLAG DESCRIPTIONS
|
|
|
3888
3793
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
3889
3794
|
```
|
|
3890
3795
|
|
|
3891
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
3796
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/create/scratch.ts)_
|
|
3892
3797
|
|
|
3893
3798
|
## `sf org create user`
|
|
3894
3799
|
|
|
@@ -3986,7 +3891,7 @@ FLAG DESCRIPTIONS
|
|
|
3986
3891
|
might be different than what you specify in the definition file.
|
|
3987
3892
|
```
|
|
3988
3893
|
|
|
3989
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
3894
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.4/src/commands/org/create/user.ts)_
|
|
3990
3895
|
|
|
3991
3896
|
## `sf org delete sandbox`
|
|
3992
3897
|
|
|
@@ -4030,7 +3935,7 @@ EXAMPLES
|
|
|
4030
3935
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
4031
3936
|
```
|
|
4032
3937
|
|
|
4033
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
3938
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/delete/sandbox.ts)_
|
|
4034
3939
|
|
|
4035
3940
|
## `sf org delete scratch`
|
|
4036
3941
|
|
|
@@ -4072,7 +3977,7 @@ EXAMPLES
|
|
|
4072
3977
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
4073
3978
|
```
|
|
4074
3979
|
|
|
4075
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
3980
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/delete/scratch.ts)_
|
|
4076
3981
|
|
|
4077
3982
|
## `sf org display`
|
|
4078
3983
|
|
|
@@ -4115,7 +4020,7 @@ EXAMPLES
|
|
|
4115
4020
|
$ sf org display --target-org TestOrg1 --verbose
|
|
4116
4021
|
```
|
|
4117
4022
|
|
|
4118
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4023
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/display.ts)_
|
|
4119
4024
|
|
|
4120
4025
|
## `sf org display user`
|
|
4121
4026
|
|
|
@@ -4152,7 +4057,7 @@ EXAMPLES
|
|
|
4152
4057
|
$ sf org display user --target-org me@my.org --json
|
|
4153
4058
|
```
|
|
4154
4059
|
|
|
4155
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
4060
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.4/src/commands/org/display/user.ts)_
|
|
4156
4061
|
|
|
4157
4062
|
## `sf org generate password`
|
|
4158
4063
|
|
|
@@ -4216,7 +4121,7 @@ EXAMPLES
|
|
|
4216
4121
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
4217
4122
|
```
|
|
4218
4123
|
|
|
4219
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
4124
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.4/src/commands/org/generate/password.ts)_
|
|
4220
4125
|
|
|
4221
4126
|
## `sf org list`
|
|
4222
4127
|
|
|
@@ -4254,7 +4159,7 @@ EXAMPLES
|
|
|
4254
4159
|
$ sf org list --clean
|
|
4255
4160
|
```
|
|
4256
4161
|
|
|
4257
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4162
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/list.ts)_
|
|
4258
4163
|
|
|
4259
4164
|
## `sf org list auth`
|
|
4260
4165
|
|
|
@@ -4285,7 +4190,7 @@ EXAMPLES
|
|
|
4285
4190
|
$ sf org list auth
|
|
4286
4191
|
```
|
|
4287
4192
|
|
|
4288
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.
|
|
4193
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/list/auth.ts)_
|
|
4289
4194
|
|
|
4290
4195
|
## `sf org list limits`
|
|
4291
4196
|
|
|
@@ -4323,7 +4228,7 @@ EXAMPLES
|
|
|
4323
4228
|
$ sf org list limits --target-org my-scratch-org
|
|
4324
4229
|
```
|
|
4325
4230
|
|
|
4326
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0.
|
|
4231
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0.2/src/commands/org/list/limits.ts)_
|
|
4327
4232
|
|
|
4328
4233
|
## `sf org list metadata`
|
|
4329
4234
|
|
|
@@ -4387,7 +4292,7 @@ FLAG DESCRIPTIONS
|
|
|
4387
4292
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
4388
4293
|
```
|
|
4389
4294
|
|
|
4390
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4295
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/list/metadata.ts)_
|
|
4391
4296
|
|
|
4392
4297
|
## `sf org list metadata-types`
|
|
4393
4298
|
|
|
@@ -4440,7 +4345,7 @@ FLAG DESCRIPTIONS
|
|
|
4440
4345
|
Override the api version used for api requests made by this command
|
|
4441
4346
|
```
|
|
4442
4347
|
|
|
4443
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4348
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/list/metadata-types.ts)_
|
|
4444
4349
|
|
|
4445
4350
|
## `sf org list sobject record-counts`
|
|
4446
4351
|
|
|
@@ -4484,7 +4389,7 @@ EXAMPLES
|
|
|
4484
4389
|
$ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
|
|
4485
4390
|
```
|
|
4486
4391
|
|
|
4487
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0.
|
|
4392
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0.2/src/commands/org/list/sobject/record-counts.ts)_
|
|
4488
4393
|
|
|
4489
4394
|
## `sf org list users`
|
|
4490
4395
|
|
|
@@ -4520,7 +4425,7 @@ EXAMPLES
|
|
|
4520
4425
|
$ sf org list users --target-org me@my.org
|
|
4521
4426
|
```
|
|
4522
4427
|
|
|
4523
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
4428
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.4/src/commands/org/list/users.ts)_
|
|
4524
4429
|
|
|
4525
4430
|
## `sf org login access-token`
|
|
4526
4431
|
|
|
@@ -4573,7 +4478,7 @@ FLAG DESCRIPTIONS
|
|
|
4573
4478
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4574
4479
|
```
|
|
4575
4480
|
|
|
4576
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.
|
|
4481
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/access-token.ts)_
|
|
4577
4482
|
|
|
4578
4483
|
## `sf org login device`
|
|
4579
4484
|
|
|
@@ -4632,7 +4537,7 @@ FLAG DESCRIPTIONS
|
|
|
4632
4537
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4633
4538
|
```
|
|
4634
4539
|
|
|
4635
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.
|
|
4540
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/device.ts)_
|
|
4636
4541
|
|
|
4637
4542
|
## `sf org login jwt`
|
|
4638
4543
|
|
|
@@ -4721,7 +4626,7 @@ FLAG DESCRIPTIONS
|
|
|
4721
4626
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4722
4627
|
```
|
|
4723
4628
|
|
|
4724
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.
|
|
4629
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/jwt.ts)_
|
|
4725
4630
|
|
|
4726
4631
|
## `sf org login sfdx-url`
|
|
4727
4632
|
|
|
@@ -4779,7 +4684,7 @@ EXAMPLES
|
|
|
4779
4684
|
$ sf org login sfdx-url --sfdx-url-file files/authFile.json --set-default --alias MyDefaultOrg
|
|
4780
4685
|
```
|
|
4781
4686
|
|
|
4782
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.
|
|
4687
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/sfdx-url.ts)_
|
|
4783
4688
|
|
|
4784
4689
|
## `sf org login web`
|
|
4785
4690
|
|
|
@@ -4864,7 +4769,7 @@ FLAG DESCRIPTIONS
|
|
|
4864
4769
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4865
4770
|
```
|
|
4866
4771
|
|
|
4867
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.
|
|
4772
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/login/web.ts)_
|
|
4868
4773
|
|
|
4869
4774
|
## `sf org logout`
|
|
4870
4775
|
|
|
@@ -4924,7 +4829,7 @@ FLAG DESCRIPTIONS
|
|
|
4924
4829
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
4925
4830
|
```
|
|
4926
4831
|
|
|
4927
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.
|
|
4832
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0.6/src/commands/org/logout.ts)_
|
|
4928
4833
|
|
|
4929
4834
|
## `sf org open`
|
|
4930
4835
|
|
|
@@ -4989,7 +4894,7 @@ EXAMPLES
|
|
|
4989
4894
|
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
4990
4895
|
```
|
|
4991
4896
|
|
|
4992
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4897
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/open.ts)_
|
|
4993
4898
|
|
|
4994
4899
|
## `sf org resume sandbox`
|
|
4995
4900
|
|
|
@@ -5051,7 +4956,7 @@ FLAG DESCRIPTIONS
|
|
|
5051
4956
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
5052
4957
|
```
|
|
5053
4958
|
|
|
5054
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4959
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/resume/sandbox.ts)_
|
|
5055
4960
|
|
|
5056
4961
|
## `sf org resume scratch`
|
|
5057
4962
|
|
|
@@ -5097,7 +5002,7 @@ FLAG DESCRIPTIONS
|
|
|
5097
5002
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
5098
5003
|
```
|
|
5099
5004
|
|
|
5100
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
5005
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/resume/scratch.ts)_
|
|
5101
5006
|
|
|
5102
5007
|
## `sf plugins`
|
|
5103
5008
|
|
|
@@ -5120,7 +5025,7 @@ EXAMPLES
|
|
|
5120
5025
|
$ sf plugins
|
|
5121
5026
|
```
|
|
5122
5027
|
|
|
5123
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5028
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.8/src/commands/plugins/index.ts)_
|
|
5124
5029
|
|
|
5125
5030
|
## `sf plugins discover`
|
|
5126
5031
|
|
|
@@ -5137,7 +5042,7 @@ EXAMPLES
|
|
|
5137
5042
|
$ sf plugins discover
|
|
5138
5043
|
```
|
|
5139
5044
|
|
|
5140
|
-
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-template-sf/blob/1.0.
|
|
5045
|
+
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-template-sf/blob/1.0.6/src/commands/plugins/discover.ts)_
|
|
5141
5046
|
|
|
5142
5047
|
## `sf plugins:inspect PLUGIN...`
|
|
5143
5048
|
|
|
@@ -5164,7 +5069,7 @@ EXAMPLES
|
|
|
5164
5069
|
$ sf plugins inspect myplugin
|
|
5165
5070
|
```
|
|
5166
5071
|
|
|
5167
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5072
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.8/src/commands/plugins/inspect.ts)_
|
|
5168
5073
|
|
|
5169
5074
|
## `sf plugins:install PLUGIN...`
|
|
5170
5075
|
|
|
@@ -5208,7 +5113,7 @@ EXAMPLES
|
|
|
5208
5113
|
$ sf plugins install someuser/someplugin
|
|
5209
5114
|
```
|
|
5210
5115
|
|
|
5211
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5116
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.8/src/commands/plugins/install.ts)_
|
|
5212
5117
|
|
|
5213
5118
|
## `sf plugins:link PLUGIN`
|
|
5214
5119
|
|
|
@@ -5238,7 +5143,7 @@ EXAMPLES
|
|
|
5238
5143
|
$ sf plugins link myplugin
|
|
5239
5144
|
```
|
|
5240
5145
|
|
|
5241
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5146
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.8/src/commands/plugins/link.ts)_
|
|
5242
5147
|
|
|
5243
5148
|
## `sf plugins reset`
|
|
5244
5149
|
|
|
@@ -5249,7 +5154,7 @@ USAGE
|
|
|
5249
5154
|
$ sf plugins reset
|
|
5250
5155
|
```
|
|
5251
5156
|
|
|
5252
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5157
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.8/src/commands/plugins/reset.ts)_
|
|
5253
5158
|
|
|
5254
5159
|
## `sf plugins trust verify`
|
|
5255
5160
|
|
|
@@ -5277,7 +5182,7 @@ EXAMPLES
|
|
|
5277
5182
|
$ sf plugins trust verify --npm @scope/npmName
|
|
5278
5183
|
```
|
|
5279
5184
|
|
|
5280
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.0.
|
|
5185
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.0.4/src/commands/plugins/trust/verify.ts)_
|
|
5281
5186
|
|
|
5282
5187
|
## `sf plugins:uninstall PLUGIN...`
|
|
5283
5188
|
|
|
@@ -5305,7 +5210,7 @@ EXAMPLES
|
|
|
5305
5210
|
$ sf plugins uninstall myplugin
|
|
5306
5211
|
```
|
|
5307
5212
|
|
|
5308
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5213
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.8/src/commands/plugins/uninstall.ts)_
|
|
5309
5214
|
|
|
5310
5215
|
## `sf plugins update`
|
|
5311
5216
|
|
|
@@ -5323,7 +5228,7 @@ DESCRIPTION
|
|
|
5323
5228
|
Update installed plugins.
|
|
5324
5229
|
```
|
|
5325
5230
|
|
|
5326
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5231
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.8/src/commands/plugins/update.ts)_
|
|
5327
5232
|
|
|
5328
5233
|
## `sf project convert mdapi`
|
|
5329
5234
|
|
|
@@ -5385,7 +5290,7 @@ FLAG DESCRIPTIONS
|
|
|
5385
5290
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5386
5291
|
```
|
|
5387
5292
|
|
|
5388
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
5293
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/convert/mdapi.ts)_
|
|
5389
5294
|
|
|
5390
5295
|
## `sf project convert source`
|
|
5391
5296
|
|
|
@@ -5397,7 +5302,7 @@ USAGE
|
|
|
5397
5302
|
<value> | -m <value>]
|
|
5398
5303
|
|
|
5399
5304
|
FLAGS
|
|
5400
|
-
-d, --output-dir=<value> [default:
|
|
5305
|
+
-d, --output-dir=<value> [default: metadataPackage_1700091865711] Output directory to store the Metadata
|
|
5401
5306
|
API–formatted files in.
|
|
5402
5307
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
5403
5308
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -5457,7 +5362,7 @@ FLAG DESCRIPTIONS
|
|
|
5457
5362
|
Override the api version used for api requests made by this command
|
|
5458
5363
|
```
|
|
5459
5364
|
|
|
5460
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
5365
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/convert/source.ts)_
|
|
5461
5366
|
|
|
5462
5367
|
## `sf project delete source`
|
|
5463
5368
|
|
|
@@ -5465,7 +5370,7 @@ Delete source from your project and from a non-source-tracked org.
|
|
|
5465
5370
|
|
|
5466
5371
|
```
|
|
5467
5372
|
USAGE
|
|
5468
|
-
$ sf project delete source -o <value> [--json] [--api-version <value>] [-w <value>] [--tests <value> -l
|
|
5373
|
+
$ sf project delete source -o <value> [--json] [--api-version <value>] [-w <value>] [--tests <value>] [-l
|
|
5469
5374
|
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>] [-p <value>] [-f [-t | -c]]
|
|
5470
5375
|
[--verbose]
|
|
5471
5376
|
|
|
@@ -5595,7 +5500,7 @@ FLAG DESCRIPTIONS
|
|
|
5595
5500
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
5596
5501
|
```
|
|
5597
5502
|
|
|
5598
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
5503
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/delete/source.ts)_
|
|
5599
5504
|
|
|
5600
5505
|
## `sf project delete tracking`
|
|
5601
5506
|
|
|
@@ -5630,7 +5535,7 @@ EXAMPLES
|
|
|
5630
5535
|
$ sf project delete tracking --target-org my-scratch
|
|
5631
5536
|
```
|
|
5632
5537
|
|
|
5633
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
5538
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/delete/tracking.ts)_
|
|
5634
5539
|
|
|
5635
5540
|
## `sf project deploy cancel`
|
|
5636
5541
|
|
|
@@ -5700,7 +5605,7 @@ FLAG DESCRIPTIONS
|
|
|
5700
5605
|
project deploy report".
|
|
5701
5606
|
```
|
|
5702
5607
|
|
|
5703
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
5608
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/deploy/cancel.ts)_
|
|
5704
5609
|
|
|
5705
5610
|
## `sf project deploy preview`
|
|
5706
5611
|
|
|
@@ -5783,7 +5688,7 @@ FLAG DESCRIPTIONS
|
|
|
5783
5688
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
5784
5689
|
```
|
|
5785
5690
|
|
|
5786
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
5691
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/deploy/preview.ts)_
|
|
5787
5692
|
|
|
5788
5693
|
## `sf project deploy quick`
|
|
5789
5694
|
|
|
@@ -5876,7 +5781,7 @@ ERROR CODES
|
|
|
5876
5781
|
Canceling (69) The deploy is being canceled.
|
|
5877
5782
|
```
|
|
5878
5783
|
|
|
5879
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
5784
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/deploy/quick.ts)_
|
|
5880
5785
|
|
|
5881
5786
|
## `sf project deploy report`
|
|
5882
5787
|
|
|
@@ -5971,7 +5876,7 @@ FLAG DESCRIPTIONS
|
|
|
5971
5876
|
--coverage-formatters lcov --coverage-formatters clover
|
|
5972
5877
|
```
|
|
5973
5878
|
|
|
5974
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
5879
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/deploy/report.ts)_
|
|
5975
5880
|
|
|
5976
5881
|
## `sf project deploy resume`
|
|
5977
5882
|
|
|
@@ -6067,7 +5972,7 @@ ERROR CODES
|
|
|
6067
5972
|
Canceling (69) The deploy is being canceled.
|
|
6068
5973
|
```
|
|
6069
5974
|
|
|
6070
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
5975
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/deploy/resume.ts)_
|
|
6071
5976
|
|
|
6072
5977
|
## `sf project deploy start`
|
|
6073
5978
|
|
|
@@ -6076,7 +5981,7 @@ Deploy metadata to an org from your local project.
|
|
|
6076
5981
|
```
|
|
6077
5982
|
USAGE
|
|
6078
5983
|
$ sf project deploy start -o <value> [--json] [-a <value>] [--async | -w <value>] [--concise | --verbose] [--dry-run]
|
|
6079
|
-
[-c] [-r] [-g] [--single-package ] [-t <value> -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg]
|
|
5984
|
+
[-c] [-r] [-g] [--single-package ] [-t <value>] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg]
|
|
6080
5985
|
[--purge-on-delete [-x <value> | -d <value> | -m <value> | --metadata-dir <value>]] [--pre-destructive-changes
|
|
6081
5986
|
<value> ] [--post-destructive-changes <value> ] [--coverage-formatters
|
|
6082
5987
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir
|
|
@@ -6296,7 +6201,7 @@ ERROR CODES
|
|
|
6296
6201
|
Canceling (69) The deploy is being canceled.
|
|
6297
6202
|
```
|
|
6298
6203
|
|
|
6299
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
6204
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/deploy/start.ts)_
|
|
6300
6205
|
|
|
6301
6206
|
## `sf project deploy validate`
|
|
6302
6207
|
|
|
@@ -6305,7 +6210,7 @@ Validate a metadata deployment without actually executing it.
|
|
|
6305
6210
|
```
|
|
6306
6211
|
USAGE
|
|
6307
6212
|
$ sf project deploy validate -o <value> [--json] [-a <value>] [--async] [--concise | --verbose] [-m <value>] [-d <value>]
|
|
6308
|
-
[--single-package --metadata-dir <value>] [-t <value> -l RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w
|
|
6213
|
+
[--single-package --metadata-dir <value>] [-t <value>] [-l RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w
|
|
6309
6214
|
<value>] [-g] [--coverage-formatters
|
|
6310
6215
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir
|
|
6311
6216
|
<value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
@@ -6475,7 +6380,7 @@ ERROR CODES
|
|
|
6475
6380
|
Canceling (69) The deploy is being canceled.
|
|
6476
6381
|
```
|
|
6477
6382
|
|
|
6478
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
6383
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/deploy/validate.ts)_
|
|
6479
6384
|
|
|
6480
6385
|
## `sf project generate`
|
|
6481
6386
|
|
|
@@ -6654,7 +6559,7 @@ EXAMPLES
|
|
|
6654
6559
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
6655
6560
|
```
|
|
6656
6561
|
|
|
6657
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
6562
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/generate/manifest.ts)_
|
|
6658
6563
|
|
|
6659
6564
|
## `sf project list ignored`
|
|
6660
6565
|
|
|
@@ -6695,7 +6600,7 @@ EXAMPLES
|
|
|
6695
6600
|
$ sf project list ignored --source-dir package.xml
|
|
6696
6601
|
```
|
|
6697
6602
|
|
|
6698
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
6603
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/list/ignored.ts)_
|
|
6699
6604
|
|
|
6700
6605
|
## `sf project reset tracking`
|
|
6701
6606
|
|
|
@@ -6742,7 +6647,7 @@ EXAMPLES
|
|
|
6742
6647
|
$ sf project reset tracking --revision 30
|
|
6743
6648
|
```
|
|
6744
6649
|
|
|
6745
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
6650
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/reset/tracking.ts)_
|
|
6746
6651
|
|
|
6747
6652
|
## `sf project retrieve preview`
|
|
6748
6653
|
|
|
@@ -6797,7 +6702,7 @@ FLAG DESCRIPTIONS
|
|
|
6797
6702
|
Overrides your default org.
|
|
6798
6703
|
```
|
|
6799
6704
|
|
|
6800
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
6705
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/retrieve/preview.ts)_
|
|
6801
6706
|
|
|
6802
6707
|
## `sf project retrieve start`
|
|
6803
6708
|
|
|
@@ -6951,7 +6856,7 @@ ENVIRONMENT VARIABLES
|
|
|
6951
6856
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
6952
6857
|
```
|
|
6953
6858
|
|
|
6954
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.
|
|
6859
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.1.1/src/commands/project/retrieve/start.ts)_
|
|
6955
6860
|
|
|
6956
6861
|
## `sf schema generate field`
|
|
6957
6862
|
|
|
@@ -7002,7 +6907,7 @@ FLAG DESCRIPTIONS
|
|
|
7002
6907
|
If you don't specify this flag, the command prompts you to choose from your local objects.
|
|
7003
6908
|
```
|
|
7004
6909
|
|
|
7005
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.
|
|
6910
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.2/src/commands/schema/generate/field.ts)_
|
|
7006
6911
|
|
|
7007
6912
|
## `sf schema generate platformevent`
|
|
7008
6913
|
|
|
@@ -7031,7 +6936,7 @@ EXAMPLES
|
|
|
7031
6936
|
$ sf schema generate platformevent --label "My Platform Event"
|
|
7032
6937
|
```
|
|
7033
6938
|
|
|
7034
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.
|
|
6939
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.2/src/commands/schema/generate/platformevent.ts)_
|
|
7035
6940
|
|
|
7036
6941
|
## `sf schema generate sobject`
|
|
7037
6942
|
|
|
@@ -7085,7 +6990,7 @@ FLAG DESCRIPTIONS
|
|
|
7085
6990
|
* Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
|
|
7086
6991
|
```
|
|
7087
6992
|
|
|
7088
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.
|
|
6993
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.2/src/commands/schema/generate/sobject.ts)_
|
|
7089
6994
|
|
|
7090
6995
|
## `sf schema generate tab`
|
|
7091
6996
|
|
|
@@ -7132,7 +7037,7 @@ FLAG DESCRIPTIONS
|
|
|
7132
7037
|
The API name for a custom object always ends in "__c", such as "MyObject__c".
|
|
7133
7038
|
```
|
|
7134
7039
|
|
|
7135
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.
|
|
7040
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.2/src/commands/schema/generate/tab.ts)_
|
|
7136
7041
|
|
|
7137
7042
|
## `sf search`
|
|
7138
7043
|
|
|
@@ -7193,7 +7098,7 @@ EXAMPLES
|
|
|
7193
7098
|
$ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
|
|
7194
7099
|
```
|
|
7195
7100
|
|
|
7196
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0.
|
|
7101
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0.4/src/commands/sobject/describe.ts)_
|
|
7197
7102
|
|
|
7198
7103
|
## `sf sobject list`
|
|
7199
7104
|
|
|
@@ -7230,7 +7135,7 @@ EXAMPLES
|
|
|
7230
7135
|
$ sf sobject list --sobject custom --target-org my-scratch-org
|
|
7231
7136
|
```
|
|
7232
7137
|
|
|
7233
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0.
|
|
7138
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0.4/src/commands/sobject/list.ts)_
|
|
7234
7139
|
|
|
7235
7140
|
## `sf static-resource generate`
|
|
7236
7141
|
|