@salesforce/cli 2.19.6 → 2.19.8

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.
@@ -1226,142 +1226,6 @@
1226
1226
  "messages:audit:dev"
1227
1227
  ]
1228
1228
  },
1229
- "dev:configure:repo": {
1230
- "aliases": [],
1231
- "args": {},
1232
- "description": "Sets up labels and exempts the CLI bot for branch protection and PR rules.",
1233
- "examples": [
1234
- "Configure the repo \"testPackageRelease\", with owner \"salesforcecli\", for GitHub Actions.\n<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
1235
- ],
1236
- "flags": {
1237
- "json": {
1238
- "description": "Format output as json.",
1239
- "helpGroup": "GLOBAL",
1240
- "name": "json",
1241
- "allowNo": false,
1242
- "type": "boolean"
1243
- },
1244
- "repository": {
1245
- "char": "r",
1246
- "name": "repository",
1247
- "required": true,
1248
- "summary": "GitHub owner/repo for which you want to configure GitHub Actions.",
1249
- "hasDynamicHelp": false,
1250
- "multiple": false,
1251
- "type": "option"
1252
- },
1253
- "dry-run": {
1254
- "aliases": [
1255
- "dryrun"
1256
- ],
1257
- "char": "d",
1258
- "name": "dry-run",
1259
- "summary": "Make no changes.",
1260
- "allowNo": false,
1261
- "type": "boolean"
1262
- },
1263
- "bot": {
1264
- "char": "b",
1265
- "name": "bot",
1266
- "summary": "GitHub login/username for the bot.",
1267
- "default": "SF-CLI-BOT",
1268
- "hasDynamicHelp": false,
1269
- "multiple": false,
1270
- "type": "option"
1271
- }
1272
- },
1273
- "hasDynamicHelp": false,
1274
- "hiddenAliases": [],
1275
- "id": "dev:configure:repo",
1276
- "pluginAlias": "@salesforce/plugin-dev",
1277
- "pluginName": "@salesforce/plugin-dev",
1278
- "pluginType": "jit",
1279
- "strict": true,
1280
- "summary": "Configure a GitHub repo for the GitHub Actions pipeline.",
1281
- "enableJsonFlag": true,
1282
- "SF_ENV": "SF_ENV",
1283
- "isESM": true,
1284
- "relativePath": [
1285
- "lib",
1286
- "commands",
1287
- "dev",
1288
- "configure",
1289
- "repo.js"
1290
- ],
1291
- "aliasPermutations": [],
1292
- "permutations": [
1293
- "dev:configure:repo",
1294
- "configure:dev:repo",
1295
- "configure:repo:dev",
1296
- "dev:repo:configure",
1297
- "repo:dev:configure",
1298
- "repo:configure:dev"
1299
- ]
1300
- },
1301
- "dev:configure:secrets": {
1302
- "aliases": [],
1303
- "args": {},
1304
- "description": "Inspects a repo's yaml files and verifies that secrets required are available for the repo (either set at the repo level or shared via organization-level secrets).\n\nThis command requires scope:admin permissions to inspect the org secrets and admin access to the repo to inspect the repo secrets.",
1305
- "examples": [
1306
- "Ensure secrets access for the repo \"testPackageRelease\", with owner \"salesforcecli\":",
1307
- "<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
1308
- ],
1309
- "flags": {
1310
- "json": {
1311
- "description": "Format output as json.",
1312
- "helpGroup": "GLOBAL",
1313
- "name": "json",
1314
- "allowNo": false,
1315
- "type": "boolean"
1316
- },
1317
- "repository": {
1318
- "char": "r",
1319
- "name": "repository",
1320
- "required": true,
1321
- "summary": "Github owner/repo.",
1322
- "hasDynamicHelp": false,
1323
- "multiple": false,
1324
- "type": "option"
1325
- },
1326
- "dry-run": {
1327
- "aliases": [
1328
- "dryrun"
1329
- ],
1330
- "char": "d",
1331
- "name": "dry-run",
1332
- "summary": "Make no changes.",
1333
- "allowNo": false,
1334
- "type": "boolean"
1335
- }
1336
- },
1337
- "hasDynamicHelp": false,
1338
- "hiddenAliases": [],
1339
- "id": "dev:configure:secrets",
1340
- "pluginAlias": "@salesforce/plugin-dev",
1341
- "pluginName": "@salesforce/plugin-dev",
1342
- "pluginType": "jit",
1343
- "strict": true,
1344
- "summary": "Ensures a GitHub repo has correct access to secrets based on its workflows.",
1345
- "enableJsonFlag": true,
1346
- "SF_ENV": "SF_ENV",
1347
- "isESM": true,
1348
- "relativePath": [
1349
- "lib",
1350
- "commands",
1351
- "dev",
1352
- "configure",
1353
- "secrets.js"
1354
- ],
1355
- "aliasPermutations": [],
1356
- "permutations": [
1357
- "dev:configure:secrets",
1358
- "configure:dev:secrets",
1359
- "configure:secrets:dev",
1360
- "dev:secrets:configure",
1361
- "secrets:dev:configure",
1362
- "secrets:configure:dev"
1363
- ]
1364
- },
1365
1229
  "dev:convert:messages": {
1366
1230
  "aliases": [],
1367
1231
  "args": {},
@@ -1682,106 +1546,242 @@
1682
1546
  "plugin:generate:dev"
1683
1547
  ]
1684
1548
  },
