@salesforce/cli 2.35.2-qa.0 → 2.35.3
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 +225 -191
- package/dist/hooks/preparse.js +81 -0
- package/npm-shrinkwrap.json +365 -100
- package/oclif.manifest.json +1 -1
- package/package.json +17 -15
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
|
|
|
24
24
|
$ sf COMMAND
|
|
25
25
|
running command...
|
|
26
26
|
$ sf (--version|-v)
|
|
27
|
-
@salesforce/cli/2.35.
|
|
27
|
+
@salesforce/cli/2.35.3 linux-x64 node-v20.11.1
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -139,11 +139,11 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
139
139
|
- [`sf plugins`](#sf-plugins)
|
|
140
140
|
- [`sf plugins discover`](#sf-plugins-discover)
|
|
141
141
|
- [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
|
|
142
|
-
- [`sf plugins
|
|
143
|
-
- [`sf plugins
|
|
142
|
+
- [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin)
|
|
143
|
+
- [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin)
|
|
144
144
|
- [`sf plugins reset`](#sf-plugins-reset)
|
|
145
145
|
- [`sf plugins trust verify`](#sf-plugins-trust-verify)
|
|
146
|
-
- [`sf plugins
|
|
146
|
+
- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin)
|
|
147
147
|
- [`sf plugins update`](#sf-plugins-update)
|
|
148
148
|
- [`sf project convert mdapi`](#sf-project-convert-mdapi)
|
|
149
149
|
- [`sf project convert source`](#sf-project-convert-source)
|
|
@@ -201,7 +201,7 @@ EXAMPLES
|
|
|
201
201
|
$ sf alias list
|
|
202
202
|
```
|
|
203
203
|
|
|
204
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
204
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.32/src/commands/alias/list.ts)_
|
|
205
205
|
|
|
206
206
|
## `sf alias set`
|
|
207
207
|
|
|
@@ -249,7 +249,7 @@ EXAMPLES
|
|
|
249
249
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
250
250
|
```
|
|
251
251
|
|
|
252
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
252
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.32/src/commands/alias/set.ts)_
|
|
253
253
|
|
|
254
254
|
## `sf alias unset`
|
|
255
255
|
|
|
@@ -288,7 +288,7 @@ EXAMPLES
|
|
|
288
288
|
$ sf alias unset --all [--no-prompt]
|
|
289
289
|
```
|
|
290
290
|
|
|
291
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
291
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.32/src/commands/alias/unset.ts)_
|
|
292
292
|
|
|
293
293
|
## `sf analytics generate template`
|
|
294
294
|
|
|
@@ -855,7 +855,7 @@ DESCRIPTION
|
|
|
855
855
|
list all the commands
|
|
856
856
|
```
|
|
857
857
|
|
|
858
|
-
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/3.2.
|
|
858
|
+
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/3.2.1/src/commands/commands.ts)_
|
|
859
859
|
|
|
860
860
|
## `sf config get`
|
|
861
861
|
|
|
@@ -903,7 +903,7 @@ CONFIGURATION VARIABLES
|
|
|
903
903
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
904
904
|
```
|
|
905
905
|
|
|
906
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
906
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.32/src/commands/config/get.ts)_
|
|
907
907
|
|
|
908
908
|
## `sf config list`
|
|
909
909
|
|
|
@@ -942,7 +942,7 @@ EXAMPLES
|
|
|
942
942
|
$ sf config list
|
|
943
943
|
```
|
|
944
944
|
|
|
945
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
945
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.32/src/commands/config/list.ts)_
|
|
946
946
|
|
|
947
947
|
## `sf config set`
|
|
948
948
|
|
|
@@ -1010,7 +1010,7 @@ CONFIGURATION VARIABLES
|
|
|
1010
1010
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1011
1011
|
```
|
|
1012
1012
|
|
|
1013
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
1013
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.32/src/commands/config/set.ts)_
|
|
1014
1014
|
|
|
1015
1015
|
## `sf config unset`
|
|
1016
1016
|
|
|
@@ -1059,7 +1059,7 @@ CONFIGURATION VARIABLES
|
|
|
1059
1059
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1060
1060
|
```
|
|
1061
1061
|
|
|
1062
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.
|
|
1062
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.0.32/src/commands/config/unset.ts)_
|
|
1063
1063
|
|
|
1064
1064
|
## `sf data create record`
|
|
1065
1065
|
|
|
@@ -1067,7 +1067,7 @@ Create and insert a record into a Salesforce or Tooling API object.
|
|
|
1067
1067
|
|
|
1068
1068
|
```
|
|
1069
1069
|
USAGE
|
|
1070
|
-
$ sf data create record -o <value> -s <value> -v <value> [--json] [--api-version <value>] [-t]
|
|
1070
|
+
$ sf data create record -o <value> -s <value> -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t]
|
|
1071
1071
|
|
|
1072
1072
|
FLAGS
|
|
1073
1073
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -1080,7 +1080,8 @@ FLAGS
|
|
|
1080
1080
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1081
1081
|
|
|
1082
1082
|
GLOBAL FLAGS
|
|
1083
|
-
--
|
|
1083
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1084
|
+
--json Format output as json.
|
|
1084
1085
|
|
|
1085
1086
|
DESCRIPTION
|
|
1086
1087
|
Create and insert a record into a Salesforce or Tooling API object.
|
|
@@ -1114,7 +1115,7 @@ EXAMPLES
|
|
|
1114
1115
|
TracedEntityId=01p17000000R6bLAAS"
|
|
1115
1116
|
```
|
|
1116
1117
|
|
|
1117
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1118
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/create/record.ts)_
|
|
1118
1119
|
|
|
1119
1120
|
## `sf data delete bulk`
|
|
1120
1121
|
|
|
@@ -1122,7 +1123,8 @@ Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.
|
|
|
1122
1123
|
|
|
1123
1124
|
```
|
|
1124
1125
|
USAGE
|
|
1125
|
-
$ sf data delete bulk -o <value> -f <value> -s <value> [--json] [--
|
|
1126
|
+
$ sf data delete bulk -o <value> -f <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w
|
|
1127
|
+
<value> | -a] [--verbose]
|
|
1126
1128
|
|
|
1127
1129
|
FLAGS
|
|
1128
1130
|
-a, --async Run the command asynchronously.
|
|
@@ -1131,13 +1133,14 @@ FLAGS
|
|
|
1131
1133
|
configuration variable is already set.
|
|
1132
1134
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1133
1135
|
update or delete records from.
|
|
1134
|
-
-w, --wait=<value> [default:
|
|
1136
|
+
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1135
1137
|
displaying the results.
|
|
1136
1138
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1137
1139
|
--verbose Print verbose output of failed records if result is available.
|
|
1138
1140
|
|
|
1139
1141
|
GLOBAL FLAGS
|
|
1140
|
-
--
|
|
1142
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1143
|
+
--json Format output as json.
|
|
1141
1144
|
|
|
1142
1145
|
DESCRIPTION
|
|
1143
1146
|
Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.
|
|
@@ -1159,7 +1162,7 @@ EXAMPLES
|
|
|
1159
1162
|
$ sf data delete bulk --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1160
1163
|
```
|
|
1161
1164
|
|
|
1162
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1165
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/delete/bulk.ts)_
|
|
1163
1166
|
|
|
1164
1167
|
## `sf data delete record`
|
|
1165
1168
|
|
|
@@ -1167,7 +1170,8 @@ Deletes a single record from a Salesforce or Tooling API object.
|
|
|
1167
1170
|
|
|
1168
1171
|
```
|
|
1169
1172
|
USAGE
|
|
1170
|
-
$ sf data delete record -o <value> -s <value> [--json] [--
|
|
1173
|
+
$ sf data delete record -o <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-w
|
|
1174
|
+
<value>] [-t]
|
|
1171
1175
|
|
|
1172
1176
|
FLAGS
|
|
1173
1177
|
-i, --record-id=<value> ID of the record you’re deleting.
|
|
@@ -1180,7 +1184,8 @@ FLAGS
|
|
|
1180
1184
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1181
1185
|
|
|
1182
1186
|
GLOBAL FLAGS
|
|
1183
|
-
--
|
|
1187
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1188
|
+
--json Format output as json.
|
|
1184
1189
|
|
|
1185
1190
|
DESCRIPTION
|
|
1186
1191
|
Deletes a single record from a Salesforce or Tooling API object.
|
|
@@ -1218,7 +1223,7 @@ EXAMPLES
|
|
|
1218
1223
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1219
1224
|
```
|
|
1220
1225
|
|
|
1221
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1226
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/delete/record.ts)_
|
|
1222
1227
|
|
|
1223
1228
|
## `sf data delete resume`
|
|
1224
1229
|
|
|
@@ -1226,19 +1231,20 @@ Resume a bulk delete job that you previously started. Uses Bulk API 2.0.
|
|
|
1226
1231
|
|
|
1227
1232
|
```
|
|
1228
1233
|
USAGE
|
|
1229
|
-
$ sf data delete resume [--json] [-o <value>] [--use-most-recent | -i <value>] [--wait <value>]
|
|
1230
|
-
|
|
1234
|
+
$ sf data delete resume [--json] [--flags-dir <value>] [-o <value>] [--use-most-recent | -i <value>] [--wait <value>]
|
|
1235
|
+
[--api-version <value>]
|
|
1231
1236
|
|
|
1232
1237
|
FLAGS
|
|
1233
1238
|
-i, --job-id=<value> ID of the job you want to resume.
|
|
1234
1239
|
-o, --target-org=<value>
|
|
1235
1240
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1236
1241
|
--use-most-recent Use the ID of the most recently-run bulk job.
|
|
1237
|
-
--wait=<value> [default:
|
|
1242
|
+
--wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1238
1243
|
displaying the results.
|
|
1239
1244
|
|
|
1240
1245
|
GLOBAL FLAGS
|
|
1241
|
-
--
|
|
1246
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1247
|
+
--json Format output as json.
|
|
1242
1248
|
|
|
1243
1249
|
DESCRIPTION
|
|
1244
1250
|
Resume a bulk delete job that you previously started. Uses Bulk API 2.0.
|
|
@@ -1255,7 +1261,7 @@ EXAMPLES
|
|
|
1255
1261
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
1256
1262
|
```
|
|
1257
1263
|
|
|
1258
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1264
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/delete/resume.ts)_
|
|
1259
1265
|
|
|
1260
1266
|
## `sf data export beta tree`
|
|
1261
1267
|
|
|
@@ -1263,7 +1269,8 @@ Export data from an org into one or more JSON files.
|
|
|
1263
1269
|
|
|
1264
1270
|
```
|
|
1265
1271
|
USAGE
|
|
1266
|
-
$ sf data export beta tree -o <value> -q <value> [--json] [--api-version <value>] [-p] [-x <value>]
|
|
1272
|
+
$ sf data export beta tree -o <value> -q <value> [--json] [--flags-dir <value>] [--api-version <value>] [-p] [-x <value>]
|
|
1273
|
+
[-d <value>]
|
|
1267
1274
|
|
|
1268
1275
|
FLAGS
|
|
1269
1276
|
-d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
|
|
@@ -1275,7 +1282,8 @@ FLAGS
|
|
|
1275
1282
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1276
1283
|
|
|
1277
1284
|
GLOBAL FLAGS
|
|
1278
|
-
--
|
|
1285
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1286
|
+
--json Format output as json.
|
|
1279
1287
|
|
|
1280
1288
|
DESCRIPTION
|
|
1281
1289
|
Export data from an org into one or more JSON files.
|
|
@@ -1311,7 +1319,7 @@ EXAMPLES
|
|
|
1311
1319
|
my-scratch
|
|
1312
1320
|
```
|
|
1313
1321
|
|
|
1314
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1322
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/export/beta/tree.ts)_
|
|
1315
1323
|
|
|
1316
1324
|
## `sf data export tree`
|
|
1317
1325
|
|
|
@@ -1319,7 +1327,8 @@ Export data from an org into one or more JSON files.
|
|
|
1319
1327
|
|
|
1320
1328
|
```
|
|
1321
1329
|
USAGE
|
|
1322
|
-
$ sf data export tree -o <value> -q <value> [--json] [--api-version <value>] [-p] [-x <value>]
|
|
1330
|
+
$ sf data export tree -o <value> -q <value> [--json] [--flags-dir <value>] [--api-version <value>] [-p] [-x <value>]
|
|
1331
|
+
[-d <value>]
|
|
1323
1332
|
|
|
1324
1333
|
FLAGS
|
|
1325
1334
|
-d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
|
|
@@ -1331,7 +1340,8 @@ FLAGS
|
|
|
1331
1340
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1332
1341
|
|
|
1333
1342
|
GLOBAL FLAGS
|
|
1334
|
-
--
|
|
1343
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1344
|
+
--json Format output as json.
|
|
1335
1345
|
|
|
1336
1346
|
DESCRIPTION
|
|
1337
1347
|
Export data from an org into one or more JSON files.
|
|
@@ -1369,7 +1379,7 @@ EXAMPLES
|
|
|
1369
1379
|
my-scratch
|
|
1370
1380
|
```
|
|
1371
1381
|
|
|
1372
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1382
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/export/tree.ts)_
|
|
1373
1383
|
|
|
1374
1384
|
## `sf data get record`
|
|
1375
1385
|
|
|
@@ -1377,7 +1387,8 @@ Retrieve and display a single record of a Salesforce or Tooling API object.
|
|
|
1377
1387
|
|
|
1378
1388
|
```
|
|
1379
1389
|
USAGE
|
|
1380
|
-
$ sf data get record -o <value> -s <value> [--json] [--
|
|
1390
|
+
$ sf data get record -o <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-w
|
|
1391
|
+
<value>] [-t]
|
|
1381
1392
|
|
|
1382
1393
|
FLAGS
|
|
1383
1394
|
-i, --record-id=<value> ID of the record you’re retrieving.
|
|
@@ -1390,7 +1401,8 @@ FLAGS
|
|
|
1390
1401
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1391
1402
|
|
|
1392
1403
|
GLOBAL FLAGS
|
|
1393
|
-
--
|
|
1404
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1405
|
+
--json Format output as json.
|
|
1394
1406
|
|
|
1395
1407
|
DESCRIPTION
|
|
1396
1408
|
Retrieve and display a single record of a Salesforce or Tooling API object.
|
|
@@ -1431,7 +1443,7 @@ EXAMPLES
|
|
|
1431
1443
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1432
1444
|
```
|
|
1433
1445
|
|
|
1434
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1446
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/get/record.ts)_
|
|
1435
1447
|
|
|
1436
1448
|
## `sf data import beta tree`
|
|
1437
1449
|
|
|
@@ -1439,7 +1451,7 @@ Import data from one or more JSON files into an org.
|
|
|
1439
1451
|
|
|
1440
1452
|
```
|
|
1441
1453
|
USAGE
|
|
1442
|
-
$ sf data import beta tree -o <value> [--json] [--api-version <value>] [-f <value>] [-p <value>]
|
|
1454
|
+
$ sf data import beta tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>] [-p <value>]
|
|
1443
1455
|
|
|
1444
1456
|
FLAGS
|
|
1445
1457
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -1450,7 +1462,8 @@ FLAGS
|
|
|
1450
1462
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1451
1463
|
|
|
1452
1464
|
GLOBAL FLAGS
|
|
1453
|
-
--
|
|
1465
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1466
|
+
--json Format output as json.
|
|
1454
1467
|
|
|
1455
1468
|
DESCRIPTION
|
|
1456
1469
|
Import data from one or more JSON files into an org.
|
|
@@ -1473,7 +1486,7 @@ EXAMPLES
|
|
|
1473
1486
|
$ sf data import beta tree --plan Account-Contact-plan.json
|
|
1474
1487
|
```
|
|
1475
1488
|
|
|
1476
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1489
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/import/beta/tree.ts)_
|
|
1477
1490
|
|
|
1478
1491
|
## `sf data import tree`
|
|
1479
1492
|
|
|
@@ -1481,7 +1494,7 @@ Import data from one or more JSON files into an org.
|
|
|
1481
1494
|
|
|
1482
1495
|
```
|
|
1483
1496
|
USAGE
|
|
1484
|
-
$ sf data import tree -o <value> [--json] [--api-version <value>] [-f <value> | -p <value>]
|
|
1497
|
+
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value> | -p <value>]
|
|
1485
1498
|
|
|
1486
1499
|
FLAGS
|
|
1487
1500
|
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
|
|
@@ -1492,7 +1505,8 @@ FLAGS
|
|
|
1492
1505
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1493
1506
|
|
|
1494
1507
|
GLOBAL FLAGS
|
|
1495
|
-
--
|
|
1508
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1509
|
+
--json Format output as json.
|
|
1496
1510
|
|
|
1497
1511
|
DESCRIPTION
|
|
1498
1512
|
Import data from one or more JSON files into an org.
|
|
@@ -1522,7 +1536,7 @@ EXAMPLES
|
|
|
1522
1536
|
$ sf data import tree --plan Account-Contact-plan.json
|
|
1523
1537
|
```
|
|
1524
1538
|
|
|
1525
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1539
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/import/tree.ts)_
|
|
1526
1540
|
|
|
1527
1541
|
## `sf data query`
|
|
1528
1542
|
|
|
@@ -1530,8 +1544,8 @@ Execute a SOQL query.
|
|
|
1530
1544
|
|
|
1531
1545
|
```
|
|
1532
1546
|
USAGE
|
|
1533
|
-
$ sf data query -o <value> [--json] [--
|
|
1534
|
-
[--async ] [--all-rows] [-r human|csv|json]
|
|
1547
|
+
$ sf data query -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-q <value>] [-f <value>]
|
|
1548
|
+
[-t | -b] [-w <value> ] [--async ] [--all-rows] [-r human|csv|json]
|
|
1535
1549
|
|
|
1536
1550
|
FLAGS
|
|
1537
1551
|
-b, --bulk Use Bulk API 2.0 to run the query.
|
|
@@ -1548,7 +1562,8 @@ FLAGS
|
|
|
1548
1562
|
--async Use Bulk API 2.0, but don't wait for the job to complete.
|
|
1549
1563
|
|
|
1550
1564
|
GLOBAL FLAGS
|
|
1551
|
-
--
|
|
1565
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1566
|
+
--json Format output as json.
|
|
1552
1567
|
|
|
1553
1568
|
DESCRIPTION
|
|
1554
1569
|
Execute a SOQL query.
|
|
@@ -1585,7 +1600,7 @@ EXAMPLES
|
|
|
1585
1600
|
$ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
|
|
1586
1601
|
```
|
|
1587
1602
|
|
|
1588
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1603
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/query.ts)_
|
|
1589
1604
|
|
|
1590
1605
|
## `sf data query resume`
|
|
1591
1606
|
|
|
@@ -1593,8 +1608,8 @@ View the status of a bulk query.
|
|
|
1593
1608
|
|
|
1594
1609
|
```
|
|
1595
1610
|
USAGE
|
|
1596
|
-
$ sf data query resume [--json] [-o <value>] [--api-version <value>] [-r human|csv|json] [-i
|
|
1597
|
-
[--use-most-recent]
|
|
1611
|
+
$ sf data query resume [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>] [-r human|csv|json] [-i
|
|
1612
|
+
<value>] [--use-most-recent]
|
|
1598
1613
|
|
|
1599
1614
|
FLAGS
|
|
1600
1615
|
-i, --bulk-query-id=<value> Job ID of the bulk query.
|
|
@@ -1605,7 +1620,8 @@ FLAGS
|
|
|
1605
1620
|
--use-most-recent Use the most recent bulk query ID from cache.
|
|
1606
1621
|
|
|
1607
1622
|
GLOBAL FLAGS
|
|
1608
|
-
--
|
|
1623
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1624
|
+
--json Format output as json.
|
|
1609
1625
|
|
|
1610
1626
|
DESCRIPTION
|
|
1611
1627
|
View the status of a bulk query.
|
|
@@ -1621,7 +1637,7 @@ EXAMPLES
|
|
|
1621
1637
|
$ sf data query resume --bulk-query-id 7500x000005BdFzXXX
|
|
1622
1638
|
```
|
|
1623
1639
|
|
|
1624
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1640
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/query/resume.ts)_
|
|
1625
1641
|
|
|
1626
1642
|
## `sf data resume`
|
|
1627
1643
|
|
|
@@ -1629,7 +1645,7 @@ View the status of a bulk data load job or batch.
|
|
|
1629
1645
|
|
|
1630
1646
|
```
|
|
1631
1647
|
USAGE
|
|
1632
|
-
$ sf data resume -o <value> -i <value> [--json] [--api-version <value>] [-b <value>]
|
|
1648
|
+
$ sf data resume -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-b <value>]
|
|
1633
1649
|
|
|
1634
1650
|
FLAGS
|
|
1635
1651
|
-b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
|
|
@@ -1639,7 +1655,8 @@ FLAGS
|
|
|
1639
1655
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1640
1656
|
|
|
1641
1657
|
GLOBAL FLAGS
|
|
1642
|
-
--
|
|
1658
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1659
|
+
--json Format output as json.
|
|
1643
1660
|
|
|
1644
1661
|
DESCRIPTION
|
|
1645
1662
|
View the status of a bulk data load job or batch.
|
|
@@ -1657,7 +1674,7 @@ EXAMPLES
|
|
|
1657
1674
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
1658
1675
|
```
|
|
1659
1676
|
|
|
1660
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1677
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/resume.ts)_
|
|
1661
1678
|
|
|
1662
1679
|
## `sf data update record`
|
|
1663
1680
|
|
|
@@ -1665,8 +1682,8 @@ Updates a single record of a Salesforce or Tooling API object.
|
|
|
1665
1682
|
|
|
1666
1683
|
```
|
|
1667
1684
|
USAGE
|
|
1668
|
-
$ sf data update record -o <value> -s <value> -v <value> [--json] [--
|
|
1669
|
-
[-t]
|
|
1685
|
+
$ sf data update record -o <value> -s <value> -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i
|
|
1686
|
+
<value>] [-w <value>] [-t]
|
|
1670
1687
|
|
|
1671
1688
|
FLAGS
|
|
1672
1689
|
-i, --record-id=<value> ID of the record you’re updating.
|
|
@@ -1680,7 +1697,8 @@ FLAGS
|
|
|
1680
1697
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1681
1698
|
|
|
1682
1699
|
GLOBAL FLAGS
|
|
1683
|
-
--
|
|
1700
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1701
|
+
--json Format output as json.
|
|
1684
1702
|
|
|
1685
1703
|
DESCRIPTION
|
|
1686
1704
|
Updates a single record of a Salesforce or Tooling API object.
|
|
@@ -1718,7 +1736,7 @@ EXAMPLES
|
|
|
1718
1736
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
1719
1737
|
```
|
|
1720
1738
|
|
|
1721
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1739
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/update/record.ts)_
|
|
1722
1740
|
|
|
1723
1741
|
## `sf data upsert bulk`
|
|
1724
1742
|
|
|
@@ -1726,8 +1744,8 @@ Bulk upsert records to an org from a CSV file. Uses Bulk API 2.0.
|
|
|
1726
1744
|
|
|
1727
1745
|
```
|
|
1728
1746
|
USAGE
|
|
1729
|
-
$ sf data upsert bulk -o <value> -f <value> -s <value> -i <value> [--json] [--
|
|
1730
|
-
[--verbose]
|
|
1747
|
+
$ sf data upsert bulk -o <value> -f <value> -s <value> -i <value> [--json] [--flags-dir <value>] [--api-version
|
|
1748
|
+
<value>] [-w <value> | -a] [--verbose]
|
|
1731
1749
|
|
|
1732
1750
|
FLAGS
|
|
1733
1751
|
-a, --async Run the command asynchronously.
|
|
@@ -1737,13 +1755,14 @@ FLAGS
|
|
|
1737
1755
|
configuration variable is already set.
|
|
1738
1756
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1739
1757
|
update or delete records from.
|
|
1740
|
-
-w, --wait=<value> [default:
|
|
1758
|
+
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1741
1759
|
displaying the results.
|
|
1742
1760
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1743
1761
|
--verbose Print verbose output of failed records if result is available.
|
|
1744
1762
|
|
|
1745
1763
|
GLOBAL FLAGS
|
|
1746
|
-
--
|
|
1764
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1765
|
+
--json Format output as json.
|
|
1747
1766
|
|
|
1748
1767
|
DESCRIPTION
|
|
1749
1768
|
Bulk upsert records to an org from a CSV file. Uses Bulk API 2.0.
|
|
@@ -1770,7 +1789,7 @@ EXAMPLES
|
|
|
1770
1789
|
my-scratch
|
|
1771
1790
|
```
|
|
1772
1791
|
|
|
1773
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1792
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/upsert/bulk.ts)_
|
|
1774
1793
|
|
|
1775
1794
|
## `sf data upsert resume`
|
|
1776
1795
|
|
|
@@ -1778,19 +1797,20 @@ Resume a bulk upsert job that you previously started. Uses Bulk API 2.0.
|
|
|
1778
1797
|
|
|
1779
1798
|
```
|
|
1780
1799
|
USAGE
|
|
1781
|
-
$ sf data upsert resume [--json] [-o <value>] [--use-most-recent | -i <value>] [--wait <value>]
|
|
1782
|
-
|
|
1800
|
+
$ sf data upsert resume [--json] [--flags-dir <value>] [-o <value>] [--use-most-recent | -i <value>] [--wait <value>]
|
|
1801
|
+
[--api-version <value>]
|
|
1783
1802
|
|
|
1784
1803
|
FLAGS
|
|
1785
1804
|
-i, --job-id=<value> ID of the job you want to resume.
|
|
1786
1805
|
-o, --target-org=<value>
|
|
1787
1806
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1788
1807
|
--use-most-recent Use the ID of the most recently-run bulk job.
|
|
1789
|
-
--wait=<value> [default:
|
|
1808
|
+
--wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1790
1809
|
displaying the results.
|
|
1791
1810
|
|
|
1792
1811
|
GLOBAL FLAGS
|
|
1793
|
-
--
|
|
1812
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1813
|
+
--json Format output as json.
|
|
1794
1814
|
|
|
1795
1815
|
DESCRIPTION
|
|
1796
1816
|
Resume a bulk upsert job that you previously started. Uses Bulk API 2.0.
|
|
@@ -1807,7 +1827,7 @@ EXAMPLES
|
|
|
1807
1827
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
1808
1828
|
```
|
|
1809
1829
|
|
|
1810
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1830
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/data/upsert/resume.ts)_
|
|
1811
1831
|
|
|
1812
1832
|
## `sf doctor`
|
|
1813
1833
|
|
|
@@ -1862,7 +1882,8 @@ Bulk delete records from an org using a CSV file. Uses Bulk API 1.0.
|
|
|
1862
1882
|
|
|
1863
1883
|
```
|
|
1864
1884
|
USAGE
|
|
1865
|
-
$ sf force data bulk delete -o <value> -f <value> -s <value> [--json] [--
|
|
1885
|
+
$ sf force data bulk delete -o <value> -f <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w
|
|
1886
|
+
<value>]
|
|
1866
1887
|
|
|
1867
1888
|
FLAGS
|
|
1868
1889
|
-f, --file=<value> (required) CSV file that contains the IDs of the records to delete.
|
|
@@ -1870,12 +1891,13 @@ FLAGS
|
|
|
1870
1891
|
configuration variable is already set.
|
|
1871
1892
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1872
1893
|
delete records from.
|
|
1873
|
-
-w, --wait=<value> [default:
|
|
1894
|
+
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1874
1895
|
displaying the results.
|
|
1875
1896
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1876
1897
|
|
|
1877
1898
|
GLOBAL FLAGS
|
|
1878
|
-
--
|
|
1899
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1900
|
+
--json Format output as json.
|
|
1879
1901
|
|
|
1880
1902
|
DESCRIPTION
|
|
1881
1903
|
Bulk delete records from an org using a CSV file. Uses Bulk API 1.0.
|
|
@@ -1899,7 +1921,7 @@ EXAMPLES
|
|
|
1899
1921
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
1900
1922
|
```
|
|
1901
1923
|
|
|
1902
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1924
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/force/data/bulk/delete.ts)_
|
|
1903
1925
|
|
|
1904
1926
|
## `sf force data bulk status`
|
|
1905
1927
|
|
|
@@ -1907,7 +1929,7 @@ View the status of a bulk data load job or batch. Uses Bulk API 1.0.
|
|
|
1907
1929
|
|
|
1908
1930
|
```
|
|
1909
1931
|
USAGE
|
|
1910
|
-
$ sf force data bulk status -o <value> -i <value> [--json] [--api-version <value>] [-b <value>]
|
|
1932
|
+
$ sf force data bulk status -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-b <value>]
|
|
1911
1933
|
|
|
1912
1934
|
FLAGS
|
|
1913
1935
|
-b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
|
|
@@ -1917,7 +1939,8 @@ FLAGS
|
|
|
1917
1939
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1918
1940
|
|
|
1919
1941
|
GLOBAL FLAGS
|
|
1920
|
-
--
|
|
1942
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1943
|
+
--json Format output as json.
|
|
1921
1944
|
|
|
1922
1945
|
DESCRIPTION
|
|
1923
1946
|
View the status of a bulk data load job or batch. Uses Bulk API 1.0.
|
|
@@ -1935,7 +1958,7 @@ EXAMPLES
|
|
|
1935
1958
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
1936
1959
|
```
|
|
1937
1960
|
|
|
1938
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
1961
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/force/data/bulk/status.ts)_
|
|
1939
1962
|
|
|
1940
1963
|
## `sf force data bulk upsert`
|
|
1941
1964
|
|
|
@@ -1943,8 +1966,8 @@ Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.
|
|
|
1943
1966
|
|
|
1944
1967
|
```
|
|
1945
1968
|
USAGE
|
|
1946
|
-
$ sf force data bulk upsert -o <value> -i <value> -f <value> -s <value> [--json] [--
|
|
1947
|
-
|
|
1969
|
+
$ sf force data bulk upsert -o <value> -i <value> -f <value> -s <value> [--json] [--flags-dir <value>] [--api-version
|
|
1970
|
+
<value>] [-w <value>] [-r]
|
|
1948
1971
|
|
|
1949
1972
|
FLAGS
|
|
1950
1973
|
-f, --file=<value> (required) CSV file that contains the records to upsert.
|
|
@@ -1954,12 +1977,13 @@ FLAGS
|
|
|
1954
1977
|
-r, --serial Run batches in serial mode.
|
|
1955
1978
|
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
|
|
1956
1979
|
upsert records to.
|
|
1957
|
-
-w, --wait=<value> [default:
|
|
1980
|
+
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
|
|
1958
1981
|
displaying the results.
|
|
1959
1982
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1960
1983
|
|
|
1961
1984
|
GLOBAL FLAGS
|
|
1962
|
-
--
|
|
1985
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1986
|
+
--json Format output as json.
|
|
1963
1987
|
|
|
1964
1988
|
DESCRIPTION
|
|
1965
1989
|
Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.
|
|
@@ -1992,7 +2016,7 @@ EXAMPLES
|
|
|
1992
2016
|
--target-org my-scratch
|
|
1993
2017
|
```
|
|
1994
2018
|
|
|
1995
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.
|
|
2019
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.2.1/src/commands/force/data/bulk/upsert.ts)_
|
|
1996
2020
|
|
|
1997
2021
|
## `sf help [COMMAND]`
|
|
1998
2022
|
|
|
@@ -3173,7 +3197,7 @@ EXAMPLES
|
|
|
3173
3197
|
$ sf org list auth
|
|
3174
3198
|
```
|
|
3175
3199
|
|
|
3176
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3200
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/list/auth.ts)_
|
|
3177
3201
|
|
|
3178
3202
|
## `sf org list limits`
|
|
3179
3203
|
|
|
@@ -3466,7 +3490,7 @@ FLAG DESCRIPTIONS
|
|
|
3466
3490
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3467
3491
|
```
|
|
3468
3492
|
|
|
3469
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3493
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/access-token.ts)_
|
|
3470
3494
|
|
|
3471
3495
|
## `sf org login device`
|
|
3472
3496
|
|
|
@@ -3525,7 +3549,7 @@ FLAG DESCRIPTIONS
|
|
|
3525
3549
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3526
3550
|
```
|
|
3527
3551
|
|
|
3528
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3552
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/device.ts)_
|
|
3529
3553
|
|
|
3530
3554
|
## `sf org login jwt`
|
|
3531
3555
|
|
|
@@ -3614,7 +3638,7 @@ FLAG DESCRIPTIONS
|
|
|
3614
3638
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3615
3639
|
```
|
|
3616
3640
|
|
|
3617
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3641
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/jwt.ts)_
|
|
3618
3642
|
|
|
3619
3643
|
## `sf org login sfdx-url`
|
|
3620
3644
|
|
|
@@ -3679,7 +3703,7 @@ EXAMPLES
|
|
|
3679
3703
|
$ echo url | sf org login sfdx-url --sfdx-url-stdin
|
|
3680
3704
|
```
|
|
3681
3705
|
|
|
3682
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3706
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/sfdx-url.ts)_
|
|
3683
3707
|
|
|
3684
3708
|
## `sf org login web`
|
|
3685
3709
|
|
|
@@ -3764,7 +3788,7 @@ FLAG DESCRIPTIONS
|
|
|
3764
3788
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3765
3789
|
```
|
|
3766
3790
|
|
|
3767
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3791
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/login/web.ts)_
|
|
3768
3792
|
|
|
3769
3793
|
## `sf org logout`
|
|
3770
3794
|
|
|
@@ -3824,7 +3848,7 @@ FLAG DESCRIPTIONS
|
|
|
3824
3848
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
3825
3849
|
```
|
|
3826
3850
|
|
|
3827
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.
|
|
3851
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.27/src/commands/org/logout.ts)_
|
|
3828
3852
|
|
|
3829
3853
|
## `sf org open`
|
|
3830
3854
|
|
|
@@ -5275,7 +5299,7 @@ EXAMPLES
|
|
|
5275
5299
|
$ sf plugins
|
|
5276
5300
|
```
|
|
5277
5301
|
|
|
5278
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
5302
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.8/src/commands/plugins/index.ts)_
|
|
5279
5303
|
|
|
5280
5304
|
## `sf plugins discover`
|
|
5281
5305
|
|
|
@@ -5319,64 +5343,59 @@ EXAMPLES
|
|
|
5319
5343
|
$ sf plugins inspect @salesforce/plugin-packaging
|
|
5320
5344
|
```
|
|
5321
5345
|
|
|
5322
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
5346
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.8/src/commands/plugins/inspect.ts)_
|
|
5323
5347
|
|
|
5324
|
-
## `sf plugins
|
|
5348
|
+
## `sf plugins:install PLUGIN...`
|
|
5325
5349
|
|
|
5326
|
-
Installs a plugin into
|
|
5350
|
+
Installs a plugin into the CLI.
|
|
5327
5351
|
|
|
5328
5352
|
```
|
|
5329
5353
|
USAGE
|
|
5330
|
-
$ sf plugins install PLUGIN...
|
|
5354
|
+
$ sf plugins install PLUGIN...
|
|
5331
5355
|
|
|
5332
5356
|
ARGUMENTS
|
|
5333
5357
|
PLUGIN... Plugin to install.
|
|
5334
5358
|
|
|
5335
5359
|
FLAGS
|
|
5336
|
-
-f, --force
|
|
5360
|
+
-f, --force Run yarn install with force flag.
|
|
5337
5361
|
-h, --help Show CLI help.
|
|
5338
|
-
-s, --silent Silences
|
|
5339
|
-
-v, --verbose Show verbose
|
|
5362
|
+
-s, --silent Silences yarn output.
|
|
5363
|
+
-v, --verbose Show verbose yarn output.
|
|
5340
5364
|
|
|
5341
5365
|
GLOBAL FLAGS
|
|
5342
5366
|
--json Format output as json.
|
|
5343
5367
|
|
|
5344
5368
|
DESCRIPTION
|
|
5345
|
-
Installs a plugin into
|
|
5346
|
-
|
|
5347
|
-
Uses bundled npm executable to install plugins into /home/runner/.local/share/sf
|
|
5369
|
+
Installs a plugin into the CLI.
|
|
5370
|
+
Can be installed from npm or a git url.
|
|
5348
5371
|
|
|
5349
5372
|
Installation of a user-installed plugin will override a core plugin.
|
|
5350
5373
|
|
|
5351
|
-
|
|
5352
|
-
|
|
5374
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
5375
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
5376
|
+
the CLI without the need to patch and update the whole CLI.
|
|
5377
|
+
|
|
5353
5378
|
|
|
5354
5379
|
ALIASES
|
|
5355
5380
|
$ sf plugins add
|
|
5356
5381
|
|
|
5357
5382
|
EXAMPLES
|
|
5358
|
-
|
|
5359
|
-
|
|
5360
|
-
$ sf plugins install @salesforce/plugin-packaging
|
|
5383
|
+
$ sf plugins install @salesforce/plugin-packaging
|
|
5361
5384
|
|
|
5362
|
-
|
|
5385
|
+
$ sf plugins install https://github.com/someuser/someplugin
|
|
5363
5386
|
|
|
5364
|
-
|
|
5365
|
-
|
|
5366
|
-
Install a plugin from a github slug.
|
|
5367
|
-
|
|
5368
|
-
$ sf plugins install someuser/someplugin
|
|
5387
|
+
$ sf plugins install someuser/someplugin
|
|
5369
5388
|
```
|
|
5370
5389
|
|
|
5371
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
5390
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.8/src/commands/plugins/install.ts)_
|
|
5372
5391
|
|
|
5373
|
-
## `sf plugins
|
|
5392
|
+
## `sf plugins:link PLUGIN`
|
|
5374
5393
|
|
|
5375
5394
|
Links a plugin into the CLI for development.
|
|
5376
5395
|
|
|
5377
5396
|
```
|
|
5378
5397
|
USAGE
|
|
5379
|
-
$ sf plugins link
|
|
5398
|
+
$ sf plugins link PLUGIN
|
|
5380
5399
|
|
|
5381
5400
|
ARGUMENTS
|
|
5382
5401
|
PATH [default: .] path to plugin
|
|
@@ -5398,7 +5417,7 @@ EXAMPLES
|
|
|
5398
5417
|
$ sf plugins link @salesforce/plugin-packaging
|
|
5399
5418
|
```
|
|
5400
5419
|
|
|
5401
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
5420
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.8/src/commands/plugins/link.ts)_
|
|
5402
5421
|
|
|
5403
5422
|
## `sf plugins reset`
|
|
5404
5423
|
|
|
@@ -5413,7 +5432,7 @@ FLAGS
|
|
|
5413
5432
|
--reinstall Reinstall all plugins after uninstalling.
|
|
5414
5433
|
```
|
|
5415
5434
|
|
|
5416
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
5435
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.8/src/commands/plugins/reset.ts)_
|
|
5417
5436
|
|
|
5418
5437
|
## `sf plugins trust verify`
|
|
5419
5438
|
|
|
@@ -5443,13 +5462,13 @@ EXAMPLES
|
|
|
5443
5462
|
|
|
5444
5463
|
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.3.17/src/commands/plugins/trust/verify.ts)_
|
|
5445
5464
|
|
|
5446
|
-
## `sf plugins
|
|
5465
|
+
## `sf plugins:uninstall PLUGIN...`
|
|
5447
5466
|
|
|
5448
5467
|
Removes a plugin from the CLI.
|
|
5449
5468
|
|
|
5450
5469
|
```
|
|
5451
5470
|
USAGE
|
|
5452
|
-
$ sf plugins uninstall
|
|
5471
|
+
$ sf plugins uninstall PLUGIN...
|
|
5453
5472
|
|
|
5454
5473
|
ARGUMENTS
|
|
5455
5474
|
PLUGIN... plugin to uninstall
|
|
@@ -5469,7 +5488,7 @@ EXAMPLES
|
|
|
5469
5488
|
$ sf plugins uninstall @salesforce/plugin-packaging
|
|
5470
5489
|
```
|
|
5471
5490
|
|
|
5472
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
5491
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.8/src/commands/plugins/uninstall.ts)_
|
|
5473
5492
|
|
|
5474
5493
|
## `sf plugins update`
|
|
5475
5494
|
|
|
@@ -5487,7 +5506,7 @@ DESCRIPTION
|
|
|
5487
5506
|
Update installed plugins.
|
|
5488
5507
|
```
|
|
5489
5508
|
|
|
5490
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
5509
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.3.8/src/commands/plugins/update.ts)_
|
|
5491
5510
|
|
|
5492
5511
|
## `sf project convert mdapi`
|
|
5493
5512
|
|
|
@@ -5495,8 +5514,8 @@ Convert metadata retrieved via Metadata API into the source format used in Sales
|
|
|
5495
5514
|
|
|
5496
5515
|
```
|
|
5497
5516
|
USAGE
|
|
5498
|
-
$ sf project convert mdapi -r <value> [--json] [--
|
|
5499
|
-
|
|
5517
|
+
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value> |
|
|
5518
|
+
-x <value> | -m <value>]
|
|
5500
5519
|
|
|
5501
5520
|
FLAGS
|
|
5502
5521
|
-d, --output-dir=<value> Directory to store your files in after they’re converted to source format; can be an
|
|
@@ -5508,7 +5527,8 @@ FLAGS
|
|
|
5508
5527
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
5509
5528
|
|
|
5510
5529
|
GLOBAL FLAGS
|
|
5511
|
-
--
|
|
5530
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5531
|
+
--json Format output as json.
|
|
5512
5532
|
|
|
5513
5533
|
DESCRIPTION
|
|
5514
5534
|
Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.
|
|
@@ -5549,7 +5569,7 @@ FLAG DESCRIPTIONS
|
|
|
5549
5569
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5550
5570
|
```
|
|
5551
5571
|
|
|
5552
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5572
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/convert/mdapi.ts)_
|
|
5553
5573
|
|
|
5554
5574
|
## `sf project convert source`
|
|
5555
5575
|
|
|
@@ -5557,11 +5577,11 @@ Convert source-formatted files into metadata that you can deploy using Metadata
|
|
|
5557
5577
|
|
|
5558
5578
|
```
|
|
5559
5579
|
USAGE
|
|
5560
|
-
$ sf project convert source [--json] [--
|
|
5561
|
-
<value> | -m <value>]
|
|
5580
|
+
$ sf project convert source [--json] [--flags-dir <value>] [--api-version <value>] [-r <value>] [-d <value>] [-n <value>]
|
|
5581
|
+
[-p <value> | -x <value> | -m <value>]
|
|
5562
5582
|
|
|
5563
5583
|
FLAGS
|
|
5564
|
-
-d, --output-dir=<value> [default:
|
|
5584
|
+
-d, --output-dir=<value> [default: metadataPackage_1711162071503] Output directory to store the Metadata
|
|
5565
5585
|
API–formatted files in.
|
|
5566
5586
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
5567
5587
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -5572,7 +5592,8 @@ FLAGS
|
|
|
5572
5592
|
from sfdx-project.json
|
|
5573
5593
|
|
|
5574
5594
|
GLOBAL FLAGS
|
|
5575
|
-
--
|
|
5595
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5596
|
+
--json Format output as json.
|
|
5576
5597
|
|
|
5577
5598
|
DESCRIPTION
|
|
5578
5599
|
Convert source-formatted files into metadata that you can deploy using Metadata API.
|
|
@@ -5621,7 +5642,7 @@ FLAG DESCRIPTIONS
|
|
|
5621
5642
|
Override the api version used for api requests made by this command
|
|
5622
5643
|
```
|
|
5623
5644
|
|
|
5624
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5645
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/convert/source.ts)_
|
|
5625
5646
|
|
|
5626
5647
|
## `sf project delete source`
|
|
5627
5648
|
|
|
@@ -5629,9 +5650,9 @@ Delete source from your project and from a non-source-tracked org.
|
|
|
5629
5650
|
|
|
5630
5651
|
```
|
|
5631
5652
|
USAGE
|
|
5632
|
-
$ sf project delete source -o <value> [--json] [--
|
|
5633
|
-
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>] [-p <value>] [-f [-t |
|
|
5634
|
-
[--verbose]
|
|
5653
|
+
$ sf project delete source -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>] [--tests
|
|
5654
|
+
<value>] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>] [-p <value>] [-f [-t |
|
|
5655
|
+
-c]] [--verbose]
|
|
5635
5656
|
|
|
5636
5657
|
FLAGS
|
|
5637
5658
|
-c, --check-only Validate delete command but don't delete anything from the org or the local project.
|
|
@@ -5642,7 +5663,7 @@ FLAGS
|
|
|
5642
5663
|
-p, --source-dir=<value>... Source file paths to delete.
|
|
5643
5664
|
-r, --no-prompt Don't prompt for delete confirmation.
|
|
5644
5665
|
-t, --track-source If the delete succeeds, update the source tracking information.
|
|
5645
|
-
-w, --wait=<value>
|
|
5666
|
+
-w, --wait=<value> Number of minutes to wait for the command to finish.
|
|
5646
5667
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
5647
5668
|
--verbose Verbose output of the delete result.
|
|
5648
5669
|
|
|
@@ -5652,7 +5673,8 @@ TEST FLAGS
|
|
|
5652
5673
|
--tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
5653
5674
|
|
|
5654
5675
|
GLOBAL FLAGS
|
|
5655
|
-
--
|
|
5676
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5677
|
+
--json Format output as json.
|
|
5656
5678
|
|
|
5657
5679
|
DESCRIPTION
|
|
5658
5680
|
Delete source from your project and from a non-source-tracked org.
|
|
@@ -5760,7 +5782,7 @@ FLAG DESCRIPTIONS
|
|
|
5760
5782
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
5761
5783
|
```
|
|
5762
5784
|
|
|
5763
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5785
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/delete/source.ts)_
|
|
5764
5786
|
|
|
5765
5787
|
## `sf project delete tracking`
|
|
5766
5788
|
|
|
@@ -5768,7 +5790,7 @@ Delete all local source tracking information.
|
|
|
5768
5790
|
|
|
5769
5791
|
```
|
|
5770
5792
|
USAGE
|
|
5771
|
-
$ sf project delete tracking -o <value> [--json] [--api-version <value>] [-p]
|
|
5793
|
+
$ sf project delete tracking -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-p]
|
|
5772
5794
|
|
|
5773
5795
|
FLAGS
|
|
5774
5796
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -5777,7 +5799,8 @@ FLAGS
|
|
|
5777
5799
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
5778
5800
|
|
|
5779
5801
|
GLOBAL FLAGS
|
|
5780
|
-
--
|
|
5802
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5803
|
+
--json Format output as json.
|
|
5781
5804
|
|
|
5782
5805
|
DESCRIPTION
|
|
5783
5806
|
Delete all local source tracking information.
|
|
@@ -5796,7 +5819,7 @@ EXAMPLES
|
|
|
5796
5819
|
$ sf project delete tracking --target-org my-scratch
|
|
5797
5820
|
```
|
|
5798
5821
|
|
|
5799
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5822
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/delete/tracking.ts)_
|
|
5800
5823
|
|
|
5801
5824
|
## `sf project deploy cancel`
|
|
5802
5825
|
|
|
@@ -5804,7 +5827,7 @@ Cancel a deploy operation.
|
|
|
5804
5827
|
|
|
5805
5828
|
```
|
|
5806
5829
|
USAGE
|
|
5807
|
-
$ sf project deploy cancel [--json] [--async | -w <value>] [-i <value>] [-r]
|
|
5830
|
+
$ sf project deploy cancel [--json] [--flags-dir <value>] [--async | -w <value>] [-i <value>] [-r]
|
|
5808
5831
|
|
|
5809
5832
|
FLAGS
|
|
5810
5833
|
-i, --job-id=<value> Job ID of the deploy operation you want to cancel.
|
|
@@ -5813,7 +5836,8 @@ FLAGS
|
|
|
5813
5836
|
--async Run the command asynchronously.
|
|
5814
5837
|
|
|
5815
5838
|
GLOBAL FLAGS
|
|
5816
|
-
--
|
|
5839
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5840
|
+
--json Format output as json.
|
|
5817
5841
|
|
|
5818
5842
|
DESCRIPTION
|
|
5819
5843
|
Cancel a deploy operation.
|
|
@@ -5866,7 +5890,7 @@ FLAG DESCRIPTIONS
|
|
|
5866
5890
|
project deploy report".
|
|
5867
5891
|
```
|
|
5868
5892
|
|
|
5869
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5893
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/deploy/cancel.ts)_
|
|
5870
5894
|
|
|
5871
5895
|
## `sf project deploy preview`
|
|
5872
5896
|
|
|
@@ -5874,7 +5898,8 @@ Preview a deployment to see what will deploy to the org, the potential conflicts
|
|
|
5874
5898
|
|
|
5875
5899
|
```
|
|
5876
5900
|
USAGE
|
|
5877
|
-
$ sf project deploy preview -o <value> [--json] [-c] [-x <value> | -d <value> | -m <value>]
|
|
5901
|
+
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value> | -m <value>]
|
|
5902
|
+
[--concise]
|
|
5878
5903
|
|
|
5879
5904
|
FLAGS
|
|
5880
5905
|
-c, --ignore-conflicts Don't display conflicts in preview of the deployment.
|
|
@@ -5885,7 +5910,8 @@ FLAGS
|
|
|
5885
5910
|
--concise Show only the changes that will be deployed; omits files that are forceignored.
|
|
5886
5911
|
|
|
5887
5912
|
GLOBAL FLAGS
|
|
5888
|
-
--
|
|
5913
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5914
|
+
--json Format output as json.
|
|
5889
5915
|
|
|
5890
5916
|
DESCRIPTION
|
|
5891
5917
|
Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.
|
|
@@ -5950,7 +5976,7 @@ FLAG DESCRIPTIONS
|
|
|
5950
5976
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
5951
5977
|
```
|
|
5952
5978
|
|
|
5953
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
5979
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/deploy/preview.ts)_
|
|
5954
5980
|
|
|
5955
5981
|
## `sf project deploy quick`
|
|
5956
5982
|
|
|
@@ -5958,22 +5984,23 @@ Quickly deploy a validated deployment to an org.
|
|
|
5958
5984
|
|
|
5959
5985
|
```
|
|
5960
5986
|
USAGE
|
|
5961
|
-
$ sf project deploy quick [--json] [--async | -w <value>] [--concise | --verbose] [-i <value>] [-o
|
|
5962
|
-
<value>]
|
|
5987
|
+
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <value>] [--concise | --verbose] [-i <value>] [-o
|
|
5988
|
+
<value>] [-r] [-a <value>]
|
|
5963
5989
|
|
|
5964
5990
|
FLAGS
|
|
5965
5991
|
-a, --api-version=<value> Target API version for the deploy.
|
|
5966
5992
|
-i, --job-id=<value> Job ID of the deployment you want to quick deploy.
|
|
5967
5993
|
-o, --target-org=<value> Login username or alias for the target org.
|
|
5968
5994
|
-r, --use-most-recent Use the job ID of the most recently validated deployment.
|
|
5969
|
-
-w, --wait=<minutes> [default:
|
|
5970
|
-
|
|
5995
|
+
-w, --wait=<minutes> [default: 33 minutes] Number of minutes to wait for the command to complete and display
|
|
5996
|
+
results.
|
|
5971
5997
|
--async Run the command asynchronously.
|
|
5972
5998
|
--concise Show concise output of the deploy result.
|
|
5973
5999
|
--verbose Show verbose output of the deploy result.
|
|
5974
6000
|
|
|
5975
6001
|
GLOBAL FLAGS
|
|
5976
|
-
--
|
|
6002
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6003
|
+
--json Format output as json.
|
|
5977
6004
|
|
|
5978
6005
|
DESCRIPTION
|
|
5979
6006
|
Quickly deploy a validated deployment to an org.
|
|
@@ -6046,7 +6073,7 @@ ERROR CODES
|
|
|
6046
6073
|
Canceling (69) The deploy is being canceled.
|
|
6047
6074
|
```
|
|
6048
6075
|
|
|
6049
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6076
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/deploy/quick.ts)_
|
|
6050
6077
|
|
|
6051
6078
|
## `sf project deploy report`
|
|
6052
6079
|
|
|
@@ -6054,7 +6081,7 @@ Check or poll for the status of a deploy operation.
|
|
|
6054
6081
|
|
|
6055
6082
|
```
|
|
6056
6083
|
USAGE
|
|
6057
|
-
$ sf project deploy report [--json] [-o <value>] [-i <value>] [-r] [--coverage-formatters
|
|
6084
|
+
$ sf project deploy report [--json] [--flags-dir <value>] [-o <value>] [-i <value>] [-r] [--coverage-formatters
|
|
6058
6085
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir
|
|
6059
6086
|
<value>] [-w <value>]
|
|
6060
6087
|
|
|
@@ -6072,7 +6099,8 @@ TEST FLAGS
|
|
|
6072
6099
|
--results-dir=<value> Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
6073
6100
|
|
|
6074
6101
|
GLOBAL FLAGS
|
|
6075
|
-
--
|
|
6102
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6103
|
+
--json Format output as json.
|
|
6076
6104
|
|
|
6077
6105
|
DESCRIPTION
|
|
6078
6106
|
Check or poll for the status of a deploy operation.
|
|
@@ -6141,7 +6169,7 @@ FLAG DESCRIPTIONS
|
|
|
6141
6169
|
--coverage-formatters lcov --coverage-formatters clover
|
|
6142
6170
|
```
|
|
6143
6171
|
|
|
6144
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6172
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/deploy/report.ts)_
|
|
6145
6173
|
|
|
6146
6174
|
## `sf project deploy resume`
|
|
6147
6175
|
|
|
@@ -6149,9 +6177,9 @@ Resume watching a deploy operation and update source tracking when the deploy co
|
|
|
6149
6177
|
|
|
6150
6178
|
```
|
|
6151
6179
|
USAGE
|
|
6152
|
-
$ sf project deploy resume [--json] [--concise | --verbose] [-i <value>] [-r] [-w <value>]
|
|
6153
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6154
|
-
<value>]
|
|
6180
|
+
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <value>]
|
|
6181
|
+
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6182
|
+
[--junit] [--results-dir <value>]
|
|
6155
6183
|
|
|
6156
6184
|
FLAGS
|
|
6157
6185
|
-i, --job-id=<value> Job ID of the deploy operation you want to resume.
|
|
@@ -6168,7 +6196,8 @@ TEST FLAGS
|
|
|
6168
6196
|
--results-dir=<value> Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
6169
6197
|
|
|
6170
6198
|
GLOBAL FLAGS
|
|
6171
|
-
--
|
|
6199
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6200
|
+
--json Format output as json.
|
|
6172
6201
|
|
|
6173
6202
|
DESCRIPTION
|
|
6174
6203
|
Resume watching a deploy operation and update source tracking when the deploy completes.
|
|
@@ -6237,7 +6266,7 @@ ERROR CODES
|
|
|
6237
6266
|
Canceling (69) The deploy is being canceled.
|
|
6238
6267
|
```
|
|
6239
6268
|
|
|
6240
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6269
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/deploy/resume.ts)_
|
|
6241
6270
|
|
|
6242
6271
|
## `sf project deploy start`
|
|
6243
6272
|
|
|
@@ -6245,12 +6274,12 @@ Deploy metadata to an org from your local project.
|
|
|
6245
6274
|
|
|
6246
6275
|
```
|
|
6247
6276
|
USAGE
|
|
6248
|
-
$ sf project deploy start -o <value> [--json] [-a <value>] [--async | -w <value>] [--concise |
|
|
6249
|
-
[-c] [-r] [-g] [--single-package ] [-t <value>] [-l
|
|
6250
|
-
[--purge-on-delete [-x <value> | -d <value> | -m <value>
|
|
6251
|
-
<value>
|
|
6252
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6253
|
-
<value>]
|
|
6277
|
+
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <value>] [--concise |
|
|
6278
|
+
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value>] [-l
|
|
6279
|
+
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value> | -m <value>
|
|
6280
|
+
| --metadata-dir <value>]] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6281
|
+
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary]
|
|
6282
|
+
[--junit] [--results-dir <value>]
|
|
6254
6283
|
|
|
6255
6284
|
FLAGS
|
|
6256
6285
|
-a, --api-version=<value> Target API version for the deploy.
|
|
@@ -6258,8 +6287,7 @@ FLAGS
|
|
|
6258
6287
|
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
6259
6288
|
-o, --target-org=<value> (required) Login username or alias for the target org.
|
|
6260
6289
|
-r, --ignore-errors Ignore any errors and don’t roll back deployment.
|
|
6261
|
-
-w, --wait=<minutes>
|
|
6262
|
-
results.
|
|
6290
|
+
-w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
|
|
6263
6291
|
--async Run the command asynchronously.
|
|
6264
6292
|
--concise Show concise output of the deploy result.
|
|
6265
6293
|
--dry-run Validate deploy and run Apex tests but don’t save to the org.
|
|
@@ -6283,7 +6311,8 @@ TEST FLAGS
|
|
|
6283
6311
|
ID.
|
|
6284
6312
|
|
|
6285
6313
|
GLOBAL FLAGS
|
|
6286
|
-
--
|
|
6314
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6315
|
+
--json Format output as json.
|
|
6287
6316
|
|
|
6288
6317
|
METADATA API FORMAT FLAGS
|
|
6289
6318
|
--metadata-dir=<value> Root of directory or zip file of metadata formatted files to deploy.
|
|
@@ -6475,7 +6504,7 @@ ERROR CODES
|
|
|
6475
6504
|
Canceling (69) The deploy is being canceled.
|
|
6476
6505
|
```
|
|
6477
6506
|
|
|
6478
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6507
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/deploy/start.ts)_
|
|
6479
6508
|
|
|
6480
6509
|
## `sf project deploy validate`
|
|
6481
6510
|
|
|
@@ -6483,9 +6512,9 @@ Validate a metadata deployment without actually executing it.
|
|
|
6483
6512
|
|
|
6484
6513
|
```
|
|
6485
6514
|
USAGE
|
|
6486
|
-
$ sf project deploy validate -o <value> [--json] [-a <value>] [--async] [--concise | --verbose] [-m
|
|
6487
|
-
[--single-package --metadata-dir <value>] [-t <value>] [-l
|
|
6488
|
-
<value>] [-g] [--coverage-formatters
|
|
6515
|
+
$ sf project deploy validate -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [--concise | --verbose] [-m
|
|
6516
|
+
<value>] [-d <value>] [--single-package --metadata-dir <value>] [-t <value>] [-l
|
|
6517
|
+
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <value>] [-g] [--coverage-formatters
|
|
6489
6518
|
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir
|
|
6490
6519
|
<value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ]
|
|
6491
6520
|
|
|
@@ -6493,8 +6522,7 @@ FLAGS
|
|
|
6493
6522
|
-a, --api-version=<value> Target API version for the validation.
|
|
6494
6523
|
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
6495
6524
|
-o, --target-org=<value> (required) Login username or alias for the target org.
|
|
6496
|
-
-w, --wait=<minutes>
|
|
6497
|
-
display results.
|
|
6525
|
+
-w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
|
|
6498
6526
|
--async Run the command asynchronously.
|
|
6499
6527
|
--concise Show concise output of the validation result.
|
|
6500
6528
|
--verbose Show verbose output of the validation result.
|
|
@@ -6516,7 +6544,8 @@ TEST FLAGS
|
|
|
6516
6544
|
ID.
|
|
6517
6545
|
|
|
6518
6546
|
GLOBAL FLAGS
|
|
6519
|
-
--
|
|
6547
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6548
|
+
--json Format output as json.
|
|
6520
6549
|
|
|
6521
6550
|
METADATA API FORMAT FLAGS
|
|
6522
6551
|
--metadata-dir=<value> Root of directory or zip file of metadata formatted files to deploy.
|
|
@@ -6667,7 +6696,7 @@ ERROR CODES
|
|
|
6667
6696
|
Canceling (69) The deploy is being canceled.
|
|
6668
6697
|
```
|
|
6669
6698
|
|
|
6670
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6699
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/deploy/validate.ts)_
|
|
6671
6700
|
|
|
6672
6701
|
## `sf project generate`
|
|
6673
6702
|
|
|
@@ -6779,8 +6808,8 @@ Create a project manifest that lists the metadata components you want to deploy
|
|
|
6779
6808
|
|
|
6780
6809
|
```
|
|
6781
6810
|
USAGE
|
|
6782
|
-
$ sf project generate manifest [--json] [--api-version <value>] [-m <value>] [-p <value>] [-n <value> |
|
|
6783
|
-
pre|post|destroy|package] [-c managed|unlocked --from-org <value>] [-d <value>]
|
|
6811
|
+
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>] [-p <value>] [-n <value> |
|
|
6812
|
+
-t pre|post|destroy|package] [-c managed|unlocked --from-org <value>] [-d <value>]
|
|
6784
6813
|
|
|
6785
6814
|
FLAGS
|
|
6786
6815
|
-c, --include-packages=<option>... Package types (managed, unlocked) whose metadata is included in the manifest; by
|
|
@@ -6797,7 +6826,8 @@ FLAGS
|
|
|
6797
6826
|
build a manifest.
|
|
6798
6827
|
|
|
6799
6828
|
GLOBAL FLAGS
|
|
6800
|
-
--
|
|
6829
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6830
|
+
--json Format output as json.
|
|
6801
6831
|
|
|
6802
6832
|
DESCRIPTION
|
|
6803
6833
|
Create a project manifest that lists the metadata components you want to deploy or retrieve.
|
|
@@ -6846,7 +6876,7 @@ EXAMPLES
|
|
|
6846
6876
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
6847
6877
|
```
|
|
6848
6878
|
|
|
6849
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6879
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/generate/manifest.ts)_
|
|
6850
6880
|
|
|
6851
6881
|
## `sf project list ignored`
|
|
6852
6882
|
|
|
@@ -6854,13 +6884,14 @@ Check your local project package directories for forceignored files.
|
|
|
6854
6884
|
|
|
6855
6885
|
```
|
|
6856
6886
|
USAGE
|
|
6857
|
-
$ sf project list ignored [--json] [-p <value>]
|
|
6887
|
+
$ sf project list ignored [--json] [--flags-dir <value>] [-p <value>]
|
|
6858
6888
|
|
|
6859
6889
|
FLAGS
|
|
6860
6890
|
-p, --source-dir=<value> File or directory of files that the command checks for foreceignored files.
|
|
6861
6891
|
|
|
6862
6892
|
GLOBAL FLAGS
|
|
6863
|
-
--
|
|
6893
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6894
|
+
--json Format output as json.
|
|
6864
6895
|
|
|
6865
6896
|
DESCRIPTION
|
|
6866
6897
|
Check your local project package directories for forceignored files.
|
|
@@ -6887,7 +6918,7 @@ EXAMPLES
|
|
|
6887
6918
|
$ sf project list ignored --source-dir package.xml
|
|
6888
6919
|
```
|
|
6889
6920
|
|
|
6890
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6921
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/list/ignored.ts)_
|
|
6891
6922
|
|
|
6892
6923
|
## `sf project reset tracking`
|
|
6893
6924
|
|
|
@@ -6895,7 +6926,7 @@ Reset local and remote source tracking.
|
|
|
6895
6926
|
|
|
6896
6927
|
```
|
|
6897
6928
|
USAGE
|
|
6898
|
-
$ sf project reset tracking -o <value> [--json] [--api-version <value>] [-r <value>] [-p]
|
|
6929
|
+
$ sf project reset tracking -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-r <value>] [-p]
|
|
6899
6930
|
|
|
6900
6931
|
FLAGS
|
|
6901
6932
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
@@ -6905,7 +6936,8 @@ FLAGS
|
|
|
6905
6936
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
6906
6937
|
|
|
6907
6938
|
GLOBAL FLAGS
|
|
6908
|
-
--
|
|
6939
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6940
|
+
--json Format output as json.
|
|
6909
6941
|
|
|
6910
6942
|
DESCRIPTION
|
|
6911
6943
|
Reset local and remote source tracking.
|
|
@@ -6935,7 +6967,7 @@ EXAMPLES
|
|
|
6935
6967
|
$ sf project reset tracking --revision 30
|
|
6936
6968
|
```
|
|
6937
6969
|
|
|
6938
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
6970
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/reset/tracking.ts)_
|
|
6939
6971
|
|
|
6940
6972
|
## `sf project retrieve preview`
|
|
6941
6973
|
|
|
@@ -6943,7 +6975,7 @@ Preview a retrieval to see what will be retrieved from the org, the potential co
|
|
|
6943
6975
|
|
|
6944
6976
|
```
|
|
6945
6977
|
USAGE
|
|
6946
|
-
$ sf project retrieve preview -o <value> [--json] [-c] [--concise]
|
|
6978
|
+
$ sf project retrieve preview -o <value> [--json] [--flags-dir <value>] [-c] [--concise]
|
|
6947
6979
|
|
|
6948
6980
|
FLAGS
|
|
6949
6981
|
-c, --ignore-conflicts Don't display conflicts in the preview of the retrieval.
|
|
@@ -6951,7 +6983,8 @@ FLAGS
|
|
|
6951
6983
|
--concise Show only the changes that will be retrieved; omits files that are forceignored.
|
|
6952
6984
|
|
|
6953
6985
|
GLOBAL FLAGS
|
|
6954
|
-
--
|
|
6986
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
6987
|
+
--json Format output as json.
|
|
6955
6988
|
|
|
6956
6989
|
DESCRIPTION
|
|
6957
6990
|
Preview a retrieval to see what will be retrieved from the org, the potential conflicts, and the ignored files.
|
|
@@ -6991,7 +7024,7 @@ FLAG DESCRIPTIONS
|
|
|
6991
7024
|
Overrides your default org.
|
|
6992
7025
|
```
|
|
6993
7026
|
|
|
6994
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7027
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/retrieve/preview.ts)_
|
|
6995
7028
|
|
|
6996
7029
|
## `sf project retrieve start`
|
|
6997
7030
|
|
|
@@ -6999,8 +7032,8 @@ Retrieve metadata from an org to your local project.
|
|
|
6999
7032
|
|
|
7000
7033
|
```
|
|
7001
7034
|
USAGE
|
|
7002
|
-
$ sf project retrieve start -o <value> [--json] [-a <value>] [-c] [-x <value> | -m <value> | -d
|
|
7003
|
-
<value> | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name <value> ]
|
|
7035
|
+
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value> | -d
|
|
7036
|
+
<value>] [-r <value> | -n <value> | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name <value> ]
|
|
7004
7037
|
|
|
7005
7038
|
FLAGS
|
|
7006
7039
|
-a, --api-version=<value> Target API version for the retrieve.
|
|
@@ -7012,8 +7045,8 @@ FLAGS
|
|
|
7012
7045
|
-n, --package-name=<value>... Package names to retrieve.
|
|
7013
7046
|
-o, --target-org=<value> (required) Login username or alias for the target org.
|
|
7014
7047
|
-r, --output-dir=<value> Directory root for the retrieved source files.
|
|
7015
|
-
-w, --wait=<value> [default:
|
|
7016
|
-
|
|
7048
|
+
-w, --wait=<value> [default: 33 minutes] Number of minutes to wait for the command to complete and display
|
|
7049
|
+
results to the terminal window.
|
|
7017
7050
|
-x, --manifest=<value> File path for the manifest (package.xml) that specifies the components to retrieve.
|
|
7018
7051
|
|
|
7019
7052
|
METADATA API FORMAT FLAGS
|
|
@@ -7023,7 +7056,8 @@ METADATA API FORMAT FLAGS
|
|
|
7023
7056
|
--zip-file-name=<value> File name to use for the retrieved zip file.
|
|
7024
7057
|
|
|
7025
7058
|
GLOBAL FLAGS
|
|
7026
|
-
--
|
|
7059
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
7060
|
+
--json Format output as json.
|
|
7027
7061
|
|
|
7028
7062
|
DESCRIPTION
|
|
7029
7063
|
Retrieve metadata from an org to your local project.
|
|
@@ -7149,7 +7183,7 @@ ENVIRONMENT VARIABLES
|
|
|
7149
7183
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
7150
7184
|
```
|
|
7151
7185
|
|
|
7152
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.
|
|
7186
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.3.1/src/commands/project/retrieve/start.ts)_
|
|
7153
7187
|
|
|
7154
7188
|
## `sf schema generate field`
|
|
7155
7189
|
|