@salesforce/cli 2.18.4 → 2.18.6
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 +336 -331
- package/npm-shrinkwrap.json +23 -23
- package/oclif.manifest.json +1 -1
- package/package.json +6 -6
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.18.
|
|
27
|
+
@salesforce/cli/2.18.6 linux-x64 node-v20.9.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -291,9 +291,9 @@ USAGE
|
|
|
291
291
|
$ sf analytics generate template -n <value> [--json] [-d <value>] [--api-version <value>]
|
|
292
292
|
|
|
293
293
|
FLAGS
|
|
294
|
-
-d, --output-dir=<value>
|
|
295
|
-
-n, --name=<value>
|
|
296
|
-
|
|
294
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
295
|
+
-n, --name=<value> (required) Name of the Analytics template.
|
|
296
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
297
297
|
|
|
298
298
|
GLOBAL FLAGS
|
|
299
299
|
--json Format output as json.
|
|
@@ -333,11 +333,11 @@ USAGE
|
|
|
333
333
|
<value>] [--api-version <value>]
|
|
334
334
|
|
|
335
335
|
FLAGS
|
|
336
|
-
-d, --output-dir=<value>
|
|
337
|
-
-n, --name=<value>
|
|
338
|
-
-t, --template=<option>
|
|
339
|
-
|
|
340
|
-
|
|
336
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
337
|
+
-n, --name=<value> (required) Name of the generated Apex class.
|
|
338
|
+
-t, --template=<option> [default: DefaultApexClass] Template to use for file creation.
|
|
339
|
+
<options: ApexException|ApexUnitTest|DefaultApexClass|InboundEmailService>
|
|
340
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
341
341
|
|
|
342
342
|
GLOBAL FLAGS
|
|
343
343
|
--json Format output as json.
|
|
@@ -389,15 +389,15 @@ USAGE
|
|
|
389
389
|
before insert|before update|before delete|after insert|after update|after delete|after undelete]
|
|
390
390
|
|
|
391
391
|
FLAGS
|
|
392
|
-
-d, --output-dir=<value>
|
|
393
|
-
-e, --event=<option>...
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
-n, --name=<value>
|
|
397
|
-
-s, --sobject=<value>
|
|
398
|
-
-t, --template=<option>
|
|
399
|
-
|
|
400
|
-
|
|
392
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
393
|
+
-e, --event=<option>... [default: before insert] Events that fire the trigger.
|
|
394
|
+
<options: before insert|before update|before delete|after insert|after update|after
|
|
395
|
+
delete|after undelete>
|
|
396
|
+
-n, --name=<value> (required) Name of the generated Apex trigger
|
|
397
|
+
-s, --sobject=<value> [default: SOBJECT] Salesforce object to generate a trigger on.
|
|
398
|
+
-t, --template=<option> [default: ApexTrigger] Template to use for file creation.
|
|
399
|
+
<options: ApexTrigger>
|
|
400
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
401
401
|
|
|
402
402
|
GLOBAL FLAGS
|
|
403
403
|
--json Format output as json.
|
|
@@ -455,11 +455,11 @@ USAGE
|
|
|
455
455
|
$ sf apex get log -o <value> [--json] [--api-version <value>] [-i <value>] [-n <value>] [-d <value>]
|
|
456
456
|
|
|
457
457
|
FLAGS
|
|
458
|
-
-d, --output-dir=<value>
|
|
459
|
-
-i, --log-id=<value>
|
|
460
|
-
-n, --number=<value>
|
|
461
|
-
-o, --target-org=<value>
|
|
462
|
-
|
|
458
|
+
-d, --output-dir=<value> Directory for saving the log files.
|
|
459
|
+
-i, --log-id=<value> ID of the specific log to display.
|
|
460
|
+
-n, --number=<value> Number of the most recent logs to display.
|
|
461
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
462
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
463
463
|
|
|
464
464
|
GLOBAL FLAGS
|
|
465
465
|
--json Format output as json.
|
|
@@ -515,7 +515,7 @@ FLAGS
|
|
|
515
515
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
516
516
|
-r, --result-format=<option> [default: human] Format of the results.
|
|
517
517
|
<options: human|tap|junit|json>
|
|
518
|
-
|
|
518
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
519
519
|
|
|
520
520
|
GLOBAL FLAGS
|
|
521
521
|
--json Format output as json.
|
|
@@ -560,8 +560,8 @@ USAGE
|
|
|
560
560
|
$ sf apex list log -o <value> [--json] [--api-version <value>]
|
|
561
561
|
|
|
562
562
|
FLAGS
|
|
563
|
-
-o, --target-org=<value>
|
|
564
|
-
|
|
563
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
564
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
565
565
|
|
|
566
566
|
GLOBAL FLAGS
|
|
567
567
|
--json Format output as json.
|
|
@@ -598,9 +598,9 @@ USAGE
|
|
|
598
598
|
$ sf apex run -o <value> [--json] [--api-version <value>] [-f <value>]
|
|
599
599
|
|
|
600
600
|
FLAGS
|
|
601
|
-
-f, --file=<value>
|
|
602
|
-
-o, --target-org=<value>
|
|
603
|
-
|
|
601
|
+
-f, --file=<value> Path to a local file that contains Apex code.
|
|
602
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
603
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
604
604
|
|
|
605
605
|
GLOBAL FLAGS
|
|
606
606
|
--json Format output as json.
|
|
@@ -661,7 +661,7 @@ FLAGS
|
|
|
661
661
|
timeouts occur frequently.
|
|
662
662
|
-y, --synchronous Runs test methods from a single Apex class synchronously; if not specified, tests are
|
|
663
663
|
run asynchronously.
|
|
664
|
-
|
|
664
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
665
665
|
|
|
666
666
|
GLOBAL FLAGS
|
|
667
667
|
--json Format output as json.
|
|
@@ -753,7 +753,7 @@ FLAGS
|
|
|
753
753
|
-d, --debug-level=<value> Debug level to set on the DEVELOPER_LOG trace flag for your user.
|
|
754
754
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
755
755
|
-s, --skip-trace-flag Skip trace flag setup. Assumes that a trace flag and debug level are fully set up.
|
|
756
|
-
|
|
756
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
757
757
|
|
|
758
758
|
GLOBAL FLAGS
|
|
759
759
|
--json Format output as json.
|
|
@@ -823,18 +823,18 @@ USAGE
|
|
|
823
823
|
[--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>]
|
|
824
824
|
|
|
825
825
|
FLAGS
|
|
826
|
-
-h, --help
|
|
827
|
-
-x, --extended
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
826
|
+
-h, --help Show CLI help.
|
|
827
|
+
-x, --extended show extra columns
|
|
828
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
829
|
+
--csv output is csv format [alias: --output=csv]
|
|
830
|
+
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
831
|
+
--hidden show hidden commands
|
|
832
|
+
--no-header hide table header from output
|
|
833
|
+
--no-truncate do not truncate output to fit screen
|
|
834
|
+
--output=<option> output in a more machine friendly format
|
|
835
|
+
<options: csv|json|yaml>
|
|
836
|
+
--sort=<value> property to sort by (prepend '-' for descending)
|
|
837
|
+
--tree show tree of commands
|
|
838
838
|
|
|
839
839
|
GLOBAL FLAGS
|
|
840
840
|
--json Format output as json.
|
|
@@ -1055,13 +1055,13 @@ USAGE
|
|
|
1055
1055
|
$ sf data create record -o <value> -s <value> -v <value> [--json] [--api-version <value>] [-t]
|
|
1056
1056
|
|
|
1057
1057
|
FLAGS
|
|
1058
|
-
-o, --target-org=<value>
|
|
1059
|
-
-s, --sobject=<value>
|
|
1060
|
-
|
|
1061
|
-
-t, --use-tooling-api
|
|
1062
|
-
-v, --values=<value>
|
|
1063
|
-
|
|
1064
|
-
|
|
1058
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1059
|
+
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're inserting a record
|
|
1060
|
+
into.
|
|
1061
|
+
-t, --use-tooling-api Use Tooling API so you can insert a record in a Tooling API object.
|
|
1062
|
+
-v, --values=<value> (required) Values for the flags in the form <fieldName>=<value>, separate multiple pairs
|
|
1063
|
+
with spaces.
|
|
1064
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1065
1065
|
|
|
1066
1066
|
GLOBAL FLAGS
|
|
1067
1067
|
--json Format output as json.
|
|
@@ -1109,15 +1109,15 @@ USAGE
|
|
|
1109
1109
|
$ sf data delete bulk -o <value> -f <value> -s <value> [--json] [--api-version <value>] [-w <value> | -a] [--verbose]
|
|
1110
1110
|
|
|
1111
1111
|
FLAGS
|
|
1112
|
-
-a, --async
|
|
1113
|
-
-f, --file=<value>
|
|
1114
|
-
-o, --target-org=<value>
|
|
1115
|
-
-s, --sobject=<value>
|
|
1116
|
-
|
|
1117
|
-
-w, --wait=<value>
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1112
|
+
-a, --async Run the command asynchronously.
|
|
1113
|
+
-f, --file=<value> (required) CSV file that contains the IDs of the records to update or delete.
|
|
1114
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1115
|
+
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1116
|
+
update or delete records from.
|
|
1117
|
+
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete before
|
|
1118
|
+
displaying the results.
|
|
1119
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1120
|
+
--verbose Print verbose output of failed records if result is available.
|
|
1121
1121
|
|
|
1122
1122
|
GLOBAL FLAGS
|
|
1123
1123
|
--json Format output as json.
|
|
@@ -1153,13 +1153,13 @@ USAGE
|
|
|
1153
1153
|
$ sf data delete record -o <value> -s <value> [--json] [--api-version <value>] [-i <value>] [-w <value>] [-t]
|
|
1154
1154
|
|
|
1155
1155
|
FLAGS
|
|
1156
|
-
-i, --record-id=<value>
|
|
1157
|
-
-o, --target-org=<value>
|
|
1158
|
-
-s, --sobject=<value>
|
|
1159
|
-
|
|
1160
|
-
-t, --use-tooling-api
|
|
1161
|
-
-w, --where=<value>
|
|
1162
|
-
|
|
1156
|
+
-i, --record-id=<value> ID of the record you’re deleting.
|
|
1157
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1158
|
+
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're deleting a record
|
|
1159
|
+
from.
|
|
1160
|
+
-t, --use-tooling-api Use Tooling API so you can delete a record from a Tooling API object.
|
|
1161
|
+
-w, --where=<value> List of <fieldName>=<value> pairs that identify the record you want to delete.
|
|
1162
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1163
1163
|
|
|
1164
1164
|
GLOBAL FLAGS
|
|
1165
1165
|
--json Format output as json.
|
|
@@ -1212,12 +1212,12 @@ USAGE
|
|
|
1212
1212
|
<value>]
|
|
1213
1213
|
|
|
1214
1214
|
FLAGS
|
|
1215
|
-
-i, --job-id=<value>
|
|
1216
|
-
-o, --target-org=<value>
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1215
|
+
-i, --job-id=<value> ID of the job you want to resume.
|
|
1216
|
+
-o, --target-org=<value> Org alias or username to use for the target org.
|
|
1217
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1218
|
+
--use-most-recent Use the ID of the most recently-run bulk job.
|
|
1219
|
+
--wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete before
|
|
1220
|
+
displaying the results.
|
|
1221
1221
|
|
|
1222
1222
|
GLOBAL FLAGS
|
|
1223
1223
|
--json Format output as json.
|
|
@@ -1248,12 +1248,12 @@ USAGE
|
|
|
1248
1248
|
$ sf data export tree -o <value> -q <value> [--json] [--api-version <value>] [-p] [-x <value>] [-d <value>]
|
|
1249
1249
|
|
|
1250
1250
|
FLAGS
|
|
1251
|
-
-d, --output-dir=<value>
|
|
1252
|
-
-o, --target-org=<value>
|
|
1253
|
-
-p, --plan
|
|
1254
|
-
-q, --query=<value>
|
|
1255
|
-
-x, --prefix=<value>
|
|
1256
|
-
|
|
1251
|
+
-d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
|
|
1252
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1253
|
+
-p, --plan Generate multiple sObject tree files and a plan definition file for aggregated import.
|
|
1254
|
+
-q, --query=<value> (required) SOQL query, or filepath of a file that contains the query, to retrieve records.
|
|
1255
|
+
-x, --prefix=<value> Prefix of generated files.
|
|
1256
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1257
1257
|
|
|
1258
1258
|
GLOBAL FLAGS
|
|
1259
1259
|
--json Format output as json.
|
|
@@ -1305,13 +1305,13 @@ USAGE
|
|
|
1305
1305
|
$ sf data get record -o <value> -s <value> [--json] [--api-version <value>] [-i <value>] [-w <value>] [-t]
|
|
1306
1306
|
|
|
1307
1307
|
FLAGS
|
|
1308
|
-
-i, --record-id=<value>
|
|
1309
|
-
-o, --target-org=<value>
|
|
1310
|
-
-s, --sobject=<value>
|
|
1311
|
-
|
|
1312
|
-
-t, --use-tooling-api
|
|
1313
|
-
-w, --where=<value>
|
|
1314
|
-
|
|
1308
|
+
-i, --record-id=<value> ID of the record you’re retrieving.
|
|
1309
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1310
|
+
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're retrieving a record
|
|
1311
|
+
from.
|
|
1312
|
+
-t, --use-tooling-api Use Tooling API so you can retrieve a record from a Tooling API object.
|
|
1313
|
+
-w, --where=<value> List of <fieldName>=<value> pairs that identify the record you want to display.
|
|
1314
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1315
1315
|
|
|
1316
1316
|
GLOBAL FLAGS
|
|
1317
1317
|
--json Format output as json.
|
|
@@ -1366,13 +1366,13 @@ USAGE
|
|
|
1366
1366
|
$ sf data import tree -o <value> [--json] [--api-version <value>] [-f <value> | -p <value>] [--config-help]
|
|
1367
1367
|
|
|
1368
1368
|
FLAGS
|
|
1369
|
-
-f, --files=<value>...
|
|
1370
|
-
|
|
1371
|
-
-o, --target-org=<value>
|
|
1372
|
-
-p, --plan=<value>
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1369
|
+
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
1370
|
+
that you want to insert.
|
|
1371
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1372
|
+
-p, --plan=<value> Plan definition file to insert multiple data files.
|
|
1373
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1374
|
+
--config-help Display schema information for the --plan configuration file to stdout; if you specify this
|
|
1375
|
+
flag, all other flags except --json are ignored.
|
|
1376
1376
|
|
|
1377
1377
|
GLOBAL FLAGS
|
|
1378
1378
|
--json Format output as json.
|
|
@@ -1425,9 +1425,9 @@ FLAGS
|
|
|
1425
1425
|
<options: human|json|csv>
|
|
1426
1426
|
-t, --use-tooling-api Use Tooling API so you can run queries on Tooling API objects.
|
|
1427
1427
|
-w, --wait=<value> Time to wait for the command to finish, in minutes.
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1428
|
+
--all-rows Include deleted records. By default, deleted records are not returned.
|
|
1429
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1430
|
+
--async Use Bulk API 2.0, but don't wait for the job to complete.
|
|
1431
1431
|
|
|
1432
1432
|
GLOBAL FLAGS
|
|
1433
1433
|
--json Format output as json.
|
|
@@ -1483,8 +1483,8 @@ FLAGS
|
|
|
1483
1483
|
-o, --target-org=<value> Org alias or username to use for the target org.
|
|
1484
1484
|
-r, --result-format=<option> [default: human] Format to display the results; the --json flag overrides this flag.
|
|
1485
1485
|
<options: human|json|csv>
|
|
1486
|
-
|
|
1487
|
-
|
|
1486
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1487
|
+
--use-most-recent Use the most recent bulk query ID from cache.
|
|
1488
1488
|
|
|
1489
1489
|
GLOBAL FLAGS
|
|
1490
1490
|
--json Format output as json.
|
|
@@ -1514,10 +1514,10 @@ USAGE
|
|
|
1514
1514
|
$ sf data resume -o <value> -i <value> [--json] [--api-version <value>] [-b <value>]
|
|
1515
1515
|
|
|
1516
1516
|
FLAGS
|
|
1517
|
-
-b, --batch-id=<value>
|
|
1518
|
-
-i, --job-id=<value>
|
|
1519
|
-
-o, --target-org=<value>
|
|
1520
|
-
|
|
1517
|
+
-b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
|
|
1518
|
+
-i, --job-id=<value> (required) ID of the job whose status you want to view.
|
|
1519
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1520
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1521
1521
|
|
|
1522
1522
|
GLOBAL FLAGS
|
|
1523
1523
|
--json Format output as json.
|
|
@@ -1550,14 +1550,14 @@ USAGE
|
|
|
1550
1550
|
[-t]
|
|
1551
1551
|
|
|
1552
1552
|
FLAGS
|
|
1553
|
-
-i, --record-id=<value>
|
|
1554
|
-
-o, --target-org=<value>
|
|
1555
|
-
-s, --sobject=<value>
|
|
1556
|
-
|
|
1557
|
-
-t, --use-tooling-api
|
|
1558
|
-
-v, --values=<value>
|
|
1559
|
-
-w, --where=<value>
|
|
1560
|
-
|
|
1553
|
+
-i, --record-id=<value> ID of the record you’re updating.
|
|
1554
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1555
|
+
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that contains the record you're
|
|
1556
|
+
updating.
|
|
1557
|
+
-t, --use-tooling-api Use Tooling API so you can update a record in a Tooling API object.
|
|
1558
|
+
-v, --values=<value> (required) Fields that you're updating, in the format of <fieldName>=<value> pairs.
|
|
1559
|
+
-w, --where=<value> List of <fieldName>=<value> pairs that identify the record you want to update.
|
|
1560
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1561
1561
|
|
|
1562
1562
|
GLOBAL FLAGS
|
|
1563
1563
|
--json Format output as json.
|
|
@@ -1618,8 +1618,8 @@ FLAGS
|
|
|
1618
1618
|
update or delete records from.
|
|
1619
1619
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete before
|
|
1620
1620
|
displaying the results.
|
|
1621
|
-
|
|
1622
|
-
|
|
1621
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1622
|
+
--verbose Print verbose output of failed records if result is available.
|
|
1623
1623
|
|
|
1624
1624
|
GLOBAL FLAGS
|
|
1625
1625
|
--json Format output as json.
|
|
@@ -1661,12 +1661,12 @@ USAGE
|
|
|
1661
1661
|
<value>]
|
|
1662
1662
|
|
|
1663
1663
|
FLAGS
|
|
1664
|
-
-i, --job-id=<value>
|
|
1665
|
-
-o, --target-org=<value>
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
|
|
1669
|
-
|
|
1664
|
+
-i, --job-id=<value> ID of the job you want to resume.
|
|
1665
|
+
-o, --target-org=<value> Org alias or username to use for the target org.
|
|
1666
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1667
|
+
--use-most-recent Use the ID of the most recently-run bulk job.
|
|
1668
|
+
--wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete before
|
|
1669
|
+
displaying the results.
|
|
1670
1670
|
|
|
1671
1671
|
GLOBAL FLAGS
|
|
1672
1672
|
--json Format output as json.
|
|
@@ -1744,13 +1744,13 @@ USAGE
|
|
|
1744
1744
|
$ sf force data bulk delete -o <value> -f <value> -s <value> [--json] [--api-version <value>] [-w <value>]
|
|
1745
1745
|
|
|
1746
1746
|
FLAGS
|
|
1747
|
-
-f, --file=<value>
|
|
1748
|
-
-o, --target-org=<value>
|
|
1749
|
-
-s, --sobject=<value>
|
|
1750
|
-
|
|
1751
|
-
-w, --wait=<value>
|
|
1752
|
-
|
|
1753
|
-
|
|
1747
|
+
-f, --file=<value> (required) CSV file that contains the IDs of the records to delete.
|
|
1748
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1749
|
+
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1750
|
+
delete records from.
|
|
1751
|
+
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete before
|
|
1752
|
+
displaying the results.
|
|
1753
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1754
1754
|
|
|
1755
1755
|
GLOBAL FLAGS
|
|
1756
1756
|
--json Format output as json.
|
|
@@ -1788,10 +1788,10 @@ USAGE
|
|
|
1788
1788
|
$ sf force data bulk status -o <value> -i <value> [--json] [--api-version <value>] [-b <value>]
|
|
1789
1789
|
|
|
1790
1790
|
FLAGS
|
|
1791
|
-
-b, --batch-id=<value>
|
|
1792
|
-
-i, --job-id=<value>
|
|
1793
|
-
-o, --target-org=<value>
|
|
1794
|
-
|
|
1791
|
+
-b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
|
|
1792
|
+
-i, --job-id=<value> (required) ID of the job whose status you want to view.
|
|
1793
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
1794
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1795
1795
|
|
|
1796
1796
|
GLOBAL FLAGS
|
|
1797
1797
|
--json Format output as json.
|
|
@@ -1832,7 +1832,7 @@ FLAGS
|
|
|
1832
1832
|
upsert records to.
|
|
1833
1833
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete before
|
|
1834
1834
|
displaying the results.
|
|
1835
|
-
|
|
1835
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1836
1836
|
|
|
1837
1837
|
GLOBAL FLAGS
|
|
1838
1838
|
--json Format output as json.
|
|
@@ -2079,11 +2079,11 @@ USAGE
|
|
|
2079
2079
|
$ sf force mdapi deploy cancel -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>]
|
|
2080
2080
|
|
|
2081
2081
|
FLAGS
|
|
2082
|
-
-i, --jobid=<value>
|
|
2083
|
-
-o, --target-org=<value>
|
|
2084
|
-
-w, --wait=<value>
|
|
2085
|
-
|
|
2086
|
-
|
|
2082
|
+
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment.
|
|
2083
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2084
|
+
-w, --wait=<value> [default: [object Object]] Number of minutes for the command to complete and display
|
|
2085
|
+
results to the terminal window.
|
|
2086
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
2087
2087
|
|
|
2088
2088
|
GLOBAL FLAGS
|
|
2089
2089
|
--json Format output as json.
|
|
@@ -2206,7 +2206,7 @@ FLAGS
|
|
|
2206
2206
|
-s, --singlepackage Specify that the zip file points to a directory structure for a single package.
|
|
2207
2207
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete.
|
|
2208
2208
|
-z, --unzip Extract all files from the retrieved zip file.
|
|
2209
|
-
|
|
2209
|
+
--verbose Display verbose output of retrieve result.
|
|
2210
2210
|
|
|
2211
2211
|
GLOBAL FLAGS
|
|
2212
2212
|
--json Format output as json.
|
|
@@ -2265,8 +2265,8 @@ FLAGS
|
|
|
2265
2265
|
retrieved.
|
|
2266
2266
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete.
|
|
2267
2267
|
-z, --unzip Extract all files from the retrieved zip file.
|
|
2268
|
-
|
|
2269
|
-
|
|
2268
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
2269
|
+
--verbose Display verbose output of retrieve result.
|
|
2270
2270
|
|
|
2271
2271
|
GLOBAL FLAGS
|
|
2272
2272
|
--json Format output as json.
|
|
@@ -2319,7 +2319,7 @@ FLAGS
|
|
|
2319
2319
|
-t, --type=<option> (required) Type of org to create.
|
|
2320
2320
|
<options: sandbox>
|
|
2321
2321
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait while polling for status.
|
|
2322
|
-
|
|
2322
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
2323
2323
|
|
|
2324
2324
|
GLOBAL FLAGS
|
|
2325
2325
|
--json Format output as json.
|
|
@@ -2371,7 +2371,7 @@ FLAGS
|
|
|
2371
2371
|
<options: scratch|sandbox>
|
|
2372
2372
|
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
|
|
2373
2373
|
-w, --wait=<value> [default: [object Object]] Streaming client socket timeout (in minutes).
|
|
2374
|
-
|
|
2374
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
2375
2375
|
|
|
2376
2376
|
GLOBAL FLAGS
|
|
2377
2377
|
--json Format output as json.
|
|
@@ -2406,9 +2406,9 @@ USAGE
|
|
|
2406
2406
|
$ sf force org delete -o <value> [--json] [--api-version <value>] [-p]
|
|
2407
2407
|
|
|
2408
2408
|
FLAGS
|
|
2409
|
-
-o, --target-org=<value>
|
|
2410
|
-
-p, --no-prompt
|
|
2411
|
-
|
|
2409
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2410
|
+
-p, --no-prompt No prompt to confirm deletion.
|
|
2411
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
2412
2412
|
|
|
2413
2413
|
GLOBAL FLAGS
|
|
2414
2414
|
--json Format output as json.
|
|
@@ -2443,7 +2443,7 @@ FLAGS
|
|
|
2443
2443
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2444
2444
|
-s, --setdefaultusername Set the created or cloned org as your default.
|
|
2445
2445
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait while polling for status.
|
|
2446
|
-
|
|
2446
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
2447
2447
|
|
|
2448
2448
|
GLOBAL FLAGS
|
|
2449
2449
|
--json Format output as json.
|
|
@@ -2742,12 +2742,12 @@ USAGE
|
|
|
2742
2742
|
$ sf force source deploy cancel -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>]
|
|
2743
2743
|
|
|
2744
2744
|
FLAGS
|
|
2745
|
-
-i, --jobid=<value>
|
|
2746
|
-
|
|
2747
|
-
-o, --target-org=<value>
|
|
2748
|
-
-w, --wait=<value>
|
|
2749
|
-
|
|
2750
|
-
|
|
2745
|
+
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment if
|
|
2746
|
+
not specified.
|
|
2747
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2748
|
+
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2749
|
+
display results.
|
|
2750
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
2751
2751
|
|
|
2752
2752
|
GLOBAL FLAGS
|
|
2753
2753
|
--json Format output as json.
|
|
@@ -2850,12 +2850,12 @@ USAGE
|
|
|
2850
2850
|
$ sf force source pull -o <value> [--json] [--verbose] [--api-version <value>] [-f] [-w <value>]
|
|
2851
2851
|
|
|
2852
2852
|
FLAGS
|
|
2853
|
-
-f, --forceoverwrite
|
|
2854
|
-
-o, --target-org=<value>
|
|
2855
|
-
-w, --wait=<value>
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2853
|
+
-f, --forceoverwrite Ignore conflict warnings; changes in the org overwrite changes in the project.
|
|
2854
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2855
|
+
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2856
|
+
display results to the terminal window.
|
|
2857
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
2858
|
+
--verbose Display additional details about the command results.
|
|
2859
2859
|
|
|
2860
2860
|
GLOBAL FLAGS
|
|
2861
2861
|
--json Format output as json.
|
|
@@ -2893,14 +2893,14 @@ USAGE
|
|
|
2893
2893
|
$ sf force source push -o <value> [--json] [--api-version <value>] [-f] [-w <value>] [-g] [--quiet]
|
|
2894
2894
|
|
|
2895
2895
|
FLAGS
|
|
2896
|
-
-f, --forceoverwrite
|
|
2897
|
-
|
|
2898
|
-
-g, --ignorewarnings
|
|
2899
|
-
-o, --target-org=<value>
|
|
2900
|
-
-w, --wait=<value>
|
|
2901
|
-
|
|
2902
|
-
|
|
2903
|
-
|
|
2896
|
+
-f, --forceoverwrite Ignore conflict warnings and push source anyway; changes in the project overwrite changes
|
|
2897
|
+
in the org.
|
|
2898
|
+
-g, --ignorewarnings Deploy changes even if warnings are generated.
|
|
2899
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2900
|
+
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2901
|
+
display results to the terminal window.
|
|
2902
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
2903
|
+
--quiet Minimize JSON and sdtout output on success.
|
|
2904
2904
|
|
|
2905
2905
|
GLOBAL FLAGS
|
|
2906
2906
|
--json Format output as json.
|
|
@@ -2952,7 +2952,7 @@ FLAGS
|
|
|
2952
2952
|
display results to the terminal window.
|
|
2953
2953
|
-x, --manifest=<value> Complete path for the manifest (package.xml) file that specifies the components to
|
|
2954
2954
|
retrieve.
|
|
2955
|
-
|
|
2955
|
+
--verbose Verbose output of retrieve result.
|
|
2956
2956
|
|
|
2957
2957
|
GLOBAL FLAGS
|
|
2958
2958
|
--json Format output as json.
|
|
@@ -3063,11 +3063,11 @@ USAGE
|
|
|
3063
3063
|
$ sf force source status -o <value> [--json] [--api-version <value>] [-l | -r] [--concise]
|
|
3064
3064
|
|
|
3065
3065
|
FLAGS
|
|
3066
|
-
-l, --local
|
|
3067
|
-
-o, --target-org=<value>
|
|
3068
|
-
-r, --remote
|
|
3069
|
-
|
|
3070
|
-
|
|
3066
|
+
-l, --local List the changes that have been made locally.
|
|
3067
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
3068
|
+
-r, --remote List the changes that have been made in the org.
|
|
3069
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3070
|
+
--concise Show only the changes that will be pushed or pulled; omits files that are forceignored.
|
|
3071
3071
|
|
|
3072
3072
|
GLOBAL FLAGS
|
|
3073
3073
|
--json Format output as json.
|
|
@@ -3100,7 +3100,7 @@ FLAGS
|
|
|
3100
3100
|
-o, --on-behalf-of=<value>... Comma-separated list of usernames or aliases to assign the password to; must have been
|
|
3101
3101
|
created locally with the "org create user" command.
|
|
3102
3102
|
-u, --target-org=<value> (required) Scratch org alias or login user.
|
|
3103
|
-
|
|
3103
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3104
3104
|
|
|
3105
3105
|
GLOBAL FLAGS
|
|
3106
3106
|
--json Format output as json.
|
|
@@ -3217,11 +3217,11 @@ USAGE
|
|
|
3217
3217
|
$ sf lightning generate app -n <value> [--json] [-t DefaultLightningApp] [-d <value>] [--api-version <value>]
|
|
3218
3218
|
|
|
3219
3219
|
FLAGS
|
|
3220
|
-
-d, --output-dir=<value>
|
|
3221
|
-
-n, --name=<value>
|
|
3222
|
-
-t, --template=<option>
|
|
3223
|
-
|
|
3224
|
-
|
|
3220
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
3221
|
+
-n, --name=<value> (required) Name of the generated Lightning App.
|
|
3222
|
+
-t, --template=<option> [default: DefaultLightningApp] Template to use for file creation.
|
|
3223
|
+
<options: DefaultLightningApp>
|
|
3224
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3225
3225
|
|
|
3226
3226
|
GLOBAL FLAGS
|
|
3227
3227
|
--json Format output as json.
|
|
@@ -3271,13 +3271,13 @@ USAGE
|
|
|
3271
3271
|
[--api-version <value>] [--type aura|lwc]
|
|
3272
3272
|
|
|
3273
3273
|
FLAGS
|
|
3274
|
-
-d, --output-dir=<value>
|
|
3275
|
-
-n, --name=<value>
|
|
3276
|
-
-t, --template=<option>
|
|
3277
|
-
|
|
3278
|
-
|
|
3279
|
-
|
|
3280
|
-
|
|
3274
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
3275
|
+
-n, --name=<value> (required) Name of the generated Lightning Component.
|
|
3276
|
+
-t, --template=<option> [default: default] Template to use for file creation.
|
|
3277
|
+
<options: default|analyticsDashboard|analyticsDashboardWithStep>
|
|
3278
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3279
|
+
--type=<option> [default: aura] Type of the component bundle.
|
|
3280
|
+
<options: aura|lwc>
|
|
3281
3281
|
|
|
3282
3282
|
GLOBAL FLAGS
|
|
3283
3283
|
--json Format output as json.
|
|
@@ -3338,11 +3338,11 @@ USAGE
|
|
|
3338
3338
|
$ sf lightning generate event -n <value> [--json] [-t DefaultLightningEvt] [-d <value>] [--api-version <value>]
|
|
3339
3339
|
|
|
3340
3340
|
FLAGS
|
|
3341
|
-
-d, --output-dir=<value>
|
|
3342
|
-
-n, --name=<value>
|
|
3343
|
-
-t, --template=<option>
|
|
3344
|
-
|
|
3345
|
-
|
|
3341
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
3342
|
+
-n, --name=<value> (required) Name of the generated Lightning Event.
|
|
3343
|
+
-t, --template=<option> [default: DefaultLightningEvt] Template to use for file creation.
|
|
3344
|
+
<options: DefaultLightningEvt>
|
|
3345
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3346
3346
|
|
|
3347
3347
|
GLOBAL FLAGS
|
|
3348
3348
|
--json Format output as json.
|
|
@@ -3391,11 +3391,11 @@ USAGE
|
|
|
3391
3391
|
$ sf lightning generate interface -n <value> [--json] [-t DefaultLightningIntf] [-d <value>] [--api-version <value>]
|
|
3392
3392
|
|
|
3393
3393
|
FLAGS
|
|
3394
|
-
-d, --output-dir=<value>
|
|
3395
|
-
-n, --name=<value>
|
|
3396
|
-
-t, --template=<option>
|
|
3397
|
-
|
|
3398
|
-
|
|
3394
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
3395
|
+
-n, --name=<value> (required) Name of the generated Lightning Interface.
|
|
3396
|
+
-t, --template=<option> [default: DefaultLightningIntf] Template to use for file creation.
|
|
3397
|
+
<options: DefaultLightningIntf>
|
|
3398
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3399
3399
|
|
|
3400
3400
|
GLOBAL FLAGS
|
|
3401
3401
|
--json Format output as json.
|
|
@@ -3444,11 +3444,11 @@ USAGE
|
|
|
3444
3444
|
$ sf lightning generate test -n <value> [--json] [-t DefaultLightningTest] [-d <value>] [--api-version <value>]
|
|
3445
3445
|
|
|
3446
3446
|
FLAGS
|
|
3447
|
-
-d, --output-dir=<value>
|
|
3448
|
-
-n, --name=<value>
|
|
3449
|
-
-t, --template=<option>
|
|
3450
|
-
|
|
3451
|
-
|
|
3447
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
3448
|
+
-n, --name=<value> (required) Name of the generated Lightning Test.
|
|
3449
|
+
-t, --template=<option> [default: DefaultLightningTest] Template to use for file creation.
|
|
3450
|
+
<options: DefaultLightningTest>
|
|
3451
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3452
3452
|
|
|
3453
3453
|
GLOBAL FLAGS
|
|
3454
3454
|
--json Format output as json.
|
|
@@ -3557,7 +3557,7 @@ FLAGS
|
|
|
3557
3557
|
-b, --on-behalf-of=<value>... Username or alias to assign the permission set to.
|
|
3558
3558
|
-n, --name=<value>... (required) Permission set to assign.
|
|
3559
3559
|
-o, --target-org=<value> (required) Scratch org alias or login user.
|
|
3560
|
-
|
|
3560
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3561
3561
|
|
|
3562
3562
|
GLOBAL FLAGS
|
|
3563
3563
|
--json Format output as json.
|
|
@@ -3600,7 +3600,7 @@ FLAGS
|
|
|
3600
3600
|
-b, --on-behalf-of=<value>... Usernames or alias to assign the permission set license to.
|
|
3601
3601
|
-n, --name=<value> (required) Name of the permission set license to assign.
|
|
3602
3602
|
-o, --target-org=<value> (required) Scratch org alias or login user.
|
|
3603
|
-
|
|
3603
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3604
3604
|
|
|
3605
3605
|
GLOBAL FLAGS
|
|
3606
3606
|
--json Format output as json.
|
|
@@ -3652,9 +3652,9 @@ FLAGS
|
|
|
3652
3652
|
-o, --target-org=<value> (required) Username or alias of the production org that contains the sandbox license.
|
|
3653
3653
|
-s, --set-default Set the sandbox org as your default org.
|
|
3654
3654
|
-w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for the sandbox org to be ready.
|
|
3655
|
-
|
|
3656
|
-
|
|
3657
|
-
|
|
3655
|
+
--async Request the sandbox creation, but don't wait for it to complete.
|
|
3656
|
+
--no-prompt Don't prompt for confirmation about the sandbox configuration.
|
|
3657
|
+
--no-track-source Do not use source tracking for this sandbox.
|
|
3658
3658
|
|
|
3659
3659
|
GLOBAL FLAGS
|
|
3660
3660
|
--json Format output as json.
|
|
@@ -3758,30 +3758,30 @@ FLAGS
|
|
|
3758
3758
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
3759
3759
|
-w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for the scratch org to be ready.
|
|
3760
3760
|
-y, --duration-days=<days> [default: [object Object]] Number of days before the org expires.
|
|
3761
|
-
|
|
3762
|
-
|
|
3761
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3762
|
+
--async Request the org, but don't wait for it to complete.
|
|
3763
3763
|
|
|
3764
3764
|
PACKAGING FLAGS
|
|
3765
3765
|
-c, --no-ancestors Don't include second-generation managed package (2GP) ancestors in the scratch org.
|
|
3766
3766
|
-m, --no-namespace Create the scratch org with no namespace, even if the Dev Hub has a namespace.
|
|
3767
3767
|
|
|
3768
3768
|
DEFINITION FILE OVERRIDE FLAGS
|
|
3769
|
-
-e, --edition=<option>
|
|
3770
|
-
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
|
|
3779
|
-
|
|
3780
|
-
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
|
|
3784
|
-
|
|
3769
|
+
-e, --edition=<option> Salesforce edition of the scratch org. Overrides the value of the "edition" option in the
|
|
3770
|
+
definition file, if set.
|
|
3771
|
+
<options: developer|enterprise|group|professional|partner-developer|partner-enterprise|part
|
|
3772
|
+
ner-group|partner-professional>
|
|
3773
|
+
--admin-email=<value> Email address that will be applied to the org's admin user. Overrides the value of the
|
|
3774
|
+
"adminEmail" option in the definition file, if set.
|
|
3775
|
+
--description=<value> Description of the scratch org in the Dev Hub. Overrides the value of the "description"
|
|
3776
|
+
option in the definition file, if set.
|
|
3777
|
+
--name=<value> Name of the org, such as "Acme Company". Overrides the value of the "orgName" option in the
|
|
3778
|
+
definition file, if set.
|
|
3779
|
+
--release=<option> Release of the scratch org as compared to the Dev Hub release.
|
|
3780
|
+
<options: preview|previous>
|
|
3781
|
+
--source-org=<value> 15-character ID of the org whose shape the new scratch org will be based on. Overrides the
|
|
3782
|
+
value of the "sourceOrg" option in the definition file, if set.
|
|
3783
|
+
--username=<value> Username of the scratch org admin user. Overrides the value of the "username" option in the
|
|
3784
|
+
definition file, if set.
|
|
3785
3785
|
|
|
3786
3786
|
GLOBAL FLAGS
|
|
3787
3787
|
--json Format output as json.
|
|
@@ -3904,7 +3904,7 @@ FLAGS
|
|
|
3904
3904
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
3905
3905
|
-s, --set-unique-username Force the username, if specified in the definition file or at the command line, to be
|
|
3906
3906
|
unique by appending the org ID.
|
|
3907
|
-
|
|
3907
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3908
3908
|
|
|
3909
3909
|
GLOBAL FLAGS
|
|
3910
3910
|
--json Format output as json.
|
|
@@ -4083,9 +4083,9 @@ USAGE
|
|
|
4083
4083
|
$ sf org display -o <value> [--json] [--api-version <value>] [--verbose]
|
|
4084
4084
|
|
|
4085
4085
|
FLAGS
|
|
4086
|
-
-o, --target-org=<value>
|
|
4087
|
-
|
|
4088
|
-
|
|
4086
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4087
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
4088
|
+
--verbose Display the sfdxAuthUrl property.
|
|
4089
4089
|
|
|
4090
4090
|
GLOBAL FLAGS
|
|
4091
4091
|
--json Format output as json.
|
|
@@ -4126,8 +4126,8 @@ USAGE
|
|
|
4126
4126
|
$ sf org display user -o <value> [--json] [--api-version <value>]
|
|
4127
4127
|
|
|
4128
4128
|
FLAGS
|
|
4129
|
-
-o, --target-org=<value>
|
|
4130
|
-
|
|
4129
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4130
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
4131
4131
|
|
|
4132
4132
|
GLOBAL FLAGS
|
|
4133
4133
|
--json Format output as json.
|
|
@@ -4170,7 +4170,7 @@ FLAGS
|
|
|
4170
4170
|
-l, --length=<value> [default: 13] Number of characters in the generated password; valid values are between
|
|
4171
4171
|
8 and 100.
|
|
4172
4172
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4173
|
-
|
|
4173
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
4174
4174
|
|
|
4175
4175
|
GLOBAL FLAGS
|
|
4176
4176
|
--json Format output as json.
|
|
@@ -4227,12 +4227,12 @@ USAGE
|
|
|
4227
4227
|
$ sf org list [--json] [--verbose] [--all] [-p --clean] [--skip-connection-status]
|
|
4228
4228
|
|
|
4229
4229
|
FLAGS
|
|
4230
|
-
-p, --no-prompt
|
|
4231
|
-
|
|
4232
|
-
|
|
4233
|
-
|
|
4234
|
-
|
|
4235
|
-
|
|
4230
|
+
-p, --no-prompt Don't prompt for confirmation.
|
|
4231
|
+
--all Include expired, deleted, and unknown-status scratch orgs.
|
|
4232
|
+
--clean Remove all local org authorizations for non-active scratch orgs. Use "org logout" to
|
|
4233
|
+
remove non-scratch orgs.
|
|
4234
|
+
--skip-connection-status Skip retrieving the connection status of non-scratch orgs.
|
|
4235
|
+
--verbose List more information about each org.
|
|
4236
4236
|
|
|
4237
4237
|
GLOBAL FLAGS
|
|
4238
4238
|
--json Format output as json.
|
|
@@ -4296,8 +4296,8 @@ USAGE
|
|
|
4296
4296
|
$ sf org list limits -o <value> [--json] [--api-version <value>]
|
|
4297
4297
|
|
|
4298
4298
|
FLAGS
|
|
4299
|
-
-o, --target-org=<value>
|
|
4300
|
-
|
|
4299
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4300
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
4301
4301
|
|
|
4302
4302
|
GLOBAL FLAGS
|
|
4303
4303
|
--json Format output as json.
|
|
@@ -4338,8 +4338,8 @@ FLAGS
|
|
|
4338
4338
|
-m, --metadata-type=<value> (required) Metadata type to be retrieved, such as CustomObject; metadata type names are
|
|
4339
4339
|
case-sensitive.
|
|
4340
4340
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4341
|
-
|
|
4342
|
-
|
|
4341
|
+
--api-version=<value> API version to use; default is the most recent API version.
|
|
4342
|
+
--folder=<value> Folder associated with the component; required for components that use folders; folder
|
|
4343
4343
|
names are case-sensitive.
|
|
4344
4344
|
|
|
4345
4345
|
GLOBAL FLAGS
|
|
@@ -4400,7 +4400,7 @@ USAGE
|
|
|
4400
4400
|
FLAGS
|
|
4401
4401
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
4402
4402
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4403
|
-
|
|
4403
|
+
--api-version=<value> API version to use; default is the most recent API version.
|
|
4404
4404
|
|
|
4405
4405
|
GLOBAL FLAGS
|
|
4406
4406
|
--json Format output as json.
|
|
@@ -4451,9 +4451,9 @@ USAGE
|
|
|
4451
4451
|
$ sf org list sobject record-counts -o <value> [--json] [-s <value>] [--api-version <value>]
|
|
4452
4452
|
|
|
4453
4453
|
FLAGS
|
|
4454
|
-
-o, --target-org=<value>
|
|
4455
|
-
-s, --sobject=<value>...
|
|
4456
|
-
|
|
4454
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4455
|
+
-s, --sobject=<value>... [default: ] API name of the standard or custom object for which to display record counts.
|
|
4456
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
4457
4457
|
|
|
4458
4458
|
GLOBAL FLAGS
|
|
4459
4459
|
--json Format output as json.
|
|
@@ -4495,8 +4495,8 @@ USAGE
|
|
|
4495
4495
|
$ sf org list users -o <value> [--json] [--api-version <value>]
|
|
4496
4496
|
|
|
4497
4497
|
FLAGS
|
|
4498
|
-
-o, --target-org=<value>
|
|
4499
|
-
|
|
4498
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4499
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
4500
4500
|
|
|
4501
4501
|
GLOBAL FLAGS
|
|
4502
4502
|
--json Format output as json.
|
|
@@ -4942,7 +4942,7 @@ FLAGS
|
|
|
4942
4942
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
4943
4943
|
-p, --path=<value> Navigation URL path to open a specific page.
|
|
4944
4944
|
-r, --url-only Display navigation URL, but don’t launch browser.
|
|
4945
|
-
|
|
4945
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
4946
4946
|
|
|
4947
4947
|
GLOBAL FLAGS
|
|
4948
4948
|
--json Format output as json.
|
|
@@ -5120,7 +5120,7 @@ EXAMPLES
|
|
|
5120
5120
|
$ sf plugins
|
|
5121
5121
|
```
|
|
5122
5122
|
|
|
5123
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5123
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.7/src/commands/plugins/index.ts)_
|
|
5124
5124
|
|
|
5125
5125
|
## `sf plugins discover`
|
|
5126
5126
|
|
|
@@ -5137,7 +5137,7 @@ EXAMPLES
|
|
|
5137
5137
|
$ sf plugins discover
|
|
5138
5138
|
```
|
|
5139
5139
|
|
|
5140
|
-
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-template-sf/blob/1.0.
|
|
5140
|
+
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-template-sf/blob/1.0.5/src/commands/plugins/discover.ts)_
|
|
5141
5141
|
|
|
5142
5142
|
## `sf plugins:inspect PLUGIN...`
|
|
5143
5143
|
|
|
@@ -5161,10 +5161,10 @@ DESCRIPTION
|
|
|
5161
5161
|
Displays installation properties of a plugin.
|
|
5162
5162
|
|
|
5163
5163
|
EXAMPLES
|
|
5164
|
-
$ sf plugins
|
|
5164
|
+
$ sf plugins inspect myplugin
|
|
5165
5165
|
```
|
|
5166
5166
|
|
|
5167
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5167
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.7/src/commands/plugins/inspect.ts)_
|
|
5168
5168
|
|
|
5169
5169
|
## `sf plugins:install PLUGIN...`
|
|
5170
5170
|
|
|
@@ -5201,14 +5201,14 @@ ALIASES
|
|
|
5201
5201
|
$ sf plugins add
|
|
5202
5202
|
|
|
5203
5203
|
EXAMPLES
|
|
5204
|
-
$ sf plugins
|
|
5204
|
+
$ sf plugins install myplugin
|
|
5205
5205
|
|
|
5206
|
-
$ sf plugins
|
|
5206
|
+
$ sf plugins install https://github.com/someuser/someplugin
|
|
5207
5207
|
|
|
5208
|
-
$ sf plugins
|
|
5208
|
+
$ sf plugins install someuser/someplugin
|
|
5209
5209
|
```
|
|
5210
5210
|
|
|
5211
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5211
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.7/src/commands/plugins/install.ts)_
|
|
5212
5212
|
|
|
5213
5213
|
## `sf plugins:link PLUGIN`
|
|
5214
5214
|
|
|
@@ -5222,9 +5222,9 @@ ARGUMENTS
|
|
|
5222
5222
|
PATH [default: .] path to plugin
|
|
5223
5223
|
|
|
5224
5224
|
FLAGS
|
|
5225
|
-
-h, --help
|
|
5225
|
+
-h, --help Show CLI help.
|
|
5226
5226
|
-v, --verbose
|
|
5227
|
-
|
|
5227
|
+
--[no-]install Install dependencies after linking the plugin.
|
|
5228
5228
|
|
|
5229
5229
|
DESCRIPTION
|
|
5230
5230
|
Links a plugin into the CLI for development.
|
|
@@ -5235,10 +5235,10 @@ DESCRIPTION
|
|
|
5235
5235
|
|
|
5236
5236
|
|
|
5237
5237
|
EXAMPLES
|
|
5238
|
-
$ sf plugins
|
|
5238
|
+
$ sf plugins link myplugin
|
|
5239
5239
|
```
|
|
5240
5240
|
|
|
5241
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5241
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.7/src/commands/plugins/link.ts)_
|
|
5242
5242
|
|
|
5243
5243
|
## `sf plugins reset`
|
|
5244
5244
|
|
|
@@ -5249,7 +5249,7 @@ USAGE
|
|
|
5249
5249
|
$ sf plugins reset
|
|
5250
5250
|
```
|
|
5251
5251
|
|
|
5252
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5252
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.7/src/commands/plugins/reset.ts)_
|
|
5253
5253
|
|
|
5254
5254
|
## `sf plugins trust verify`
|
|
5255
5255
|
|
|
@@ -5300,9 +5300,12 @@ DESCRIPTION
|
|
|
5300
5300
|
ALIASES
|
|
5301
5301
|
$ sf plugins unlink
|
|
5302
5302
|
$ sf plugins remove
|
|
5303
|
+
|
|
5304
|
+
EXAMPLES
|
|
5305
|
+
$ sf plugins uninstall myplugin
|
|
5303
5306
|
```
|
|
5304
5307
|
|
|
5305
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5308
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.7/src/commands/plugins/uninstall.ts)_
|
|
5306
5309
|
|
|
5307
5310
|
## `sf plugins update`
|
|
5308
5311
|
|
|
@@ -5320,7 +5323,7 @@ DESCRIPTION
|
|
|
5320
5323
|
Update installed plugins.
|
|
5321
5324
|
```
|
|
5322
5325
|
|
|
5323
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5326
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.7/src/commands/plugins/update.ts)_
|
|
5324
5327
|
|
|
5325
5328
|
## `sf project convert mdapi`
|
|
5326
5329
|
|
|
@@ -5338,7 +5341,7 @@ FLAGS
|
|
|
5338
5341
|
-p, --metadata-dir=<value>... Root of directory or zip file of metadata formatted files to convert.
|
|
5339
5342
|
-r, --root-dir=<value> (required) Root directory that contains the Metadata API–formatted metadata.
|
|
5340
5343
|
-x, --manifest=<value> File path to manifest (package.xml) of metadata types to convert.
|
|
5341
|
-
|
|
5344
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
5342
5345
|
|
|
5343
5346
|
GLOBAL FLAGS
|
|
5344
5347
|
--json Format output as json.
|
|
@@ -5401,7 +5404,7 @@ FLAGS
|
|
|
5401
5404
|
-p, --source-dir=<value>... Paths to the local source files to convert.
|
|
5402
5405
|
-r, --root-dir=<value> Source directory other than the default package to convert.
|
|
5403
5406
|
-x, --manifest=<value> Path to the manifest (package.xml) file that specifies the metadata types to convert.
|
|
5404
|
-
|
|
5407
|
+
--api-version=<value> API Version to use in the generated project's manifest. By default, will use the version
|
|
5405
5408
|
from sfdx-project.json
|
|
5406
5409
|
|
|
5407
5410
|
GLOBAL FLAGS
|
|
@@ -5475,13 +5478,13 @@ FLAGS
|
|
|
5475
5478
|
-r, --no-prompt Don't prompt for delete confirmation.
|
|
5476
5479
|
-t, --track-source If the delete succeeds, update the source tracking information.
|
|
5477
5480
|
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to finish.
|
|
5478
|
-
|
|
5479
|
-
|
|
5481
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
5482
|
+
--verbose Verbose output of the delete result.
|
|
5480
5483
|
|
|
5481
5484
|
TEST FLAGS
|
|
5482
5485
|
-l, --test-level=<option> Deployment Apex testing level.
|
|
5483
5486
|
<options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
|
|
5484
|
-
|
|
5487
|
+
--tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
5485
5488
|
|
|
5486
5489
|
GLOBAL FLAGS
|
|
5487
5490
|
--json Format output as json.
|
|
@@ -5603,9 +5606,9 @@ USAGE
|
|
|
5603
5606
|
$ sf project delete tracking -o <value> [--json] [--api-version <value>] [-p]
|
|
5604
5607
|
|
|
5605
5608
|
FLAGS
|
|
5606
|
-
-o, --target-org=<value>
|
|
5607
|
-
-p, --no-prompt
|
|
5608
|
-
|
|
5609
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
5610
|
+
-p, --no-prompt Don't prompt for source tracking override confirmation.
|
|
5611
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
5609
5612
|
|
|
5610
5613
|
GLOBAL FLAGS
|
|
5611
5614
|
--json Format output as json.
|
|
@@ -5641,7 +5644,7 @@ FLAGS
|
|
|
5641
5644
|
-i, --job-id=<value> Job ID of the deploy operation you want to cancel.
|
|
5642
5645
|
-r, --use-most-recent Use the job ID of the most recent deploy operation.
|
|
5643
5646
|
-w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
|
|
5644
|
-
|
|
5647
|
+
--async Run the command asynchronously.
|
|
5645
5648
|
|
|
5646
5649
|
GLOBAL FLAGS
|
|
5647
5650
|
--json Format output as json.
|
|
@@ -5798,9 +5801,9 @@ FLAGS
|
|
|
5798
5801
|
-r, --use-most-recent Use the job ID of the most recently validated deployment.
|
|
5799
5802
|
-w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
5800
5803
|
display results.
|
|
5801
|
-
|
|
5802
|
-
|
|
5803
|
-
|
|
5804
|
+
--async Run the command asynchronously.
|
|
5805
|
+
--concise Show concise output of the deploy result.
|
|
5806
|
+
--verbose Show verbose output of the deploy result.
|
|
5804
5807
|
|
|
5805
5808
|
GLOBAL FLAGS
|
|
5806
5809
|
--json Format output as json.
|
|
@@ -5984,8 +5987,8 @@ FLAGS
|
|
|
5984
5987
|
-i, --job-id=<value> Job ID of the deploy operation you want to resume.
|
|
5985
5988
|
-r, --use-most-recent Use the job ID of the most recent deploy operation.
|
|
5986
5989
|
-w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
|
|
5987
|
-
|
|
5988
|
-
|
|
5990
|
+
--concise Show concise output of the deploy operation result.
|
|
5991
|
+
--verbose Show verbose output of the deploy operation result.
|
|
5989
5992
|
|
|
5990
5993
|
TEST FLAGS
|
|
5991
5994
|
--coverage-formatters=<option>... Format of the code coverage results.
|
|
@@ -6087,10 +6090,10 @@ FLAGS
|
|
|
6087
6090
|
-r, --ignore-errors Ignore any errors and don’t roll back deployment.
|
|
6088
6091
|
-w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for command to complete and display
|
|
6089
6092
|
results.
|
|
6090
|
-
|
|
6091
|
-
|
|
6092
|
-
|
|
6093
|
-
|
|
6093
|
+
--async Run the command asynchronously.
|
|
6094
|
+
--concise Show concise output of the deploy result.
|
|
6095
|
+
--dry-run Validate deploy and run Apex tests but don’t save to the org.
|
|
6096
|
+
--verbose Show verbose output of the deploy result.
|
|
6094
6097
|
|
|
6095
6098
|
SOURCE FORMAT FLAGS
|
|
6096
6099
|
-d, --source-dir=<value>... Path to the local source files to deploy.
|
|
@@ -6099,14 +6102,15 @@ SOURCE FORMAT FLAGS
|
|
|
6099
6102
|
-x, --manifest=<value> Full file path for manifest (package.xml) of components to deploy.
|
|
6100
6103
|
|
|
6101
6104
|
TEST FLAGS
|
|
6102
|
-
-l, --test-level=<option>
|
|
6103
|
-
|
|
6104
|
-
-t, --tests=<value>...
|
|
6105
|
-
|
|
6106
|
-
|
|
6107
|
-
|
|
6108
|
-
|
|
6109
|
-
|
|
6105
|
+
-l, --test-level=<option> Deployment Apex testing level.
|
|
6106
|
+
<options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
|
|
6107
|
+
-t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
6108
|
+
--coverage-formatters=<option>... Format of the code coverage results.
|
|
6109
|
+
<options: clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamci
|
|
6110
|
+
ty|text|text-summary>
|
|
6111
|
+
--junit Output JUnit test results.
|
|
6112
|
+
--results-dir=<value> Output directory for code coverage and JUnit results; defaults to the deploy
|
|
6113
|
+
ID.
|
|
6110
6114
|
|
|
6111
6115
|
GLOBAL FLAGS
|
|
6112
6116
|
--json Format output as json.
|
|
@@ -6312,9 +6316,9 @@ FLAGS
|
|
|
6312
6316
|
-o, --target-org=<value> (required) Login username or alias for the target org.
|
|
6313
6317
|
-w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
6314
6318
|
display results.
|
|
6315
|
-
|
|
6316
|
-
|
|
6317
|
-
|
|
6319
|
+
--async Run the command asynchronously.
|
|
6320
|
+
--concise Show concise output of the validation result.
|
|
6321
|
+
--verbose Show verbose output of the validation result.
|
|
6318
6322
|
|
|
6319
6323
|
SOURCE FORMAT FLAGS
|
|
6320
6324
|
-d, --source-dir=<value>... Path to the local source files to validate for deployment.
|
|
@@ -6322,14 +6326,15 @@ SOURCE FORMAT FLAGS
|
|
|
6322
6326
|
-x, --manifest=<value> Full file path for manifest (package.xml) of components to validate for deployment.
|
|
6323
6327
|
|
|
6324
6328
|
TEST FLAGS
|
|
6325
|
-
-l, --test-level=<option>
|
|
6326
|
-
|
|
6327
|
-
-t, --tests=<value>...
|
|
6328
|
-
|
|
6329
|
-
|
|
6330
|
-
|
|
6331
|
-
|
|
6332
|
-
|
|
6329
|
+
-l, --test-level=<option> [default: RunLocalTests] Deployment Apex testing level.
|
|
6330
|
+
<options: RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests>
|
|
6331
|
+
-t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
6332
|
+
--coverage-formatters=<option>... Format of the code coverage results.
|
|
6333
|
+
<options: clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamci
|
|
6334
|
+
ty|text|text-summary>
|
|
6335
|
+
--junit Output JUnit test results.
|
|
6336
|
+
--results-dir=<value> Output directory for code coverage and JUnit results; defaults to the deploy
|
|
6337
|
+
ID.
|
|
6333
6338
|
|
|
6334
6339
|
GLOBAL FLAGS
|
|
6335
6340
|
--json Format output as json.
|
|
@@ -6489,7 +6494,7 @@ FLAGS
|
|
|
6489
6494
|
-t, --template=<option> [default: standard] Template to use for project creation.
|
|
6490
6495
|
<options: standard|empty|analytics>
|
|
6491
6496
|
-x, --manifest Generate a manifest (package.xml) for change-set based development.
|
|
6492
|
-
|
|
6497
|
+
--api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
|
|
6493
6498
|
|
|
6494
6499
|
GLOBAL FLAGS
|
|
6495
6500
|
--json Format output as json.
|
|
@@ -6595,8 +6600,8 @@ FLAGS
|
|
|
6595
6600
|
-p, --source-dir=<value>... Paths to the local source files to include in the manifest.
|
|
6596
6601
|
-t, --type=<option> Type of manifest to create; the type determines the name of the created file.
|
|
6597
6602
|
<options: pre|post|destroy|package>
|
|
6598
|
-
|
|
6599
|
-
|
|
6603
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
6604
|
+
--from-org=<value> Username or alias of the org that contains the metadata components from which to
|
|
6600
6605
|
build a manifest.
|
|
6601
6606
|
|
|
6602
6607
|
GLOBAL FLAGS
|
|
@@ -6701,10 +6706,10 @@ USAGE
|
|
|
6701
6706
|
$ sf project reset tracking -o <value> [--json] [--api-version <value>] [-r <value>] [-p]
|
|
6702
6707
|
|
|
6703
6708
|
FLAGS
|
|
6704
|
-
-o, --target-org=<value>
|
|
6705
|
-
-p, --no-prompt
|
|
6706
|
-
-r, --revision=<value>
|
|
6707
|
-
|
|
6709
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
6710
|
+
-p, --no-prompt Don't prompt for source tracking override confirmation.
|
|
6711
|
+
-r, --revision=<value> SourceMember revision counter number to reset to.
|
|
6712
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
6708
6713
|
|
|
6709
6714
|
GLOBAL FLAGS
|
|
6710
6715
|
--json Format output as json.
|
|
@@ -6820,8 +6825,8 @@ FLAGS
|
|
|
6820
6825
|
METADATA API FORMAT FLAGS
|
|
6821
6826
|
-t, --target-metadata-dir=<value> Directory that will contain the retrieved metadata format files or ZIP.
|
|
6822
6827
|
-z, --unzip Extract all files from the retrieved zip file.
|
|
6823
|
-
|
|
6824
|
-
|
|
6828
|
+
--single-package Indicates that the zip file points to a directory structure for a single package.
|
|
6829
|
+
--zip-file-name=<value> File name to use for the retrieved zip file.
|
|
6825
6830
|
|
|
6826
6831
|
GLOBAL FLAGS
|
|
6827
6832
|
--json Format output as json.
|
|
@@ -6997,7 +7002,7 @@ FLAG DESCRIPTIONS
|
|
|
6997
7002
|
If you don't specify this flag, the command prompts you to choose from your local objects.
|
|
6998
7003
|
```
|
|
6999
7004
|
|
|
7000
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/0.
|
|
7005
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.1/src/commands/schema/generate/field.ts)_
|
|
7001
7006
|
|
|
7002
7007
|
## `sf schema generate platformevent`
|
|
7003
7008
|
|
|
@@ -7026,7 +7031,7 @@ EXAMPLES
|
|
|
7026
7031
|
$ sf schema generate platformevent --label "My Platform Event"
|
|
7027
7032
|
```
|
|
7028
7033
|
|
|
7029
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/0.
|
|
7034
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.1/src/commands/schema/generate/platformevent.ts)_
|
|
7030
7035
|
|
|
7031
7036
|
## `sf schema generate sobject`
|
|
7032
7037
|
|
|
@@ -7080,7 +7085,7 @@ FLAG DESCRIPTIONS
|
|
|
7080
7085
|
* Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
|
|
7081
7086
|
```
|
|
7082
7087
|
|
|
7083
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/0.
|
|
7088
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.1/src/commands/schema/generate/sobject.ts)_
|
|
7084
7089
|
|
|
7085
7090
|
## `sf schema generate tab`
|
|
7086
7091
|
|
|
@@ -7127,7 +7132,7 @@ FLAG DESCRIPTIONS
|
|
|
7127
7132
|
The API name for a custom object always ends in "__c", such as "MyObject__c".
|
|
7128
7133
|
```
|
|
7129
7134
|
|
|
7130
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/0.
|
|
7135
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.0.1/src/commands/schema/generate/tab.ts)_
|
|
7131
7136
|
|
|
7132
7137
|
## `sf search`
|
|
7133
7138
|
|
|
@@ -7154,10 +7159,10 @@ USAGE
|
|
|
7154
7159
|
$ sf sobject describe -o <value> -s <value> [--json] [--api-version <value>] [-t]
|
|
7155
7160
|
|
|
7156
7161
|
FLAGS
|
|
7157
|
-
-o, --target-org=<value>
|
|
7158
|
-
-s, --sobject=<value>
|
|
7159
|
-
-t, --use-tooling-api
|
|
7160
|
-
|
|
7162
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
7163
|
+
-s, --sobject=<value> (required) API name of the object to describe.
|
|
7164
|
+
-t, --use-tooling-api Use Tooling API to display metadata for Tooling API objects.
|
|
7165
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
7161
7166
|
|
|
7162
7167
|
GLOBAL FLAGS
|
|
7163
7168
|
--json Format output as json.
|
|
@@ -7199,9 +7204,9 @@ USAGE
|
|
|
7199
7204
|
$ sf sobject list -o <value> [--json] [--api-version <value>] [-s <value>]
|
|
7200
7205
|
|
|
7201
7206
|
FLAGS
|
|
7202
|
-
-o, --target-org=<value>
|
|
7203
|
-
-s, --sobject=<value>
|
|
7204
|
-
|
|
7207
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
7208
|
+
-s, --sobject=<value> [default: ALL] Category of objects to list.
|
|
7209
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
7205
7210
|
|
|
7206
7211
|
GLOBAL FLAGS
|
|
7207
7212
|
--json Format output as json.
|
|
@@ -7236,10 +7241,10 @@ USAGE
|
|
|
7236
7241
|
$ sf static-resource generate -n <value> [--json] [--type <value>] [-d <value>] [--api-version <value>]
|
|
7237
7242
|
|
|
7238
7243
|
FLAGS
|
|
7239
|
-
-d, --output-dir=<value>
|
|
7240
|
-
-n, --name=<value>
|
|
7241
|
-
|
|
7242
|
-
|
|
7244
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
7245
|
+
-n, --name=<value> (required) Name of the generated static resource.
|
|
7246
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
7247
|
+
--type=<value> [default: application/zip] Content type (mime type) of the generated static resource.
|
|
7243
7248
|
|
|
7244
7249
|
GLOBAL FLAGS
|
|
7245
7250
|
--json Format output as json.
|
|
@@ -7299,7 +7304,7 @@ FLAGS
|
|
|
7299
7304
|
-a, --available See available versions.
|
|
7300
7305
|
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
|
|
7301
7306
|
-v, --version=<value> Install a specific version.
|
|
7302
|
-
|
|
7307
|
+
--force Force a re-download of the requested version.
|
|
7303
7308
|
|
|
7304
7309
|
DESCRIPTION
|
|
7305
7310
|
update the sf CLI
|
|
@@ -7354,12 +7359,12 @@ USAGE
|
|
|
7354
7359
|
<value>]
|
|
7355
7360
|
|
|
7356
7361
|
FLAGS
|
|
7357
|
-
-d, --output-dir=<value>
|
|
7358
|
-
-l, --label=<value>
|
|
7359
|
-
-n, --name=<value>
|
|
7360
|
-
-t, --template=<option>
|
|
7361
|
-
|
|
7362
|
-
|
|
7362
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
7363
|
+
-l, --label=<value> (required) Visualforce Component label.
|
|
7364
|
+
-n, --name=<value> (required) Name of the generated Visualforce Component.
|
|
7365
|
+
-t, --template=<option> [default: DefaultVFComponent] Template to use for file creation.
|
|
7366
|
+
<options: DefaultVFComponent>
|
|
7367
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
7363
7368
|
|
|
7364
7369
|
GLOBAL FLAGS
|
|
7365
7370
|
--json Format output as json.
|
|
@@ -7408,10 +7413,10 @@ USAGE
|
|
|
7408
7413
|
$ sf visualforce generate page -n <value> -l <value> [--json] [-d <value>] [--api-version <value>]
|
|
7409
7414
|
|
|
7410
7415
|
FLAGS
|
|
7411
|
-
-d, --output-dir=<value>
|
|
7412
|
-
-l, --label=<value>
|
|
7413
|
-
-n, --name=<value>
|
|
7414
|
-
|
|
7416
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
7417
|
+
-l, --label=<value> (required) Visualforce Page label.
|
|
7418
|
+
-n, --name=<value> (required) Name of the generated Visualforce Page.
|
|
7419
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
7415
7420
|
|
|
7416
7421
|
GLOBAL FLAGS
|
|
7417
7422
|
--json Format output as json.
|