1685
- "project:deploy:pipeline:quick": {
1686
- "id": "project:deploy:pipeline:quick",
1687
- "summary": "Quickly deploy a validated deployment to an org.",
1688
- "description": "Before you run this command, first create a validated deployment with the \"sf project deploy pipeline validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.",
1689
- "strict": true,
1690
- "pluginName": "@salesforce/plugin-devops-center",
1691
- "pluginAlias": "@salesforce/plugin-devops-center",
1692
- "pluginType": "jit",
1693
- "state": "beta",
1549
+ "dev:configure:repo": {
1694
1550
  "aliases": [],
1551
+ "args": {},
1552
+ "description": "Sets up labels and exempts the CLI bot for branch protection and PR rules.",
1695
1553
  "examples": [
1696
- "Run a quick deploy using your default Devops Center org and a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1697
- "Asynchronously run a quick deploy of the most recently validated deployment using an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --devops-center-username my-prod-org"
1554
+ "Configure the repo \"testPackageRelease\", with owner \"salesforcecli\", for GitHub Actions.\n<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
1698
1555
  ],
1699
1556
  "flags": {
1700
1557
  "json": {
1701
- "name": "json",
1702
- "type": "boolean",
1703
1558
  "description": "Format output as json.",
1704
1559
  "helpGroup": "GLOBAL",
1705
- "allowNo": false
1706
- },
1707
- "async": {
1708
- "name": "async",
1709
- "type": "boolean",
1710
- "summary": "Run the command asynchronously.",
1711
- "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
1712
- "allowNo": false
1713
- },
1714
- "concise": {
1715
- "name": "concise",
1716
- "type": "boolean",
1717
- "summary": "Show concise output of the command result.",
1560
+ "name": "json",
1718
1561
  "allowNo": false,
1719
- "exclusive": [
1720
- "verbose"
1721
- ]
1722
- },
1723
- "verbose": {
1724
- "name": "verbose",
1725
- "type": "boolean",
1726
- "summary": "Show verbose output of the command result.",
1727
- "allowNo": false
1728
- },
1729
- "wait": {
1730
- "name": "wait",
1731
- "type": "option",
1732
- "char": "w",
1733
- "summary": "Number of minutes to wait for command to complete and display results.",
1734
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"<%= config.bin %> <%= command.id.split(' ').slice(0, -1).join(' ') %> report\".",
1735
- "helpValue": "<minutes>",
1736
- "multiple": false,
1737
- "exclusive": [
1738
- "async"
1739
- ],
1740
- "default": {
1741
- "quantity": 33,
1742
- "unit": 0
1743
- }
1562
+ "type": "boolean"
1744
1563
  },
1745
- "devops-center-username": {
1746
- "name": "devops-center-username",
1747
- "type": "option",
1748
- "char": "c",
1749
- "summary": "Username or alias of the DevOps Center org.",
1564
+ "repository": {
1565
+ "char": "r",
1566
+ "name": "repository",
1750
1567
  "required": true,
1751
- "multiple": false
1568
+ "summary": "GitHub owner/repo for which you want to configure GitHub Actions.",
1569
+ "hasDynamicHelp": false,
1570
+ "multiple": false,
1571
+ "type": "option"
1752
1572
  },
1753
- "job-id": {
1754
- "name": "job-id",
1755
- "type": "option",
1756
- "char": "i",
1757
- "summary": "Job ID of the validated deployment to quick deploy.",
1758
- "description": "The job ID is valid for 10 days from when you started the validation.",
1759
- "multiple": false
1573
+ "dry-run": {
1574
+ "aliases": [
1575
+ "dryrun"
1576
+ ],
1577
+ "char": "d",
1578
+ "name": "dry-run",
1579
+ "summary": "Make no changes.",
1580
+ "allowNo": false,
1581
+ "type": "boolean"
1760
1582
  },
1761
- "use-most-recent": {
1762
- "name": "use-most-recent",
1763
- "type": "boolean",
1764
- "char": "r",
1765
- "summary": "Use the job ID of the most recently validated deployment.",
1766
- "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find the job ID.",
1767
- "allowNo": false
1583
+ "bot": {
1584
+ "char": "b",
1585
+ "name": "bot",
1586
+ "summary": "GitHub login/username for the bot.",
1587
+ "default": "SF-CLI-BOT",
1588
+ "hasDynamicHelp": false,
1589
+ "multiple": false,
1590
+ "type": "option"
1768
1591
  }
1769
1592
  },
1770
- "args": {},
1771
- "hasDynamicHelp": true
1772
- },
1773
- "project:deploy:pipeline:report": {
1774
- "id": "project:deploy:pipeline:report",
1775
- "summary": "Check the status of a pipeline deploy operation.",
1776
- "description": "Run this command by either indicating a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.",
1777
- "strict": true,
1778
- "pluginName": "@salesforce/plugin-devops-center",
1779
- "pluginAlias": "@salesforce/plugin-devops-center",
1593
+ "hasDynamicHelp": false,
1594
+ "hiddenAliases": [],
1595
+ "id": "dev:configure:repo",
1596
+ "pluginAlias": "@salesforce/plugin-dev",
1597
+ "pluginName": "@salesforce/plugin-dev",
1780
1598
  "pluginType": "jit",
1781
- "state": "beta",
1782
- "aliases": [],
1783
- "examples": [
1784
- "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2",
1599
+ "strict": true,
1600
+ "summary": "Configure a GitHub repo for the GitHub Actions pipeline.",
1601
+ "enableJsonFlag": true,
1602
+ "SF_ENV": "SF_ENV",
1603
+ "isESM": true,
1604
+ "relativePath": [
1605
+ "lib",
1606
+ "commands",
1607
+ "dev",
1608
+ "configure",
1609
+ "repo.js"
1610
+ ],
1611
+ "aliasPermutations": [],
1612
+ "permutations": [
1613
+ "dev:configure:repo",
1614
+ "configure:dev:repo",
1615
+ "configure:repo:dev",
1616
+ "dev:repo:configure",
1617
+ "repo:dev:configure",
1618
+ "repo:configure:dev"
1619
+ ]
1620
+ },
1621
+ "dev:configure:secrets": {
1622
+ "aliases": [],
1623
+ "args": {},
1624
+ "description": "Inspects a repo's yaml files and verifies that secrets required are available for the repo (either set at the repo level or shared via organization-level secrets).\n\nThis command requires scope:admin permissions to inspect the org secrets and admin access to the repo to inspect the repo secrets.",
1625
+ "examples": [
1626
+ "Ensure secrets access for the repo \"testPackageRelease\", with owner \"salesforcecli\":",
1627
+ "<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
1628
+ ],
1629
+ "flags": {
1630
+ "json": {
1631
+ "description": "Format output as json.",
1632
+ "helpGroup": "GLOBAL",
1633
+ "name": "json",
1634
+ "allowNo": false,
1635
+ "type": "boolean"
1636
+ },
1637
+ "repository": {
1638
+ "char": "r",
1639
+ "name": "repository",
1640
+ "required": true,
1641
+ "summary": "Github owner/repo.",
1642
+ "hasDynamicHelp": false,
1643
+ "multiple": false,
1644
+ "type": "option"
1645
+ },
1646
+ "dry-run": {
1647
+ "aliases": [
1648
+ "dryrun"
1649
+ ],
1650
+ "char": "d",
1651
+ "name": "dry-run",
1652
+ "summary": "Make no changes.",
1653
+ "allowNo": false,
1654
+ "type": "boolean"
1655
+ }
1656
+ },
1657
+ "hasDynamicHelp": false,
1658
+ "hiddenAliases": [],
1659
+ "id": "dev:configure:secrets",
1660
+ "pluginAlias": "@salesforce/plugin-dev",
1661
+ "pluginName": "@salesforce/plugin-dev",
1662
+ "pluginType": "jit",
1663
+ "strict": true,
1664
+ "summary": "Ensures a GitHub repo has correct access to secrets based on its workflows.",
1665
+ "enableJsonFlag": true,
1666
+ "SF_ENV": "SF_ENV",
1667
+ "isESM": true,
1668
+ "relativePath": [
1669
+ "lib",
1670
+ "commands",
1671
+ "dev",
1672
+ "configure",
1673
+ "secrets.js"
1674
+ ],
1675
+ "aliasPermutations": [],
1676
+ "permutations": [
1677
+ "dev:configure:secrets",
1678
+ "configure:dev:secrets",
1679
+ "configure:secrets:dev",
1680
+ "dev:secrets:configure",
1681
+ "secrets:dev:configure",
1682
+ "secrets:configure:dev"
1683
+ ]
1684
+ },
1685
+ "project:deploy:pipeline:quick": {
1686
+ "id": "project:deploy:pipeline:quick",
1687
+ "summary": "Quickly deploy a validated deployment to an org.",
1688
+ "description": "Before you run this command, first create a validated deployment with the \"sf project deploy pipeline validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.",
1689
+ "strict": true,
1690
+ "pluginName": "@salesforce/plugin-devops-center",
1691
+ "pluginAlias": "@salesforce/plugin-devops-center",
1692
+ "pluginType": "jit",
1693
+ "state": "beta",
1694
+ "aliases": [],
1695
+ "examples": [
1696
+ "Run a quick deploy using your default Devops Center org and a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1697
+ "Asynchronously run a quick deploy of the most recently validated deployment using an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --devops-center-username my-prod-org"
1698
+ ],
1699
+ "flags": {
1700
+ "json": {
1701
+ "name": "json",
1702
+ "type": "boolean",
1703
+ "description": "Format output as json.",
1704
+ "helpGroup": "GLOBAL",
1705
+ "allowNo": false
1706
+ },
1707
+ "async": {
1708
+ "name": "async",
1709
+ "type": "boolean",
1710
+ "summary": "Run the command asynchronously.",
1711
+ "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
1712
+ "allowNo": false
1713
+ },
1714
+ "concise": {
1715
+ "name": "concise",
1716
+ "type": "boolean",
1717
+ "summary": "Show concise output of the command result.",
1718
+ "allowNo": false,
1719
+ "exclusive": [
1720
+ "verbose"
1721
+ ]
1722
+ },
1723
+ "verbose": {
1724
+ "name": "verbose",
1725
+ "type": "boolean",
1726
+ "summary": "Show verbose output of the command result.",
1727
+ "allowNo": false
1728
+ },
1729
+ "wait": {
1730
+ "name": "wait",
1731
+ "type": "option",
1732
+ "char": "w",
1733
+ "summary": "Number of minutes to wait for command to complete and display results.",
1734
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"<%= config.bin %> <%= command.id.split(' ').slice(0, -1).join(' ') %> report\".",
1735
+ "helpValue": "<minutes>",
1736
+ "multiple": false,
1737
+ "exclusive": [
1738
+ "async"
1739
+ ],
1740
+ "default": {
1741
+ "quantity": 33,
1742
+ "unit": 0
1743
+ }
1744
+ },
1745
+ "devops-center-username": {
1746
+ "name": "devops-center-username",
1747
+ "type": "option",
1748
+ "char": "c",
1749
+ "summary": "Username or alias of the DevOps Center org.",
1750
+ "required": true,
1751
+ "multiple": false
1752
+ },
1753
+ "job-id": {
1754
+ "name": "job-id",
1755
+ "type": "option",
1756
+ "char": "i",
1757
+ "summary": "Job ID of the validated deployment to quick deploy.",
1758
+ "description": "The job ID is valid for 10 days from when you started the validation.",
1759
+ "multiple": false
1760
+ },
1761
+ "use-most-recent": {
1762
+ "name": "use-most-recent",
1763
+ "type": "boolean",
1764
+ "char": "r",
1765
+ "summary": "Use the job ID of the most recently validated deployment.",
1766
+ "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find the job ID.",
1767
+ "allowNo": false
1768
+ }
1769
+ },
1770
+ "args": {},
1771
+ "hasDynamicHelp": true
1772
+ },
1773
+ "project:deploy:pipeline:report": {
1774
+ "id": "project:deploy:pipeline:report",
1775
+ "summary": "Check the status of a pipeline deploy operation.",
1776
+ "description": "Run this command by either indicating a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.",
1777
+ "strict": true,
1778
+ "pluginName": "@salesforce/plugin-devops-center",
1779
+ "pluginAlias": "@salesforce/plugin-devops-center",
1780
+ "pluginType": "jit",
1781
+ "state": "beta",
1782
+ "aliases": [],
1783
+ "examples": [
1784
+ "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2",
1785
1785
  "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
1786
1786
  ],
1787
1787
  "flags": {
@@ -3410,2388 +3410,6 @@
3410
3410
  },
3411
3411
  "args": {}
3412
3412
  },
3413
- "package:convert": {
3414
- "id": "package:convert",
3415
- "summary": "Create a second-generation package version from a first-generation package.",
3416
- "description": "The package convert creates a new package in the Dev Hub if one does not already exist for the specified first-generation package.\n\nIt then creates a new package version in the Dev Hub with contents based on the specified first-generation package.\n\nThe latest released non-patch package version from the specified first-generation package will be converted.\n\nTo retrieve details about a package version create request, including status and package version ID (04t), run \"<%= config.bin %> package version create report -i 08c...\".\n\nWe recommend specifying the --installation-key to protect the contents of your package and to prevent unauthorized installation of your package.\n\nTo list package version creation requests in the org, run \"<%= config.bin %> package version create list\".",
3417
- "strict": true,
3418
- "pluginName": "@salesforce/plugin-packaging",
3419
- "pluginAlias": "@salesforce/plugin-packaging",
3420
- "pluginType": "jit",
3421
- "hidden": true,
3422
- "aliases": [
3423
- "force:package:convert"
3424
- ],
3425
- "examples": [
3426
- "Create a second-generation package version from the first-generation package with the specified ID and give it the installation key \"password123\"; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 033... --installation-key password123",
3427
- "Similar to previous example, but uses the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 033... --installation-key password123 --target-dev-hub devhuborg@example.com"
3428
- ],
3429
- "deprecateAliases": true,
3430
- "flags": {
3431
- "loglevel": {
3432
- "name": "loglevel",
3433
- "type": "option",
3434
- "hidden": true,
3435
- "multiple": false,
3436
- "deprecated": {
3437
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
3438
- },
3439
- "deprecateAliases": true
3440
- },
3441
- "target-dev-hub": {
3442
- "name": "target-dev-hub",
3443
- "type": "option",
3444
- "char": "v",
3445
- "summary": "Username or alias of the Dev Hub org.",
3446
- "required": true,
3447
- "multiple": false,
3448
- "deprecateAliases": true,
3449
- "aliases": [
3450
- "targetdevhubusername",
3451
- "target-hub-org"
3452
- ]
3453
- },
3454
- "api-version": {
3455
- "name": "api-version",
3456
- "type": "option",
3457
- "description": "Override the api version used for api requests made by this command",
3458
- "multiple": false,
3459
- "deprecateAliases": true,
3460
- "aliases": [
3461
- "apiversion"
3462
- ]
3463
- },
3464
- "package": {
3465
- "name": "package",
3466
- "type": "option",
3467
- "char": "p",
3468
- "summary": "ID (starts with 033) of the first-generation package to convert.",
3469
- "required": true,
3470
- "multiple": false,
3471
- "deprecateAliases": true
3472
- },
3473
- "installation-key": {
3474
- "name": "installation-key",
3475
- "type": "option",
3476
- "char": "k",
3477
- "summary": "Installation key for key-protected package.",
3478
- "description": "Either an --installation-key value or the --installation-key-bypass flag is required.",
3479
- "multiple": false,
3480
- "deprecateAliases": true,
3481
- "aliases": [
3482
- "installationkey"
3483
- ]
3484
- },
3485
- "definition-file": {
3486
- "name": "definition-file",
3487
- "type": "option",
3488
- "char": "f",
3489
- "summary": "Path to a definition file that contains features and org preferences that the metadata of the package version depends on.",
3490
- "description": "This definition file is similar to the scratch org definition file.",
3491
- "multiple": false,
3492
- "deprecateAliases": true,
3493
- "aliases": [
3494
- "definitionfile"
3495
- ]
3496
- },
3497
- "installation-key-bypass": {
3498
- "name": "installation-key-bypass",
3499
- "type": "boolean",
3500
- "char": "x",
3501
- "summary": "Bypass the installation key requirement.",
3502
- "description": "If you bypass this requirement, anyone can install your package. Either an --installation-key value or the --installation-key-bypass flag is required.",
3503
- "allowNo": false,
3504
- "deprecateAliases": true,
3505
- "aliases": [
3506
- "installationkeybypass"
3507
- ]
3508
- },
3509
- "wait": {
3510
- "name": "wait",
3511
- "type": "option",
3512
- "char": "w",
3513
- "summary": "Minutes to wait for the package version to be created.",
3514
- "multiple": false,
3515
- "default": {
3516
- "quantity": 0,
3517
- "unit": 0
3518
- },
3519
- "deprecateAliases": true
3520
- },
3521
- "build-instance": {
3522
- "name": "build-instance",
3523
- "type": "option",
3524
- "char": "s",
3525
- "summary": "Instance where the conversion package version will be created, such as NA50.",
3526
- "hidden": true,
3527
- "multiple": false,
3528
- "deprecateAliases": true,
3529
- "aliases": [
3530
- "buildinstance"
3531
- ]
3532
- },
3533
- "seed-metadata": {
3534
- "name": "seed-metadata",
3535
- "type": "option",
3536
- "char": "m",
3537
- "summary": "Directory containing metadata to be deployed prior to conversion.",
3538
- "description": "The directory containing metadata that will be deployed on the build org prior to attempting conversion.",
3539
- "multiple": false,
3540
- "deprecateAliases": true
3541
- },
3542
- "verbose": {
3543
- "name": "verbose",
3544
- "type": "boolean",
3545
- "summary": "Display verbose command output.",
3546
- "allowNo": false,
3547
- "deprecateAliases": true
3548
- }
3549
- },
3550
- "args": {},
3551
- "hasDynamicHelp": true
3552
- },
3553
- "package:create": {
3554
- "id": "package:create",
3555
- "summary": "Create a package.",
3556
- "description": "First, use this command to create a package. Then create a package version.\n\nIf you don’t have a namespace defined in your sfdx-project.json file, use --no-namespace.\n\nYour --name value must be unique within your namespace.\n\nRun '<%= config.bin %> package list to list all packages in the Dev Hub org.",
3557
- "strict": true,
3558
- "pluginName": "@salesforce/plugin-packaging",
3559
- "pluginAlias": "@salesforce/plugin-packaging",
3560
- "pluginType": "jit",
3561
- "aliases": [
3562
- "force:package:create"
3563
- ],
3564
- "examples": [
3565
- "Create an unlocked package from the files in the \"force-app\" directory; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --name MyUnlockedPackage --package-type Unlocked --path force-app",
3566
- "Create a managed packaged from the \"force-app\" directory files, give the package a description, and use the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --name MyManagedPackage --description \"Your Package Descripton\" --package-type Managed --path force-app --target-dev-hub devhub@example.com"
3567
- ],
3568
- "deprecateAliases": true,
3569
- "flags": {
3570
- "loglevel": {
3571
- "name": "loglevel",
3572
- "type": "option",
3573
- "hidden": true,
3574
- "multiple": false,
3575
- "deprecated": {
3576
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
3577
- },
3578
- "deprecateAliases": true
3579
- },
3580
- "target-dev-hub": {
3581
- "name": "target-dev-hub",
3582
- "type": "option",
3583
- "char": "v",
3584
- "summary": "Username or alias of the Dev Hub org.",
3585
- "required": true,
3586
- "multiple": false,
3587
- "deprecateAliases": true,
3588
- "aliases": [
3589
- "targetdevhubusername",
3590
- "target-hub-org"
3591
- ]
3592
- },
3593
- "api-version": {
3594
- "name": "api-version",
3595
- "type": "option",
3596
- "description": "Override the api version used for api requests made by this command",
3597
- "multiple": false,
3598
- "deprecateAliases": true,
3599
- "aliases": [
3600
- "apiversion"
3601
- ]
3602
- },
3603
- "name": {
3604
- "name": "name",
3605
- "type": "option",
3606
- "char": "n",
3607
- "summary": "Name of the package to create.",
3608
- "required": true,
3609
- "multiple": false,
3610
- "deprecateAliases": true
3611
- },
3612
- "package-type": {
3613
- "name": "package-type",
3614
- "type": "option",
3615
- "char": "t",
3616
- "summary": "Type of package.",
3617
- "description": "The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable). These options determine upgrade and editability rules.",
3618
- "required": true,
3619
- "multiple": false,
3620
- "options": [
3621
- "Managed",
3622
- "Unlocked"
3623
- ],
3624
- "deprecateAliases": true,
3625
- "aliases": [
3626
- "packagetype"
3627
- ]
3628
- },
3629
- "description": {
3630
- "name": "description",
3631
- "type": "option",
3632
- "char": "d",
3633
- "summary": "Description of the package.",
3634
- "multiple": false,
3635
- "deprecateAliases": true
3636
- },
3637
- "no-namespace": {
3638
- "name": "no-namespace",
3639
- "type": "boolean",
3640
- "char": "e",
3641
- "summary": "Create the package with no namespace; available only for unlocked packages.",
3642
- "description": "This flag is useful when you’re migrating an existing org to packages. But use a namespaced package for new metadata.",
3643
- "allowNo": false,
3644
- "deprecateAliases": true,
3645
- "aliases": [
3646
- "nonamespace"
3647
- ]
3648
- },
3649
- "path": {
3650
- "name": "path",
3651
- "type": "option",
3652
- "char": "r",
3653
- "summary": "Path to directory that contains the contents of the package.",
3654
- "required": true,
3655
- "multiple": false,
3656
- "deprecateAliases": true
3657
- },
3658
- "org-dependent": {
3659
- "name": "org-dependent",
3660
- "type": "boolean",
3661
- "summary": "Depends on unpackaged metadata in the installation org; applies to unlocked packages only.",
3662
- "description": "Use Source Tracking in Sandboxes to develop your org-dependent unlocked package. For more information, see \"Create Org-Dependent Unlocked Packages\" in the Salesforce DX Developer Guide.",
3663
- "allowNo": false,
3664
- "deprecateAliases": true,
3665
- "aliases": [
3666
- "orgdependent"
3667
- ]
3668
- },
3669
- "error-notification-username": {
3670
- "name": "error-notification-username",
3671
- "type": "option",
3672
- "char": "o",
3673
- "summary": "Active Dev Hub user designated to receive email notifications for package errors.",
3674
- "description": "Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.",
3675
- "multiple": false,
3676
- "deprecateAliases": true,
3677
- "aliases": [
3678
- "errornotificationusername"
3679
- ]
3680
- }
3681
- },
3682
- "args": {},
3683
- "requiresProject": true,
3684
- "hasDynamicHelp": true
3685
- },
3686
- "package:delete": {
3687
- "id": "package:delete",
3688
- "summary": "Delete a package.",
3689
- "description": "Specify the ID or alias of the package you want to delete.\n\nDelete unlocked and second-generation managed packages. Before you delete a package, first delete all associated package versions.",
3690
- "strict": true,
3691
- "pluginName": "@salesforce/plugin-packaging",
3692
- "pluginAlias": "@salesforce/plugin-packaging",
3693
- "pluginType": "jit",
3694
- "aliases": [
3695
- "force:package:delete"
3696
- ],
3697
- "examples": [
3698
- "Delete a package using its alias from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\"",
3699
- "Delete a package using its ID from the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 0Ho... --target-dev-hub devhub@example.com"
3700
- ],
3701
- "deprecateAliases": true,
3702
- "flags": {
3703
- "loglevel": {
3704
- "name": "loglevel",
3705
- "type": "option",
3706
- "hidden": true,
3707
- "multiple": false,
3708
- "deprecated": {
3709
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
3710
- },
3711
- "deprecateAliases": true
3712
- },
3713
- "target-dev-hub": {
3714
- "name": "target-dev-hub",
3715
- "type": "option",
3716
- "char": "v",
3717
- "summary": "Username or alias of the Dev Hub org.",
3718
- "required": true,
3719
- "multiple": false,
3720
- "deprecateAliases": true,
3721
- "aliases": [
3722
- "targetdevhubusername",
3723
- "target-hub-org"
3724
- ]
3725
- },
3726
- "api-version": {
3727
- "name": "api-version",
3728
- "type": "option",
3729
- "description": "Override the api version used for api requests made by this command",
3730
- "multiple": false,
3731
- "deprecateAliases": true,
3732
- "aliases": [
3733
- "apiversion"
3734
- ]
3735
- },
3736
- "no-prompt": {
3737
- "name": "no-prompt",
3738
- "type": "boolean",
3739
- "char": "n",
3740
- "summary": "Don’t prompt before deleting the package.",
3741
- "allowNo": false,
3742
- "deprecateAliases": true,
3743
- "aliases": [
3744
- "noprompt"
3745
- ]
3746
- },
3747
- "package": {
3748
- "name": "package",
3749
- "type": "option",
3750
- "char": "p",
3751
- "summary": "ID (starts with 0Ho) or alias of the package to delete.",
3752
- "required": true,
3753
- "multiple": false,
3754
- "deprecateAliases": true
3755
- },
3756
- "undelete": {
3757
- "name": "undelete",
3758
- "type": "boolean",
3759
- "summary": "Undelete a deleted package.",
3760
- "hidden": true,
3761
- "allowNo": false,
3762
- "deprecateAliases": true
3763
- }
3764
- },
3765
- "args": {},
3766
- "requiresProject": true,
3767
- "hasDynamicHelp": true
3768
- },
3769
- "package:install": {
3770
- "id": "package:install",
3771
- "summary": "Install a version of a package in the target org.",
3772
- "description": "To install a package, specify a specific version of the package using the 04t package ID. The package and the version you specified installs in your default target org unless you supply the username for a different target org.\n\nFor package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgrade-type value. To delete components that can be safely deleted and deprecate the others, specify --upgrade-type Mixed (the default). To deprecate all removed components, specify --upgrade-type DeprecateOnly. To delete all removed components, except for custom objects and custom fields, that don't have dependencies, specify --upgrade-type Delete. (Note: This option can result in the loss of data that is associated with the deleted components.) The default is Mixed.",
3773
- "strict": true,
3774
- "pluginName": "@salesforce/plugin-packaging",
3775
- "pluginAlias": "@salesforce/plugin-packaging",
3776
- "pluginType": "jit",
3777
- "aliases": [
3778
- "force:package:install"
3779
- ],
3780
- "examples": [
3781
- "Install a package version with the specified ID in the org with username \"me@example.com\":\n<%= config.bin %> <%= command.id %> --package 04t... --target-org me@example.com",
3782
- "Install a package version with the specified alias into your default org:\n<%= config.bin %> <%= command.id %> --package awesome_package_alias",
3783
- "Install a package version with an alias that includes spaces into your default org:\n<%= config.bin %> <%= command.id %> --package \"Awesome Package Alias\"",
3784
- "Install an unlocked package version with the specified ID and deprecate all removed components:\n<%= config.bin %> <%= command.id %> --package 04t... --upgrade-type DeprecateOnly"
3785
- ],
3786
- "deprecateAliases": true,
3787
- "flags": {
3788
- "loglevel": {
3789
- "name": "loglevel",
3790
- "type": "option",
3791
- "hidden": true,
3792
- "multiple": false,
3793
- "deprecated": {
3794
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
3795
- },
3796
- "deprecateAliases": true
3797
- },
3798
- "target-org": {
3799
- "name": "target-org",
3800
- "type": "option",
3801
- "char": "o",
3802
- "summary": "Username or alias of the target org.",
3803
- "required": true,
3804
- "multiple": false,
3805
- "deprecateAliases": true,
3806
- "aliases": [
3807
- "targetusername",
3808
- "u"
3809
- ]
3810
- },
3811
- "api-version": {
3812
- "name": "api-version",
3813
- "type": "option",
3814
- "description": "Override the api version used for api requests made by this command",
3815
- "multiple": false,
3816
- "deprecateAliases": true,
3817
- "aliases": [
3818
- "apiversion"
3819
- ]
3820
- },
3821
- "wait": {
3822
- "name": "wait",
3823
- "type": "option",
3824
- "char": "w",
3825
- "summary": "Number of minutes to wait for installation status.",
3826
- "multiple": false,
3827
- "default": {
3828
- "quantity": 0,
3829
- "unit": 0
3830
- },
3831
- "deprecateAliases": true
3832
- },
3833
- "installation-key": {
3834
- "name": "installation-key",
3835
- "type": "option",
3836
- "char": "k",
3837
- "summary": "Installation key for key-protected package (default: null).",
3838
- "multiple": false,
3839
- "deprecateAliases": true,
3840
- "aliases": [
3841
- "installationkey"
3842
- ]
3843
- },
3844
- "publish-wait": {
3845
- "name": "publish-wait",
3846
- "type": "option",
3847
- "char": "b",
3848
- "summary": "Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request.",
3849
- "multiple": false,
3850
- "default": {
3851
- "quantity": 0,
3852
- "unit": 0
3853
- },
3854
- "deprecateAliases": true,
3855
- "aliases": [
3856
- "publishwait"
3857
- ]
3858
- },
3859
- "no-prompt": {
3860
- "name": "no-prompt",
3861
- "type": "boolean",
3862
- "char": "r",
3863
- "summary": "Don't prompt for confirmation.",
3864
- "description": "Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy websites to send or receive data, and 2) --upgrade-type Delete to proceed.",
3865
- "allowNo": false,
3866
- "deprecateAliases": true,
3867
- "aliases": [
3868
- "noprompt"
3869
- ]
3870
- },
3871
- "package": {
3872
- "name": "package",
3873
- "type": "option",
3874
- "char": "p",
3875
- "summary": "ID (starts with 04t) or alias of the package version to install.",
3876
- "required": true,
3877
- "multiple": false,
3878
- "deprecateAliases": true
3879
- },
3880
- "apex-compile": {
3881
- "name": "apex-compile",
3882
- "type": "option",
3883
- "char": "a",
3884
- "summary": "Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.",
3885
- "description": "Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in the package.\n\nFor package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles all Apex in the org after the package install or upgrade operation completes.\n\nThis approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if --apex-compile package is specified.",
3886
- "multiple": false,
3887
- "options": [
3888
- "all",
3889
- "package"
3890
- ],
3891
- "default": "all",
3892
- "deprecateAliases": true,
3893
- "aliases": [
3894
- "apexcompile"
3895
- ]
3896
- },
3897
- "security-type": {
3898
- "name": "security-type",
3899
- "type": "option",
3900
- "char": "s",
3901
- "summary": "Security access type for the installed package. (deprecation notice: The default --security-type value will change from AllUsers to AdminsOnly in v47.0 or later.)",
3902
- "multiple": false,
3903
- "options": [
3904
- "AllUsers",
3905
- "AdminsOnly"
3906
- ],
3907
- "default": "AdminsOnly",
3908
- "deprecateAliases": true,
3909
- "aliases": [
3910
- "securitytype"
3911
- ]
3912
- },
3913
- "upgrade-type": {
3914
- "name": "upgrade-type",
3915
- "type": "option",
3916
- "char": "t",
3917
- "summary": "Upgrade type for the package installation; available only for unlocked packages.",
3918
- "description": "For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components, except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can specify DeprecateOnly or Delete only for unlocked package upgrades.",
3919
- "multiple": false,
3920
- "options": [
3921
- "DeprecateOnly",
3922
- "Mixed",
3923
- "Delete"
3924
- ],
3925
- "default": "Mixed",
3926
- "deprecateAliases": true,
3927
- "aliases": [
3928
- "upgradetype"
3929
- ]
3930
- },
3931
- "skip-handlers": {
3932
- "name": "skip-handlers",
3933
- "type": "option",
3934
- "char": "l",
3935
- "summary": "Skip install handlers (available handlers: FeatureEnforcement).",
3936
- "description": "Allows the installer of a package to optionally skip install handlers in order to decrease overall installation time (available handlers: FeatureEnforcement).",
3937
- "hidden": true,
3938
- "multiple": true,
3939
- "options": [
3940
- "FeatureEnforcement"
3941
- ],
3942
- "deprecateAliases": true
3943
- }
3944
- },
3945
- "args": {},
3946
- "hasDynamicHelp": true
3947
- },
3948
- "package:list": {
3949
- "id": "package:list",
3950
- "summary": "List all packages in the Dev Hub org.",
3951
- "description": "Description",
3952
- "strict": true,
3953
- "pluginName": "@salesforce/plugin-packaging",
3954
- "pluginAlias": "@salesforce/plugin-packaging",
3955
- "pluginType": "jit",
3956
- "aliases": [
3957
- "force:package:list"
3958
- ],
3959
- "examples": [
3960
- "List all packages in the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com",
3961
- "List all packages details in the specified Dev Hub org, and show extended details about each package:\n<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com --verbose"
3962
- ],
3963
- "deprecateAliases": true,
3964
- "flags": {
3965
- "loglevel": {
3966
- "name": "loglevel",
3967
- "type": "option",
3968
- "hidden": true,
3969
- "multiple": false,
3970
- "deprecated": {
3971
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
3972
- },
3973
- "deprecateAliases": true
3974
- },
3975
- "target-dev-hub": {
3976
- "name": "target-dev-hub",
3977
- "type": "option",
3978
- "char": "v",
3979
- "summary": "Username or alias of the Dev Hub org.",
3980
- "required": true,
3981
- "multiple": false,
3982
- "deprecateAliases": true,
3983
- "aliases": [
3984
- "targetdevhubusername",
3985
- "target-hub-org"
3986
- ]
3987
- },
3988
- "api-version": {
3989
- "name": "api-version",
3990
- "type": "option",
3991
- "description": "Override the api version used for api requests made by this command",
3992
- "multiple": false,
3993
- "deprecateAliases": true,
3994
- "aliases": [
3995
- "apiversion"
3996
- ]
3997
- },
3998
- "verbose": {
3999
- "name": "verbose",
4000
- "type": "boolean",
4001
- "summary": "Display extended package detail.",
4002
- "allowNo": false,
4003
- "deprecateAliases": true
4004
- }
4005
- },
4006
- "args": {},
4007
- "requiresProject": true,
4008
- "hasDynamicHelp": true
4009
- },
4010
- "package:uninstall": {
4011
- "id": "package:uninstall",
4012
- "summary": "Uninstall a second-generation package from the target org.",
4013
- "description": "Specify the package ID for a second-generation package.\n\nTo list the org’s installed packages, run \"<%= config.bin %> package installed list\".\n\nTo uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select Installed Packages.",
4014
- "strict": true,
4015
- "pluginName": "@salesforce/plugin-packaging",
4016
- "pluginAlias": "@salesforce/plugin-packaging",
4017
- "pluginType": "jit",
4018
- "aliases": [
4019
- "force:package:uninstall"
4020
- ],
4021
- "examples": [
4022
- "Uninstall a package with specified ID from an org with username me@example.com:\n<%= config.bin %> <%= command.id %> --package 04t... --target-org me@example.com",
4023
- "Uninstall a package with the specified alias from your default org:\n<%= config.bin %> <%= command.id %> --package undesirable_package_alias",
4024
- "Uninstall a package with an alias that contains spaces from your default org:\n<%= config.bin %> <%= command.id %> --package \"Undesirable Package Alias\""
4025
- ],
4026
- "deprecateAliases": true,
4027
- "flags": {
4028
- "loglevel": {
4029
- "name": "loglevel",
4030
- "type": "option",
4031
- "hidden": true,
4032
- "multiple": false,
4033
- "deprecated": {
4034
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4035
- },
4036
- "deprecateAliases": true
4037
- },
4038
- "target-org": {
4039
- "name": "target-org",
4040
- "type": "option",
4041
- "char": "o",
4042
- "summary": "Username or alias of the target org.",
4043
- "required": true,
4044
- "multiple": false,
4045
- "deprecateAliases": true,
4046
- "aliases": [
4047
- "targetusername",
4048
- "u"
4049
- ]
4050
- },
4051
- "api-version": {
4052
- "name": "api-version",
4053
- "type": "option",
4054
- "description": "Override the api version used for api requests made by this command",
4055
- "multiple": false,
4056
- "deprecateAliases": true,
4057
- "aliases": [
4058
- "apiversion"
4059
- ]
4060
- },
4061
- "wait": {
4062
- "name": "wait",
4063
- "type": "option",
4064
- "char": "w",
4065
- "summary": "Number of minutes to wait for uninstall status.",
4066
- "multiple": false,
4067
- "default": {
4068
- "quantity": 0,
4069
- "unit": 0
4070
- },
4071
- "deprecateAliases": true
4072
- },
4073
- "package": {
4074
- "name": "package",
4075
- "type": "option",
4076
- "char": "p",
4077
- "summary": "ID (starts with 04t) or alias of the package version to uninstall.",
4078
- "required": true,
4079
- "multiple": false,
4080
- "deprecateAliases": true
4081
- }
4082
- },
4083
- "args": {},
4084
- "hasDynamicHelp": true
4085
- },
4086
- "package:update": {
4087
- "id": "package:update",
4088
- "summary": "Update package details.",
4089
- "description": "Specify a new value for each option you want to update.\n\nRun \"<%= config.bin %> package list\" to list all packages in the Dev Hub org.",
4090
- "strict": true,
4091
- "pluginName": "@salesforce/plugin-packaging",
4092
- "pluginAlias": "@salesforce/plugin-packaging",
4093
- "pluginType": "jit",
4094
- "aliases": [
4095
- "force:package:update"
4096
- ],
4097
- "examples": [
4098
- "Update the name of the package with the specified alias; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --name \"New Package Name\"",
4099
- "Update the description of the package with the specified ID; uses the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 0Ho... --description \"New Package Description\" --target-dev-hub devhub@example.com"
4100
- ],
4101
- "deprecateAliases": true,
4102
- "flags": {
4103
- "loglevel": {
4104
- "name": "loglevel",
4105
- "type": "option",
4106
- "hidden": true,
4107
- "multiple": false,
4108
- "deprecated": {
4109
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4110
- },
4111
- "deprecateAliases": true
4112
- },
4113
- "target-dev-hub": {
4114
- "name": "target-dev-hub",
4115
- "type": "option",
4116
- "char": "v",
4117
- "summary": "Username or alias of the Dev Hub org.",
4118
- "required": true,
4119
- "multiple": false,
4120
- "deprecateAliases": true,
4121
- "aliases": [
4122
- "targetdevhubusername",
4123
- "target-hub-org"
4124
- ]
4125
- },
4126
- "api-version": {
4127
- "name": "api-version",
4128
- "type": "option",
4129
- "description": "Override the api version used for api requests made by this command",
4130
- "multiple": false,
4131
- "deprecateAliases": true,
4132
- "aliases": [
4133
- "apiversion"
4134
- ]
4135
- },
4136
- "package": {
4137
- "name": "package",
4138
- "type": "option",
4139
- "char": "p",
4140
- "summary": "ID (starts with 0Ho) or alias of the package to update.",
4141
- "required": true,
4142
- "multiple": false,
4143
- "deprecateAliases": true
4144
- },
4145
- "name": {
4146
- "name": "name",
4147
- "type": "option",
4148
- "char": "n",
4149
- "summary": "New name of the package.",
4150
- "multiple": false,
4151
- "deprecateAliases": true
4152
- },
4153
- "description": {
4154
- "name": "description",
4155
- "type": "option",
4156
- "char": "d",
4157
- "summary": "New description of the package.",
4158
- "multiple": false,
4159
- "deprecateAliases": true
4160
- },
4161
- "error-notification-username": {
4162
- "name": "error-notification-username",
4163
- "type": "option",
4164
- "char": "o",
4165
- "summary": "Active Dev Hub user designated to receive email notifications for package errors.",
4166
- "description": "Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.",
4167
- "multiple": false,
4168
- "deprecateAliases": true,
4169
- "aliases": [
4170
- "errornotificationusername"
4171
- ]
4172
- },
4173
- "enable-app-analytics": {
4174
- "name": "enable-app-analytics",
4175
- "type": "boolean",
4176
- "summary": "Enable AppExchange App Analytics usage data collection on this managed package and its components.",
4177
- "allowNo": true,
4178
- "deprecateAliases": true
4179
- }
4180
- },
4181
- "args": {},
4182
- "requiresProject": true,
4183
- "hasDynamicHelp": true
4184
- },
4185
- "package:install:report": {
4186
- "id": "package:install:report",
4187
- "summary": "Retrieve the status of a package installation request.",
4188
- "strict": true,
4189
- "pluginName": "@salesforce/plugin-packaging",
4190
- "pluginAlias": "@salesforce/plugin-packaging",
4191
- "pluginType": "jit",
4192
- "aliases": [
4193
- "force:package:install:report"
4194
- ],
4195
- "examples": [
4196
- "Retrieve the status of a package installation request with the specified ID on your default org:\n<%= config.bin %> <%= command.id %> --request-id 0Hf...",
4197
- "Similar to previous example, except use the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --request-id 0Hf... --target-org me@example.com"
4198
- ],
4199
- "deprecateAliases": true,
4200
- "flags": {
4201
- "target-org": {
4202
- "name": "target-org",
4203
- "type": "option",
4204
- "char": "o",
4205
- "summary": "Username or alias of the target org.",
4206
- "required": true,
4207
- "multiple": false,
4208
- "deprecateAliases": true,
4209
- "aliases": [
4210
- "targetusername",
4211
- "u"
4212
- ]
4213
- },
4214
- "api-version": {
4215
- "name": "api-version",
4216
- "type": "option",
4217
- "description": "Override the api version used for api requests made by this command",
4218
- "multiple": false,
4219
- "deprecateAliases": true,
4220
- "aliases": [
4221
- "apiversion"
4222
- ]
4223
- },
4224
- "loglevel": {
4225
- "name": "loglevel",
4226
- "type": "option",
4227
- "hidden": true,
4228
- "multiple": false,
4229
- "deprecated": {
4230
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4231
- },
4232
- "deprecateAliases": true
4233
- },
4234
- "request-id": {
4235
- "name": "request-id",
4236
- "type": "option",
4237
- "char": "i",
4238
- "summary": "ID of the package install request you want to check; starts with 0Hf.",
4239
- "required": true,
4240
- "multiple": false,
4241
- "deprecateAliases": true,
4242
- "aliases": [
4243
- "requestid"
4244
- ]
4245
- }
4246
- },
4247
- "args": {},
4248
- "hasDynamicHelp": true
4249
- },
4250
- "package:installed:list": {
4251
- "id": "package:installed:list",
4252
- "summary": "List the org’s installed packages.",
4253
- "strict": true,
4254
- "pluginName": "@salesforce/plugin-packaging",
4255
- "pluginAlias": "@salesforce/plugin-packaging",
4256
- "pluginType": "jit",
4257
- "aliases": [
4258
- "force:package:installed:list"
4259
- ],
4260
- "examples": [
4261
- "List the installed packages in your default org:\n<%= config.bin %> <%= command.id %>",
4262
- "List the installed packages in the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --target-org me@example.com"
4263
- ],
4264
- "deprecateAliases": true,
4265
- "flags": {
4266
- "loglevel": {
4267
- "name": "loglevel",
4268
- "type": "option",
4269
- "hidden": true,
4270
- "multiple": false,
4271
- "deprecated": {
4272
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4273
- },
4274
- "deprecateAliases": true
4275
- },
4276
- "target-org": {
4277
- "name": "target-org",
4278
- "type": "option",
4279
- "char": "o",
4280
- "summary": "Username or alias of the target org.",
4281
- "required": true,
4282
- "multiple": false,
4283
- "deprecateAliases": true,
4284
- "aliases": [
4285
- "targetusername",
4286
- "u"
4287
- ]
4288
- },
4289
- "api-version": {
4290
- "name": "api-version",
4291
- "type": "option",
4292
- "description": "Override the api version used for api requests made by this command",
4293
- "multiple": false,
4294
- "deprecateAliases": true,
4295
- "aliases": [
4296
- "apiversion"
4297
- ]
4298
- }
4299
- },
4300
- "args": {},
4301
- "requiresProject": true,
4302
- "hasDynamicHelp": true
4303
- },
4304
- "package:uninstall:report": {
4305
- "id": "package:uninstall:report",
4306
- "summary": "Retrieve the status of a package uninstall request.",
4307
- "strict": true,
4308
- "pluginName": "@salesforce/plugin-packaging",
4309
- "pluginAlias": "@salesforce/plugin-packaging",
4310
- "pluginType": "jit",
4311
- "aliases": [
4312
- "force:package:uninstall:report"
4313
- ],
4314
- "examples": [
4315
- "Retrieve the status of a package uninstall in your default org using the specified request ID:\n<%= config.bin %> <%= command.id %> --request-id 06y...",
4316
- "Similar to previous example, but use the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --request-id 06y... --target-org me@example.com"
4317
- ],
4318
- "deprecateAliases": true,
4319
- "flags": {
4320
- "loglevel": {
4321
- "name": "loglevel",
4322
- "type": "option",
4323
- "hidden": true,
4324
- "multiple": false,
4325
- "deprecated": {
4326
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4327
- },
4328
- "deprecateAliases": true
4329
- },
4330
- "target-org": {
4331
- "name": "target-org",
4332
- "type": "option",
4333
- "char": "o",
4334
- "summary": "Username or alias of the target org.",
4335
- "required": true,
4336
- "multiple": false,
4337
- "deprecateAliases": true,
4338
- "aliases": [
4339
- "targetusername",
4340
- "u"
4341
- ]
4342
- },
4343
- "api-version": {
4344
- "name": "api-version",
4345
- "type": "option",
4346
- "description": "Override the api version used for api requests made by this command",
4347
- "multiple": false,
4348
- "deprecateAliases": true,
4349
- "aliases": [
4350
- "apiversion"
4351
- ]
4352
- },
4353
- "request-id": {
4354
- "name": "request-id",
4355
- "type": "option",
4356
- "char": "i",
4357
- "summary": "ID of the package uninstall request you want to check; starts with 06y.",
4358
- "required": true,
4359
- "multiple": false,
4360
- "deprecateAliases": true,
4361
- "aliases": [
4362
- "requestid"
4363
- ]
4364
- }
4365
- },
4366
- "args": {},
4367
- "hasDynamicHelp": true
4368
- },
4369
- "package:version:create": {
4370
- "id": "package:version:create",
4371
- "summary": "Create a package version in the Dev Hub org.",
4372
- "description": "The package version is based on the package contents in the specified directory.\n\nTo retrieve details about a package version create request, including status and package version ID (04t), run \"<%= config.bin %> package version create report -i 08c...\".\n\nWe recommend that you specify the --installation-key parameter to protect the contents of your package and to prevent unauthorized installation of your package.\n\nTo list package version creation requests in the org, run \"<%= config.bin %> package version create list\".\nTo promote a package version to released, you must use the --code-coverage parameter. The package must also meet the code coverage requirements. This requirement applies to both managed and unlocked packages.\n\nWe don’t calculate code coverage for org-dependent unlocked packages, or for package versions that specify --skip-validation.",
4373
- "strict": true,
4374
- "pluginName": "@salesforce/plugin-packaging",
4375
- "pluginAlias": "@salesforce/plugin-packaging",
4376
- "pluginType": "jit",
4377
- "aliases": [
4378
- "force:package:version:create"
4379
- ],
4380
- "examples": [
4381
- "Create a package version from the contents of the \"common\" directory and give it an installation key of \"password123\"; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --path common --installation-key password123",
4382
- "Create a package version from a package with the specified alias; uses the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --installation-key password123 --target-dev-hub devhub@example.com",
4383
- "Create a package version from a package with the specified ID:\n<%= config.bin %> <%= command.id %> --package 0Ho... --installation-key password123",
4384
- "Create a package version and skip the validation step:\n<%= config.bin %> <%= command.id %> --path common --installation-key password123 --skip-validation"
4385
- ],
4386
- "deprecateAliases": true,
4387
- "flags": {
4388
- "loglevel": {
4389
- "name": "loglevel",
4390
- "type": "option",
4391
- "hidden": true,
4392
- "multiple": false,
4393
- "deprecated": {
4394
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4395
- },
4396
- "deprecateAliases": true
4397
- },
4398
- "target-dev-hub": {
4399
- "name": "target-dev-hub",
4400
- "type": "option",
4401
- "char": "v",
4402
- "summary": "Username or alias of the Dev Hub org.",
4403
- "required": true,
4404
- "multiple": false,
4405
- "deprecateAliases": true,
4406
- "aliases": [
4407
- "targetdevhubusername",
4408
- "target-hub-org"
4409
- ]
4410
- },
4411
- "api-version": {
4412
- "name": "api-version",
4413
- "type": "option",
4414
- "description": "Override the api version used for api requests made by this command",
4415
- "multiple": false,
4416
- "deprecateAliases": true,
4417
- "aliases": [
4418
- "apiversion"
4419
- ]
4420
- },
4421
- "branch": {
4422
- "name": "branch",
4423
- "type": "option",
4424
- "char": "b",
4425
- "summary": "Name of the branch in your source control system that the package version is based on.",
4426
- "multiple": false,
4427
- "deprecateAliases": true
4428
- },
4429
- "build-instance": {
4430
- "name": "build-instance",
4431
- "type": "option",
4432
- "char": "s",
4433
- "summary": "Instance where the package version will be created, such as NA50.",
4434
- "hidden": true,
4435
- "multiple": false,
4436
- "deprecateAliases": true,
4437
- "aliases": [
4438
- "buildinstance"
4439
- ]
4440
- },
4441
- "code-coverage": {
4442
- "name": "code-coverage",
4443
- "type": "boolean",
4444
- "char": "c",
4445
- "summary": "Calculate and store the code coverage percentage by running the packaged Apex tests included in this package version.",
4446
- "description": "Before you can promote and release a managed or unlocked package version, the Apex code must meet a minimum 75% code coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions that specify --skip-validation.",
4447
- "allowNo": false,
4448
- "exclusive": [
4449
- "skip-validation"
4450
- ],
4451
- "deprecateAliases": true,
4452
- "aliases": [
4453
- "codecoverage"
4454
- ]
4455
- },
4456
- "definition-file": {
4457
- "name": "definition-file",
4458
- "type": "option",
4459
- "char": "f",
4460
- "summary": "Path to a definition file similar to scratch org definition file that contains the list of features and org preferences that the metadata of the package version depends on.",
4461
- "multiple": false,
4462
- "deprecateAliases": true,
4463
- "aliases": [
4464
- "definitionfile"
4465
- ]
4466
- },
4467
- "installation-key": {
4468
- "name": "installation-key",
4469
- "type": "option",
4470
- "char": "k",
4471
- "summary": "Installation key for key-protected package. (either --installation-key or --installation-key-bypass is required)",
4472
- "multiple": false,
4473
- "deprecateAliases": true,
4474
- "aliases": [
4475
- "installationkey"
4476
- ]
4477
- },
4478
- "installation-key-bypass": {
4479
- "name": "installation-key-bypass",
4480
- "type": "boolean",
4481
- "char": "x",
4482
- "summary": "Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)",
4483
- "description": "If you bypass this requirement, anyone can install your package.",
4484
- "allowNo": false,
4485
- "deprecateAliases": true,
4486
- "aliases": [
4487
- "installationkeybypass"
4488
- ]
4489
- },
4490
- "package": {
4491
- "name": "package",
4492
- "type": "option",
4493
- "char": "p",
4494
- "summary": "ID (starts with 0Ho) or alias of the package to create a version of.",
4495
- "multiple": false,
4496
- "deprecateAliases": true
4497
- },
4498
- "path": {
4499
- "name": "path",
4500
- "type": "option",
4501
- "char": "d",
4502
- "summary": "Path to the directory that contains the contents of the package.",
4503
- "multiple": false,
4504
- "deprecateAliases": true
4505
- },
4506
- "post-install-script": {
4507
- "name": "post-install-script",
4508
- "type": "option",
4509
- "summary": "Name of the post-install script; applies to managed packages only.",
4510
- "description": "The post-install script is an Apex class within this package that is run in the installing org after installations or upgrades of this package version.",
4511
- "multiple": false,
4512
- "deprecateAliases": true,
4513
- "aliases": [
4514
- "postinstallscript"
4515
- ]
4516
- },
4517
- "post-install-url": {
4518
- "name": "post-install-url",
4519
- "type": "option",
4520
- "summary": "Post-install instructions URL.",
4521
- "description": "The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.",
4522
- "multiple": false,
4523
- "deprecateAliases": true,
4524
- "aliases": [
4525
- "postinstallurl"
4526
- ]
4527
- },
4528
- "preserve": {
4529
- "name": "preserve",
4530
- "type": "boolean",
4531
- "char": "r",
4532
- "summary": "Preserve temp files that would otherwise be deleted.",
4533
- "hidden": true,
4534
- "allowNo": false,
4535
- "deprecateAliases": true
4536
- },
4537
- "releasenotes-url": {
4538
- "name": "releasenotes-url",
4539
- "type": "option",
4540
- "summary": "Release notes URL.",
4541
- "description": "This link is displayed in the package installation UI to provide release notes for this package version to subscribers.",
4542
- "multiple": false,
4543
- "deprecateAliases": true,
4544
- "aliases": [
4545
- "releasenotesurl"
4546
- ]
4547
- },
4548
- "skip-ancestor-check": {
4549
- "name": "skip-ancestor-check",
4550
- "type": "boolean",
4551
- "summary": "Overrides ancestry requirements, which allows you to specify a package ancestor that isn’t the highest released package version.",
4552
- "allowNo": false,
4553
- "deprecateAliases": true,
4554
- "aliases": [
4555
- "skipancestorcheck"
4556
- ]
4557
- },
4558
- "skip-validation": {
4559
- "name": "skip-validation",
4560
- "type": "boolean",
4561
- "summary": "Skip validation during package version creation; you can’t promote unvalidated package versions.",
4562
- "description": "Skips validation of dependencies, package ancestors, and metadata during package version creation. Skipping validation reduces the time it takes to create a new package version, but you can promote only validated package versions. Skipping validation can suppress important errors that can surface at a later stage. You can specify skip validation or code coverage, but not both. Code coverage is calculated during validation.",
4563
- "allowNo": false,
4564
- "exclusive": [
4565
- "code-coverage"
4566
- ],
4567
- "deprecateAliases": true,
4568
- "aliases": [
4569
- "skipvalidation"
4570
- ]
4571
- },
4572
- "tag": {
4573
- "name": "tag",
4574
- "type": "option",
4575
- "char": "t",
4576
- "summary": "Package version’s tag.",
4577
- "multiple": false,
4578
- "deprecateAliases": true
4579
- },
4580
- "uninstall-script": {
4581
- "name": "uninstall-script",
4582
- "type": "option",
4583
- "summary": "Uninstall script name; applies to managed packages only.",
4584
- "description": "The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of this package.",
4585
- "multiple": false,
4586
- "deprecateAliases": true,
4587
- "aliases": [
4588
- "uninstallscript"
4589
- ]
4590
- },
4591
- "validate-schema": {
4592
- "name": "validate-schema",
4593
- "type": "boolean",
4594
- "char": "j",
4595
- "summary": "Validate the sfdx-project.json file against the JSON schema.",
4596
- "hidden": true,
4597
- "allowNo": false,
4598
- "deprecateAliases": true,
4599
- "aliases": [
4600
- "validateschema"
4601
- ]
4602
- },
4603
- "version-description": {
4604
- "name": "version-description",
4605
- "type": "option",
4606
- "char": "e",
4607
- "summary": "Description of the package version to be created; overrides the sfdx-project.json value.",
4608
- "multiple": false,
4609
- "deprecateAliases": true,
4610
- "aliases": [
4611
- "versiondescription"
4612
- ]
4613
- },
4614
- "version-name": {
4615
- "name": "version-name",
4616
- "type": "option",
4617
- "char": "a",
4618
- "summary": "Name of the package version to be created; overrides the sfdx-project.json value.",
4619
- "multiple": false,
4620
- "deprecateAliases": true,
4621
- "aliases": [
4622
- "versionname"
4623
- ]
4624
- },
4625
- "version-number": {
4626
- "name": "version-number",
4627
- "type": "option",
4628
- "char": "n",
4629
- "summary": "Version number of the package version to be created; overrides the sfdx-project.json value.",
4630
- "description": "For information about the format of the version number, see https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev2gp_config_file.htm.",
4631
- "multiple": false,
4632
- "deprecateAliases": true,
4633
- "aliases": [
4634
- "versionnumber"
4635
- ]
4636
- },
4637
- "wait": {
4638
- "name": "wait",
4639
- "type": "option",
4640
- "char": "w",
4641
- "summary": "Number of minutes to wait for the package version to be created.",
4642
- "multiple": false,
4643
- "default": {
4644
- "quantity": 0,
4645
- "unit": 0
4646
- },
4647
- "deprecateAliases": true
4648
- },
4649
- "language": {
4650
- "name": "language",
4651
- "type": "option",
4652
- "summary": "Language for the package.",
4653
- "description": "Specify the language using a language code listed under \"Supported Languages\" in Salesforce Help. If no language is specified, the language defaults to the language of the Dev Hub user who created the package.",
4654
- "multiple": false,
4655
- "deprecateAliases": true
4656
- },
4657
- "verbose": {
4658
- "name": "verbose",
4659
- "type": "boolean",
4660
- "summary": "Display verbose command output.",
4661
- "description": "Display verbose command output. When polling for the status of the creation, this will output status and timeout data on a separate line for each poll request, which is useful in CI systems where timeouts can occur with long periods of no output from commands.",
4662
- "allowNo": false,
4663
- "deprecateAliases": true
4664
- }
4665
- },
4666
- "args": {},
4667
- "requiresProject": true,
4668
- "hasDynamicHelp": true
4669
- },
4670
- "package:version:delete": {
4671
- "id": "package:version:delete",
4672
- "summary": "Delete a package version.",
4673
- "description": "Specify the ID or alias of the package version you want to delete.",
4674
- "strict": true,
4675
- "pluginName": "@salesforce/plugin-packaging",
4676
- "pluginAlias": "@salesforce/plugin-packaging",
4677
- "pluginType": "jit",
4678
- "aliases": [
4679
- "force:package:version:delete"
4680
- ],
4681
- "examples": [
4682
- "Delete a package version with the specified alias using your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\"",
4683
- "Delete a package version with the specified ID using the Dev Hub org with username \"devhub@example.com\":\n<%= config.bin %> <%= command.id %> --package 04t... --target-org devhub@example.com"
4684
- ],
4685
- "deprecateAliases": true,
4686
- "flags": {
4687
- "loglevel": {
4688
- "name": "loglevel",
4689
- "type": "option",
4690
- "hidden": true,
4691
- "multiple": false,
4692
- "deprecated": {
4693
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4694
- },
4695
- "deprecateAliases": true
4696
- },
4697
- "target-dev-hub": {
4698
- "name": "target-dev-hub",
4699
- "type": "option",
4700
- "char": "v",
4701
- "summary": "Username or alias of the Dev Hub org.",
4702
- "required": true,
4703
- "multiple": false,
4704
- "deprecateAliases": true,
4705
- "aliases": [
4706
- "targetdevhubusername",
4707
- "target-hub-org"
4708
- ]
4709
- },
4710
- "api-version": {
4711
- "name": "api-version",
4712
- "type": "option",
4713
- "description": "Override the api version used for api requests made by this command",
4714
- "multiple": false,
4715
- "deprecateAliases": true,
4716
- "aliases": [
4717
- "apiversion"
4718
- ]
4719
- },
4720
- "no-prompt": {
4721
- "name": "no-prompt",
4722
- "type": "boolean",
4723
- "char": "n",
4724
- "summary": "Don’t prompt before deleting the package version.",
4725
- "allowNo": false,
4726
- "deprecateAliases": true,
4727
- "aliases": [
4728
- "noprompt"
4729
- ]
4730
- },
4731
- "package": {
4732
- "name": "package",
4733
- "type": "option",
4734
- "char": "p",
4735
- "summary": "ID (starts with 04t) or alias of the package version to delete.",
4736
- "required": true,
4737
- "multiple": false,
4738
- "deprecateAliases": true
4739
- },
4740
- "undelete": {
4741
- "name": "undelete",
4742
- "type": "boolean",
4743
- "summary": "Undelete a deleted package version.",
4744
- "hidden": true,
4745
- "allowNo": false,
4746
- "deprecateAliases": true
4747
- }
4748
- },
4749
- "args": {},
4750
- "requiresProject": true,
4751
- "hasDynamicHelp": true
4752
- },
4753
- "package:version:displayancestry": {
4754
- "id": "package:version:displayancestry",
4755
- "summary": "Display the ancestry tree for a 2GP managed package version.",
4756
- "strict": true,
4757
- "pluginName": "@salesforce/plugin-packaging",
4758
- "pluginAlias": "@salesforce/plugin-packaging",
4759
- "pluginType": "jit",
4760
- "aliases": [
4761
- "force:package:version:displayancestry"
4762
- ],
4763
- "examples": [
4764
- "Display the ancestry tree for a package version with the specified alias, using your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package package_version_alias",
4765
- "Similar to previous example, but display the output in DOT code:\n<%= config.bin %> <%= command.id %> --package package_version_alias --dot-code",
4766
- "Display the ancestry tree for a package with the specified ID, using the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package OHo... --target-dev-hub devhub@example.com",
4767
- "Display the ancestry tree of a package version with the specified ID, using your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 04t..."
4768
- ],
4769
- "deprecateAliases": true,
4770
- "flags": {
4771
- "loglevel": {
4772
- "name": "loglevel",
4773
- "type": "option",
4774
- "hidden": true,
4775
- "multiple": false,
4776
- "deprecated": {
4777
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4778
- },
4779
- "deprecateAliases": true
4780
- },
4781
- "target-dev-hub": {
4782
- "name": "target-dev-hub",
4783
- "type": "option",
4784
- "char": "v",
4785
- "summary": "Username or alias of the Dev Hub org.",
4786
- "required": true,
4787
- "multiple": false,
4788
- "deprecateAliases": true,
4789
- "aliases": [
4790
- "targetdevhubusername",
4791
- "target-hub-org"
4792
- ]
4793
- },
4794
- "api-version": {
4795
- "name": "api-version",
4796
- "type": "option",
4797
- "description": "Override the api version used for api requests made by this command",
4798
- "multiple": false,
4799
- "deprecateAliases": true,
4800
- "aliases": [
4801
- "apiversion"
4802
- ]
4803
- },
4804
- "package": {
4805
- "name": "package",
4806
- "type": "option",
4807
- "char": "p",
4808
- "summary": "ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for.",
4809
- "description": "If you specify a package ID (starts with 0Ho) or alias, the ancestor tree for every package version associated with the package ID is displayed. If you specify a package version (starts with 04t) or alias, the ancestry tree of the specified package version is displayed.",
4810
- "required": true,
4811
- "multiple": false,
4812
- "deprecateAliases": true
4813
- },
4814
- "dot-code": {
4815
- "name": "dot-code",
4816
- "type": "boolean",
4817
- "summary": "Display the ancestry tree in DOT code.",
4818
- "description": "You can use the DOT code output in graph visualization software to create tree visualizations.",
4819
- "allowNo": false,
4820
- "deprecateAliases": true,
4821
- "aliases": [
4822
- "dotcode"
4823
- ]
4824
- },
4825
- "verbose": {
4826
- "name": "verbose",
4827
- "type": "boolean",
4828
- "summary": "Display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree.",
4829
- "allowNo": false,
4830
- "deprecateAliases": true
4831
- }
4832
- },
4833
- "args": {},
4834
- "requiresProject": true,
4835
- "hasDynamicHelp": true
4836
- },
4837
- "package:version:list": {
4838
- "id": "package:version:list",
4839
- "summary": "List all package versions in the Dev Hub org.",
4840
- "description": "Description",
4841
- "strict": true,
4842
- "pluginName": "@salesforce/plugin-packaging",
4843
- "pluginAlias": "@salesforce/plugin-packaging",
4844
- "pluginType": "jit",
4845
- "aliases": [
4846
- "force:package:version:list"
4847
- ],
4848
- "examples": [
4849
- "List package versions in your default Dev Hub org that were created in the last 3 days; show only the released versions and order the list using the PatchVersion field. Display extended details about each package version:\n<%= config.bin %> <%= command.id %> --verbose --created-last-days 3 --released --order-by PatchVersion",
4850
- "List the released package versions for the two specified packages that were modified today; use the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --packages 0Ho000000000000,0Ho000000000001 --released --modified-last-days 0 --target-dev-hub devhub@example.com",
4851
- "List all released package versions in your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --released",
4852
- "List package versions that were modified today in your default Dev Hub org; show limited details about each one:\n<%= config.bin %> <%= command.id %> --concise --modified-last-days 0",
4853
- "List released package versions that were created in the last 3 days in your default Dev Hub org; show limited details:\n<%= config.bin %> <%= command.id %> --concise --created-last-days 3 --released",
4854
- "List released package versions that were modified today for the two packages with specified aliases in your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --packages exp-mgr,exp-mgr-util --released --modified-last-days 0"
4855
- ],
4856
- "deprecateAliases": true,
4857
- "flags": {
4858
- "loglevel": {
4859
- "name": "loglevel",
4860
- "type": "option",
4861
- "hidden": true,
4862
- "multiple": false,
4863
- "deprecated": {
4864
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4865
- },
4866
- "deprecateAliases": true
4867
- },
4868
- "target-dev-hub": {
4869
- "name": "target-dev-hub",
4870
- "type": "option",
4871
- "char": "v",
4872
- "summary": "Username or alias of the Dev Hub org.",
4873
- "required": true,
4874
- "multiple": false,
4875
- "deprecateAliases": true,
4876
- "aliases": [
4877
- "targetdevhubusername",
4878
- "target-hub-org"
4879
- ]
4880
- },
4881
- "api-version": {
4882
- "name": "api-version",
4883
- "type": "option",
4884
- "description": "Override the api version used for api requests made by this command",
4885
- "multiple": false,
4886
- "deprecateAliases": true,
4887
- "aliases": [
4888
- "apiversion"
4889
- ]
4890
- },
4891
- "created-last-days": {
4892
- "name": "created-last-days",
4893
- "type": "option",
4894
- "char": "c",
4895
- "summary": "Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.",
4896
- "multiple": false,
4897
- "deprecateAliases": true,
4898
- "aliases": [
4899
- "createdlastdays"
4900
- ]
4901
- },
4902
- "concise": {
4903
- "name": "concise",
4904
- "type": "boolean",
4905
- "summary": "Display limited package version details.",
4906
- "allowNo": false,
4907
- "deprecateAliases": true
4908
- },
4909
- "show-conversions-only": {
4910
- "name": "show-conversions-only",
4911
- "type": "boolean",
4912
- "summary": "Filter the list output to display only converted package version.",
4913
- "allowNo": false,
4914
- "deprecateAliases": true
4915
- },
4916
- "modified-last-days": {
4917
- "name": "modified-last-days",
4918
- "type": "option",
4919
- "char": "m",
4920
- "summary": "Number of days since the items were modified, starting at 00:00:00 of first day to now. Use 0 for today.",
4921
- "multiple": false,
4922
- "deprecateAliases": true,
4923
- "aliases": [
4924
- "modifiedlastdays"
4925
- ]
4926
- },
4927
- "packages": {
4928
- "name": "packages",
4929
- "type": "option",
4930
- "char": "p",
4931
- "summary": "Comma-delimited list of packages (aliases or 0Ho IDs) to list.",
4932
- "multiple": false,
4933
- "deprecateAliases": true
4934
- },
4935
- "released": {
4936
- "name": "released",
4937
- "type": "boolean",
4938
- "char": "r",
4939
- "summary": "Display released versions only (IsReleased=true).",
4940
- "allowNo": false,
4941
- "deprecateAliases": true
4942
- },
4943
- "order-by": {
4944
- "name": "order-by",
4945
- "type": "option",
4946
- "char": "o",
4947
- "summary": "Package version fields used to order the list.",
4948
- "multiple": false,
4949
- "deprecateAliases": true,
4950
- "aliases": [
4951
- "orderby"
4952
- ]
4953
- },
4954
- "verbose": {
4955
- "name": "verbose",
4956
- "type": "boolean",
4957
- "summary": "Display extended package version details.",
4958
- "allowNo": false,
4959
- "deprecateAliases": true
4960
- }
4961
- },
4962
- "args": {},
4963
- "hasDynamicHelp": true
4964
- },
4965
- "package:version:promote": {
4966
- "id": "package:version:promote",
4967
- "summary": "Promote a package version to released.",
4968
- "description": "Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.",
4969
- "strict": true,
4970
- "pluginName": "@salesforce/plugin-packaging",
4971
- "pluginAlias": "@salesforce/plugin-packaging",
4972
- "pluginType": "jit",
4973
- "aliases": [
4974
- "force:package:version:promote"
4975
- ],
4976
- "examples": [
4977
- "Promote the package version with the specified ID to released; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 04t...",
4978
- "Promote the package version with the specified alias to released; uses the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package awesome_package_alias --target-dev-hub devhub@example.com",
4979
- "Promote the package version with an alias that has spaces to released:\n<%= config.bin %> <%= command.id %> --package \"Awesome Package Alias\""
4980
- ],
4981
- "deprecateAliases": true,
4982
- "flags": {
4983
- "loglevel": {
4984
- "name": "loglevel",
4985
- "type": "option",
4986
- "hidden": true,
4987
- "multiple": false,
4988
- "deprecated": {
4989
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4990
- },
4991
- "deprecateAliases": true
4992
- },
4993
- "target-dev-hub": {
4994
- "name": "target-dev-hub",
4995
- "type": "option",
4996
- "char": "v",
4997
- "summary": "Username or alias of the Dev Hub org.",
4998
- "required": true,
4999
- "multiple": false,
5000
- "deprecateAliases": true,
5001
- "aliases": [
5002
- "targetdevhubusername",
5003
- "target-hub-org"
5004
- ]
5005
- },
5006
- "api-version": {
5007
- "name": "api-version",
5008
- "type": "option",
5009
- "description": "Override the api version used for api requests made by this command",
5010
- "multiple": false,
5011
- "deprecateAliases": true,
5012
- "aliases": [
5013
- "apiversion"
5014
- ]
5015
- },
5016
- "package": {
5017
- "name": "package",
5018
- "type": "option",
5019
- "char": "p",
5020
- "summary": "ID (starts with 04t) or alias of the package version to promote.",
5021
- "required": true,
5022
- "multiple": false,
5023
- "deprecateAliases": true
5024
- },
5025
- "no-prompt": {
5026
- "name": "no-prompt",
5027
- "type": "boolean",
5028
- "char": "n",
5029
- "summary": "Don't prompt to confirm setting the package version as released.",
5030
- "allowNo": false,
5031
- "deprecateAliases": true,
5032
- "aliases": [
5033
- "noprompt"
5034
- ]
5035
- }
5036
- },
5037
- "args": {},
5038
- "requiresProject": true,
5039
- "hasDynamicHelp": true
5040
- },
5041
- "package:version:report": {
5042
- "id": "package:version:report",
5043
- "summary": "Retrieve details about a package version in the Dev Hub org.",
5044
- "description": "To update package version values, run \"<%= config.bin %> package version update\".",
5045
- "strict": true,
5046
- "pluginName": "@salesforce/plugin-packaging",
5047
- "pluginAlias": "@salesforce/plugin-packaging",
5048
- "pluginType": "jit",
5049
- "aliases": [
5050
- "force:package:version:report"
5051
- ],
5052
- "examples": [
5053
- "Retrieve details about the package version with the specified ID from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 04t...",
5054
- "Retrieve details about the package version with the specified alias (that contains spaces) from the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --target-dev-hub devhub@example.com"
5055
- ],
5056
- "deprecateAliases": true,
5057
- "flags": {
5058
- "loglevel": {
5059
- "name": "loglevel",
5060
- "type": "option",
5061
- "hidden": true,
5062
- "multiple": false,
5063
- "deprecated": {
5064
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
5065
- },
5066
- "deprecateAliases": true
5067
- },
5068
- "target-dev-hub": {
5069
- "name": "target-dev-hub",
5070
- "type": "option",
5071
- "char": "v",
5072
- "summary": "Username or alias of the Dev Hub org.",
5073
- "required": true,
5074
- "multiple": false,
5075
- "deprecateAliases": true,
5076
- "aliases": [
5077
- "targetdevhubusername",
5078
- "target-hub-org"
5079
- ]
5080
- },
5081
- "api-version": {
5082
- "name": "api-version",
5083
- "type": "option",
5084
- "description": "Override the api version used for api requests made by this command",
5085
- "multiple": false,
5086
- "deprecateAliases": true,
5087
- "aliases": [
5088
- "apiversion"
5089
- ]
5090
- },
5091
- "package": {
5092
- "name": "package",
5093
- "type": "option",
5094
- "char": "p",
5095
- "summary": "ID (starts with 04t) or alias of the package to retrieve details for.",
5096
- "required": true,
5097
- "multiple": false,
5098
- "deprecateAliases": true
5099
- },
5100
- "verbose": {
5101
- "name": "verbose",
5102
- "type": "boolean",
5103
- "summary": "Display extended package version details.",
5104
- "allowNo": false,
5105
- "deprecateAliases": true
5106
- }
5107
- },
5108
- "args": {},
5109
- "requiresProject": true,
5110
- "hasDynamicHelp": true
5111
- },
5112
- "package:version:retrieve": {
5113
- "id": "package:version:retrieve",
5114
- "summary": "Retrieve package metadata for a specified package version.",
5115
- "description": "Retrieving a package version downloads the metadata into the directory you specify.\n\nYou can retrieve metadata for a second- or first-generation managed package, or an unlocked package.\n\nSpecify the subscriber package version ID (starts with 04t) and the path to an empty directory when you run this command.",
5116
- "strict": true,
5117
- "pluginName": "@salesforce/plugin-packaging",
5118
- "pluginAlias": "@salesforce/plugin-packaging",
5119
- "pluginType": "jit",
5120
- "hidden": true,
5121
- "aliases": [],
5122
- "examples": [
5123
- "Retrieve package metadata for a subscriber package version ID (starts with 04t) into my-folder/ within your Salesforce DX project directory:\n<%= config.bin %> <%= command.id %> --package 04t... --output-dir my-folder –-target-org my-scratch\nIf you omit --target-org, this command runs against your default org."
5124
- ],
5125
- "flags": {
5126
- "loglevel": {
5127
- "name": "loglevel",
5128
- "type": "option",
5129
- "hidden": true,
5130
- "multiple": false,
5131
- "deprecated": {
5132
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
5133
- }
5134
- },
5135
- "api-version": {
5136
- "name": "api-version",
5137
- "type": "option",
5138
- "description": "Override the api version used for api requests made by this command",
5139
- "multiple": false,
5140
- "aliases": [
5141
- "apiversion"
5142
- ]
5143
- },
5144
- "target-org": {
5145
- "name": "target-org",
5146
- "type": "option",
5147
- "char": "o",
5148
- "summary": "Username or alias of the target org.",
5149
- "required": true,
5150
- "multiple": false,
5151
- "aliases": [
5152
- "targetusername",
5153
- "u"
5154
- ]
5155
- },
5156
- "package": {
5157
- "name": "package",
5158
- "type": "option",
5159
- "char": "p",
5160
- "summary": "Subscriber package version ID (starts with 04t).",
5161
- "required": true,
5162
- "multiple": false
5163
- },
5164
- "output-dir": {
5165
- "name": "output-dir",
5166
- "type": "option",
5167
- "char": "d",
5168
- "summary": "Path within your Salesforce DX project directory in which to download the metadata. This directory must be empty.",
5169
- "multiple": false,
5170
- "default": "force-app"
5171
- }
5172
- },
5173
- "args": {},
5174
- "requiresProject": true,
5175
- "hasDynamicHelp": true
5176
- },
5177
- "package:version:update": {
5178
- "id": "package:version:update",
5179
- "summary": "Update a package version.",
5180
- "description": "Specify a new value for each option you want to update.\n\nTo display details about a package version, run \"<%= config.bin %> package version display\".",
5181
- "strict": true,
5182
- "pluginName": "@salesforce/plugin-packaging",
5183
- "pluginAlias": "@salesforce/plugin-packaging",
5184
- "pluginType": "jit",
5185
- "aliases": [
5186
- "force:package:version:update"
5187
- ],
5188
- "examples": [
5189
- "Update the package version that has the specified alias (that contains spaces) with a new installation key \"password123\"; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --installation-key password123",
5190
- "Update the package version that has the specified ID with a new branch and tag; use the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package 04t... --branch main --tag 'Release 1.0.7' --target-dev-hub devhub@example.com",
5191
- "Update the package version that has the specified ID with a new description:\n<%= config.bin %> <%= command.id %> --package 04t... --version-description \"New Package Version Description\""
5192
- ],
5193
- "deprecateAliases": true,
5194
- "flags": {
5195
- "loglevel": {
5196
- "name": "loglevel",
5197
- "type": "option",
5198
- "hidden": true,
5199
- "multiple": false,
5200
- "deprecated": {
5201
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
5202
- },
5203
- "deprecateAliases": true
5204
- },
5205
- "target-dev-hub": {
5206
- "name": "target-dev-hub",
5207
- "type": "option",
5208
- "char": "v",
5209
- "summary": "Username or alias of the Dev Hub org.",
5210
- "required": true,
5211
- "multiple": false,
5212
- "deprecateAliases": true,
5213
- "aliases": [
5214
- "targetdevhubusername",
5215
- "target-hub-org"
5216
- ]
5217
- },
5218
- "api-version": {
5219
- "name": "api-version",
5220
- "type": "option",
5221
- "description": "Override the api version used for api requests made by this command",
5222
- "multiple": false,
5223
- "deprecateAliases": true,
5224
- "aliases": [
5225
- "apiversion"
5226
- ]
5227
- },
5228
- "package": {
5229
- "name": "package",
5230
- "type": "option",
5231
- "char": "p",
5232
- "summary": "ID (starts with 04t) or alias of the package to update a version of.",
5233
- "required": true,
5234
- "multiple": false,
5235
- "deprecateAliases": true
5236
- },
5237
- "version-name": {
5238
- "name": "version-name",
5239
- "type": "option",
5240
- "char": "a",
5241
- "summary": "New package version name.",
5242
- "multiple": false,
5243
- "deprecateAliases": true,
5244
- "aliases": [
5245
- "versionname"
5246
- ]
5247
- },
5248
- "version-description": {
5249
- "name": "version-description",
5250
- "type": "option",
5251
- "char": "e",
5252
- "summary": "New package version description.",
5253
- "multiple": false,
5254
- "deprecateAliases": true,
5255
- "aliases": [
5256
- "versiondescription"
5257
- ]
5258
- },
5259
- "branch": {
5260
- "name": "branch",
5261
- "type": "option",
5262
- "char": "b",
5263
- "summary": "New package version branch.",
5264
- "multiple": false,
5265
- "deprecateAliases": true
5266
- },
5267
- "tag": {
5268
- "name": "tag",
5269
- "type": "option",
5270
- "char": "t",
5271
- "summary": "New package version tag.",
5272
- "multiple": false,
5273
- "deprecateAliases": true
5274
- },
5275
- "installation-key": {
5276
- "name": "installation-key",
5277
- "type": "option",
5278
- "char": "k",
5279
- "summary": "New installation key for key-protected package (default: null)",
5280
- "multiple": false,
5281
- "deprecateAliases": true,
5282
- "aliases": [
5283
- "installationkey"
5284
- ]
5285
- }
5286
- },
5287
- "args": {},
5288
- "requiresProject": true,
5289
- "hasDynamicHelp": true
5290
- },
5291
- "package1:version:create": {
5292
- "id": "package1:version:create",
5293
- "summary": "Create a first-generation package version in the release org.",
5294
- "description": "The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to create an unmanaged package version.",
5295
- "strict": true,
5296
- "pluginName": "@salesforce/plugin-packaging",
5297
- "pluginAlias": "@salesforce/plugin-packaging",
5298
- "pluginType": "jit",
5299
- "aliases": [
5300
- "force:package1:version:create"
5301
- ],
5302
- "examples": [
5303
- "Create a first-generation package version from the package with the specified ID and name the package version \"example\"; use your default org:\n<%= config.bin %> <%= command.id %> --package-id 033... --name example",
5304
- "Same as previous example, but provide a description and wait for 30 minutes for the package version to be created; use the specified org:\n<%= config.bin %> <%= command.id %> --package-id 033... --name example --description \"example description\" --wait 30 --target-org myorg@example.com"
5305
- ],
5306
- "deprecateAliases": true,
5307
- "flags": {
5308
- "loglevel": {
5309
- "name": "loglevel",
5310
- "type": "option",
5311
- "hidden": true,
5312
- "multiple": false,
5313
- "deprecated": {
5314
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
5315
- },
5316
- "deprecateAliases": true
5317
- },
5318
- "target-org": {
5319
- "name": "target-org",
5320
- "type": "option",
5321
- "char": "o",
5322
- "summary": "Username or alias of the target org.",
5323
- "required": true,
5324
- "multiple": false,
5325
- "deprecateAliases": true,
5326
- "aliases": [
5327
- "targetusername",
5328
- "u"
5329
- ]
5330
- },
5331
- "api-version": {
5332
- "name": "api-version",
5333
- "type": "option",
5334
- "description": "Override the api version used for api requests made by this command",
5335
- "multiple": false,
5336
- "deprecateAliases": true,
5337
- "aliases": [
5338
- "apiversion"
5339
- ]
5340
- },
5341
- "package-id": {
5342
- "name": "package-id",
5343
- "type": "option",
5344
- "char": "i",
5345
- "summary": "ID of the metadata package (starts with 033) of which you’re creating a new version.",
5346
- "required": true,
5347
- "multiple": false,
5348
- "deprecateAliases": true,
5349
- "aliases": [
5350
- "packageid"
5351
- ]
5352
- },
5353
- "name": {
5354
- "name": "name",
5355
- "type": "option",
5356
- "char": "n",
5357
- "summary": "Package version name.",
5358
- "required": true,
5359
- "multiple": false,
5360
- "deprecateAliases": true
5361
- },
5362
- "description": {
5363
- "name": "description",
5364
- "type": "option",
5365
- "char": "d",
5366
- "summary": "Package version description.",
5367
- "multiple": false,
5368
- "deprecateAliases": true
5369
- },
5370
- "version": {
5371
- "name": "version",
5372
- "type": "option",
5373
- "char": "v",
5374
- "summary": "Package version in major.minor format, for example, 3.2.",
5375
- "multiple": false,
5376
- "deprecateAliases": true
5377
- },
5378
- "managed-released": {
5379
- "name": "managed-released",
5380
- "type": "boolean",
5381
- "char": "m",
5382
- "summary": "Create a managed package version.",
5383
- "description": "To create a beta version, don’t include this parameter.",
5384
- "allowNo": false,
5385
- "deprecateAliases": true,
5386
- "aliases": [
5387
- "managedrelease"
5388
- ]
5389
- },
5390
- "release-notes-url": {
5391
- "name": "release-notes-url",
5392
- "type": "option",
5393
- "char": "r",
5394
- "summary": "Release notes URL.",
5395
- "description": "This link is displayed in the package installation UI to provide release notes for this package version to subscribers.",
5396
- "multiple": false,
5397
- "deprecateAliases": true,
5398
- "aliases": [
5399
- "releasenotesurl"
5400
- ]
5401
- },
5402
- "post-install-url": {
5403
- "name": "post-install-url",
5404
- "type": "option",
5405
- "char": "p",
5406
- "summary": "Post install URL.",
5407
- "description": "The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.",
5408
- "multiple": false,
5409
- "deprecateAliases": true,
5410
- "aliases": [
5411
- "postinstallurl"
5412
- ]
5413
- },
5414
- "installation-key": {
5415
- "name": "installation-key",
5416
- "type": "option",
5417
- "char": "k",
5418
- "summary": "Installation key for key-protected package (default: null).",
5419
- "multiple": false,
5420
- "deprecateAliases": true,
5421
- "aliases": [
5422
- "installationkey"
5423
- ]
5424
- },
5425
- "wait": {
5426
- "name": "wait",
5427
- "type": "option",
5428
- "char": "w",
5429
- "summary": "Minutes to wait for the package version to be created (default: 2 minutes).",
5430
- "multiple": false,
5431
- "deprecateAliases": true
5432
- }
5433
- },
5434
- "args": {},
5435
- "requiresProject": true,
5436
- "hasDynamicHelp": true
5437
- },
5438
- "package1:version:display": {
5439
- "id": "package1:version:display",
5440
- "summary": "Display details about a first-generation package version.",
5441
- "strict": true,
5442
- "pluginName": "@salesforce/plugin-packaging",
5443
- "pluginAlias": "@salesforce/plugin-packaging",
5444
- "pluginType": "jit",
5445
- "aliases": [
5446
- "force:package1:version:display"
5447
- ],
5448
- "examples": [
5449
- "Display details about the first-generation package version with the specified ID in your default org:\n<%= config.bin %> <%= command.id %> --package-version-id 04t...",
5450
- "Same as previous example, but use the specified org:\n<%= config.bin %> <%= command.id %> --package-version-id 04t... --target-org myorg@example.com"
5451
- ],
5452
- "deprecateAliases": true,
5453
- "flags": {
5454
- "loglevel": {
5455
- "name": "loglevel",
5456
- "type": "option",
5457
- "hidden": true,
5458
- "multiple": false,
5459
- "deprecated": {
5460
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
5461
- },
5462
- "deprecateAliases": true
5463
- },
5464
- "target-org": {
5465
- "name": "target-org",
5466
- "type": "option",
5467
- "char": "o",
5468
- "summary": "Username or alias of the target org.",
5469
- "required": true,
5470
- "multiple": false,
5471
- "deprecateAliases": true,
5472
- "aliases": [
5473
- "targetusername",
5474
- "u"
5475
- ]
5476
- },
5477
- "api-version": {
5478
- "name": "api-version",
5479
- "type": "option",
5480
- "description": "Override the api version used for api requests made by this command",
5481
- "multiple": false,
5482
- "deprecateAliases": true,
5483
- "aliases": [
5484
- "apiversion"
5485
- ]
5486
- },
5487
- "package-version-id": {
5488
- "name": "package-version-id",
5489
- "type": "option",
5490
- "char": "i",
5491
- "summary": "ID (starts with 04t) of the metadata package version whose details you want to display.",
5492
- "required": true,
5493
- "multiple": false,
5494
- "deprecateAliases": true,
5495
- "aliases": [
5496
- "packageversionid"
5497
- ]
5498
- }
5499
- },
5500
- "args": {},
5501
- "hasDynamicHelp": true
5502
- },
5503
- "package1:version:list": {
5504
- "id": "package1:version:list",
5505
- "summary": "List package versions for the specified first-generation package or for the org.",
5506
- "strict": true,
5507
- "pluginName": "@salesforce/plugin-packaging",
5508
- "pluginAlias": "@salesforce/plugin-packaging",
5509
- "pluginType": "jit",
5510
- "aliases": [
5511
- "force:package1:version:list"
5512
- ],
5513
- "examples": [
5514
- "List all first-generation package versions in your default org:\n<%= config.bin %> <%= command.id %>",
5515
- "List package versions for the specified first-generation package in the specifief org:\n<%= config.bin %> <%= command.id %> --package-id 033... --target-org myorg@example.com"
5516
- ],
5517
- "deprecateAliases": true,
5518
- "flags": {
5519
- "loglevel": {
5520
- "name": "loglevel",
5521
- "type": "option",
5522
- "hidden": true,
5523
- "multiple": false,
5524
- "deprecated": {
5525
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
5526
- },
5527
- "deprecateAliases": true
5528
- },
5529
- "target-org": {
5530
- "name": "target-org",
5531
- "type": "option",
5532
- "char": "o",
5533
- "summary": "Username or alias of the target org.",
5534
- "required": true,
5535
- "multiple": false,
5536
- "deprecateAliases": true,
5537
- "aliases": [
5538
- "targetusername",
5539
- "u"
5540
- ]
5541
- },
5542
- "api-version": {
5543
- "name": "api-version",
5544
- "type": "option",
5545
- "description": "Override the api version used for api requests made by this command",
5546
- "multiple": false,
5547
- "deprecateAliases": true,
5548
- "aliases": [
5549
- "apiversion"
5550
- ]
5551
- },
5552
- "package-id": {
5553
- "name": "package-id",
5554
- "type": "option",
5555
- "char": "i",
5556
- "summary": "Metadata package ID (starts with 033) whose package versions you want to list.",
5557
- "description": "If not specified, shows all versions for all packages (managed and unmanaged) in the org.",
5558
- "multiple": false,
5559
- "deprecateAliases": true,
5560
- "aliases": [
5561
- "packageid"
5562
- ]
5563
- }
5564
- },
5565
- "args": {},
5566
- "hasDynamicHelp": true
5567
- },
5568
- "package:version:create:list": {
5569
- "id": "package:version:create:list",
5570
- "summary": "List package version creation requests.",
5571
- "description": "Shows the details of each request to create a package version in the Dev Hub org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"<%= config.bin %> package version create report\" and supply the request ID.",
5572
- "strict": true,
5573
- "pluginName": "@salesforce/plugin-packaging",
5574
- "pluginAlias": "@salesforce/plugin-packaging",
5575
- "pluginType": "jit",
5576
- "aliases": [
5577
- "force:package:version:create:list"
5578
- ],
5579
- "examples": [
5580
- "List all package version creation requests in your default Dev Hub org:\n<%= config.bin %> <%= command.id %>",
5581
- "List package version creation requests from the last 3 days in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub",
5582
- "List package version creation requests with status Error:\n<%= config.bin %> <%= command.id %> --status Error",
5583
- "List package version creation requests with status InProgress:\n<%= config.bin %> <%= command.id %> --status InProgress",
5584
- "List package version creation requests with status Success that were created today:\n<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success"
5585
- ],
5586
- "deprecateAliases": true,
5587
- "flags": {
5588
- "loglevel": {
5589
- "name": "loglevel",
5590
- "type": "option",
5591
- "hidden": true,
5592
- "multiple": false,
5593
- "deprecated": {
5594
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
5595
- },
5596
- "deprecateAliases": true
5597
- },
5598
- "target-dev-hub": {
5599
- "name": "target-dev-hub",
5600
- "type": "option",
5601
- "char": "v",
5602
- "summary": "Username or alias of the Dev Hub org.",
5603
- "required": true,
5604
- "multiple": false,
5605
- "deprecateAliases": true,
5606
- "aliases": [
5607
- "targetdevhubusername",
5608
- "target-hub-org"
5609
- ]
5610
- },
5611
- "api-version": {
5612
- "name": "api-version",
5613
- "type": "option",
5614
- "description": "Override the api version used for api requests made by this command",
5615
- "multiple": false,
5616
- "deprecateAliases": true,
5617
- "aliases": [
5618
- "apiversion"
5619
- ]
5620
- },
5621
- "created-last-days": {
5622
- "name": "created-last-days",
5623
- "type": "option",
5624
- "char": "c",
5625
- "summary": "Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.",
5626
- "multiple": false,
5627
- "deprecateAliases": true,
5628
- "aliases": [
5629
- "createdlastdays"
5630
- ]
5631
- },
5632
- "status": {
5633
- "name": "status",
5634
- "type": "option",
5635
- "char": "s",
5636
- "summary": "Status of the version creation request, used to filter the list.",
5637
- "multiple": false,
5638
- "options": [
5639
- "Queued",
5640
- "InProgress",
5641
- "Success",
5642
- "Error"
5643
- ],
5644
- "deprecateAliases": true
5645
- },
5646
- "show-conversions-only": {
5647
- "name": "show-conversions-only",
5648
- "type": "boolean",
5649
- "summary": "Filter the list output to display only converted package version.",
5650
- "allowNo": false,
5651
- "deprecateAliases": true
5652
- },
5653
- "verbose": {
5654
- "name": "verbose",
5655
- "type": "boolean",
5656
- "summary": "Displays additional information at a slight performance cost, such as the version name and number for each package version create request.",
5657
- "allowNo": false,
5658
- "deprecateAliases": true
5659
- }
5660
- },
5661
- "args": {},
5662
- "hasDynamicHelp": true
5663
- },
5664
- "package:version:create:report": {
5665
- "id": "package:version:create:report",
5666
- "summary": "Retrieve details about a package version creation request.",
5667
- "description": "Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.\n\nTo show all requests in the org, run \"<%= config.bin %> package version create list\".",
5668
- "strict": true,
5669
- "pluginName": "@salesforce/plugin-packaging",
5670
- "pluginAlias": "@salesforce/plugin-packaging",
5671
- "pluginType": "jit",
5672
- "aliases": [
5673
- "force:package:version:create:report"
5674
- ],
5675
- "examples": [
5676
- "Retrieve details about the package version creation request with the specified ID; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package-create-request-id 08c...",
5677
- "Retrieve details about the specified package version creation request in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package-create-request-id 08c... --target-dev-hub devhub@example.com"
5678
- ],
5679
- "deprecateAliases": true,
5680
- "flags": {
5681
- "loglevel": {
5682
- "name": "loglevel",
5683
- "type": "option",
5684
- "hidden": true,
5685
- "multiple": false,
5686
- "deprecated": {
5687
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
5688
- },
5689
- "deprecateAliases": true
5690
- },
5691
- "target-dev-hub": {
5692
- "name": "target-dev-hub",
5693
- "type": "option",
5694
- "char": "v",
5695
- "summary": "Username or alias of the Dev Hub org.",
5696
- "required": true,
5697
- "multiple": false,
5698
- "deprecateAliases": true,
5699
- "aliases": [
5700
- "targetdevhubusername",
5701
- "target-hub-org"
5702
- ]
5703
- },
5704
- "api-version": {
5705
- "name": "api-version",
5706
- "type": "option",
5707
- "description": "Override the api version used for api requests made by this command",
5708
- "multiple": false,
5709
- "deprecateAliases": true,
5710
- "aliases": [
5711
- "apiversion"
5712
- ]
5713
- },
5714
- "package-create-request-id": {
5715
- "name": "package-create-request-id",
5716
- "type": "option",
5717
- "char": "i",
5718
- "summary": "ID (starts with 08c) of the package version creation request you want to display.",
5719
- "required": true,
5720
- "multiple": false,
5721
- "deprecateAliases": true,
5722
- "aliases": [
5723
- "packagecreaterequestid"
5724
- ]
5725
- }
5726
- },
5727
- "args": {},
5728
- "hasDynamicHelp": true
5729
- },
5730
- "package1:version:create:get": {
5731
- "id": "package1:version:create:get",
5732
- "summary": "Retrieve the status of a package version creation request.",
5733
- "strict": true,
5734
- "pluginName": "@salesforce/plugin-packaging",
5735
- "pluginAlias": "@salesforce/plugin-packaging",
5736
- "pluginType": "jit",
5737
- "aliases": [
5738
- "force:package1:version:create:get"
5739
- ],
5740
- "examples": [
5741
- "Get the status of the creation request for the package version with the specified ID in your default org:\n<%= config.bin %> <%= command.id %> --request-id 0HD...",
5742
- "Same as previous example, but use the specified org:\n<%= config.bin %> <%= command.id %> --request-id 0HD... --target-org myorg@example.com"
5743
- ],
5744
- "deprecateAliases": true,
5745
- "flags": {
5746
- "loglevel": {
5747
- "name": "loglevel",
5748
- "type": "option",
5749
- "hidden": true,
5750
- "multiple": false,
5751
- "deprecated": {
5752
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
5753
- },
5754
- "deprecateAliases": true
5755
- },
5756
- "target-org": {
5757
- "name": "target-org",
5758
- "type": "option",
5759
- "char": "o",
5760
- "summary": "Username or alias of the target org.",
5761
- "required": true,
5762
- "multiple": false,
5763
- "deprecateAliases": true,
5764
- "aliases": [
5765
- "targetusername",
5766
- "u"
5767
- ]
5768
- },
5769
- "api-version": {
5770
- "name": "api-version",
5771
- "type": "option",
5772
- "description": "Override the api version used for api requests made by this command",
5773
- "multiple": false,
5774
- "deprecateAliases": true,
5775
- "aliases": [
5776
- "apiversion"
5777
- ]
5778
- },
5779
- "request-id": {
5780
- "name": "request-id",
5781
- "type": "option",
5782
- "char": "i",
5783
- "summary": "ID of the PackageUploadRequest (starts with 0HD).",
5784
- "required": true,
5785
- "multiple": false,
5786
- "deprecateAliases": true,
5787
- "aliases": [
5788
- "requestid"
5789
- ]
5790
- }
5791
- },
5792
- "args": {},
5793
- "hasDynamicHelp": true
5794
- },
5795
3413
  "org:create:shape": {
5796
3414
  "aliases": [
5797
3415
  "force:org:shape:create"
@@ -7622,5 +5240,5 @@
7622
5240
  ]
7623
5241
  }
7624
5242
  },
7625
- "version": "2.19.6"
5243
+ "version": "2.19.8"
7626
5244
  }