@salesforce/cli 1.69.0 → 1.70.0

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.
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.69.0",
2
+ "version": "1.70.0",
3
3
  "commands": {
4
4
  "cmdt:generate:field": {
5
5
  "id": "cmdt:generate:field",
@@ -1177,6 +1177,1046 @@
1177
1177
  "flags": {},
1178
1178
  "args": {}
1179
1179
  },
1180
+ "deploy:functions": {
1181
+ "id": "deploy:functions",
1182
+ "summary": "Deploy a Salesforce Function to an org from your local project.",
1183
+ "description": "You must run this command from within a git repository. Only committed changes to Functions are deployed. The active branch is deployed unless specified otherwise with `--branch`.",
1184
+ "strict": true,
1185
+ "pluginName": "@salesforce/plugin-functions",
1186
+ "pluginAlias": "@salesforce/plugin-functions",
1187
+ "pluginType": "jit",
1188
+ "aliases": [],
1189
+ "examples": [
1190
+ "Deploy a Salesforce Function:\n<%= config.bin %> <%= command.id %> --connected-org org-alias",
1191
+ "Deploy to 'deploy-branch':\n<%= config.bin %> <%= command.id %> --connected-org org-alias --branch deploy-branch",
1192
+ "Overwrite the remote repository:\n<%= config.bin %> <%= command.id %> --connected-org org-alias --force"
1193
+ ],
1194
+ "flags": {
1195
+ "json": {
1196
+ "name": "json",
1197
+ "type": "boolean",
1198
+ "description": "Format output as json.",
1199
+ "helpGroup": "GLOBAL",
1200
+ "allowNo": false
1201
+ },
1202
+ "connected-org": {
1203
+ "name": "connected-org",
1204
+ "type": "option",
1205
+ "char": "o",
1206
+ "description": "Username or alias for the org that the compute environment should be connected to.",
1207
+ "required": true,
1208
+ "multiple": false
1209
+ },
1210
+ "branch": {
1211
+ "name": "branch",
1212
+ "type": "option",
1213
+ "char": "b",
1214
+ "description": "Deploy the latest commit from a branch different from the currently active branch.",
1215
+ "multiple": false
1216
+ },
1217
+ "force": {
1218
+ "name": "force",
1219
+ "type": "boolean",
1220
+ "description": "Ignore warnings and overwrite remote repository (not allowed in production).",
1221
+ "allowNo": false
1222
+ },
1223
+ "quiet": {
1224
+ "name": "quiet",
1225
+ "type": "boolean",
1226
+ "char": "q",
1227
+ "description": "Limit the amount of output displayed from the deploy process.",
1228
+ "allowNo": false
1229
+ }
1230
+ },
1231
+ "args": {}
1232
+ },
1233
+ "env:delete": {
1234
+ "id": "env:delete",
1235
+ "summary": "Delete an environment.",
1236
+ "description": "You must include the name of the environment to delete using '--target-compute'. Run 'sf env list' to see a list of environments.\n\nRunning this command will prompt a confirmation. If you want to skip this confirmation, use the '--confirm' flag and the environment alias to skip confirmation.",
1237
+ "strict": true,
1238
+ "pluginName": "@salesforce/plugin-functions",
1239
+ "pluginAlias": "@salesforce/plugin-functions",
1240
+ "pluginType": "jit",
1241
+ "aliases": [],
1242
+ "examples": [
1243
+ "Delete a compute environment:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias",
1244
+ "Delete without a confirmation step:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias --confirm environment-alias"
1245
+ ],
1246
+ "flags": {
1247
+ "json": {
1248
+ "name": "json",
1249
+ "type": "boolean",
1250
+ "description": "Format output as json.",
1251
+ "helpGroup": "GLOBAL",
1252
+ "allowNo": false
1253
+ },
1254
+ "target-compute": {
1255
+ "name": "target-compute",
1256
+ "type": "option",
1257
+ "char": "e",
1258
+ "description": "Environment name.",
1259
+ "required": false,
1260
+ "multiple": false,
1261
+ "exclusive": [
1262
+ "environment"
1263
+ ]
1264
+ },
1265
+ "environment": {
1266
+ "name": "environment",
1267
+ "type": "option",
1268
+ "char": "e",
1269
+ "description": "Environment name.",
1270
+ "hidden": true,
1271
+ "required": false,
1272
+ "multiple": false,
1273
+ "exclusive": [
1274
+ "target-compute"
1275
+ ]
1276
+ },
1277
+ "confirm": {
1278
+ "name": "confirm",
1279
+ "type": "option",
1280
+ "description": "Confirmation name.",
1281
+ "helpValue": "name",
1282
+ "multiple": true
1283
+ }
1284
+ },
1285
+ "args": {}
1286
+ },
1287
+ "env:log": {
1288
+ "id": "env:log",
1289
+ "summary": "Stream log output for an environment.",
1290
+ "strict": true,
1291
+ "pluginName": "@salesforce/plugin-functions",
1292
+ "pluginAlias": "@salesforce/plugin-functions",
1293
+ "pluginType": "jit",
1294
+ "state": "beta",
1295
+ "aliases": [],
1296
+ "examples": [
1297
+ "Stream log output:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias"
1298
+ ],
1299
+ "flags": {
1300
+ "target-compute": {
1301
+ "name": "target-compute",
1302
+ "type": "option",
1303
+ "char": "e",
1304
+ "description": "Compute environment name to retrieve logs.",
1305
+ "required": false,
1306
+ "multiple": false,
1307
+ "exclusive": [
1308
+ "environment"
1309
+ ]
1310
+ },
1311
+ "environment": {
1312
+ "name": "environment",
1313
+ "type": "option",
1314
+ "char": "e",
1315
+ "description": "Environment name.",
1316
+ "hidden": true,
1317
+ "required": false,
1318
+ "multiple": false,
1319
+ "exclusive": [
1320
+ "target-compute"
1321
+ ]
1322
+ },
1323
+ "num": {
1324
+ "name": "num",
1325
+ "type": "option",
1326
+ "char": "n",
1327
+ "description": "Number of lines to display.",
1328
+ "multiple": false
1329
+ }
1330
+ },
1331
+ "args": {}
1332
+ },
1333
+ "generate:function": {
1334
+ "id": "generate:function",
1335
+ "summary": "Create a Salesforce Function with basic scaffolding specific to a given language.",
1336
+ "description": "Both '--language' and '--name' are required flags. Function names must start with a capital letter.",
1337
+ "strict": true,
1338
+ "pluginName": "@salesforce/plugin-functions",
1339
+ "pluginAlias": "@salesforce/plugin-functions",
1340
+ "pluginType": "jit",
1341
+ "aliases": [],
1342
+ "examples": [
1343
+ "Create a JavaScript function:\n<%= config.bin %> <%= command.id %> --function-name myfunction --language javascript"
1344
+ ],
1345
+ "flags": {
1346
+ "function-name": {
1347
+ "name": "function-name",
1348
+ "type": "option",
1349
+ "char": "n",
1350
+ "description": "Function name. Must start with a capital letter.",
1351
+ "multiple": false,
1352
+ "exclusive": [
1353
+ "name"
1354
+ ]
1355
+ },
1356
+ "name": {
1357
+ "name": "name",
1358
+ "type": "option",
1359
+ "char": "n",
1360
+ "description": "Function name. Must start with a capital letter.",
1361
+ "hidden": true,
1362
+ "multiple": false,
1363
+ "exclusive": [
1364
+ "function-name"
1365
+ ]
1366
+ },
1367
+ "language": {
1368
+ "name": "language",
1369
+ "type": "option",
1370
+ "char": "l",
1371
+ "description": "The language in which the function is written.",
1372
+ "required": true,
1373
+ "multiple": false,
1374
+ "options": [
1375
+ "java",
1376
+ "javascript",
1377
+ "python",
1378
+ "typescript"
1379
+ ]
1380
+ }
1381
+ },
1382
+ "args": {}
1383
+ },
1384
+ "login:functions": {
1385
+ "id": "login:functions",
1386
+ "summary": "Log in to Salesforce Functions.",
1387
+ "description": "This step is required to develop or deploy Salesforce Functions.",
1388
+ "strict": true,
1389
+ "pluginName": "@salesforce/plugin-functions",
1390
+ "pluginAlias": "@salesforce/plugin-functions",
1391
+ "pluginType": "jit",
1392
+ "aliases": [],
1393
+ "examples": [
1394
+ "Log in to Salesforce Functions:\n<%= config.bin %> <%= command.id %>"
1395
+ ],
1396
+ "flags": {
1397
+ "json": {
1398
+ "name": "json",
1399
+ "type": "boolean",
1400
+ "description": "Format output as json.",
1401
+ "helpGroup": "GLOBAL",
1402
+ "allowNo": false
1403
+ }
1404
+ },
1405
+ "args": {}
1406
+ },
1407
+ "logout:functions": {
1408
+ "id": "logout:functions",
1409
+ "summary": "Log out of your Salesforce Functions account.",
1410
+ "strict": true,
1411
+ "pluginName": "@salesforce/plugin-functions",
1412
+ "pluginAlias": "@salesforce/plugin-functions",
1413
+ "pluginType": "jit",
1414
+ "aliases": [],
1415
+ "examples": [
1416
+ "Log out:\n<%= config.bin %> <%= command.id %>"
1417
+ ],
1418
+ "flags": {
1419
+ "json": {
1420
+ "name": "json",
1421
+ "type": "boolean",
1422
+ "description": "Format output as json.",
1423
+ "helpGroup": "GLOBAL",
1424
+ "allowNo": false
1425
+ }
1426
+ },
1427
+ "args": {}
1428
+ },
1429
+ "run:function": {
1430
+ "id": "run:function",
1431
+ "summary": "Send a cloudevent to a function.",
1432
+ "strict": true,
1433
+ "pluginName": "@salesforce/plugin-functions",
1434
+ "pluginAlias": "@salesforce/plugin-functions",
1435
+ "pluginType": "jit",
1436
+ "aliases": [],
1437
+ "examples": [
1438
+ "Run a function:\n<%= config.bin %> <%= command.id %> --url http://path/to/function",
1439
+ "Run a function with a payload and a JSON response:\n<%= config.bin %> <%= command.id %> --url http://path/to/function --payload '@file.json' --structured"
1440
+ ],
1441
+ "flags": {
1442
+ "json": {
1443
+ "name": "json",
1444
+ "type": "boolean",
1445
+ "description": "Format output as json.",
1446
+ "helpGroup": "GLOBAL",
1447
+ "allowNo": false
1448
+ },
1449
+ "function-url": {
1450
+ "name": "function-url",
1451
+ "type": "option",
1452
+ "char": "l",
1453
+ "description": "URL of the function to run.",
1454
+ "multiple": false,
1455
+ "exclusive": [
1456
+ "url"
1457
+ ]
1458
+ },
1459
+ "url": {
1460
+ "name": "url",
1461
+ "type": "option",
1462
+ "char": "l",
1463
+ "description": "URL of the function to run.",
1464
+ "hidden": true,
1465
+ "multiple": false,
1466
+ "exclusive": [
1467
+ "function-url"
1468
+ ]
1469
+ },
1470
+ "headers": {
1471
+ "name": "headers",
1472
+ "type": "option",
1473
+ "char": "H",
1474
+ "description": "Set headers.",
1475
+ "multiple": true
1476
+ },
1477
+ "payload": {
1478
+ "name": "payload",
1479
+ "type": "option",
1480
+ "char": "p",
1481
+ "description": "Set the payload of the cloudevent as a JSON object or a path to a file via @file.json.",
1482
+ "multiple": false
1483
+ },
1484
+ "structured": {
1485
+ "name": "structured",
1486
+ "type": "boolean",
1487
+ "char": "s",
1488
+ "description": "Set the cloudevent to be emitted as a structured JSON cloudevent.",
1489
+ "allowNo": false
1490
+ },
1491
+ "connected-org": {
1492
+ "name": "connected-org",
1493
+ "type": "option",
1494
+ "char": "o",
1495
+ "description": "Username or alias for the target org; overrides default target org.",
1496
+ "multiple": false
1497
+ }
1498
+ },
1499
+ "args": {}
1500
+ },
1501
+ "whoami:functions": {
1502
+ "id": "whoami:functions",
1503
+ "summary": "Show information on your Salesforce Functions login.",
1504
+ "description": "Returns your email and ID. Use '--show-token' to show your Salesforce Functions token.",
1505
+ "strict": true,
1506
+ "pluginName": "@salesforce/plugin-functions",
1507
+ "pluginAlias": "@salesforce/plugin-functions",
1508
+ "pluginType": "jit",
1509
+ "aliases": [],
1510
+ "examples": [
1511
+ "Get account information:\n<%= config.bin %> <%= command.id %>",
1512
+ "Show token and output result as JSON:\n<%= config.bin %> <%= command.id %> --show-token --json"
1513
+ ],
1514
+ "flags": {
1515
+ "json": {
1516
+ "name": "json",
1517
+ "type": "boolean",
1518
+ "description": "Format output as json.",
1519
+ "helpGroup": "GLOBAL",
1520
+ "allowNo": false
1521
+ },
1522
+ "show-token": {
1523
+ "name": "show-token",
1524
+ "type": "boolean",
1525
+ "description": "Show the stored functions token.",
1526
+ "hidden": true,
1527
+ "allowNo": false
1528
+ }
1529
+ },
1530
+ "args": {}
1531
+ },
1532
+ "env:create:compute": {
1533
+ "id": "env:create:compute",
1534
+ "summary": "Create a compute environment for use with Salesforce Functions.",
1535
+ "description": "Compute environments must be connected to a Salesforce org. By default the command uses your local environment's connected org. Use the '--connected-org' flag to specify a specific org. Run 'sf env list' to see a list of environments.",
1536
+ "strict": true,
1537
+ "pluginName": "@salesforce/plugin-functions",
1538
+ "pluginAlias": "@salesforce/plugin-functions",
1539
+ "pluginType": "jit",
1540
+ "aliases": [],
1541
+ "examples": [
1542
+ "Create a compute environment to run Salesforce Functions:\n<%= config.bin %> <%= command.id %>",
1543
+ "Connect the environment to a specific org:\n<%= config.bin %> <%= command.id %> --connected-org=org-alias",
1544
+ "Create an alias for the compute environment:\n<%= config.bin %> <%= command.id %> --alias environment-alias"
1545
+ ],
1546
+ "flags": {
1547
+ "json": {
1548
+ "name": "json",
1549
+ "type": "boolean",
1550
+ "description": "Format output as json.",
1551
+ "helpGroup": "GLOBAL",
1552
+ "allowNo": false
1553
+ },
1554
+ "connected-org": {
1555
+ "name": "connected-org",
1556
+ "type": "option",
1557
+ "char": "o",
1558
+ "description": "Username or alias for the org that the compute environment should be connected to.",
1559
+ "required": false,
1560
+ "multiple": false
1561
+ },
1562
+ "alias": {
1563
+ "name": "alias",
1564
+ "type": "option",
1565
+ "char": "a",
1566
+ "description": "Alias for the created environment.",
1567
+ "multiple": false
1568
+ }
1569
+ },
1570
+ "args": {}
1571
+ },
1572
+ "env:log:tail": {
1573
+ "id": "env:log:tail",
1574
+ "summary": "Stream log output for an environment.",
1575
+ "strict": true,
1576
+ "pluginName": "@salesforce/plugin-functions",
1577
+ "pluginAlias": "@salesforce/plugin-functions",
1578
+ "pluginType": "jit",
1579
+ "aliases": [],
1580
+ "examples": [
1581
+ "Stream log output:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias"
1582
+ ],
1583
+ "flags": {
1584
+ "target-compute": {
1585
+ "name": "target-compute",
1586
+ "type": "option",
1587
+ "char": "e",
1588
+ "description": "Compute environment name to retrieve logs.",
1589
+ "required": false,
1590
+ "multiple": false,
1591
+ "exclusive": [
1592
+ "environment"
1593
+ ]
1594
+ },
1595
+ "environment": {
1596
+ "name": "environment",
1597
+ "type": "option",
1598
+ "char": "e",
1599
+ "description": "Environment name.",
1600
+ "hidden": true,
1601
+ "required": false,
1602
+ "multiple": false,
1603
+ "exclusive": [
1604
+ "target-compute"
1605
+ ]
1606
+ }
1607
+ },
1608
+ "args": {}
1609
+ },
1610
+ "env:logdrain:add": {
1611
+ "id": "env:logdrain:add",
1612
+ "summary": "Add log drain to a specified environment.",
1613
+ "description": "Both '--target-compute' and '--url' are required flags. '--url' should be a HTTP or HTTPS URL that can receive the log drain messages.",
1614
+ "strict": true,
1615
+ "pluginName": "@salesforce/plugin-functions",
1616
+ "pluginAlias": "@salesforce/plugin-functions",
1617
+ "pluginType": "jit",
1618
+ "aliases": [],
1619
+ "examples": [
1620
+ "Add a log drain:\n<%= config.bin %> <%= command.id %> --target-compute environment-name --url https://path/to/logdrain"
1621
+ ],
1622
+ "flags": {
1623
+ "json": {
1624
+ "name": "json",
1625
+ "type": "boolean",
1626
+ "description": "Format output as json.",
1627
+ "helpGroup": "GLOBAL",
1628
+ "allowNo": false
1629
+ },
1630
+ "target-compute": {
1631
+ "name": "target-compute",
1632
+ "type": "option",
1633
+ "char": "e",
1634
+ "description": "Environment name.",
1635
+ "required": false,
1636
+ "multiple": false,
1637
+ "exclusive": [
1638
+ "environment"
1639
+ ]
1640
+ },
1641
+ "environment": {
1642
+ "name": "environment",
1643
+ "type": "option",
1644
+ "char": "e",
1645
+ "description": "Environment name.",
1646
+ "hidden": true,
1647
+ "required": false,
1648
+ "multiple": false,
1649
+ "exclusive": [
1650
+ "target-compute"
1651
+ ]
1652
+ },
1653
+ "drain-url": {
1654
+ "name": "drain-url",
1655
+ "type": "option",
1656
+ "char": "l",
1657
+ "description": "Endpoint that will receive sent logs.",
1658
+ "multiple": false,
1659
+ "exclusive": [
1660
+ "url"
1661
+ ]
1662
+ },
1663
+ "url": {
1664
+ "name": "url",
1665
+ "type": "option",
1666
+ "char": "u",
1667
+ "description": "Endpoint that will receive sent logs.",
1668
+ "hidden": true,
1669
+ "multiple": false,
1670
+ "exclusive": [
1671
+ "drain-url"
1672
+ ]
1673
+ }
1674
+ },
1675
+ "args": {}
1676
+ },
1677
+ "env:logdrain:list": {
1678
+ "id": "env:logdrain:list",
1679
+ "summary": "List log drains connected to a specified environment.",
1680
+ "strict": true,
1681
+ "pluginName": "@salesforce/plugin-functions",
1682
+ "pluginAlias": "@salesforce/plugin-functions",
1683
+ "pluginType": "jit",
1684
+ "aliases": [],
1685
+ "examples": [
1686
+ "List log drains:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias",
1687
+ "List log drains as json:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias --json"
1688
+ ],
1689
+ "flags": {
1690
+ "json": {
1691
+ "name": "json",
1692
+ "type": "boolean",
1693
+ "description": "Format output as json.",
1694
+ "helpGroup": "GLOBAL",
1695
+ "allowNo": false
1696
+ },
1697
+ "target-compute": {
1698
+ "name": "target-compute",
1699
+ "type": "option",
1700
+ "char": "e",
1701
+ "description": "Environment name.",
1702
+ "required": false,
1703
+ "multiple": false,
1704
+ "exclusive": [
1705
+ "environment"
1706
+ ]
1707
+ },
1708
+ "environment": {
1709
+ "name": "environment",
1710
+ "type": "option",
1711
+ "char": "e",
1712
+ "description": "Environment name.",
1713
+ "hidden": true,
1714
+ "required": false,
1715
+ "multiple": false,
1716
+ "exclusive": [
1717
+ "target-compute"
1718
+ ]
1719
+ }
1720
+ },
1721
+ "args": {}
1722
+ },
1723
+ "env:logdrain:remove": {
1724
+ "id": "env:logdrain:remove",
1725
+ "summary": "Remove log drain from a specified environment.",
1726
+ "description": "Both '--target-compute' and '--drain-url' are required flags.",
1727
+ "strict": true,
1728
+ "pluginName": "@salesforce/plugin-functions",
1729
+ "pluginAlias": "@salesforce/plugin-functions",
1730
+ "pluginType": "jit",
1731
+ "aliases": [],
1732
+ "examples": [
1733
+ "Remove a logdrain:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias --url https://path/to/logdrain"
1734
+ ],
1735
+ "flags": {
1736
+ "json": {
1737
+ "name": "json",
1738
+ "type": "boolean",
1739
+ "description": "Format output as json.",
1740
+ "helpGroup": "GLOBAL",
1741
+ "allowNo": false
1742
+ },
1743
+ "target-compute": {
1744
+ "name": "target-compute",
1745
+ "type": "option",
1746
+ "char": "e",
1747
+ "description": "Environment name.",
1748
+ "required": false,
1749
+ "multiple": false,
1750
+ "exclusive": [
1751
+ "environment"
1752
+ ]
1753
+ },
1754
+ "environment": {
1755
+ "name": "environment",
1756
+ "type": "option",
1757
+ "char": "e",
1758
+ "description": "Environment name.",
1759
+ "hidden": true,
1760
+ "required": false,
1761
+ "multiple": false,
1762
+ "exclusive": [
1763
+ "target-compute"
1764
+ ]
1765
+ },
1766
+ "drain-url": {
1767
+ "name": "drain-url",
1768
+ "type": "option",
1769
+ "char": "l",
1770
+ "description": "Log drain url to remove.",
1771
+ "multiple": false,
1772
+ "exclusive": [
1773
+ "url"
1774
+ ]
1775
+ },
1776
+ "url": {
1777
+ "name": "url",
1778
+ "type": "option",
1779
+ "char": "u",
1780
+ "description": "Log drain url to remove.",
1781
+ "hidden": true,
1782
+ "multiple": false,
1783
+ "exclusive": [
1784
+ "drain-url"
1785
+ ]
1786
+ }
1787
+ },
1788
+ "args": {}
1789
+ },
1790
+ "env:var:get": {
1791
+ "id": "env:var:get",
1792
+ "summary": "Display a single config variable for an environment.",
1793
+ "description": "You must provide the '--target-compute' flag and the key to retrieve.",
1794
+ "strict": true,
1795
+ "pluginName": "@salesforce/plugin-functions",
1796
+ "pluginAlias": "@salesforce/plugin-functions",
1797
+ "pluginType": "jit",
1798
+ "aliases": [],
1799
+ "examples": [
1800
+ "Get a config variable:\n<%= config.bin %> <%= command.id %> [KEY] --target-compute environment-alias"
1801
+ ],
1802
+ "flags": {
1803
+ "json": {
1804
+ "name": "json",
1805
+ "type": "boolean",
1806
+ "description": "Format output as json.",
1807
+ "helpGroup": "GLOBAL",
1808
+ "allowNo": false
1809
+ },
1810
+ "target-compute": {
1811
+ "name": "target-compute",
1812
+ "type": "option",
1813
+ "char": "e",
1814
+ "description": "Environment name.",
1815
+ "required": false,
1816
+ "multiple": false,
1817
+ "exclusive": [
1818
+ "environment"
1819
+ ]
1820
+ },
1821
+ "environment": {
1822
+ "name": "environment",
1823
+ "type": "option",
1824
+ "char": "e",
1825
+ "description": "Environment name.",
1826
+ "hidden": true,
1827
+ "required": false,
1828
+ "multiple": false,
1829
+ "exclusive": [
1830
+ "target-compute"
1831
+ ]
1832
+ }
1833
+ },
1834
+ "args": {
1835
+ "key": {
1836
+ "name": "key",
1837
+ "required": true
1838
+ }
1839
+ }
1840
+ },
1841
+ "env:var:list": {
1842
+ "id": "env:var:list",
1843
+ "summary": "List your environment's config vars in a table.",
1844
+ "description": "Use the '--json' flag to return config vars in JSON format.",
1845
+ "strict": true,
1846
+ "pluginName": "@salesforce/plugin-functions",
1847
+ "pluginAlias": "@salesforce/plugin-functions",
1848
+ "pluginType": "jit",
1849
+ "aliases": [],
1850
+ "examples": [
1851
+ "List config vars:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias",
1852
+ "List in JSON format:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias --json"
1853
+ ],
1854
+ "flags": {
1855
+ "json": {
1856
+ "name": "json",
1857
+ "type": "boolean",
1858
+ "description": "Format output as json.",
1859
+ "helpGroup": "GLOBAL",
1860
+ "allowNo": false
1861
+ },
1862
+ "target-compute": {
1863
+ "name": "target-compute",
1864
+ "type": "option",
1865
+ "char": "e",
1866
+ "description": "Environment name.",
1867
+ "required": false,
1868
+ "multiple": false,
1869
+ "exclusive": [
1870
+ "environment"
1871
+ ]
1872
+ },
1873
+ "environment": {
1874
+ "name": "environment",
1875
+ "type": "option",
1876
+ "char": "e",
1877
+ "description": "Environment name.",
1878
+ "hidden": true,
1879
+ "required": false,
1880
+ "multiple": false,
1881
+ "exclusive": [
1882
+ "target-compute"
1883
+ ]
1884
+ }
1885
+ },
1886
+ "args": {}
1887
+ },
1888
+ "env:var:set": {
1889
+ "id": "env:var:set",
1890
+ "summary": "Set a single config value for an environment.",
1891
+ "strict": false,
1892
+ "pluginName": "@salesforce/plugin-functions",
1893
+ "pluginAlias": "@salesforce/plugin-functions",
1894
+ "pluginType": "jit",
1895
+ "aliases": [],
1896
+ "examples": [
1897
+ "Set a config value:\n<%= config.bin %> <%= command.id %> [KEY]=[VALUE] --target-compute environment-alias"
1898
+ ],
1899
+ "flags": {
1900
+ "json": {
1901
+ "name": "json",
1902
+ "type": "boolean",
1903
+ "description": "Format output as json.",
1904
+ "helpGroup": "GLOBAL",
1905
+ "allowNo": false
1906
+ },
1907
+ "target-compute": {
1908
+ "name": "target-compute",
1909
+ "type": "option",
1910
+ "char": "e",
1911
+ "description": "Environment name.",
1912
+ "required": false,
1913
+ "multiple": false,
1914
+ "exclusive": [
1915
+ "environment"
1916
+ ]
1917
+ },
1918
+ "environment": {
1919
+ "name": "environment",
1920
+ "type": "option",
1921
+ "char": "e",
1922
+ "description": "Environment name.",
1923
+ "hidden": true,
1924
+ "required": false,
1925
+ "multiple": false,
1926
+ "exclusive": [
1927
+ "target-compute"
1928
+ ]
1929
+ }
1930
+ },
1931
+ "args": {}
1932
+ },
1933
+ "env:var:unset": {
1934
+ "id": "env:var:unset",
1935
+ "summary": "Unset a single config value for an environment.",
1936
+ "description": "Run 'sf env var list' to see a list of config values that can be unset.",
1937
+ "strict": false,
1938
+ "pluginName": "@salesforce/plugin-functions",
1939
+ "pluginAlias": "@salesforce/plugin-functions",
1940
+ "pluginType": "jit",
1941
+ "aliases": [],
1942
+ "examples": [
1943
+ "Unset a value:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias"
1944
+ ],
1945
+ "flags": {
1946
+ "json": {
1947
+ "name": "json",
1948
+ "type": "boolean",
1949
+ "description": "Format output as json.",
1950
+ "helpGroup": "GLOBAL",
1951
+ "allowNo": false
1952
+ },
1953
+ "target-compute": {
1954
+ "name": "target-compute",
1955
+ "type": "option",
1956
+ "char": "e",
1957
+ "description": "Environment name.",
1958
+ "required": false,
1959
+ "multiple": false,
1960
+ "exclusive": [
1961
+ "environment"
1962
+ ]
1963
+ },
1964
+ "environment": {
1965
+ "name": "environment",
1966
+ "type": "option",
1967
+ "char": "e",
1968
+ "description": "Environment name.",
1969
+ "hidden": true,
1970
+ "required": false,
1971
+ "multiple": false,
1972
+ "exclusive": [
1973
+ "target-compute"
1974
+ ]
1975
+ }
1976
+ },
1977
+ "args": {}
1978
+ },
1979
+ "login:functions:jwt": {
1980
+ "id": "login:functions:jwt",
1981
+ "summary": "Login using JWT instead of default web-based flow. This will authenticate you with both sf and Salesforce Functions.",
1982
+ "description": "Use this command when executing from a script.",
1983
+ "strict": true,
1984
+ "pluginName": "@salesforce/plugin-functions",
1985
+ "pluginAlias": "@salesforce/plugin-functions",
1986
+ "pluginType": "jit",
1987
+ "aliases": [],
1988
+ "examples": [
1989
+ "Log in using JWT:\n<%= config.bin %> <%= command.id %> --username example@username.org --keyfile file.key --clientid 123456",
1990
+ "Log in and specify the org alias and URL, set as default org and default Dev Hub, and format output as JSON:\n<%= config.bin %> <%= command.id %> --username example@username.org --keyfile file.key --clientid 123456 --alias org-alias --set-default --set-default-dev-hub --instance-url https://path/to/instance --json"
1991
+ ],
1992
+ "flags": {
1993
+ "json": {
1994
+ "name": "json",
1995
+ "type": "boolean",
1996
+ "description": "Format output as json.",
1997
+ "helpGroup": "GLOBAL",
1998
+ "allowNo": false
1999
+ },
2000
+ "username": {
2001
+ "name": "username",
2002
+ "type": "option",
2003
+ "char": "u",
2004
+ "description": "Authentication username.",
2005
+ "required": true,
2006
+ "multiple": false
2007
+ },
2008
+ "keyfile": {
2009
+ "name": "keyfile",
2010
+ "type": "option",
2011
+ "char": "f",
2012
+ "description": "Path to JWT keyfile.",
2013
+ "required": true,
2014
+ "multiple": false
2015
+ },
2016
+ "clientid": {
2017
+ "name": "clientid",
2018
+ "type": "option",
2019
+ "char": "i",
2020
+ "description": "OAuth client ID.",
2021
+ "required": true,
2022
+ "multiple": false
2023
+ },
2024
+ "instance-url": {
2025
+ "name": "instance-url",
2026
+ "type": "option",
2027
+ "char": "l",
2028
+ "description": "The login URL of the instance the org lives on.",
2029
+ "multiple": false,
2030
+ "exclusive": [
2031
+ "instanceurl"
2032
+ ]
2033
+ },
2034
+ "instanceurl": {
2035
+ "name": "instanceurl",
2036
+ "type": "option",
2037
+ "char": "l",
2038
+ "description": "The login URL of the instance the org lives on.",
2039
+ "hidden": true,
2040
+ "multiple": false,
2041
+ "exclusive": [
2042
+ "instance-url"
2043
+ ]
2044
+ },
2045
+ "alias": {
2046
+ "name": "alias",
2047
+ "type": "option",
2048
+ "char": "a",
2049
+ "description": "Alias for the org.",
2050
+ "multiple": false
2051
+ },
2052
+ "set-default": {
2053
+ "name": "set-default",
2054
+ "type": "boolean",
2055
+ "char": "d",
2056
+ "description": "Set the org as the default that all org-related commands run against.",
2057
+ "allowNo": false
2058
+ },
2059
+ "set-default-dev-hub": {
2060
+ "name": "set-default-dev-hub",
2061
+ "type": "boolean",
2062
+ "char": "v",
2063
+ "description": "Set the org as the default Dev Hub for scratch org creation.",
2064
+ "allowNo": false
2065
+ }
2066
+ },
2067
+ "args": {}
2068
+ },
2069
+ "run:function:start": {
2070
+ "id": "run:function:start",
2071
+ "summary": "Build and run a Salesforce Function.",
2072
+ "description": "Run this command from the directory of your Salesforce Functions project.\n\nThis command will run the target function locally (on the same operating system as this CLI), just like the `local` subcommand.",
2073
+ "strict": true,
2074
+ "pluginName": "@salesforce/plugin-functions",
2075
+ "pluginAlias": "@salesforce/plugin-functions",
2076
+ "pluginType": "jit",
2077
+ "aliases": [],
2078
+ "examples": [
2079
+ "Build a function and start the invoker\n<%= config.bin %> <%= command.id %>",
2080
+ "Start the invoker with a specific language and port\n<%= config.bin %> <%= command.id %> --port 5000 --language javascript"
2081
+ ],
2082
+ "flags": {
2083
+ "path": {
2084
+ "name": "path",
2085
+ "type": "option",
2086
+ "description": "Path to function directory.",
2087
+ "hidden": true,
2088
+ "multiple": false,
2089
+ "default": "/home/runner/work/cli/cli"
2090
+ },
2091
+ "port": {
2092
+ "name": "port",
2093
+ "type": "option",
2094
+ "char": "p",
2095
+ "description": "Port for running the function.",
2096
+ "multiple": false,
2097
+ "default": 8080
2098
+ },
2099
+ "debug-port": {
2100
+ "name": "debug-port",
2101
+ "type": "option",
2102
+ "char": "b",
2103
+ "description": "Port for remote debugging.",
2104
+ "multiple": false,
2105
+ "default": 9229
2106
+ },
2107
+ "language": {
2108
+ "name": "language",
2109
+ "type": "option",
2110
+ "char": "l",
2111
+ "description": "The language that the function runs in.",
2112
+ "multiple": false,
2113
+ "options": [
2114
+ "auto",
2115
+ "java",
2116
+ "javascript",
2117
+ "python",
2118
+ "typescript"
2119
+ ],
2120
+ "default": "auto"
2121
+ },
2122
+ "verbose": {
2123
+ "name": "verbose",
2124
+ "type": "boolean",
2125
+ "char": "v",
2126
+ "description": "Output additional logs.",
2127
+ "allowNo": false
2128
+ }
2129
+ },
2130
+ "args": {}
2131
+ },
2132
+ "env:compute:collaborator:add": {
2133
+ "id": "env:compute:collaborator:add",
2134
+ "summary": "Add a Heroku user as a collaborator on this Functions account, allowing them to attach Heroku add-ons to compute environments.",
2135
+ "strict": true,
2136
+ "pluginName": "@salesforce/plugin-functions",
2137
+ "pluginAlias": "@salesforce/plugin-functions",
2138
+ "pluginType": "jit",
2139
+ "aliases": [],
2140
+ "examples": [
2141
+ "Add a Heroku user as a collaborator on this Functions account.\n<%= config.bin %> <%= command.id %> --heroku-user example@heroku.com"
2142
+ ],
2143
+ "flags": {
2144
+ "heroku-user": {
2145
+ "name": "heroku-user",
2146
+ "type": "option",
2147
+ "char": "h",
2148
+ "description": "Email address of the Heroku user you're adding as a collaborator.",
2149
+ "required": true,
2150
+ "multiple": false
2151
+ }
2152
+ },
2153
+ "args": {}
2154
+ },
2155
+ "run:function:start:container": {
2156
+ "id": "run:function:start:container",
2157
+ "strict": true,
2158
+ "pluginName": "@salesforce/plugin-functions",
2159
+ "pluginAlias": "@salesforce/plugin-functions",
2160
+ "pluginType": "jit",
2161
+ "aliases": [],
2162
+ "flags": {},
2163
+ "args": {}
2164
+ },
2165
+ "run:function:start:local": {
2166
+ "id": "run:function:start:local",
2167
+ "description": "Build and run a Salesforce Function locally.",
2168
+ "strict": true,
2169
+ "pluginName": "@salesforce/plugin-functions",
2170
+ "pluginAlias": "@salesforce/plugin-functions",
2171
+ "pluginType": "jit",
2172
+ "aliases": [],
2173
+ "examples": [
2174
+ "Build a function and start the invoker\n<%= config.bin %> <%= command.id %>",
2175
+ "Start the invoker with a specific language and port\n<%= config.bin %> <%= command.id %> --port 5000 --language javascript"
2176
+ ],
2177
+ "flags": {
2178
+ "path": {
2179
+ "name": "path",
2180
+ "type": "option",
2181
+ "description": "Path to function directory.",
2182
+ "hidden": true,
2183
+ "multiple": false,
2184
+ "default": "/home/runner/work/cli/cli"
2185
+ },
2186
+ "port": {
2187
+ "name": "port",
2188
+ "type": "option",
2189
+ "char": "p",
2190
+ "description": "Port to bind the invoker to.",
2191
+ "multiple": false,
2192
+ "default": 8080
2193
+ },
2194
+ "debug-port": {
2195
+ "name": "debug-port",
2196
+ "type": "option",
2197
+ "char": "b",
2198
+ "description": "Port to use for debugging the function.",
2199
+ "multiple": false,
2200
+ "default": 9229
2201
+ },
2202
+ "language": {
2203
+ "name": "language",
2204
+ "type": "option",
2205
+ "char": "l",
2206
+ "description": "The language in which the function is written.",
2207
+ "multiple": false,
2208
+ "options": [
2209
+ "auto",
2210
+ "java",
2211
+ "javascript",
2212
+ "python",
2213
+ "typescript"
2214
+ ],
2215
+ "default": "auto"
2216
+ }
2217
+ },
2218
+ "args": {}
2219
+ },
1180
2220
  "package:convert": {
1181
2221
  "id": "package:convert",
1182
2222
  "summary": "Create a second-generation package version from a first-generation package.",
@@ -1263,7 +2303,6 @@
1263
2303
  "char": "f",
1264
2304
  "summary": "Path to a definition file that contains features and org preferences that the metadata of the package version depends on.",
1265
2305
  "description": "This definition file is similar to the scratch org definition file.",
1266
- "hidden": true,
1267
2306
  "multiple": false,
1268
2307
  "deprecateAliases": true,
1269
2308
  "aliases": [