@salesforce/cli 2.20.3 → 2.20.4
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 +197 -135
- package/npm-shrinkwrap.json +269 -109
- package/oclif.manifest.json +2 -2
- package/package.json +21 -21
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
|
|
|
24
24
|
$ sf COMMAND
|
|
25
25
|
running command...
|
|
26
26
|
$ sf (--version|-v)
|
|
27
|
-
@salesforce/cli/2.20.
|
|
27
|
+
@salesforce/cli/2.20.4 linux-x64 node-v20.9.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -215,7 +215,7 @@ EXAMPLES
|
|
|
215
215
|
$ sf alias list
|
|
216
216
|
```
|
|
217
217
|
|
|
218
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
218
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.9/src/commands/alias/list.ts)_
|
|
219
219
|
|
|
220
220
|
## `sf alias set`
|
|
221
221
|
|
|
@@ -263,7 +263,7 @@ EXAMPLES
|
|
|
263
263
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
264
264
|
```
|
|
265
265
|
|
|
266
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
266
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.9/src/commands/alias/set.ts)_
|
|
267
267
|
|
|
268
268
|
## `sf alias unset`
|
|
269
269
|
|
|
@@ -302,7 +302,7 @@ EXAMPLES
|
|
|
302
302
|
$ sf alias unset --all [--no-prompt]
|
|
303
303
|
```
|
|
304
304
|
|
|
305
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
305
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.9/src/commands/alias/unset.ts)_
|
|
306
306
|
|
|
307
307
|
## `sf analytics generate template`
|
|
308
308
|
|
|
@@ -343,7 +343,7 @@ FLAG DESCRIPTIONS
|
|
|
343
343
|
directory.
|
|
344
344
|
```
|
|
345
345
|
|
|
346
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
346
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/analytics/generate/template.ts)_
|
|
347
347
|
|
|
348
348
|
## `sf apex generate class`
|
|
349
349
|
|
|
@@ -399,7 +399,7 @@ FLAG DESCRIPTIONS
|
|
|
399
399
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
400
400
|
```
|
|
401
401
|
|
|
402
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
402
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/apex/generate/class.ts)_
|
|
403
403
|
|
|
404
404
|
## `sf apex generate trigger`
|
|
405
405
|
|
|
@@ -466,7 +466,7 @@ FLAG DESCRIPTIONS
|
|
|
466
466
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
467
467
|
```
|
|
468
468
|
|
|
469
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
469
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/apex/generate/trigger.ts)_
|
|
470
470
|
|
|
471
471
|
## `sf apex get log`
|
|
472
472
|
|
|
@@ -519,7 +519,7 @@ FLAG DESCRIPTIONS
|
|
|
519
519
|
directory.
|
|
520
520
|
```
|
|
521
521
|
|
|
522
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.
|
|
522
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.7/src/commands/apex/get/log.ts)_
|
|
523
523
|
|
|
524
524
|
## `sf apex get test`
|
|
525
525
|
|
|
@@ -571,7 +571,7 @@ EXAMPLES
|
|
|
571
571
|
me@myorg',
|
|
572
572
|
```
|
|
573
573
|
|
|
574
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.
|
|
574
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.7/src/commands/apex/get/test.ts)_
|
|
575
575
|
|
|
576
576
|
## `sf apex list log`
|
|
577
577
|
|
|
@@ -609,7 +609,7 @@ EXAMPLES
|
|
|
609
609
|
$ sf apex list log --target-org me@my.org
|
|
610
610
|
```
|
|
611
611
|
|
|
612
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.
|
|
612
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.7/src/commands/apex/list/log.ts)_
|
|
613
613
|
|
|
614
614
|
## `sf apex run`
|
|
615
615
|
|
|
@@ -654,7 +654,7 @@ EXAMPLES
|
|
|
654
654
|
$ sf apex run
|
|
655
655
|
```
|
|
656
656
|
|
|
657
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.
|
|
657
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.7/src/commands/apex/run.ts)_
|
|
658
658
|
|
|
659
659
|
## `sf apex run test`
|
|
660
660
|
|
|
@@ -760,7 +760,7 @@ FLAG DESCRIPTIONS
|
|
|
760
760
|
--tests Test1 --tests Test2
|
|
761
761
|
```
|
|
762
762
|
|
|
763
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.
|
|
763
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.7/src/commands/apex/run/test.ts)_
|
|
764
764
|
|
|
765
765
|
## `sf apex tail log`
|
|
766
766
|
|
|
@@ -799,7 +799,7 @@ EXAMPLES
|
|
|
799
799
|
$ sf apex tail log --color --skip-trace-flag
|
|
800
800
|
```
|
|
801
801
|
|
|
802
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.
|
|
802
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.0.7/src/commands/apex/tail/log.ts)_
|
|
803
803
|
|
|
804
804
|
## `sf autocomplete [SHELL]`
|
|
805
805
|
|
|
@@ -909,7 +909,7 @@ CONFIGURATION VARIABLES
|
|
|
909
909
|
org-max-query-limit Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
|
|
910
910
|
```
|
|
911
911
|
|
|
912
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
912
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.9/src/commands/config/get.ts)_
|
|
913
913
|
|
|
914
914
|
## `sf config list`
|
|
915
915
|
|
|
@@ -948,7 +948,7 @@ EXAMPLES
|
|
|
948
948
|
$ sf config list
|
|
949
949
|
```
|
|
950
950
|
|
|
951
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
951
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.9/src/commands/config/list.ts)_
|
|
952
952
|
|
|
953
953
|
## `sf config set`
|
|
954
954
|
|
|
@@ -1015,7 +1015,7 @@ CONFIGURATION VARIABLES
|
|
|
1015
1015
|
org-max-query-limit Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
|
|
1016
1016
|
```
|
|
1017
1017
|
|
|
1018
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
1018
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.9/src/commands/config/set.ts)_
|
|
1019
1019
|
|
|
1020
1020
|
## `sf config unset`
|
|
1021
1021
|
|
|
@@ -1063,7 +1063,7 @@ CONFIGURATION VARIABLES
|
|
|
1063
1063
|
org-max-query-limit Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
|
|
1064
1064
|
```
|
|
1065
1065
|
|
|
1066
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
1066
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.9/src/commands/config/unset.ts)_
|
|
1067
1067
|
|
|
1068
1068
|
## `sf data create record`
|
|
1069
1069
|
|
|
@@ -1074,7 +1074,8 @@ USAGE
|
|
|
1074
1074
|
$ sf data create record -o <value> -s <value> -v <value> [--json] [--api-version <value>] [-t]
|
|
1075
1075
|
|
|
1076
1076
|
FLAGS
|
|
1077
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1077
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1078
|
+
configuration variable is already set.
|
|
1078
1079
|
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're inserting a record
|
|
1079
1080
|
into.
|
|
1080
1081
|
-t, --use-tooling-api Use Tooling API so you can insert a record in a Tooling API object.
|
|
@@ -1117,7 +1118,7 @@ EXAMPLES
|
|
|
1117
1118
|
TracedEntityId=01p17000000R6bLAAS"
|
|
1118
1119
|
```
|
|
1119
1120
|
|
|
1120
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1121
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/create/record.ts)_
|
|
1121
1122
|
|
|
1122
1123
|
## `sf data delete bulk`
|
|
1123
1124
|
|
|
@@ -1130,7 +1131,8 @@ USAGE
|
|
|
1130
1131
|
FLAGS
|
|
1131
1132
|
-a, --async Run the command asynchronously.
|
|
1132
1133
|
-f, --file=<value> (required) CSV file that contains the IDs of the records to update or delete.
|
|
1133
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1134
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1135
|
+
configuration variable is already set.
|
|
1134
1136
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1135
1137
|
update or delete records from.
|
|
1136
1138
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete before
|
|
@@ -1161,7 +1163,7 @@ EXAMPLES
|
|
|
1161
1163
|
$ sf data delete bulk --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1162
1164
|
```
|
|
1163
1165
|
|
|
1164
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1166
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/delete/bulk.ts)_
|
|
1165
1167
|
|
|
1166
1168
|
## `sf data delete record`
|
|
1167
1169
|
|
|
@@ -1173,7 +1175,8 @@ USAGE
|
|
|
1173
1175
|
|
|
1174
1176
|
FLAGS
|
|
1175
1177
|
-i, --record-id=<value> ID of the record you’re deleting.
|
|
1176
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1178
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1179
|
+
configuration variable is already set.
|
|
1177
1180
|
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're deleting a record
|
|
1178
1181
|
from.
|
|
1179
1182
|
-t, --use-tooling-api Use Tooling API so you can delete a record from a Tooling API object.
|
|
@@ -1219,7 +1222,7 @@ EXAMPLES
|
|
|
1219
1222
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1220
1223
|
```
|
|
1221
1224
|
|
|
1222
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1225
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/delete/record.ts)_
|
|
1223
1226
|
|
|
1224
1227
|
## `sf data delete resume`
|
|
1225
1228
|
|
|
@@ -1256,7 +1259,7 @@ EXAMPLES
|
|
|
1256
1259
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
1257
1260
|
```
|
|
1258
1261
|
|
|
1259
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1262
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/delete/resume.ts)_
|
|
1260
1263
|
|
|
1261
1264
|
## `sf data export tree`
|
|
1262
1265
|
|
|
@@ -1268,7 +1271,8 @@ USAGE
|
|
|
1268
1271
|
|
|
1269
1272
|
FLAGS
|
|
1270
1273
|
-d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
|
|
1271
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1274
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1275
|
+
configuration variable is already set.
|
|
1272
1276
|
-p, --plan Generate multiple sObject tree files and a plan definition file for aggregated import.
|
|
1273
1277
|
-q, --query=<value> (required) SOQL query, or filepath of a file that contains the query, to retrieve records.
|
|
1274
1278
|
-x, --prefix=<value> Prefix of generated files.
|
|
@@ -1313,7 +1317,7 @@ EXAMPLES
|
|
|
1313
1317
|
my-scratch
|
|
1314
1318
|
```
|
|
1315
1319
|
|
|
1316
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1320
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/export/tree.ts)_
|
|
1317
1321
|
|
|
1318
1322
|
## `sf data get record`
|
|
1319
1323
|
|
|
@@ -1325,7 +1329,8 @@ USAGE
|
|
|
1325
1329
|
|
|
1326
1330
|
FLAGS
|
|
1327
1331
|
-i, --record-id=<value> ID of the record you’re retrieving.
|
|
1328
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1332
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1333
|
+
configuration variable is already set.
|
|
1329
1334
|
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're retrieving a record
|
|
1330
1335
|
from.
|
|
1331
1336
|
-t, --use-tooling-api Use Tooling API so you can retrieve a record from a Tooling API object.
|
|
@@ -1374,7 +1379,7 @@ EXAMPLES
|
|
|
1374
1379
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1375
1380
|
```
|
|
1376
1381
|
|
|
1377
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1382
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/get/record.ts)_
|
|
1378
1383
|
|
|
1379
1384
|
## `sf data import tree`
|
|
1380
1385
|
|
|
@@ -1387,7 +1392,8 @@ USAGE
|
|
|
1387
1392
|
FLAGS
|
|
1388
1393
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
1389
1394
|
that you want to insert.
|
|
1390
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1395
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1396
|
+
configuration variable is already set.
|
|
1391
1397
|
-p, --plan=<value> Plan definition file to insert multiple data files.
|
|
1392
1398
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1393
1399
|
--config-help Display schema information for the --plan configuration file to stdout; if you specify this
|
|
@@ -1424,7 +1430,7 @@ EXAMPLES
|
|
|
1424
1430
|
$ sf data import tree --plan Account-Contact-plan.json
|
|
1425
1431
|
```
|
|
1426
1432
|
|
|
1427
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1433
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/import/tree.ts)_
|
|
1428
1434
|
|
|
1429
1435
|
## `sf data query`
|
|
1430
1436
|
|
|
@@ -1438,7 +1444,8 @@ USAGE
|
|
|
1438
1444
|
FLAGS
|
|
1439
1445
|
-b, --bulk Use Bulk API 2.0 to run the query.
|
|
1440
1446
|
-f, --file=<value> File that contains the SOQL query.
|
|
1441
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1447
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1448
|
+
configuration variable is already set.
|
|
1442
1449
|
-q, --query=<value> SOQL query to execute.
|
|
1443
1450
|
-r, --result-format=<option> [default: human] Format to display the results; the --json flag overrides this flag.
|
|
1444
1451
|
<options: human|json|csv>
|
|
@@ -1486,7 +1493,7 @@ EXAMPLES
|
|
|
1486
1493
|
$ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
|
|
1487
1494
|
```
|
|
1488
1495
|
|
|
1489
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1496
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/query.ts)_
|
|
1490
1497
|
|
|
1491
1498
|
## `sf data query resume`
|
|
1492
1499
|
|
|
@@ -1522,7 +1529,7 @@ EXAMPLES
|
|
|
1522
1529
|
$ sf data query resume --bulk-query-id 7500x000005BdFzXXX
|
|
1523
1530
|
```
|
|
1524
1531
|
|
|
1525
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1532
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/query/resume.ts)_
|
|
1526
1533
|
|
|
1527
1534
|
## `sf data resume`
|
|
1528
1535
|
|
|
@@ -1535,7 +1542,8 @@ USAGE
|
|
|
1535
1542
|
FLAGS
|
|
1536
1543
|
-b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
|
|
1537
1544
|
-i, --job-id=<value> (required) ID of the job whose status you want to view.
|
|
1538
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1545
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1546
|
+
configuration variable is already set.
|
|
1539
1547
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1540
1548
|
|
|
1541
1549
|
GLOBAL FLAGS
|
|
@@ -1557,7 +1565,7 @@ EXAMPLES
|
|
|
1557
1565
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
1558
1566
|
```
|
|
1559
1567
|
|
|
1560
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1568
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/resume.ts)_
|
|
1561
1569
|
|
|
1562
1570
|
## `sf data update record`
|
|
1563
1571
|
|
|
@@ -1570,7 +1578,8 @@ USAGE
|
|
|
1570
1578
|
|
|
1571
1579
|
FLAGS
|
|
1572
1580
|
-i, --record-id=<value> ID of the record you’re updating.
|
|
1573
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1581
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1582
|
+
configuration variable is already set.
|
|
1574
1583
|
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that contains the record you're
|
|
1575
1584
|
updating.
|
|
1576
1585
|
-t, --use-tooling-api Use Tooling API so you can update a record in a Tooling API object.
|
|
@@ -1617,7 +1626,7 @@ EXAMPLES
|
|
|
1617
1626
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
1618
1627
|
```
|
|
1619
1628
|
|
|
1620
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1629
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/update/record.ts)_
|
|
1621
1630
|
|
|
1622
1631
|
## `sf data upsert bulk`
|
|
1623
1632
|
|
|
@@ -1632,7 +1641,8 @@ FLAGS
|
|
|
1632
1641
|
-a, --async Run the command asynchronously.
|
|
1633
1642
|
-f, --file=<value> (required) CSV file that contains the IDs of the records to update or delete.
|
|
1634
1643
|
-i, --external-id=<value> (required) Name of the external ID field, or the Id field.
|
|
1635
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1644
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1645
|
+
configuration variable is already set.
|
|
1636
1646
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1637
1647
|
update or delete records from.
|
|
1638
1648
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete before
|
|
@@ -1668,7 +1678,7 @@ EXAMPLES
|
|
|
1668
1678
|
my-scratch
|
|
1669
1679
|
```
|
|
1670
1680
|
|
|
1671
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1681
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/upsert/bulk.ts)_
|
|
1672
1682
|
|
|
1673
1683
|
## `sf data upsert resume`
|
|
1674
1684
|
|
|
@@ -1705,7 +1715,7 @@ EXAMPLES
|
|
|
1705
1715
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
1706
1716
|
```
|
|
1707
1717
|
|
|
1708
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1718
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/data/upsert/resume.ts)_
|
|
1709
1719
|
|
|
1710
1720
|
## `sf doctor`
|
|
1711
1721
|
|
|
@@ -1752,7 +1762,7 @@ EXAMPLES
|
|
|
1752
1762
|
$ sf doctor --plugin @salesforce/plugin-source
|
|
1753
1763
|
```
|
|
1754
1764
|
|
|
1755
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0.
|
|
1765
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0.5/src/commands/doctor.ts)_
|
|
1756
1766
|
|
|
1757
1767
|
## `sf force data bulk delete`
|
|
1758
1768
|
|
|
@@ -1764,7 +1774,8 @@ USAGE
|
|
|
1764
1774
|
|
|
1765
1775
|
FLAGS
|
|
1766
1776
|
-f, --file=<value> (required) CSV file that contains the IDs of the records to delete.
|
|
1767
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1777
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1778
|
+
configuration variable is already set.
|
|
1768
1779
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1769
1780
|
delete records from.
|
|
1770
1781
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete before
|
|
@@ -1796,7 +1807,7 @@ EXAMPLES
|
|
|
1796
1807
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1797
1808
|
```
|
|
1798
1809
|
|
|
1799
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1810
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/force/data/bulk/delete.ts)_
|
|
1800
1811
|
|
|
1801
1812
|
## `sf force data bulk status`
|
|
1802
1813
|
|
|
@@ -1809,7 +1820,8 @@ USAGE
|
|
|
1809
1820
|
FLAGS
|
|
1810
1821
|
-b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
|
|
1811
1822
|
-i, --job-id=<value> (required) ID of the job whose status you want to view.
|
|
1812
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1823
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1824
|
+
configuration variable is already set.
|
|
1813
1825
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1814
1826
|
|
|
1815
1827
|
GLOBAL FLAGS
|
|
@@ -1831,7 +1843,7 @@ EXAMPLES
|
|
|
1831
1843
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
1832
1844
|
```
|
|
1833
1845
|
|
|
1834
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1846
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/force/data/bulk/status.ts)_
|
|
1835
1847
|
|
|
1836
1848
|
## `sf force data bulk upsert`
|
|
1837
1849
|
|
|
@@ -1845,7 +1857,8 @@ USAGE
|
|
|
1845
1857
|
FLAGS
|
|
1846
1858
|
-f, --file=<value> (required) CSV file that contains the records to upsert.
|
|
1847
1859
|
-i, --external-id=<value> (required) Name of the external ID field, or the Id field.
|
|
1848
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1860
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1861
|
+
configuration variable is already set.
|
|
1849
1862
|
-r, --serial Run batches in serial mode.
|
|
1850
1863
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1851
1864
|
upsert records to.
|
|
@@ -1887,7 +1900,7 @@ EXAMPLES
|
|
|
1887
1900
|
--target-org my-scratch
|
|
1888
1901
|
```
|
|
1889
1902
|
|
|
1890
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.
|
|
1903
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.2/src/commands/force/data/bulk/upsert.ts)_
|
|
1891
1904
|
|
|
1892
1905
|
## `sf force mdapi deploy`
|
|
1893
1906
|
|
|
@@ -1895,8 +1908,8 @@ Deploy metadata to an org using Metadata API.
|
|
|
1895
1908
|
|
|
1896
1909
|
```
|
|
1897
1910
|
USAGE
|
|
1898
|
-
$ sf force mdapi deploy -u <value> [--api-version <value>] [-d <value>] [-w <value>] [-o] [-g] [-q <value> |
|
|
1899
|
-
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <value> | -c] [--verbose] [-f <value>] [-s]
|
|
1911
|
+
$ sf force mdapi deploy -u <value> [--json] [--api-version <value>] [-d <value>] [-w <value>] [-o] [-g] [-q <value> |
|
|
1912
|
+
-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <value> | -c] [--verbose] [-f <value>] [-s]
|
|
1900
1913
|
[--soapdeploy] [--purgeondelete] [--concise] [--resultsdir <value>] [--coverageformatters
|
|
1901
1914
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
1902
1915
|
|
|
@@ -1960,6 +1973,9 @@ FLAGS
|
|
|
1960
1973
|
--verbose
|
|
1961
1974
|
Display verbose output of the deploy results.
|
|
1962
1975
|
|
|
1976
|
+
GLOBAL FLAGS
|
|
1977
|
+
--json Format output as json.
|
|
1978
|
+
|
|
1963
1979
|
EXAMPLES
|
|
1964
1980
|
Return a job ID you can use to check the deploy status:
|
|
1965
1981
|
|
|
@@ -2084,7 +2100,7 @@ FLAG DESCRIPTIONS
|
|
|
2084
2100
|
Indicates that you want verbose output from the deploy operation.
|
|
2085
2101
|
```
|
|
2086
2102
|
|
|
2087
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2103
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/mdapi/deploy.ts)_
|
|
2088
2104
|
|
|
2089
2105
|
## `sf force mdapi deploy cancel`
|
|
2090
2106
|
|
|
@@ -2092,7 +2108,7 @@ Cancel a metadata deployment.
|
|
|
2092
2108
|
|
|
2093
2109
|
```
|
|
2094
2110
|
USAGE
|
|
2095
|
-
$ sf force mdapi deploy cancel -o <value> [--api-version <value>] [-w <value>] [-i <value>]
|
|
2111
|
+
$ sf force mdapi deploy cancel -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>]
|
|
2096
2112
|
|
|
2097
2113
|
FLAGS
|
|
2098
2114
|
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment.
|
|
@@ -2101,6 +2117,9 @@ FLAGS
|
|
|
2101
2117
|
results to the terminal window.
|
|
2102
2118
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2103
2119
|
|
|
2120
|
+
GLOBAL FLAGS
|
|
2121
|
+
--json Format output as json.
|
|
2122
|
+
|
|
2104
2123
|
DESCRIPTION
|
|
2105
2124
|
Cancel a metadata deployment.
|
|
2106
2125
|
|
|
@@ -2124,7 +2143,7 @@ FLAG DESCRIPTIONS
|
|
|
2124
2143
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2125
2144
|
```
|
|
2126
2145
|
|
|
2127
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2146
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/mdapi/deploy/cancel.ts)_
|
|
2128
2147
|
|
|
2129
2148
|
## `sf force mdapi deploy report`
|
|
2130
2149
|
|
|
@@ -2132,7 +2151,7 @@ Check the status of a metadata deployment.
|
|
|
2132
2151
|
|
|
2133
2152
|
```
|
|
2134
2153
|
USAGE
|
|
2135
|
-
$ sf force mdapi deploy report -o <value> [--api-version <value>] [-w <value>] [-i <value>] [--verbose] [--concise]
|
|
2154
|
+
$ sf force mdapi deploy report -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>] [--verbose] [--concise]
|
|
2136
2155
|
[--resultsdir <value>] [--coverageformatters
|
|
2137
2156
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2138
2157
|
|
|
@@ -2165,6 +2184,9 @@ FLAGS
|
|
|
2165
2184
|
--verbose
|
|
2166
2185
|
Verbose output of deploy results.
|
|
2167
2186
|
|
|
2187
|
+
GLOBAL FLAGS
|
|
2188
|
+
--json Format output as json.
|
|
2189
|
+
|
|
2168
2190
|
DESCRIPTION
|
|
2169
2191
|
Check the status of a metadata deployment.
|
|
2170
2192
|
|
|
@@ -2192,7 +2214,7 @@ FLAG DESCRIPTIONS
|
|
|
2192
2214
|
use the ID of the most recent metadata deployment.
|
|
2193
2215
|
```
|
|
2194
2216
|
|
|
2195
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2217
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/mdapi/deploy/report.ts)_
|
|
2196
2218
|
|
|
2197
2219
|
## `sf force mdapi retrieve`
|
|
2198
2220
|
|
|
@@ -2200,8 +2222,8 @@ Retrieve metadata from an org using Metadata API.
|
|
|
2200
2222
|
|
|
2201
2223
|
```
|
|
2202
2224
|
USAGE
|
|
2203
|
-
$ sf force mdapi retrieve -o <value> -r <value> [-k <value> | -d <value> | -p <value>] [-s] [-n <value>] [-z]
|
|
2204
|
-
<value>] [-a <value>] [--verbose]
|
|
2225
|
+
$ sf force mdapi retrieve -o <value> -r <value> [--json] [-k <value> | -d <value> | -p <value>] [-s] [-n <value>] [-z]
|
|
2226
|
+
[-w <value>] [-a <value>] [--verbose]
|
|
2205
2227
|
|
|
2206
2228
|
FLAGS
|
|
2207
2229
|
-a, --apiversion=<value> Target API version for the retrieve.
|
|
@@ -2218,6 +2240,9 @@ FLAGS
|
|
|
2218
2240
|
-z, --unzip Extract all files from the retrieved zip file.
|
|
2219
2241
|
--verbose Display verbose output of retrieve result.
|
|
2220
2242
|
|
|
2243
|
+
GLOBAL FLAGS
|
|
2244
|
+
--json Format output as json.
|
|
2245
|
+
|
|
2221
2246
|
DESCRIPTION
|
|
2222
2247
|
Retrieve metadata from an org using Metadata API.
|
|
2223
2248
|
|
|
@@ -2253,7 +2278,7 @@ FLAG DESCRIPTIONS
|
|
|
2253
2278
|
By default, the CLI assumes the directory is structured for a set of packages.
|
|
2254
2279
|
```
|
|
2255
2280
|
|
|
2256
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2281
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/mdapi/retrieve.ts)_
|
|
2257
2282
|
|
|
2258
2283
|
## `sf force mdapi retrieve report`
|
|
2259
2284
|
|
|
@@ -2261,8 +2286,8 @@ Check the status of a metadata retrieval.
|
|
|
2261
2286
|
|
|
2262
2287
|
```
|
|
2263
2288
|
USAGE
|
|
2264
|
-
$ sf force mdapi retrieve report -o <value> [--api-version <value>] [-r <value>] [-i <value>] [-n <value>] [-z] [-w
|
|
2265
|
-
[--verbose]
|
|
2289
|
+
$ sf force mdapi retrieve report -o <value> [--json] [--api-version <value>] [-r <value>] [-i <value>] [-n <value>] [-z] [-w
|
|
2290
|
+
<value>] [--verbose]
|
|
2266
2291
|
|
|
2267
2292
|
FLAGS
|
|
2268
2293
|
-i, --jobid=<value> Job ID of the retrieve you want to check; defaults to your most recent CLI retrieval.
|
|
@@ -2275,6 +2300,9 @@ FLAGS
|
|
|
2275
2300
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2276
2301
|
--verbose Display verbose output of retrieve result.
|
|
2277
2302
|
|
|
2303
|
+
GLOBAL FLAGS
|
|
2304
|
+
--json Format output as json.
|
|
2305
|
+
|
|
2278
2306
|
DESCRIPTION
|
|
2279
2307
|
Check the status of a metadata retrieval.
|
|
2280
2308
|
|
|
@@ -2304,7 +2332,7 @@ FLAG DESCRIPTIONS
|
|
|
2304
2332
|
You must specify a --retrievetargetdir. Use with --wait to resume waiting.
|
|
2305
2333
|
```
|
|
2306
2334
|
|
|
2307
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2335
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/mdapi/retrieve/report.ts)_
|
|
2308
2336
|
|
|
2309
2337
|
## `sf force org clone`
|
|
2310
2338
|
|
|
@@ -2318,7 +2346,8 @@ USAGE
|
|
|
2318
2346
|
FLAGS
|
|
2319
2347
|
-a, --setalias=<value> Alias for the cloned org.
|
|
2320
2348
|
-f, --definitionfile=<value> Path to the sandbox definition file.
|
|
2321
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2349
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2350
|
+
configuration variable is already set.
|
|
2322
2351
|
-s, --setdefaultusername Set the cloned org as your default.
|
|
2323
2352
|
-t, --type=<option> (required) Type of org to create.
|
|
2324
2353
|
<options: sandbox>
|
|
@@ -2351,7 +2380,7 @@ FLAG DESCRIPTIONS
|
|
|
2351
2380
|
for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
|
|
2352
2381
|
```
|
|
2353
2382
|
|
|
2354
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
2383
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/force/org/clone.ts)_
|
|
2355
2384
|
|
|
2356
2385
|
## `sf force org create`
|
|
2357
2386
|
|
|
@@ -2373,7 +2402,8 @@ FLAGS
|
|
|
2373
2402
|
-s, --setdefaultusername Set the created org as the default username.
|
|
2374
2403
|
-t, --type=<option> [default: scratch] Type of org to create.
|
|
2375
2404
|
<options: scratch|sandbox>
|
|
2376
|
-
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
|
|
2405
|
+
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration
|
|
2406
|
+
variable is already set.
|
|
2377
2407
|
-w, --wait=<value> [default: [object Object]] Streaming client socket timeout (in minutes).
|
|
2378
2408
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2379
2409
|
|
|
@@ -2399,7 +2429,7 @@ EXAMPLES
|
|
|
2399
2429
|
$ sf force org create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
|
|
2400
2430
|
```
|
|
2401
2431
|
|
|
2402
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
2432
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/force/org/create.ts)_
|
|
2403
2433
|
|
|
2404
2434
|
## `sf force org delete`
|
|
2405
2435
|
|
|
@@ -2431,7 +2461,7 @@ EXAMPLES
|
|
|
2431
2461
|
$ sf force org delete -u MyOrgAlias -p
|
|
2432
2462
|
```
|
|
2433
2463
|
|
|
2434
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
2464
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/force/org/delete.ts)_
|
|
2435
2465
|
|
|
2436
2466
|
## `sf force org status`
|
|
2437
2467
|
|
|
@@ -2444,7 +2474,8 @@ USAGE
|
|
|
2444
2474
|
FLAGS
|
|
2445
2475
|
-a, --setalias=<value> Alias for the created or cloned org.
|
|
2446
2476
|
-n, --sandboxname=<value> (required) Name of the sandbox org to check status for.
|
|
2447
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2477
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2478
|
+
configuration variable is already set.
|
|
2448
2479
|
-s, --setdefaultusername Set the created or cloned org as your default.
|
|
2449
2480
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait while polling for status.
|
|
2450
2481
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
@@ -2469,7 +2500,7 @@ EXAMPLES
|
|
|
2469
2500
|
$ sf force org status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
|
|
2470
2501
|
```
|
|
2471
2502
|
|
|
2472
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
2503
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/force/org/status.ts)_
|
|
2473
2504
|
|
|
2474
2505
|
## `sf force source deploy`
|
|
2475
2506
|
|
|
@@ -2477,10 +2508,10 @@ Deploy source to an org.
|
|
|
2477
2508
|
|
|
2478
2509
|
```
|
|
2479
2510
|
USAGE
|
|
2480
|
-
$ sf force source deploy -u <value> [--api-version <value>] [--soapdeploy] [-w <value>] [-o] [-g]
|
|
2481
|
-
<value>] [-q <value> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r
|
|
2482
|
-
[--verbose] [-m <value>] [-p <value>] [--predestructivechanges <value> ] [--postdestructivechanges
|
|
2483
|
-
[--resultsdir <value>] [--coverageformatters
|
|
2511
|
+
$ sf force source deploy -u <value> [--json] [--api-version <value>] [--soapdeploy] [-w <value>] [-o] [-g]
|
|
2512
|
+
[--purgeondelete -x <value>] [-q <value> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r
|
|
2513
|
+
<value> | -t] [--verbose] [-m <value>] [-p <value>] [--predestructivechanges <value> ] [--postdestructivechanges
|
|
2514
|
+
<value> ] [-f ] [--resultsdir <value>] [--coverageformatters
|
|
2484
2515
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2485
2516
|
|
|
2486
2517
|
FLAGS
|
|
@@ -2552,6 +2583,9 @@ FLAGS
|
|
|
2552
2583
|
--verbose
|
|
2553
2584
|
Specify verbose output about the deploy result.
|
|
2554
2585
|
|
|
2586
|
+
GLOBAL FLAGS
|
|
2587
|
+
--json Format output as json.
|
|
2588
|
+
|
|
2555
2589
|
DESCRIPTION
|
|
2556
2590
|
Deploy source to an org.
|
|
2557
2591
|
|
|
@@ -2732,7 +2766,7 @@ FLAG DESCRIPTIONS
|
|
|
2732
2766
|
If you specify this parameter, don’t specify --metadata or --sourcepath.
|
|
2733
2767
|
```
|
|
2734
2768
|
|
|
2735
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2769
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/source/deploy.ts)_
|
|
2736
2770
|
|
|
2737
2771
|
## `sf force source deploy cancel`
|
|
2738
2772
|
|
|
@@ -2740,7 +2774,7 @@ Cancel a source deployment.
|
|
|
2740
2774
|
|
|
2741
2775
|
```
|
|
2742
2776
|
USAGE
|
|
2743
|
-
$ sf force source deploy cancel -o <value> [--api-version <value>] [-w <value>] [-i <value>]
|
|
2777
|
+
$ sf force source deploy cancel -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>]
|
|
2744
2778
|
|
|
2745
2779
|
FLAGS
|
|
2746
2780
|
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment if
|
|
@@ -2750,6 +2784,9 @@ FLAGS
|
|
|
2750
2784
|
display results.
|
|
2751
2785
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2752
2786
|
|
|
2787
|
+
GLOBAL FLAGS
|
|
2788
|
+
--json Format output as json.
|
|
2789
|
+
|
|
2753
2790
|
DESCRIPTION
|
|
2754
2791
|
Cancel a source deployment.
|
|
2755
2792
|
|
|
@@ -2774,7 +2811,7 @@ FLAG DESCRIPTIONS
|
|
|
2774
2811
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2775
2812
|
```
|
|
2776
2813
|
|
|
2777
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2814
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/source/deploy/cancel.ts)_
|
|
2778
2815
|
|
|
2779
2816
|
## `sf force source deploy report`
|
|
2780
2817
|
|
|
@@ -2782,8 +2819,8 @@ Check the status of a metadata deployment.
|
|
|
2782
2819
|
|
|
2783
2820
|
```
|
|
2784
2821
|
USAGE
|
|
2785
|
-
$ sf force source deploy report -o <value> [--api-version <value>] [-w <value>] [-i <value>] [--verbose]
|
|
2786
|
-
<value>] [--coverageformatters
|
|
2822
|
+
$ sf force source deploy report -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>] [--verbose]
|
|
2823
|
+
[--resultsdir <value>] [--coverageformatters
|
|
2787
2824
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2788
2825
|
|
|
2789
2826
|
FLAGS
|
|
@@ -2812,6 +2849,9 @@ FLAGS
|
|
|
2812
2849
|
--verbose
|
|
2813
2850
|
Verbose output of deploy result.
|
|
2814
2851
|
|
|
2852
|
+
GLOBAL FLAGS
|
|
2853
|
+
--json Format output as json.
|
|
2854
|
+
|
|
2815
2855
|
DESCRIPTION
|
|
2816
2856
|
Check the status of a metadata deployment.
|
|
2817
2857
|
|
|
@@ -2834,7 +2874,7 @@ FLAG DESCRIPTIONS
|
|
|
2834
2874
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2835
2875
|
```
|
|
2836
2876
|
|
|
2837
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2877
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/source/deploy/report.ts)_
|
|
2838
2878
|
|
|
2839
2879
|
## `sf force source pull`
|
|
2840
2880
|
|
|
@@ -2842,7 +2882,7 @@ Pull changed source from the org to your project to keep them in sync.
|
|
|
2842
2882
|
|
|
2843
2883
|
```
|
|
2844
2884
|
USAGE
|
|
2845
|
-
$ sf force source pull -o <value> [--verbose] [--api-version <value>] [-f] [-w <value>]
|
|
2885
|
+
$ sf force source pull -o <value> [--json] [--verbose] [--api-version <value>] [-f] [-w <value>]
|
|
2846
2886
|
|
|
2847
2887
|
FLAGS
|
|
2848
2888
|
-f, --forceoverwrite Ignore conflict warnings; changes in the org overwrite changes in the project.
|
|
@@ -2852,6 +2892,9 @@ FLAGS
|
|
|
2852
2892
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2853
2893
|
--verbose Display additional details about the command results.
|
|
2854
2894
|
|
|
2895
|
+
GLOBAL FLAGS
|
|
2896
|
+
--json Format output as json.
|
|
2897
|
+
|
|
2855
2898
|
DESCRIPTION
|
|
2856
2899
|
Pull changed source from the org to your project to keep them in sync.
|
|
2857
2900
|
|
|
@@ -2874,7 +2917,7 @@ FLAG DESCRIPTIONS
|
|
|
2874
2917
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2875
2918
|
```
|
|
2876
2919
|
|
|
2877
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2920
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/source/pull.ts)_
|
|
2878
2921
|
|
|
2879
2922
|
## `sf force source push`
|
|
2880
2923
|
|
|
@@ -2882,7 +2925,7 @@ Push changed source from your project to an org to keep them in sync.
|
|
|
2882
2925
|
|
|
2883
2926
|
```
|
|
2884
2927
|
USAGE
|
|
2885
|
-
$ sf force source push -o <value> [--api-version <value>] [-f] [-w <value>] [-g] [--quiet]
|
|
2928
|
+
$ sf force source push -o <value> [--json] [--api-version <value>] [-f] [-w <value>] [-g] [--quiet]
|
|
2886
2929
|
|
|
2887
2930
|
FLAGS
|
|
2888
2931
|
-f, --forceoverwrite Ignore conflict warnings and push source anyway; changes in the project overwrite changes
|
|
@@ -2894,6 +2937,9 @@ FLAGS
|
|
|
2894
2937
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
2895
2938
|
--quiet Minimize JSON and sdtout output on success.
|
|
2896
2939
|
|
|
2940
|
+
GLOBAL FLAGS
|
|
2941
|
+
--json Format output as json.
|
|
2942
|
+
|
|
2897
2943
|
DESCRIPTION
|
|
2898
2944
|
Push changed source from your project to an org to keep them in sync.
|
|
2899
2945
|
|
|
@@ -2916,7 +2962,7 @@ FLAG DESCRIPTIONS
|
|
|
2916
2962
|
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2917
2963
|
```
|
|
2918
2964
|
|
|
2919
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
2965
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/source/push.ts)_
|
|
2920
2966
|
|
|
2921
2967
|
## `sf force source retrieve`
|
|
2922
2968
|
|
|
@@ -2924,8 +2970,8 @@ Retrieve source from an org.
|
|
|
2924
2970
|
|
|
2925
2971
|
```
|
|
2926
2972
|
USAGE
|
|
2927
|
-
$ sf force source retrieve -o <value> [-a <value>] [-r <value> | -n <value> | -p <value>] [-w <value>] [-x
|
|
2928
|
-
<value> | ] [-f -t] [--verbose]
|
|
2973
|
+
$ sf force source retrieve -o <value> [--json] [-a <value>] [-r <value> | -n <value> | -p <value>] [-w <value>] [-x
|
|
2974
|
+
<value> | -m <value> | ] [-f -t] [--verbose]
|
|
2929
2975
|
|
|
2930
2976
|
FLAGS
|
|
2931
2977
|
-a, --api-version=<value> Override the api version used for api requests made by this command
|
|
@@ -2943,6 +2989,9 @@ FLAGS
|
|
|
2943
2989
|
retrieve.
|
|
2944
2990
|
--verbose Verbose output of retrieve result.
|
|
2945
2991
|
|
|
2992
|
+
GLOBAL FLAGS
|
|
2993
|
+
--json Format output as json.
|
|
2994
|
+
|
|
2946
2995
|
DESCRIPTION
|
|
2947
2996
|
Retrieve source from an org.
|
|
2948
2997
|
|
|
@@ -3038,7 +3087,7 @@ FLAG DESCRIPTIONS
|
|
|
3038
3087
|
If you specify this parameter, don’t specify --metadata or --sourcepath.
|
|
3039
3088
|
```
|
|
3040
3089
|
|
|
3041
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
3090
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/source/retrieve.ts)_
|
|
3042
3091
|
|
|
3043
3092
|
## `sf force source status`
|
|
3044
3093
|
|
|
@@ -3046,7 +3095,7 @@ List changes that have been made locally, in an org, or both.
|
|
|
3046
3095
|
|
|
3047
3096
|
```
|
|
3048
3097
|
USAGE
|
|
3049
|
-
$ sf force source status -o <value> [--api-version <value>] [-l | -r] [--concise]
|
|
3098
|
+
$ sf force source status -o <value> [--json] [--api-version <value>] [-l | -r] [--concise]
|
|
3050
3099
|
|
|
3051
3100
|
FLAGS
|
|
3052
3101
|
-l, --local List the changes that have been made locally.
|
|
@@ -3055,6 +3104,9 @@ FLAGS
|
|
|
3055
3104
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
3056
3105
|
--concise Show only the changes that will be pushed or pulled; omits files that are forceignored.
|
|
3057
3106
|
|
|
3107
|
+
GLOBAL FLAGS
|
|
3108
|
+
--json Format output as json.
|
|
3109
|
+
|
|
3058
3110
|
EXAMPLES
|
|
3059
3111
|
List changes that have been made locally but not in the org with alias "myscratch":
|
|
3060
3112
|
|
|
@@ -3065,7 +3117,7 @@ EXAMPLES
|
|
|
3065
3117
|
$ sf force source status --remote
|
|
3066
3118
|
```
|
|
3067
3119
|
|
|
3068
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/
|
|
3120
|
+
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.1/src/commands/force/source/status.ts)_
|
|
3069
3121
|
|
|
3070
3122
|
## `sf force user password generate`
|
|
3071
3123
|
|
|
@@ -3130,7 +3182,7 @@ EXAMPLES
|
|
|
3130
3182
|
user3@my.org
|
|
3131
3183
|
```
|
|
3132
3184
|
|
|
3133
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
3185
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.6/src/commands/force/user/password/generate.ts)_
|
|
3134
3186
|
|
|
3135
3187
|
## `sf help [COMMANDS]`
|
|
3136
3188
|
|
|
@@ -3189,7 +3241,7 @@ EXAMPLES
|
|
|
3189
3241
|
$ sf info releasenotes display --version latest
|
|
3190
3242
|
```
|
|
3191
3243
|
|
|
3192
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0.
|
|
3244
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.0.5/src/commands/info/releasenotes/display.ts)_
|
|
3193
3245
|
|
|
3194
3246
|
## `sf lightning generate app`
|
|
3195
3247
|
|
|
@@ -3242,7 +3294,7 @@ FLAG DESCRIPTIONS
|
|
|
3242
3294
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3243
3295
|
```
|
|
3244
3296
|
|
|
3245
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
3297
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/lightning/generate/app.ts)_
|
|
3246
3298
|
|
|
3247
3299
|
## `sf lightning generate component`
|
|
3248
3300
|
|
|
@@ -3310,7 +3362,7 @@ FLAG DESCRIPTIONS
|
|
|
3310
3362
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3311
3363
|
```
|
|
3312
3364
|
|
|
3313
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
3365
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/lightning/generate/component.ts)_
|
|
3314
3366
|
|
|
3315
3367
|
## `sf lightning generate event`
|
|
3316
3368
|
|
|
@@ -3363,7 +3415,7 @@ FLAG DESCRIPTIONS
|
|
|
3363
3415
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3364
3416
|
```
|
|
3365
3417
|
|
|
3366
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
3418
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/lightning/generate/event.ts)_
|
|
3367
3419
|
|
|
3368
3420
|
## `sf lightning generate interface`
|
|
3369
3421
|
|
|
@@ -3416,7 +3468,7 @@ FLAG DESCRIPTIONS
|
|
|
3416
3468
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3417
3469
|
```
|
|
3418
3470
|
|
|
3419
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
3471
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/lightning/generate/interface.ts)_
|
|
3420
3472
|
|
|
3421
3473
|
## `sf lightning generate test`
|
|
3422
3474
|
|
|
@@ -3469,7 +3521,7 @@ FLAG DESCRIPTIONS
|
|
|
3469
3521
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3470
3522
|
```
|
|
3471
3523
|
|
|
3472
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
3524
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/lightning/generate/test.ts)_
|
|
3473
3525
|
|
|
3474
3526
|
## `sf org assign permset`
|
|
3475
3527
|
|
|
@@ -3512,7 +3564,7 @@ EXAMPLES
|
|
|
3512
3564
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
3513
3565
|
```
|
|
3514
3566
|
|
|
3515
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
3567
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.6/src/commands/org/assign/permset.ts)_
|
|
3516
3568
|
|
|
3517
3569
|
## `sf org assign permsetlicense`
|
|
3518
3570
|
|
|
@@ -3556,7 +3608,7 @@ EXAMPLES
|
|
|
3556
3608
|
user3
|
|
3557
3609
|
```
|
|
3558
3610
|
|
|
3559
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
3611
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.6/src/commands/org/assign/permsetlicense.ts)_
|
|
3560
3612
|
|
|
3561
3613
|
## `sf org create sandbox`
|
|
3562
3614
|
|
|
@@ -3661,7 +3713,7 @@ FLAG DESCRIPTIONS
|
|
|
3661
3713
|
sandbox.
|
|
3662
3714
|
```
|
|
3663
3715
|
|
|
3664
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
3716
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/create/sandbox.ts)_
|
|
3665
3717
|
|
|
3666
3718
|
## `sf org create scratch`
|
|
3667
3719
|
|
|
@@ -3814,7 +3866,7 @@ FLAG DESCRIPTIONS
|
|
|
3814
3866
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
3815
3867
|
```
|
|
3816
3868
|
|
|
3817
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
3869
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/create/scratch.ts)_
|
|
3818
3870
|
|
|
3819
3871
|
## `sf org create user`
|
|
3820
3872
|
|
|
@@ -3912,7 +3964,7 @@ FLAG DESCRIPTIONS
|
|
|
3912
3964
|
might be different than what you specify in the definition file.
|
|
3913
3965
|
```
|
|
3914
3966
|
|
|
3915
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
3967
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.6/src/commands/org/create/user.ts)_
|
|
3916
3968
|
|
|
3917
3969
|
## `sf org delete sandbox`
|
|
3918
3970
|
|
|
@@ -3956,7 +4008,7 @@ EXAMPLES
|
|
|
3956
4008
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
3957
4009
|
```
|
|
3958
4010
|
|
|
3959
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4011
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/delete/sandbox.ts)_
|
|
3960
4012
|
|
|
3961
4013
|
## `sf org delete scratch`
|
|
3962
4014
|
|
|
@@ -3998,7 +4050,7 @@ EXAMPLES
|
|
|
3998
4050
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
3999
4051
|
```
|
|
4000
4052
|
|
|
4001
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4053
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/delete/scratch.ts)_
|
|
4002
4054
|
|
|
4003
4055
|
## `sf org disable tracking`
|
|
4004
4056
|
|
|
@@ -4009,7 +4061,8 @@ USAGE
|
|
|
4009
4061
|
$ sf org disable tracking -o <value> [--json]
|
|
4010
4062
|
|
|
4011
4063
|
FLAGS
|
|
4012
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4064
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4065
|
+
configuration variable is already set.
|
|
4013
4066
|
|
|
4014
4067
|
GLOBAL FLAGS
|
|
4015
4068
|
--json Format output as json.
|
|
@@ -4035,7 +4088,7 @@ EXAMPLES
|
|
|
4035
4088
|
$ sf org disable tracking
|
|
4036
4089
|
```
|
|
4037
4090
|
|
|
4038
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4091
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/disable/tracking.ts)_
|
|
4039
4092
|
|
|
4040
4093
|
## `sf org display`
|
|
4041
4094
|
|
|
@@ -4046,7 +4099,8 @@ USAGE
|
|
|
4046
4099
|
$ sf org display -o <value> [--json] [--api-version <value>] [--verbose]
|
|
4047
4100
|
|
|
4048
4101
|
FLAGS
|
|
4049
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4102
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4103
|
+
configuration variable is already set.
|
|
4050
4104
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4051
4105
|
--verbose Display the sfdxAuthUrl property.
|
|
4052
4106
|
|
|
@@ -4078,7 +4132,7 @@ EXAMPLES
|
|
|
4078
4132
|
$ sf org display --target-org TestOrg1 --verbose
|
|
4079
4133
|
```
|
|
4080
4134
|
|
|
4081
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4135
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/display.ts)_
|
|
4082
4136
|
|
|
4083
4137
|
## `sf org display user`
|
|
4084
4138
|
|
|
@@ -4115,7 +4169,7 @@ EXAMPLES
|
|
|
4115
4169
|
$ sf org display user --target-org me@my.org --json
|
|
4116
4170
|
```
|
|
4117
4171
|
|
|
4118
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
4172
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.6/src/commands/org/display/user.ts)_
|
|
4119
4173
|
|
|
4120
4174
|
## `sf org enable tracking`
|
|
4121
4175
|
|
|
@@ -4126,7 +4180,8 @@ USAGE
|
|
|
4126
4180
|
$ sf org enable tracking -o <value> [--json]
|
|
4127
4181
|
|
|
4128
4182
|
FLAGS
|
|
4129
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4183
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4184
|
+
configuration variable is already set.
|
|
4130
4185
|
|
|
4131
4186
|
GLOBAL FLAGS
|
|
4132
4187
|
--json Format output as json.
|
|
@@ -4155,7 +4210,7 @@ EXAMPLES
|
|
|
4155
4210
|
$ sf org enable tracking
|
|
4156
4211
|
```
|
|
4157
4212
|
|
|
4158
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4213
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/enable/tracking.ts)_
|
|
4159
4214
|
|
|
4160
4215
|
## `sf org generate password`
|
|
4161
4216
|
|
|
@@ -4219,7 +4274,7 @@ EXAMPLES
|
|
|
4219
4274
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
4220
4275
|
```
|
|
4221
4276
|
|
|
4222
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
4277
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.6/src/commands/org/generate/password.ts)_
|
|
4223
4278
|
|
|
4224
4279
|
## `sf org list`
|
|
4225
4280
|
|
|
@@ -4257,7 +4312,7 @@ EXAMPLES
|
|
|
4257
4312
|
$ sf org list --clean
|
|
4258
4313
|
```
|
|
4259
4314
|
|
|
4260
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4315
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/list.ts)_
|
|
4261
4316
|
|
|
4262
4317
|
## `sf org list auth`
|
|
4263
4318
|
|
|
@@ -4299,7 +4354,8 @@ USAGE
|
|
|
4299
4354
|
$ sf org list limits -o <value> [--json] [--api-version <value>]
|
|
4300
4355
|
|
|
4301
4356
|
FLAGS
|
|
4302
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4357
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4358
|
+
configuration variable is already set.
|
|
4303
4359
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4304
4360
|
|
|
4305
4361
|
GLOBAL FLAGS
|
|
@@ -4326,7 +4382,7 @@ EXAMPLES
|
|
|
4326
4382
|
$ sf org list limits --target-org my-scratch-org
|
|
4327
4383
|
```
|
|
4328
4384
|
|
|
4329
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0.
|
|
4385
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0.4/src/commands/org/list/limits.ts)_
|
|
4330
4386
|
|
|
4331
4387
|
## `sf org list metadata`
|
|
4332
4388
|
|
|
@@ -4340,7 +4396,8 @@ FLAGS
|
|
|
4340
4396
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
4341
4397
|
-m, --metadata-type=<value> (required) Metadata type to be retrieved, such as CustomObject; metadata type names are
|
|
4342
4398
|
case-sensitive.
|
|
4343
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4399
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4400
|
+
configuration variable is already set.
|
|
4344
4401
|
--api-version=<value> API version to use; default is the most recent API version.
|
|
4345
4402
|
--folder=<value> Folder associated with the component; required for components that use folders; folder
|
|
4346
4403
|
names are case-sensitive.
|
|
@@ -4390,7 +4447,7 @@ FLAG DESCRIPTIONS
|
|
|
4390
4447
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
4391
4448
|
```
|
|
4392
4449
|
|
|
4393
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4450
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/list/metadata.ts)_
|
|
4394
4451
|
|
|
4395
4452
|
## `sf org list metadata-types`
|
|
4396
4453
|
|
|
@@ -4402,7 +4459,8 @@ USAGE
|
|
|
4402
4459
|
|
|
4403
4460
|
FLAGS
|
|
4404
4461
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
4405
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4462
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4463
|
+
configuration variable is already set.
|
|
4406
4464
|
--api-version=<value> API version to use; default is the most recent API version.
|
|
4407
4465
|
|
|
4408
4466
|
GLOBAL FLAGS
|
|
@@ -4443,7 +4501,7 @@ FLAG DESCRIPTIONS
|
|
|
4443
4501
|
Override the api version used for api requests made by this command
|
|
4444
4502
|
```
|
|
4445
4503
|
|
|
4446
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
4504
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/list/metadata-types.ts)_
|
|
4447
4505
|
|
|
4448
4506
|
## `sf org list sobject record-counts`
|
|
4449
4507
|
|
|
@@ -4454,7 +4512,8 @@ USAGE
|
|
|
4454
4512
|
$ sf org list sobject record-counts -o <value> [--json] [-s <value>] [--api-version <value>]
|
|
4455
4513
|
|
|
4456
4514
|
FLAGS
|
|
4457
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4515
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
4516
|
+
configuration variable is already set.
|
|
4458
4517
|
-s, --sobject=<value>... [default: ] API name of the standard or custom object for which to display record counts.
|
|
4459
4518
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
4460
4519
|
|
|
@@ -4487,7 +4546,7 @@ EXAMPLES
|
|
|
4487
4546
|
$ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
|
|
4488
4547
|
```
|
|
4489
4548
|
|
|
4490
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0.
|
|
4549
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0.4/src/commands/org/list/sobject/record-counts.ts)_
|
|
4491
4550
|
|
|
4492
4551
|
## `sf org list users`
|
|
4493
4552
|
|
|
@@ -4523,7 +4582,7 @@ EXAMPLES
|
|
|
4523
4582
|
$ sf org list users --target-org me@my.org
|
|
4524
4583
|
```
|
|
4525
4584
|
|
|
4526
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.
|
|
4585
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.0.6/src/commands/org/list/users.ts)_
|
|
4527
4586
|
|
|
4528
4587
|
## `sf org login access-token`
|
|
4529
4588
|
|
|
@@ -4942,7 +5001,8 @@ FLAGS
|
|
|
4942
5001
|
-b, --browser=<option> Browser where the org opens.
|
|
4943
5002
|
<options: chrome|edge|firefox>
|
|
4944
5003
|
-f, --source-file=<value> Path to an ApexPage or FlexiPage to open in Lightning App Builder.
|
|
4945
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
5004
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
5005
|
+
configuration variable is already set.
|
|
4946
5006
|
-p, --path=<value> Navigation URL path to open a specific page.
|
|
4947
5007
|
-r, --url-only Display navigation URL, but don’t launch browser.
|
|
4948
5008
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
@@ -4992,7 +5052,7 @@ EXAMPLES
|
|
|
4992
5052
|
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
4993
5053
|
```
|
|
4994
5054
|
|
|
4995
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
5055
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/open.ts)_
|
|
4996
5056
|
|
|
4997
5057
|
## `sf org resume sandbox`
|
|
4998
5058
|
|
|
@@ -5054,7 +5114,7 @@ FLAG DESCRIPTIONS
|
|
|
5054
5114
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
5055
5115
|
```
|
|
5056
5116
|
|
|
5057
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
5117
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/resume/sandbox.ts)_
|
|
5058
5118
|
|
|
5059
5119
|
## `sf org resume scratch`
|
|
5060
5120
|
|
|
@@ -5100,7 +5160,7 @@ FLAG DESCRIPTIONS
|
|
|
5100
5160
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
5101
5161
|
```
|
|
5102
5162
|
|
|
5103
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
5163
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.0.9/src/commands/org/resume/scratch.ts)_
|
|
5104
5164
|
|
|
5105
5165
|
## `sf package1 version create`
|
|
5106
5166
|
|
|
@@ -6247,7 +6307,7 @@ EXAMPLES
|
|
|
6247
6307
|
$ sf plugins discover
|
|
6248
6308
|
```
|
|
6249
6309
|
|
|
6250
|
-
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-template-sf/blob/1.0.
|
|
6310
|
+
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-template-sf/blob/1.0.7/src/commands/plugins/discover.ts)_
|
|
6251
6311
|
|
|
6252
6312
|
## `sf plugins:inspect PLUGIN...`
|
|
6253
6313
|
|
|
@@ -6387,7 +6447,7 @@ EXAMPLES
|
|
|
6387
6447
|
$ sf plugins trust verify --npm @scope/npmName
|
|
6388
6448
|
```
|
|
6389
6449
|
|
|
6390
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.0.
|
|
6450
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.0.6/src/commands/plugins/trust/verify.ts)_
|
|
6391
6451
|
|
|
6392
6452
|
## `sf plugins:uninstall PLUGIN...`
|
|
6393
6453
|
|
|
@@ -7689,7 +7749,7 @@ FLAG DESCRIPTIONS
|
|
|
7689
7749
|
Override the api version used for api requests made by this command
|
|
7690
7750
|
```
|
|
7691
7751
|
|
|
7692
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
7752
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/project/generate.ts)_
|
|
7693
7753
|
|
|
7694
7754
|
## `sf project generate manifest`
|
|
7695
7755
|
|
|
@@ -8269,7 +8329,8 @@ USAGE
|
|
|
8269
8329
|
$ sf sobject describe -o <value> -s <value> [--json] [--api-version <value>] [-t]
|
|
8270
8330
|
|
|
8271
8331
|
FLAGS
|
|
8272
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
8332
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
8333
|
+
configuration variable is already set.
|
|
8273
8334
|
-s, --sobject=<value> (required) API name of the object to describe.
|
|
8274
8335
|
-t, --use-tooling-api Use Tooling API to display metadata for Tooling API objects.
|
|
8275
8336
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
@@ -8303,7 +8364,7 @@ EXAMPLES
|
|
|
8303
8364
|
$ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
|
|
8304
8365
|
```
|
|
8305
8366
|
|
|
8306
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0.
|
|
8367
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0.6/src/commands/sobject/describe.ts)_
|
|
8307
8368
|
|
|
8308
8369
|
## `sf sobject list`
|
|
8309
8370
|
|
|
@@ -8314,7 +8375,8 @@ USAGE
|
|
|
8314
8375
|
$ sf sobject list -o <value> [--json] [--api-version <value>] [-s <value>]
|
|
8315
8376
|
|
|
8316
8377
|
FLAGS
|
|
8317
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
8378
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
8379
|
+
configuration variable is already set.
|
|
8318
8380
|
-s, --sobject=<value> [default: ALL] Category of objects to list.
|
|
8319
8381
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
8320
8382
|
|
|
@@ -8340,7 +8402,7 @@ EXAMPLES
|
|
|
8340
8402
|
$ sf sobject list --sobject custom --target-org my-scratch-org
|
|
8341
8403
|
```
|
|
8342
8404
|
|
|
8343
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0.
|
|
8405
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0.6/src/commands/sobject/list.ts)_
|
|
8344
8406
|
|
|
8345
8407
|
## `sf static-resource generate`
|
|
8346
8408
|
|
|
@@ -8400,7 +8462,7 @@ FLAG DESCRIPTIONS
|
|
|
8400
8462
|
etc.
|
|
8401
8463
|
```
|
|
8402
8464
|
|
|
8403
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
8465
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/static-resource/generate.ts)_
|
|
8404
8466
|
|
|
8405
8467
|
## `sf update [CHANNEL]`
|
|
8406
8468
|
|
|
@@ -8437,7 +8499,7 @@ EXAMPLES
|
|
|
8437
8499
|
$ sf update --available
|
|
8438
8500
|
```
|
|
8439
8501
|
|
|
8440
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.1.
|
|
8502
|
+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.1.4/src/commands/update.ts)_
|
|
8441
8503
|
|
|
8442
8504
|
## `sf version`
|
|
8443
8505
|
|
|
@@ -8457,7 +8519,7 @@ FLAG DESCRIPTIONS
|
|
|
8457
8519
|
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
|
|
8458
8520
|
```
|
|
8459
8521
|
|
|
8460
|
-
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.0.
|
|
8522
|
+
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.0.8/src/commands/version.ts)_
|
|
8461
8523
|
|
|
8462
8524
|
## `sf visualforce generate component`
|
|
8463
8525
|
|
|
@@ -8512,7 +8574,7 @@ FLAG DESCRIPTIONS
|
|
|
8512
8574
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
8513
8575
|
```
|
|
8514
8576
|
|
|
8515
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
8577
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/visualforce/generate/component.ts)_
|
|
8516
8578
|
|
|
8517
8579
|
## `sf visualforce generate page`
|
|
8518
8580
|
|
|
@@ -8560,7 +8622,7 @@ FLAG DESCRIPTIONS
|
|
|
8560
8622
|
The name can be up to 40 characters and must start with a letter.
|
|
8561
8623
|
```
|
|
8562
8624
|
|
|
8563
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.
|
|
8625
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.0.3/src/commands/visualforce/generate/page.ts)_
|
|
8564
8626
|
|
|
8565
8627
|
## `sf which`
|
|
8566
8628
|
|
|
@@ -8579,6 +8641,6 @@ EXAMPLES
|
|
|
8579
8641
|
$ sf which help
|
|
8580
8642
|
```
|
|
8581
8643
|
|
|
8582
|
-
_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.0.
|
|
8644
|
+
_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.0.11/src/commands/which.ts)_
|
|
8583
8645
|
|
|
8584
8646
|
<!-- commandsstop -->
|