@salesforce/cli 2.35.1 → 2.35.2
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 +188 -149
- package/dist/hooks/preparse.js +81 -0
- package/npm-shrinkwrap.json +319 -47
- package/oclif.manifest.json +1 -1
- package/package.json +11 -9
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
|
|
|
24
24
|
$ sf COMMAND
|
|
25
25
|
running command...
|
|
26
26
|
$ sf (--version|-v)
|
|
27
|
-
@salesforce/cli/2.35.
|
|
27
|
+
@salesforce/cli/2.35.2 linux-x64 node-v20.11.1
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -1067,7 +1067,7 @@ Create and insert a record into a Salesforce or Tooling API object.
|
|
|
1067
1067
|
|
|
1068
1068
|
```
|
|
1069
1069
|
USAGE
|
|
1070
|
-
$ sf data create record -o <value> -s <value> -v <value> [--json] [--api-version <value>] [-t]
|
|
1070
|
+
$ sf data create record -o <value> -s <value> -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t]
|
|
1071
1071
|
|
|
1072
1072
|
FLAGS
|
|
1073
1073
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -1080,7 +1080,8 @@ FLAGS
|
|
|
1080
1080
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1081
1081
|
|
|
1082
1082
|
GLOBAL FLAGS
|
|
1083
|
-
--
|
|
1083
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1084
|
+
--json Format output as json.
|
|
1084
1085
|
|
|
1085
1086
|
DESCRIPTION
|
|
1086
1087
|
Create and insert a record into a Salesforce or Tooling API object.
|
|
@@ -1114,7 +1115,7 @@ EXAMPLES
|
|
|
1114
1115
|
TracedEntityId=01p17000000R6bLAAS"
|
|
1115
1116
|
```
|
|
1116
1117
|
|
|
1117
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1118
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/create/record.ts)_
|
|
1118
1119
|
|
|
1119
1120
|
## `sf data delete bulk`
|
|
1120
1121
|
|
|
@@ -1122,7 +1123,8 @@ Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.
|
|
|
1122
1123
|
|
|
1123
1124
|
```
|
|
1124
1125
|
USAGE
|
|
1125
|
-
$ sf data delete bulk -o <value> -f <value> -s <value> [--json] [--
|
|
1126
|
+
$ sf data delete bulk -o <value> -f <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w
|
|
1127
|
+
<value> | -a] [--verbose]
|
|
1126
1128
|
|
|
1127
1129
|
FLAGS
|
|
1128
1130
|
-a, --async Run the command asynchronously.
|
|
@@ -1131,13 +1133,14 @@ FLAGS
|
|
|
1131
1133
|
configuration variable is already set.
|
|
1132
1134
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1133
1135
|
update or delete records from.
|
|
1134
|
-
-w, --wait=<value> [default:
|
|
1136
|
+
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1135
1137
|
displaying the results.
|
|
1136
1138
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1137
1139
|
--verbose Print verbose output of failed records if result is available.
|
|
1138
1140
|
|
|
1139
1141
|
GLOBAL FLAGS
|
|
1140
|
-
--
|
|
1142
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1143
|
+
--json Format output as json.
|
|
1141
1144
|
|
|
1142
1145
|
DESCRIPTION
|
|
1143
1146
|
Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.
|
|
@@ -1159,7 +1162,7 @@ EXAMPLES
|
|
|
1159
1162
|
$ sf data delete bulk --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1160
1163
|
```
|
|
1161
1164
|
|
|
1162
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1165
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/delete/bulk.ts)_
|
|
1163
1166
|
|
|
1164
1167
|
## `sf data delete record`
|
|
1165
1168
|
|
|
@@ -1167,7 +1170,8 @@ Deletes a single record from a Salesforce or Tooling API object.
|
|
|
1167
1170
|
|
|
1168
1171
|
```
|
|
1169
1172
|
USAGE
|
|
1170
|
-
$ sf data delete record -o <value> -s <value> [--json] [--
|
|
1173
|
+
$ sf data delete record -o <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-w
|
|
1174
|
+
<value>] [-t]
|
|
1171
1175
|
|
|
1172
1176
|
FLAGS
|
|
1173
1177
|
-i, --record-id=<value> ID of the record you’re deleting.
|
|
@@ -1180,7 +1184,8 @@ FLAGS
|
|
|
1180
1184
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1181
1185
|
|
|
1182
1186
|
GLOBAL FLAGS
|
|
1183
|
-
--
|
|
1187
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1188
|
+
--json Format output as json.
|
|
1184
1189
|
|
|
1185
1190
|
DESCRIPTION
|
|
1186
1191
|
Deletes a single record from a Salesforce or Tooling API object.
|
|
@@ -1218,7 +1223,7 @@ EXAMPLES
|
|
|
1218
1223
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1219
1224
|
```
|
|
1220
1225
|
|
|
1221
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1226
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/delete/record.ts)_
|
|
1222
1227
|
|
|
1223
1228
|
## `sf data delete resume`
|
|
1224
1229
|
|
|
@@ -1226,19 +1231,20 @@ Resume a bulk delete job that you previously started. Uses Bulk API 2.0.
|
|
|
1226
1231
|
|
|
1227
1232
|
```
|
|
1228
1233
|
USAGE
|
|
1229
|
-
$ sf data delete resume [--json] [-o <value>] [--use-most-recent | -i <value>] [--wait <value>]
|
|
1230
|
-
|
|
1234
|
+
$ sf data delete resume [--json] [--flags-dir <value>] [-o <value>] [--use-most-recent | -i <value>] [--wait <value>]
|
|
1235
|
+
[--api-version <value>]
|
|
1231
1236
|
|
|
1232
1237
|
FLAGS
|
|
1233
1238
|
-i, --job-id=<value> ID of the job you want to resume.
|
|
1234
1239
|
-o, --target-org=<value>
|
|
1235
1240
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1236
1241
|
--use-most-recent Use the ID of the most recently-run bulk job.
|
|
1237
|
-
--wait=<value> [default:
|
|
1242
|
+
--wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1238
1243
|
displaying the results.
|
|
1239
1244
|
|
|
1240
1245
|
GLOBAL FLAGS
|
|
1241
|
-
--
|
|
1246
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1247
|
+
--json Format output as json.
|
|
1242
1248
|
|
|
1243
1249
|
DESCRIPTION
|
|
1244
1250
|
Resume a bulk delete job that you previously started. Uses Bulk API 2.0.
|
|
@@ -1255,7 +1261,7 @@ EXAMPLES
|
|
|
1255
1261
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
1256
1262
|
```
|
|
1257
1263
|
|
|
1258
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1264
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/delete/resume.ts)_
|
|
1259
1265
|
|
|
1260
1266
|
## `sf data export beta tree`
|
|
1261
1267
|
|
|
@@ -1263,7 +1269,8 @@ Export data from an org into one or more JSON files.
|
|
|
1263
1269
|
|
|
1264
1270
|
```
|
|
1265
1271
|
USAGE
|
|
1266
|
-
$ sf data export beta tree -o <value> -q <value> [--json] [--api-version <value>] [-p] [-x <value>]
|
|
1272
|
+
$ sf data export beta tree -o <value> -q <value> [--json] [--flags-dir <value>] [--api-version <value>] [-p] [-x <value>]
|
|
1273
|
+
[-d <value>]
|
|
1267
1274
|
|
|
1268
1275
|
FLAGS
|
|
1269
1276
|
-d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
|
|
@@ -1275,7 +1282,8 @@ FLAGS
|
|
|
1275
1282
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1276
1283
|
|
|
1277
1284
|
GLOBAL FLAGS
|
|
1278
|
-
--
|
|
1285
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1286
|
+
--json Format output as json.
|
|
1279
1287
|
|
|
1280
1288
|
DESCRIPTION
|
|
1281
1289
|
Export data from an org into one or more JSON files.
|
|
@@ -1311,7 +1319,7 @@ EXAMPLES
|
|
|
1311
1319
|
my-scratch
|
|
1312
1320
|
```
|
|
1313
1321
|
|
|
1314
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1322
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/export/beta/tree.ts)_
|
|
1315
1323
|
|
|
1316
1324
|
## `sf data export tree`
|
|
1317
1325
|
|
|
@@ -1319,7 +1327,8 @@ Export data from an org into one or more JSON files.
|
|
|
1319
1327
|
|
|
1320
1328
|
```
|
|
1321
1329
|
USAGE
|
|
1322
|
-
$ sf data export tree -o <value> -q <value> [--json] [--api-version <value>] [-p] [-x <value>]
|
|
1330
|
+
$ sf data export tree -o <value> -q <value> [--json] [--flags-dir <value>] [--api-version <value>] [-p] [-x <value>]
|
|
1331
|
+
[-d <value>]
|
|
1323
1332
|
|
|
1324
1333
|
FLAGS
|
|
1325
1334
|
-d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
|
|
@@ -1331,7 +1340,8 @@ FLAGS
|
|
|
1331
1340
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1332
1341
|
|
|
1333
1342
|
GLOBAL FLAGS
|
|
1334
|
-
--
|
|
1343
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1344
|
+
--json Format output as json.
|
|
1335
1345
|
|
|
1336
1346
|
DESCRIPTION
|
|
1337
1347
|
Export data from an org into one or more JSON files.
|
|
@@ -1369,7 +1379,7 @@ EXAMPLES
|
|
|
1369
1379
|
my-scratch
|
|
1370
1380
|
```
|
|
1371
1381
|
|
|
1372
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1382
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/export/tree.ts)_
|
|
1373
1383
|
|
|
1374
1384
|
## `sf data get record`
|
|
1375
1385
|
|
|
@@ -1377,7 +1387,8 @@ Retrieve and display a single record of a Salesforce or Tooling API object.
|
|
|
1377
1387
|
|
|
1378
1388
|
```
|
|
1379
1389
|
USAGE
|
|
1380
|
-
$ sf data get record -o <value> -s <value> [--json] [--
|
|
1390
|
+
$ sf data get record -o <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-w
|
|
1391
|
+
<value>] [-t]
|
|
1381
1392
|
|
|
1382
1393
|
FLAGS
|
|
1383
1394
|
-i, --record-id=<value> ID of the record you’re retrieving.
|
|
@@ -1390,7 +1401,8 @@ FLAGS
|
|
|
1390
1401
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1391
1402
|
|
|
1392
1403
|
GLOBAL FLAGS
|
|
1393
|
-
--
|
|
1404
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1405
|
+
--json Format output as json.
|
|
1394
1406
|
|
|
1395
1407
|
DESCRIPTION
|
|
1396
1408
|
Retrieve and display a single record of a Salesforce or Tooling API object.
|
|
@@ -1431,7 +1443,7 @@ EXAMPLES
|
|
|
1431
1443
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1432
1444
|
```
|
|
1433
1445
|
|
|
1434
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1446
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/get/record.ts)_
|
|
1435
1447
|
|
|
1436
1448
|
## `sf data import beta tree`
|
|
1437
1449
|
|
|
@@ -1439,7 +1451,7 @@ Import data from one or more JSON files into an org.
|
|
|
1439
1451
|
|
|
1440
1452
|
```
|
|
1441
1453
|
USAGE
|
|
1442
|
-
$ sf data import beta tree -o <value> [--json] [--api-version <value>] [-f <value>] [-p <value>]
|
|
1454
|
+
$ sf data import beta tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>] [-p <value>]
|
|
1443
1455
|
|
|
1444
1456
|
FLAGS
|
|
1445
1457
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -1450,7 +1462,8 @@ FLAGS
|
|
|
1450
1462
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1451
1463
|
|
|
1452
1464
|
GLOBAL FLAGS
|
|
1453
|
-
--
|
|
1465
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1466
|
+
--json Format output as json.
|
|
1454
1467
|
|
|
1455
1468
|
DESCRIPTION
|
|
1456
1469
|
Import data from one or more JSON files into an org.
|
|
@@ -1473,7 +1486,7 @@ EXAMPLES
|
|
|
1473
1486
|
$ sf data import beta tree --plan Account-Contact-plan.json
|
|
1474
1487
|
```
|
|
1475
1488
|
|
|
1476
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1489
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/import/beta/tree.ts)_
|
|
1477
1490
|
|
|
1478
1491
|
## `sf data import tree`
|
|
1479
1492
|
|
|
@@ -1481,7 +1494,7 @@ Import data from one or more JSON files into an org.
|
|
|
1481
1494
|
|
|
1482
1495
|
```
|
|
1483
1496
|
USAGE
|
|
1484
|
-
$ sf data import tree -o <value> [--json] [--api-version <value>] [-f <value> | -p <value>]
|
|
1497
|
+
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value> | -p <value>]
|
|
1485
1498
|
|
|
1486
1499
|
FLAGS
|
|
1487
1500
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -1492,7 +1505,8 @@ FLAGS
|
|
|
1492
1505
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1493
1506
|
|
|
1494
1507
|
GLOBAL FLAGS
|
|
1495
|
-
--
|
|
1508
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1509
|
+
--json Format output as json.
|
|
1496
1510
|
|
|
1497
1511
|
DESCRIPTION
|
|
1498
1512
|
Import data from one or more JSON files into an org.
|
|
@@ -1522,7 +1536,7 @@ EXAMPLES
|
|
|
1522
1536
|
$ sf data import tree --plan Account-Contact-plan.json
|
|
1523
1537
|
```
|
|
1524
1538
|
|
|
1525
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1539
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/import/tree.ts)_
|
|
1526
1540
|
|
|
1527
1541
|
## `sf data query`
|
|
1528
1542
|
|
|
@@ -1530,8 +1544,8 @@ Execute a SOQL query.
|
|
|
1530
1544
|
|
|
1531
1545
|
```
|
|
1532
1546
|
USAGE
|
|
1533
|
-
$ sf data query -o <value> [--json] [--
|
|
1534
|
-
[--async ] [--all-rows] [-r human|csv|json]
|
|
1547
|
+
$ sf data query -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-q <value>] [-f <value>]
|
|
1548
|
+
[-t | -b] [-w <value> ] [--async ] [--all-rows] [-r human|csv|json]
|
|
1535
1549
|
|
|
1536
1550
|
FLAGS
|
|
1537
1551
|
-b, --bulk Use Bulk API 2.0 to run the query.
|
|
@@ -1548,7 +1562,8 @@ FLAGS
|
|
|
1548
1562
|
--async Use Bulk API 2.0, but don't wait for the job to complete.
|
|
1549
1563
|
|
|
1550
1564
|
GLOBAL FLAGS
|
|
1551
|
-
--
|
|
1565
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1566
|
+
--json Format output as json.
|
|
1552
1567
|
|
|
1553
1568
|
DESCRIPTION
|
|
1554
1569
|
Execute a SOQL query.
|
|
@@ -1585,7 +1600,7 @@ EXAMPLES
|
|
|
1585
1600
|
$ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
|
|
1586
1601
|
```
|
|
1587
1602
|
|
|
1588
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1603
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/query.ts)_
|
|
1589
1604
|
|
|
1590
1605
|
## `sf data query resume`
|
|
1591
1606
|
|
|
@@ -1593,8 +1608,8 @@ View the status of a bulk query.
|
|
|
1593
1608
|
|
|
1594
1609
|
```
|
|
1595
1610
|
USAGE
|
|
1596
|
-
$ sf data query resume [--json] [-o <value>] [--api-version <value>] [-r human|csv|json] [-i
|
|
1597
|
-
[--use-most-recent]
|
|
1611
|
+
$ sf data query resume [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>] [-r human|csv|json] [-i
|
|
1612
|
+
<value>] [--use-most-recent]
|
|
1598
1613
|
|
|
1599
1614
|
FLAGS
|
|
1600
1615
|
-i, --bulk-query-id=<value> Job ID of the bulk query.
|
|
@@ -1605,7 +1620,8 @@ FLAGS
|
|
|
1605
1620
|
--use-most-recent Use the most recent bulk query ID from cache.
|
|
1606
1621
|
|
|
1607
1622
|
GLOBAL FLAGS
|
|
1608
|
-
--
|
|
1623
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1624
|
+
--json Format output as json.
|
|
1609
1625
|
|
|
1610
1626
|
DESCRIPTION
|
|
1611
1627
|
View the status of a bulk query.
|
|
@@ -1621,7 +1637,7 @@ EXAMPLES
|
|
|
1621
1637
|
$ sf data query resume --bulk-query-id 7500x000005BdFzXXX
|
|
1622
1638
|
```
|
|
1623
1639
|
|
|
1624
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1640
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/query/resume.ts)_
|
|
1625
1641
|
|
|
1626
1642
|
## `sf data resume`
|
|
1627
1643
|
|
|
@@ -1629,7 +1645,7 @@ View the status of a bulk data load job or batch.
|
|
|
1629
1645
|
|
|
1630
1646
|
```
|
|
1631
1647
|
USAGE
|
|
1632
|
-
$ sf data resume -o <value> -i <value> [--json] [--api-version <value>] [-b <value>]
|
|
1648
|
+
$ sf data resume -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-b <value>]
|
|
1633
1649
|
|
|
1634
1650
|
FLAGS
|
|
1635
1651
|
-b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
|
|
@@ -1639,7 +1655,8 @@ FLAGS
|
|
|
1639
1655
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1640
1656
|
|
|
1641
1657
|
GLOBAL FLAGS
|
|
1642
|
-
--
|
|
1658
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1659
|
+
--json Format output as json.
|
|
1643
1660
|
|
|
1644
1661
|
DESCRIPTION
|
|
1645
1662
|
View the status of a bulk data load job or batch.
|
|
@@ -1657,7 +1674,7 @@ EXAMPLES
|
|
|
1657
1674
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
1658
1675
|
```
|
|
1659
1676
|
|
|
1660
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1677
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/resume.ts)_
|
|
1661
1678
|
|
|
1662
1679
|
## `sf data update record`
|
|
1663
1680
|
|
|
@@ -1665,8 +1682,8 @@ Updates a single record of a Salesforce or Tooling API object.
|
|
|
1665
1682
|
|
|
1666
1683
|
```
|
|
1667
1684
|
USAGE
|
|
1668
|
-
$ sf data update record -o <value> -s <value> -v <value> [--json] [--
|
|
1669
|
-
[-t]
|
|
1685
|
+
$ sf data update record -o <value> -s <value> -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i
|
|
1686
|
+
<value>] [-w <value>] [-t]
|
|
1670
1687
|
|
|
1671
1688
|
FLAGS
|
|
1672
1689
|
-i, --record-id=<value> ID of the record you’re updating.
|
|
@@ -1680,7 +1697,8 @@ FLAGS
|
|
|
1680
1697
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1681
1698
|
|
|
1682
1699
|
GLOBAL FLAGS
|
|
1683
|
-
--
|
|
1700
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1701
|
+
--json Format output as json.
|
|
1684
1702
|
|
|
1685
1703
|
DESCRIPTION
|
|
1686
1704
|
Updates a single record of a Salesforce or Tooling API object.
|
|
@@ -1718,7 +1736,7 @@ EXAMPLES
|
|
|
1718
1736
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
1719
1737
|
```
|
|
1720
1738
|
|
|
1721
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1739
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/update/record.ts)_
|
|
1722
1740
|
|
|
1723
1741
|
## `sf data upsert bulk`
|
|
1724
1742
|
|
|
@@ -1726,8 +1744,8 @@ Bulk upsert records to an org from a CSV file. Uses Bulk API 2.0.
|
|
|
1726
1744
|
|
|
1727
1745
|
```
|
|
1728
1746
|
USAGE
|
|
1729
|
-
$ sf data upsert bulk -o <value> -f <value> -s <value> -i <value> [--json] [--
|
|
1730
|
-
[--verbose]
|
|
1747
|
+
$ sf data upsert bulk -o <value> -f <value> -s <value> -i <value> [--json] [--flags-dir <value>] [--api-version
|
|
1748
|
+
<value>] [-w <value> | -a] [--verbose]
|
|
1731
1749
|
|
|
1732
1750
|
FLAGS
|
|
1733
1751
|
-a, --async Run the command asynchronously.
|
|
@@ -1737,13 +1755,14 @@ FLAGS
|
|
|
1737
1755
|
configuration variable is already set.
|
|
1738
1756
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1739
1757
|
update or delete records from.
|
|
1740
|
-
-w, --wait=<value> [default:
|
|
1758
|
+
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1741
1759
|
displaying the results.
|
|
1742
1760
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1743
1761
|
--verbose Print verbose output of failed records if result is available.
|
|
1744
1762
|
|
|
1745
1763
|
GLOBAL FLAGS
|
|
1746
|
-
--
|
|
1764
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1765
|
+
--json Format output as json.
|
|
1747
1766
|
|
|
1748
1767
|
DESCRIPTION
|
|
1749
1768
|
Bulk upsert records to an org from a CSV file. Uses Bulk API 2.0.
|
|
@@ -1770,7 +1789,7 @@ EXAMPLES
|
|
|
1770
1789
|
my-scratch
|
|
1771
1790
|
```
|
|
1772
1791
|
|
|
1773
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1792
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/upsert/bulk.ts)_
|
|
1774
1793
|
|
|
1775
1794
|
## `sf data upsert resume`
|
|
1776
1795
|
|
|
@@ -1778,19 +1797,20 @@ Resume a bulk upsert job that you previously started. Uses Bulk API 2.0.
|
|
|
1778
1797
|
|
|
1779
1798
|
```
|
|
1780
1799
|
USAGE
|
|
1781
|
-
$ sf data upsert resume [--json] [-o <value>] [--use-most-recent | -i <value>] [--wait <value>]
|
|
1782
|
-
|
|
1800
|
+
$ sf data upsert resume [--json] [--flags-dir <value>] [-o <value>] [--use-most-recent | -i <value>] [--wait <value>]
|
|
1801
|
+
[--api-version <value>]
|
|
1783
1802
|
|
|
1784
1803
|
FLAGS
|
|
1785
1804
|
-i, --job-id=<value> ID of the job you want to resume.
|
|
1786
1805
|
-o, --target-org=<value>
|
|
1787
1806
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1788
1807
|
--use-most-recent Use the ID of the most recently-run bulk job.
|
|
1789
|
-
--wait=<value> [default:
|
|
1808
|
+
--wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1790
1809
|
displaying the results.
|
|
1791
1810
|
|
|
1792
1811
|
GLOBAL FLAGS
|
|
1793
|
-
--
|
|
1812
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1813
|
+
--json Format output as json.
|
|
1794
1814
|
|
|
1795
1815
|
DESCRIPTION
|
|
1796
1816
|
Resume a bulk upsert job that you previously started. Uses Bulk API 2.0.
|
|
@@ -1807,7 +1827,7 @@ EXAMPLES
|
|
|
1807
1827
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
1808
1828
|
```
|
|
1809
1829
|
|
|
1810
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1830
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/upsert/resume.ts)_
|
|
1811
1831
|
|
|
1812
1832
|
## `sf doctor`
|
|
1813
1833
|
|
|
@@ -1862,7 +1882,8 @@ Bulk delete records from an org using a CSV file. Uses Bulk API 1.0.
|
|
|
1862
1882
|
|
|
1863
1883
|
```
|
|
1864
1884
|
USAGE
|
|
1865
|
-
$ sf force data bulk delete -o <value> -f <value> -s <value> [--json] [--
|
|
1885
|
+
$ sf force data bulk delete -o <value> -f <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w
|
|
1886
|
+
<value>]
|
|
1866
1887
|
|
|
1867
1888
|
FLAGS
|
|
1868
1889
|
-f, --file=<value> (required) CSV file that contains the IDs of the records to delete.
|
|
@@ -1870,12 +1891,13 @@ FLAGS
|
|
|
1870
1891
|
configuration variable is already set.
|
|
1871
1892
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1872
1893
|
delete records from.
|
|
1873
|
-
-w, --wait=<value> [default:
|
|
1894
|
+
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1874
1895
|
displaying the results.
|
|
1875
1896
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1876
1897
|
|
|
1877
1898
|
GLOBAL FLAGS
|
|
1878
|
-
--
|
|
1899
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1900
|
+
--json Format output as json.
|
|
1879
1901
|
|
|
1880
1902
|
DESCRIPTION
|
|
1881
1903
|
Bulk delete records from an org using a CSV file. Uses Bulk API 1.0.
|
|
@@ -1899,7 +1921,7 @@ EXAMPLES
|
|
|
1899
1921
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1900
1922
|
```
|
|
1901
1923
|
|
|
1902
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1924
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/force/data/bulk/delete.ts)_
|
|
1903
1925
|
|
|
1904
1926
|
## `sf force data bulk status`
|
|
1905
1927
|
|
|
@@ -1907,7 +1929,7 @@ View the status of a bulk data load job or batch. Uses Bulk API 1.0.
|
|
|
1907
1929
|
|
|
1908
1930
|
```
|
|
1909
1931
|
USAGE
|
|
1910
|
-
$ sf force data bulk status -o <value> -i <value> [--json] [--api-version <value>] [-b <value>]
|
|
1932
|
+
$ sf force data bulk status -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-b <value>]
|
|
1911
1933
|
|
|
1912
1934
|
FLAGS
|
|
1913
1935
|
-b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
|
|
@@ -1917,7 +1939,8 @@ FLAGS
|
|
|
1917
1939
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1918
1940
|
|
|
1919
1941
|
GLOBAL FLAGS
|
|
1920
|
-
--
|
|
1942
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1943
|
+
--json Format output as json.
|
|
1921
1944
|
|
|
1922
1945
|
DESCRIPTION
|
|
1923
1946
|
View the status of a bulk data load job or batch. Uses Bulk API 1.0.
|
|
@@ -1935,7 +1958,7 @@ EXAMPLES
|
|
|
1935
1958
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
1936
1959
|
```
|
|
1937
1960
|
|
|
1938
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1961
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/force/data/bulk/status.ts)_
|
|
1939
1962
|
|
|
1940
1963
|
## `sf force data bulk upsert`
|
|
1941
1964
|
|
|
@@ -1943,8 +1966,8 @@ Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.
|
|
|
1943
1966
|
|
|
1944
1967
|
```
|
|
1945
1968
|
USAGE
|
|
1946
|
-
$ sf force data bulk upsert -o <value> -i <value> -f <value> -s <value> [--json] [--
|
|
1947
|
-
|
|
1969
|
+
$ sf force data bulk upsert -o <value> -i <value> -f <value> -s <value> [--json] [--flags-dir <value>] [--api-version
|
|
1970
|
+
<value>] [-w <value>] [-r]
|
|
1948
1971
|
|
|
1949
1972
|
FLAGS
|
|
1950
1973
|
-f, --file=<value> (required) CSV file that contains the records to upsert.
|
|
@@ -1954,12 +1977,13 @@ FLAGS
|
|
|
1954
1977
|
-r, --serial Run batches in serial mode.
|
|
1955
1978
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1956
1979
|
upsert records to.
|
|
1957
|
-
-w, --wait=<value> [default:
|
|
1980
|
+
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1958
1981
|
displaying the results.
|
|
1959
1982
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1960
1983
|
|
|
1961
1984
|
GLOBAL FLAGS
|
|
1962
|
-
--
|
|
1985
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1986
|
+
--json Format output as json.
|
|
1963
1987
|
|
|
1964
1988
|
DESCRIPTION
|
|
1965
1989
|
Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.
|
|
@@ -1992,7 +2016,7 @@ EXAMPLES
|
|
|
1992
2016
|
--target-org my-scratch
|
|
1993
2017
|
```
|
|
1994
2018
|
|
|
1995
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
2019
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/force/data/bulk/upsert.ts)_
|
|
1996
2020
|
|
|
1997
2021
|
## `sf help [COMMAND]`
|
|
1998
2022
|
|
|
@@ -3173,7 +3197,7 @@ EXAMPLES
|
|
|
3173
3197
|
$ sf org list auth
|
|
3174
3198
|
```
|
|
3175
3199
|
|
|
3176
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3200
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/list/auth.ts)_
|
|
3177
3201
|
|
|
3178
3202
|
## `sf org list limits`
|
|
3179
3203
|
|
|
@@ -3466,7 +3490,7 @@ FLAG DESCRIPTIONS
|
|
|
3466
3490
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3467
3491
|
```
|
|
3468
3492
|
|
|
3469
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3493
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/access-token.ts)_
|
|
3470
3494
|
|
|
3471
3495
|
## `sf org login device`
|
|
3472
3496
|
|
|
@@ -3525,7 +3549,7 @@ FLAG DESCRIPTIONS
|
|
|
3525
3549
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3526
3550
|
```
|
|
3527
3551
|
|
|
3528
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3552
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/device.ts)_
|
|
3529
3553
|
|
|
3530
3554
|
## `sf org login jwt`
|
|
3531
3555
|
|
|
@@ -3614,7 +3638,7 @@ FLAG DESCRIPTIONS
|
|
|
3614
3638
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3615
3639
|
```
|
|
3616
3640
|
|
|
3617
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3641
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/jwt.ts)_
|
|
3618
3642
|
|
|
3619
3643
|
## `sf org login sfdx-url`
|
|
3620
3644
|
|
|
@@ -3679,7 +3703,7 @@ EXAMPLES
|
|
|
3679
3703
|
$ echo url | sf org login sfdx-url --sfdx-url-stdin
|
|
3680
3704
|
```
|
|
3681
3705
|
|
|
3682
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3706
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/sfdx-url.ts)_
|
|
3683
3707
|
|
|
3684
3708
|
## `sf org login web`
|
|
3685
3709
|
|
|
@@ -3764,7 +3788,7 @@ FLAG DESCRIPTIONS
|
|
|
3764
3788
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3765
3789
|
```
|
|
3766
3790
|
|
|
3767
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3791
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/web.ts)_
|
|
3768
3792
|
|
|
3769
3793
|
## `sf org logout`
|
|
3770
3794
|
|
|
@@ -3824,7 +3848,7 @@ FLAG DESCRIPTIONS
|
|
|
3824
3848
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
3825
3849
|
```
|
|
3826
3850
|
|
|
3827
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3851
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/logout.ts)_
|
|
3828
3852
|
|
|
3829
3853
|
## `sf org open`
|
|
3830
3854
|
|
|
@@ -5490,8 +5514,8 @@ Convert metadata retrieved via Metadata API into the source format used in Sales
|
|
|
5490
5514
|
|
|
5491
5515
|
```
|
|
5492
5516
|
USAGE
|
|
5493
|
-
$ sf project convert mdapi -r <value> [--json] [--
|
|
5494
|
-
|
|
5517
|
+
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value> |
|
|
5518
|
+
-x <value> | -m <value>]
|
|
5495
5519
|
|
|
5496
5520
|
FLAGS
|
|
5497
5521
|
-d, --output-dir=<value> Directory to store your files in after they’re converted to source format; can be an
|
|
@@ -5503,7 +5527,8 @@ FLAGS
|
|
|
5503
5527
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
5504
5528
|
|
|
5505
5529
|
GLOBAL FLAGS
|
|
5506
|
-
--
|
|
5530
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5531
|
+
--json Format output as json.
|
|
5507
5532
|
|
|
5508
5533
|
DESCRIPTION
|
|
5509
5534
|
Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.
|
|
@@ -5544,7 +5569,7 @@ FLAG DESCRIPTIONS
|
|
|
5544
5569
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5545
5570
|
```
|
|
5546
5571
|
|
|
5547
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5572
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/convert/mdapi.ts)_
|
|
5548
5573
|
|
|
5549
5574
|
## `sf project convert source`
|
|
5550
5575
|
|
|
@@ -5552,11 +5577,11 @@ Convert source-formatted files into metadata that you can deploy using Metadata
|
|
|
5552
5577
|
|
|
5553
5578
|
```
|
|
5554
5579
|
USAGE
|
|
5555
|
-
$ sf project convert source [--json] [--
|
|
5556
|
-
<value> | -m <value>]
|
|
5580
|
+
$ sf project convert source [--json] [--flags-dir <value>] [--api-version <value>] [-r <value>] [-d <value>] [-n <value>]
|
|
5581
|
+
[-p <value> | -x <value> | -m <value>]
|
|
5557
5582
|
|
|
5558
5583
|
FLAGS
|
|
5559
|
-
-d, --output-dir=<value> [default:
|
|
5584
|
+
-d, --output-dir=<value> [default: metadataPackage_1711142855338] Output directory to store the Metadata
|
|
5560
5585
|
API–formatted files in.
|
|
5561
5586
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
5562
5587
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -5567,7 +5592,8 @@ FLAGS
|
|
|
5567
5592
|
from sfdx-project.json
|
|
5568
5593
|
|
|
5569
5594
|
GLOBAL FLAGS
|
|
5570
|
-
--
|
|
5595
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5596
|
+
--json Format output as json.
|
|
5571
5597
|
|
|
5572
5598
|
DESCRIPTION
|
|
5573
5599
|
Convert source-formatted files into metadata that you can deploy using Metadata API.
|
|
@@ -5616,7 +5642,7 @@ FLAG DESCRIPTIONS
|
|
|
5616
5642
|
Override the api version used for api requests made by this command
|
|
5617
5643
|
```
|
|
5618
5644
|
|
|
5619
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5645
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/convert/source.ts)_
|
|
5620
5646
|
|
|
5621
5647
|
## `sf project delete source`
|
|
5622
5648
|
|
|
@@ -5624,9 +5650,9 @@ Delete source from your project and from a non-source-tracked org.
|
|
|
5624
5650
|
|
|
5625
5651
|
```
|
|
5626
5652
|
USAGE
|
|
5627
|
-
$ sf project delete source -o <value> [--json] [--
|
|
5628
|
-
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>] [-p <value>] [-f [-t |
|
|
5629
|
-
[--verbose]
|
|
5653
|
+
$ sf project delete source -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>] [--tests
|
|
5654
|
+
<value>] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>] [-p <value>] [-f [-t |
|
|
5655
|
+
-c]] [--verbose]
|
|
5630
5656
|
|
|
5631
5657
|
FLAGS
|
|
5632
5658
|
-c, --check-only Validate delete command but don't delete anything from the org or the local project.
|
|
@@ -5637,7 +5663,7 @@ FLAGS
|
|
|
5637
5663
|
-p, --source-dir=<value>... Source file paths to delete.
|
|
5638
5664
|
-r, --no-prompt Don't prompt for delete confirmation.
|
|
5639
5665
|
-t, --track-source If the delete succeeds, update the source tracking information.
|
|
5640
|
-
-w, --wait=<value>
|
|
5666
|
+
-w, --wait=<value> Number of minutes to wait for the command to finish.
|
|
5641
5667
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
5642
5668
|
--verbose Verbose output of the delete result.
|
|
5643
5669
|
|
|
@@ -5647,7 +5673,8 @@ TEST FLAGS
|
|
|
5647
5673
|
--tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
5648
5674
|
|
|
5649
5675
|
GLOBAL FLAGS
|
|
5650
|
-
--
|
|
5676
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5677
|
+
--json Format output as json.
|
|
5651
5678
|
|
|
5652
5679
|
DESCRIPTION
|
|
5653
5680
|
Delete source from your project and from a non-source-tracked org.
|
|
@@ -5755,7 +5782,7 @@ FLAG DESCRIPTIONS
|
|
|
5755
5782
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
5756
5783
|
```
|
|
5757
5784
|
|
|
5758
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5785
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/delete/source.ts)_
|
|
5759
5786
|
|
|
5760
5787
|
## `sf project delete tracking`
|
|
5761
5788
|
|
|
@@ -5763,7 +5790,7 @@ Delete all local source tracking information.
|
|
|
5763
5790
|
|
|
5764
5791
|
```
|
|
5765
5792
|
USAGE
|
|
5766
|
-
$ sf project delete tracking -o <value> [--json] [--api-version <value>] [-p]
|
|
5793
|
+
$ sf project delete tracking -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-p]
|
|
5767
5794
|
|
|
5768
5795
|
FLAGS
|
|
5769
5796
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -5772,7 +5799,8 @@ FLAGS
|
|
|
5772
5799
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
5773
5800
|
|
|
5774
5801
|
GLOBAL FLAGS
|
|
5775
|
-
--
|
|
5802
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5803
|
+
--json Format output as json.
|
|
5776
5804
|
|
|
5777
5805
|
DESCRIPTION
|
|
5778
5806
|
Delete all local source tracking information.
|
|
@@ -5791,7 +5819,7 @@ EXAMPLES
|
|
|
5791
5819
|
$ sf project delete tracking --target-org my-scratch
|
|
5792
5820
|
```
|
|
5793
5821
|
|
|
5794
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5822
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/delete/tracking.ts)_
|
|
5795
5823
|
|
|
5796
5824
|
## `sf project deploy cancel`
|
|
5797
5825
|
|
|
@@ -5799,7 +5827,7 @@ Cancel a deploy operation.
|
|
|
5799
5827
|
|
|
5800
5828
|
```
|
|
5801
5829
|
USAGE
|
|
5802
|
-
$ sf project deploy cancel [--json] [--async | -w <value>] [-i <value>] [-r]
|
|
5830
|
+
$ sf project deploy cancel [--json] [--flags-dir <value>] [--async | -w <value>] [-i <value>] [-r]
|
|
5803
5831
|
|
|
5804
5832
|
FLAGS
|
|
5805
5833
|
-i, --job-id=<value> Job ID of the deploy operation you want to cancel.
|
|
@@ -5808,7 +5836,8 @@ FLAGS
|
|
|
5808
5836
|
--async Run the command asynchronously.
|
|
5809
5837
|
|
|
5810
5838
|
GLOBAL FLAGS
|
|
5811
|
-
--
|
|
5839
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5840
|
+
--json Format output as json.
|
|
5812
5841
|
|
|
5813
5842
|
DESCRIPTION
|
|
5814
5843
|
Cancel a deploy operation.
|
|
@@ -5861,7 +5890,7 @@ FLAG DESCRIPTIONS
|
|
|
5861
5890
|
project deploy report".
|
|
5862
5891
|
```
|
|
5863
5892
|
|
|
5864
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5893
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/deploy/cancel.ts)_
|
|
5865
5894
|
|
|
5866
5895
|
## `sf project deploy preview`
|
|
5867
5896
|
|
|
@@ -5869,7 +5898,8 @@ Preview a deployment to see what will deploy to the org, the potential conflicts
|
|
|
5869
5898
|
|
|
5870
5899
|
```
|
|
5871
5900
|
USAGE
|
|
5872
|
-
$ sf project deploy preview -o <value> [--json] [-c] [-x <value> | -d <value> | -m <value>]
|
|
5901
|
+
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value> | -m <value>]
|
|
5902
|
+
[--concise]
|
|
5873
5903
|
|
|
5874
5904
|
FLAGS
|
|
5875
5905
|
-c, --ignore-conflicts Don't display conflicts in preview of the deployment.
|
|
@@ -5880,7 +5910,8 @@ FLAGS
|
|
|
5880
5910
|
--concise Show only the changes that will be deployed; omits files that are forceignored.
|
|
5881
5911
|
|
|
5882
5912
|
GLOBAL FLAGS
|
|
5883
|
-
--
|
|
5913
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5914
|
+
--json Format output as json.
|
|
5884
5915
|
|
|
5885
5916
|
DESCRIPTION
|
|
5886
5917
|
Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.
|
|
@@ -5945,7 +5976,7 @@ FLAG DESCRIPTIONS
|
|
|
5945
5976
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
5946
5977
|
```
|
|
5947
5978
|
|
|
5948
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5979
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/deploy/preview.ts)_
|
|
5949
5980
|
|
|
5950
5981
|
## `sf project deploy quick`
|
|
5951
5982
|
|
|
@@ -5953,22 +5984,23 @@ Quickly deploy a validated deployment to an org.
|
|
|
5953
5984
|
|
|
5954
5985
|
```
|
|
5955
5986
|
USAGE
|
|
5956
|
-
$ sf project deploy quick [--json] [--async | -w <value>] [--concise | --verbose] [-i <value>] [-o
|
|
5957
|
-
<value>]
|
|
5987
|
+
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <value>] [--concise | --verbose] [-i <value>] [-o
|
|
5988
|
+
<value>] [-r] [-a <value>]
|
|
5958
5989
|
|
|
5959
5990
|
FLAGS
|
|
5960
5991
|
-a, --api-version=<value> Target API version for the deploy.
|
|
5961
5992
|
-i, --job-id=<value> Job ID of the deployment you want to quick deploy.
|
|
5962
5993
|
-o, --target-org=<value> Login username or alias for the target org.
|
|
5963
5994
|
-r, --use-most-recent Use the job ID of the most recently validated deployment.
|
|
5964
|
-
-w, --wait=<minutes> [default:
|
|
5965
|
-
|
|
5995
|
+
-w, --wait=<minutes> [default: 33 minutes] Number of minutes to wait for the command to complete and display
|
|
5996
|
+
results.
|
|
5966
5997
|
--async Run the command asynchronously.
|
|
5967
5998
|
--concise Show concise output of the deploy result.
|
|
5968
5999
|
--verbose Show verbose output of the deploy result.
|
|
5969
6000
|
|
|
5970
6001
|
GLOBAL FLAGS
|
|
5971
|
-
--
|
|
6002
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6003
|
+
--json Format output as json.
|
|
5972
6004
|
|
|
5973
6005
|
DESCRIPTION
|
|
5974
6006
|
Quickly deploy a validated deployment to an org.
|
|
@@ -6041,7 +6073,7 @@ ERROR CODES
|
|
|
6041
6073
|
Canceling (69) The deploy is being canceled.
|
|
6042
6074
|
```
|
|
6043
6075
|
|
|
6044
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6076
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/deploy/quick.ts)_
|
|
6045
6077
|
|
|
6046
6078
|
## `sf project deploy report`
|
|
6047
6079
|
|
|
@@ -6049,7 +6081,7 @@ Check or poll for the status of a deploy operation.
|
|
|
6049
6081
|
|
|
6050
6082
|
```
|
|
6051
6083
|
USAGE
|
|
6052
|
-
$ sf project deploy report [--json] [-o <value>] [-i <value>] [-r] [--coverage-formatters
|
|
6084
|
+
$ sf project deploy report [--json] [--flags-dir <value>] [-o <value>] [-i <value>] [-r] [--coverage-formatters
|
|
6053
6085
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir
|
|
6054
6086
|
<value>] [-w <value>]
|
|
6055
6087
|
|
|
@@ -6067,7 +6099,8 @@ TEST FLAGS
|
|
|
6067
6099
|
--results-dir=<value> Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
6068
6100
|
|
|
6069
6101
|
GLOBAL FLAGS
|
|
6070
|
-
--
|
|
6102
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6103
|
+
--json Format output as json.
|
|
6071
6104
|
|
|
6072
6105
|
DESCRIPTION
|
|
6073
6106
|
Check or poll for the status of a deploy operation.
|
|
@@ -6136,7 +6169,7 @@ FLAG DESCRIPTIONS
|
|
|
6136
6169
|
--coverage-formatters lcov --coverage-formatters clover
|
|
6137
6170
|
```
|
|
6138
6171
|
|
|
6139
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6172
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/deploy/report.ts)_
|
|
6140
6173
|
|
|
6141
6174
|
## `sf project deploy resume`
|
|
6142
6175
|
|
|
@@ -6144,9 +6177,9 @@ Resume watching a deploy operation and update source tracking when the deploy co
|
|
|
6144
6177
|
|
|
6145
6178
|
```
|
|
6146
6179
|
USAGE
|
|
6147
|
-
$ sf project deploy resume [--json] [--concise | --verbose] [-i <value>] [-r] [-w <value>]
|
|
6148
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6149
|
-
<value>]
|
|
6180
|
+
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <value>]
|
|
6181
|
+
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6182
|
+
[--junit] [--results-dir <value>]
|
|
6150
6183
|
|
|
6151
6184
|
FLAGS
|
|
6152
6185
|
-i, --job-id=<value> Job ID of the deploy operation you want to resume.
|
|
@@ -6163,7 +6196,8 @@ TEST FLAGS
|
|
|
6163
6196
|
--results-dir=<value> Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
6164
6197
|
|
|
6165
6198
|
GLOBAL FLAGS
|
|
6166
|
-
--
|
|
6199
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6200
|
+
--json Format output as json.
|
|
6167
6201
|
|
|
6168
6202
|
DESCRIPTION
|
|
6169
6203
|
Resume watching a deploy operation and update source tracking when the deploy completes.
|
|
@@ -6232,7 +6266,7 @@ ERROR CODES
|
|
|
6232
6266
|
Canceling (69) The deploy is being canceled.
|
|
6233
6267
|
```
|
|
6234
6268
|
|
|
6235
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6269
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/deploy/resume.ts)_
|
|
6236
6270
|
|
|
6237
6271
|
## `sf project deploy start`
|
|
6238
6272
|
|
|
@@ -6240,12 +6274,12 @@ Deploy metadata to an org from your local project.
|
|
|
6240
6274
|
|
|
6241
6275
|
```
|
|
6242
6276
|
USAGE
|
|
6243
|
-
$ sf project deploy start -o <value> [--json] [-a <value>] [--async | -w <value>] [--concise |
|
|
6244
|
-
[-c] [-r] [-g] [--single-package ] [-t <value>] [-l
|
|
6245
|
-
[--purge-on-delete [-x <value> | -d <value> | -m <value>
|
|
6246
|
-
<value>
|
|
6247
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6248
|
-
<value>]
|
|
6277
|
+
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <value>] [--concise |
|
|
6278
|
+
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value>] [-l
|
|
6279
|
+
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value> | -m <value>
|
|
6280
|
+
| --metadata-dir <value>]] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6281
|
+
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6282
|
+
[--junit] [--results-dir <value>]
|
|
6249
6283
|
|
|
6250
6284
|
FLAGS
|
|
6251
6285
|
-a, --api-version=<value> Target API version for the deploy.
|
|
@@ -6253,8 +6287,7 @@ FLAGS
|
|
|
6253
6287
|
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
6254
6288
|
-o, --target-org=<value> (required) Login username or alias for the target org.
|
|
6255
6289
|
-r, --ignore-errors Ignore any errors and don’t roll back deployment.
|
|
6256
|
-
-w, --wait=<minutes>
|
|
6257
|
-
results.
|
|
6290
|
+
-w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
|
|
6258
6291
|
--async Run the command asynchronously.
|
|
6259
6292
|
--concise Show concise output of the deploy result.
|
|
6260
6293
|
--dry-run Validate deploy and run Apex tests but don’t save to the org.
|
|
@@ -6278,7 +6311,8 @@ TEST FLAGS
|
|
|
6278
6311
|
ID.
|
|
6279
6312
|
|
|
6280
6313
|
GLOBAL FLAGS
|
|
6281
|
-
--
|
|
6314
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6315
|
+
--json Format output as json.
|
|
6282
6316
|
|
|
6283
6317
|
METADATA API FORMAT FLAGS
|
|
6284
6318
|
--metadata-dir=<value> Root of directory or zip file of metadata formatted files to deploy.
|
|
@@ -6470,7 +6504,7 @@ ERROR CODES
|
|
|
6470
6504
|
Canceling (69) The deploy is being canceled.
|
|
6471
6505
|
```
|
|
6472
6506
|
|
|
6473
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6507
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/deploy/start.ts)_
|
|
6474
6508
|
|
|
6475
6509
|
## `sf project deploy validate`
|
|
6476
6510
|
|
|
@@ -6478,9 +6512,9 @@ Validate a metadata deployment without actually executing it.
|
|
|
6478
6512
|
|
|
6479
6513
|
```
|
|
6480
6514
|
USAGE
|
|
6481
|
-
$ sf project deploy validate -o <value> [--json] [-a <value>] [--async] [--concise | --verbose] [-m
|
|
6482
|
-
[--single-package --metadata-dir <value>] [-t <value>] [-l
|
|
6483
|
-
<value>] [-g] [--coverage-formatters
|
|
6515
|
+
$ sf project deploy validate -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [--concise | --verbose] [-m
|
|
6516
|
+
<value>] [-d <value>] [--single-package --metadata-dir <value>] [-t <value>] [-l
|
|
6517
|
+
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <value>] [-g] [--coverage-formatters
|
|
6484
6518
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir
|
|
6485
6519
|
<value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6486
6520
|
|
|
@@ -6488,8 +6522,7 @@ FLAGS
|
|
|
6488
6522
|
-a, --api-version=<value> Target API version for the validation.
|
|
6489
6523
|
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
6490
6524
|
-o, --target-org=<value> (required) Login username or alias for the target org.
|
|
6491
|
-
-w, --wait=<minutes>
|
|
6492
|
-
display results.
|
|
6525
|
+
-w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
|
|
6493
6526
|
--async Run the command asynchronously.
|
|
6494
6527
|
--concise Show concise output of the validation result.
|
|
6495
6528
|
--verbose Show verbose output of the validation result.
|
|
@@ -6511,7 +6544,8 @@ TEST FLAGS
|
|
|
6511
6544
|
ID.
|
|
6512
6545
|
|
|
6513
6546
|
GLOBAL FLAGS
|
|
6514
|
-
--
|
|
6547
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6548
|
+
--json Format output as json.
|
|
6515
6549
|
|
|
6516
6550
|
METADATA API FORMAT FLAGS
|
|
6517
6551
|
--metadata-dir=<value> Root of directory or zip file of metadata formatted files to deploy.
|
|
@@ -6662,7 +6696,7 @@ ERROR CODES
|
|
|
6662
6696
|
Canceling (69) The deploy is being canceled.
|
|
6663
6697
|
```
|
|
6664
6698
|
|
|
6665
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6699
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/deploy/validate.ts)_
|
|
6666
6700
|
|
|
6667
6701
|
## `sf project generate`
|
|
6668
6702
|
|
|
@@ -6774,8 +6808,8 @@ Create a project manifest that lists the metadata components you want to deploy
|
|
|
6774
6808
|
|
|
6775
6809
|
```
|
|
6776
6810
|
USAGE
|
|
6777
|
-
$ sf project generate manifest [--json] [--api-version <value>] [-m <value>] [-p <value>] [-n <value> |
|
|
6778
|
-
pre|post|destroy|package] [-c managed|unlocked --from-org <value>] [-d <value>]
|
|
6811
|
+
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>] [-p <value>] [-n <value> |
|
|
6812
|
+
-t pre|post|destroy|package] [-c managed|unlocked --from-org <value>] [-d <value>]
|
|
6779
6813
|
|
|
6780
6814
|
FLAGS
|
|
6781
6815
|
-c, --include-packages=<option>... Package types (managed, unlocked) whose metadata is included in the manifest; by
|
|
@@ -6792,7 +6826,8 @@ FLAGS
|
|
|
6792
6826
|
build a manifest.
|
|
6793
6827
|
|
|
6794
6828
|
GLOBAL FLAGS
|
|
6795
|
-
--
|
|
6829
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6830
|
+
--json Format output as json.
|
|
6796
6831
|
|
|
6797
6832
|
DESCRIPTION
|
|
6798
6833
|
Create a project manifest that lists the metadata components you want to deploy or retrieve.
|
|
@@ -6841,7 +6876,7 @@ EXAMPLES
|
|
|
6841
6876
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
6842
6877
|
```
|
|
6843
6878
|
|
|
6844
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6879
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/generate/manifest.ts)_
|
|
6845
6880
|
|
|
6846
6881
|
## `sf project list ignored`
|
|
6847
6882
|
|
|
@@ -6849,13 +6884,14 @@ Check your local project package directories for forceignored files.
|
|
|
6849
6884
|
|
|
6850
6885
|
```
|
|
6851
6886
|
USAGE
|
|
6852
|
-
$ sf project list ignored [--json] [-p <value>]
|
|
6887
|
+
$ sf project list ignored [--json] [--flags-dir <value>] [-p <value>]
|
|
6853
6888
|
|
|
6854
6889
|
FLAGS
|
|
6855
6890
|
-p, --source-dir=<value> File or directory of files that the command checks for foreceignored files.
|
|
6856
6891
|
|
|
6857
6892
|
GLOBAL FLAGS
|
|
6858
|
-
--
|
|
6893
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6894
|
+
--json Format output as json.
|
|
6859
6895
|
|
|
6860
6896
|
DESCRIPTION
|
|
6861
6897
|
Check your local project package directories for forceignored files.
|
|
@@ -6882,7 +6918,7 @@ EXAMPLES
|
|
|
6882
6918
|
$ sf project list ignored --source-dir package.xml
|
|
6883
6919
|
```
|
|
6884
6920
|
|
|
6885
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6921
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/list/ignored.ts)_
|
|
6886
6922
|
|
|
6887
6923
|
## `sf project reset tracking`
|
|
6888
6924
|
|
|
@@ -6890,7 +6926,7 @@ Reset local and remote source tracking.
|
|
|
6890
6926
|
|
|
6891
6927
|
```
|
|
6892
6928
|
USAGE
|
|
6893
|
-
$ sf project reset tracking -o <value> [--json] [--api-version <value>] [-r <value>] [-p]
|
|
6929
|
+
$ sf project reset tracking -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-r <value>] [-p]
|
|
6894
6930
|
|
|
6895
6931
|
FLAGS
|
|
6896
6932
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -6900,7 +6936,8 @@ FLAGS
|
|
|
6900
6936
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
6901
6937
|
|
|
6902
6938
|
GLOBAL FLAGS
|
|
6903
|
-
--
|
|
6939
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6940
|
+
--json Format output as json.
|
|
6904
6941
|
|
|
6905
6942
|
DESCRIPTION
|
|
6906
6943
|
Reset local and remote source tracking.
|
|
@@ -6930,7 +6967,7 @@ EXAMPLES
|
|
|
6930
6967
|
$ sf project reset tracking --revision 30
|
|
6931
6968
|
```
|
|
6932
6969
|
|
|
6933
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6970
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/reset/tracking.ts)_
|
|
6934
6971
|
|
|
6935
6972
|
## `sf project retrieve preview`
|
|
6936
6973
|
|
|
@@ -6938,7 +6975,7 @@ Preview a retrieval to see what will be retrieved from the org, the potential co
|
|
|
6938
6975
|
|
|
6939
6976
|
```
|
|
6940
6977
|
USAGE
|
|
6941
|
-
$ sf project retrieve preview -o <value> [--json] [-c] [--concise]
|
|
6978
|
+
$ sf project retrieve preview -o <value> [--json] [--flags-dir <value>] [-c] [--concise]
|
|
6942
6979
|
|
|
6943
6980
|
FLAGS
|
|
6944
6981
|
-c, --ignore-conflicts Don't display conflicts in the preview of the retrieval.
|
|
@@ -6946,7 +6983,8 @@ FLAGS
|
|
|
6946
6983
|
--concise Show only the changes that will be retrieved; omits files that are forceignored.
|
|
6947
6984
|
|
|
6948
6985
|
GLOBAL FLAGS
|
|
6949
|
-
--
|
|
6986
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6987
|
+
--json Format output as json.
|
|
6950
6988
|
|
|
6951
6989
|
DESCRIPTION
|
|
6952
6990
|
Preview a retrieval to see what will be retrieved from the org, the potential conflicts, and the ignored files.
|
|
@@ -6986,7 +7024,7 @@ FLAG DESCRIPTIONS
|
|
|
6986
7024
|
Overrides your default org.
|
|
6987
7025
|
```
|
|
6988
7026
|
|
|
6989
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7027
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/retrieve/preview.ts)_
|
|
6990
7028
|
|
|
6991
7029
|
## `sf project retrieve start`
|
|
6992
7030
|
|
|
@@ -6994,8 +7032,8 @@ Retrieve metadata from an org to your local project.
|
|
|
6994
7032
|
|
|
6995
7033
|
```
|
|
6996
7034
|
USAGE
|
|
6997
|
-
$ sf project retrieve start -o <value> [--json] [-a <value>] [-c] [-x <value> | -m <value> | -d
|
|
6998
|
-
<value> | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name <value> ]
|
|
7035
|
+
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value> | -d
|
|
7036
|
+
<value>] [-r <value> | -n <value> | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name <value> ]
|
|
6999
7037
|
|
|
7000
7038
|
FLAGS
|
|
7001
7039
|
-a, --api-version=<value> Target API version for the retrieve.
|
|
@@ -7007,8 +7045,8 @@ FLAGS
|
|
|
7007
7045
|
-n, --package-name=<value>... Package names to retrieve.
|
|
7008
7046
|
-o, --target-org=<value> (required) Login username or alias for the target org.
|
|
7009
7047
|
-r, --output-dir=<value> Directory root for the retrieved source files.
|
|
7010
|
-
-w, --wait=<value> [default:
|
|
7011
|
-
|
|
7048
|
+
-w, --wait=<value> [default: 33 minutes] Number of minutes to wait for the command to complete and display
|
|
7049
|
+
results to the terminal window.
|
|
7012
7050
|
-x, --manifest=<value> File path for the manifest (package.xml) that specifies the components to retrieve.
|
|
7013
7051
|
|
|
7014
7052
|
METADATA API FORMAT FLAGS
|
|
@@ -7018,7 +7056,8 @@ METADATA API FORMAT FLAGS
|
|
|
7018
7056
|
--zip-file-name=<value> File name to use for the retrieved zip file.
|
|
7019
7057
|
|
|
7020
7058
|
GLOBAL FLAGS
|
|
7021
|
-
--
|
|
7059
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7060
|
+
--json Format output as json.
|
|
7022
7061
|
|
|
7023
7062
|
DESCRIPTION
|
|
7024
7063
|
Retrieve metadata from an org to your local project.
|
|
@@ -7144,7 +7183,7 @@ ENVIRONMENT VARIABLES
|
|
|
7144
7183
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
7145
7184
|
```
|
|
7146
7185
|
|
|
7147
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7186
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.0/src/commands/project/retrieve/start.ts)_
|
|
7148
7187
|
|
|
7149
7188
|
## `sf schema generate field`
|
|
7150
7189
|
|