@salesforce/plugin-org 5.9.0 → 5.9.2

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.
Files changed (3) hide show
  1. package/README.md +15 -15
  2. package/oclif.manifest.json +650 -650
  3. package/package.json +5 -5
@@ -385,17 +385,18 @@
385
385
  "open:org"
386
386
  ]
387
387
  },
388
- "org:delete:sandbox": {
388
+ "org:create:sandbox": {
389
389
  "aliases": [
390
- "env:delete:sandbox"
390
+ "env:create:sandbox"
391
391
  ],
392
392
  "args": {},
393
393
  "deprecateAliases": true,
394
- "description": "Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes all local references to the org from your computer.\nSpecify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including sandboxes, and their aliases.\nBoth the sandbox and the associated production org must already be authenticated with the CLI to successfully delete the sandbox.",
394
+ "description": "There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.\n\nYou can also use this command to clone an existing sandbox. Use the --source-sandbox-name flag to specify the existing sandbox name and the --name flag to the name of the new sandbox.",
395
395
  "examples": [
396
- "Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox",
397
- "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa",
398
- "Delete the sandbox without prompting to confirm:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt"
396
+ "Create a sandbox org using a definition file and give it the alias \"MyDevSandbox\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg",
397
+ "Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.\n<%= config.bin %> <%= command.id %> --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg --set-default",
398
+ "Clone the existing sandbox with name \"ExistingSandbox\" and name the new sandbox \"NewClonedSandbox\". Set the new sandbox as your default org. Wait for 30 minutes for the sandbox creation to complete.\n<%= config.bin %> <%= command.id %> --source-sandbox-name ExistingSandbox --name NewClonedSandbox --target-org prodOrg --alias MyDevSandbox --set-default --wait 30",
399
+ "Clone the existing sandbox with ID \"0GQB0000000TVobOAG\" and do not wait.\n<%= config.bin %> <%= command.id %> --source-id 0GQB0000000TVobOAG --name SbxClone --target-org prodOrg --async"
399
400
  ],
400
401
  "flags": {
401
402
  "json": {
@@ -413,154 +414,193 @@
413
414
  "multiple": false,
414
415
  "type": "option"
415
416
  },
416
- "target-org": {
417
- "aliases": [
418
- "targetusername",
419
- "u"
420
- ],
421
- "char": "o",
422
- "deprecateAliases": true,
423
- "name": "target-org",
424
- "required": true,
425
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
426
- "hasDynamicHelp": true,
417
+ "definition-file": {
418
+ "char": "f",
419
+ "description": "The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each sandbox type that you use in the development process. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
420
+ "name": "definition-file",
421
+ "summary": "Path to a sandbox definition file.",
422
+ "hasDynamicHelp": false,
427
423
  "multiple": false,
428
424
  "type": "option"
429
425
  },
430
- "no-prompt": {
431
- "char": "p",
432
- "name": "no-prompt",
433
- "summary": "Don't prompt the user to confirm the deletion.",
426
+ "set-default": {
427
+ "char": "s",
428
+ "name": "set-default",
429
+ "summary": "Set the sandbox org as your default org.",
434
430
  "allowNo": false,
435
431
  "type": "boolean"
436
- }
437
- },
438
- "hasDynamicHelp": true,
439
- "hiddenAliases": [],
440
- "id": "org:delete:sandbox",
441
- "pluginAlias": "@salesforce/plugin-org",
442
- "pluginName": "@salesforce/plugin-org",
443
- "pluginType": "core",
444
- "strict": true,
445
- "summary": "Delete a sandbox.",
446
- "enableJsonFlag": true,
447
- "isESM": true,
448
- "relativePath": [
449
- "lib",
450
- "commands",
451
- "org",
452
- "delete",
453
- "sandbox.js"
454
- ],
455
- "aliasPermutations": [
456
- "env:delete:sandbox",
457
- "delete:env:sandbox",
458
- "delete:sandbox:env",
459
- "env:sandbox:delete",
460
- "sandbox:env:delete",
461
- "sandbox:delete:env"
462
- ],
463
- "permutations": [
464
- "org:delete:sandbox",
465
- "delete:org:sandbox",
466
- "delete:sandbox:org",
467
- "org:sandbox:delete",
468
- "sandbox:org:delete",
469
- "sandbox:delete:org"
470
- ]
471
- },
472
- "org:delete:scratch": {
473
- "aliases": [
474
- "env:delete:scratch"
475
- ],
476
- "args": {},
477
- "deprecateAliases": true,
478
- "description": "Salesforce CLI marks the org for deletion in the Dev Hub org and then deletes all local references to the org from your computer.\nSpecify a scratch org with either the username or the alias you gave the scratch org when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including scratch orgs, and their aliases.",
479
- "examples": [
480
- "Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org",
481
- "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com",
482
- "Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt"
483
- ],
484
- "flags": {
485
- "json": {
486
- "description": "Format output as json.",
487
- "helpGroup": "GLOBAL",
488
- "name": "json",
432
+ },
433
+ "alias": {
434
+ "char": "a",
435
+ "description": "When you create a sandbox, the generated usernames are based on the usernames present in the production org. To ensure uniqueness, the new usernames are appended with the name of the sandbox. For example, the username \"user@example.com\" in the production org results in the username \"user@example.com.mysandbox\" in a sandbox named \"mysandbox\". When you set an alias for a sandbox org, it's assigned to the resulting username of the user running this command.",
436
+ "name": "alias",
437
+ "summary": "Alias for the sandbox org.",
438
+ "hasDynamicHelp": false,
439
+ "multiple": false,
440
+ "type": "option"
441
+ },
442
+ "wait": {
443
+ "char": "w",
444
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command you run to check the status of the create. The displayed command includes the job ID for the running sandbox creation.",
445
+ "exclusive": [
446
+ "async"
447
+ ],
448
+ "name": "wait",
449
+ "summary": "Number of minutes to wait for the sandbox org to be ready.",
450
+ "hasDynamicHelp": true,
451
+ "helpValue": "<minutes>",
452
+ "multiple": false,
453
+ "type": "option"
454
+ },
455
+ "poll-interval": {
456
+ "char": "i",
457
+ "exclusive": [
458
+ "async"
459
+ ],
460
+ "name": "poll-interval",
461
+ "summary": "Number of seconds to wait between retries.",
462
+ "hasDynamicHelp": true,
463
+ "helpValue": "<seconds>",
464
+ "multiple": false,
465
+ "type": "option"
466
+ },
467
+ "async": {
468
+ "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox creation, run \"<%= config.bin %> org resume sandbox\".",
469
+ "exclusive": [
470
+ "wait",
471
+ "poll-interval"
472
+ ],
473
+ "name": "async",
474
+ "summary": "Request the sandbox creation, but don't wait for it to complete.",
489
475
  "allowNo": false,
490
476
  "type": "boolean"
491
477
  },
492
- "flags-dir": {
493
- "helpGroup": "GLOBAL",
494
- "name": "flags-dir",
495
- "summary": "Import flag values from a directory.",
478
+ "name": {
479
+ "char": "n",
480
+ "description": "The name must be a unique alphanumeric string (10 or fewer characters) to identify the sandbox. You can’t reuse a name while a sandbox is in the process of being deleted.",
481
+ "name": "name",
482
+ "summary": "Name of the sandbox org.",
496
483
  "hasDynamicHelp": false,
497
484
  "multiple": false,
498
485
  "type": "option"
499
486
  },
500
- "target-org": {
487
+ "source-sandbox-name": {
501
488
  "aliases": [
502
- "targetusername",
503
- "u"
489
+ "clone",
490
+ "c"
504
491
  ],
505
- "char": "o",
506
492
  "deprecateAliases": true,
493
+ "description": "The value of --source-sandbox-name must be an existing sandbox. The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.",
494
+ "exclusive": [
495
+ "license-type",
496
+ "source-id"
497
+ ],
498
+ "name": "source-sandbox-name",
499
+ "summary": "Name of the sandbox org to clone.",
500
+ "hasDynamicHelp": false,
501
+ "multiple": false,
502
+ "type": "option"
503
+ },
504
+ "source-id": {
505
+ "description": "The value of --source-id must be an existing sandbox (SandboxInfo.Id). The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.",
506
+ "exclusive": [
507
+ "license-type",
508
+ "source-sandbox-name"
509
+ ],
510
+ "name": "source-id",
511
+ "summary": "ID of the sandbox org to clone.",
512
+ "hasDynamicHelp": false,
513
+ "multiple": false,
514
+ "type": "option"
515
+ },
516
+ "license-type": {
517
+ "char": "l",
518
+ "exclusive": [
519
+ "source-sandbox-name",
520
+ "source-id"
521
+ ],
522
+ "name": "license-type",
523
+ "summary": "Type of sandbox license.",
524
+ "hasDynamicHelp": false,
525
+ "multiple": false,
526
+ "options": [
527
+ "Developer",
528
+ "Developer_Pro",
529
+ "Partial",
530
+ "Full"
531
+ ],
532
+ "type": "option"
533
+ },
534
+ "target-org": {
535
+ "char": "o",
536
+ "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
507
537
  "name": "target-org",
538
+ "noCacheDefault": true,
508
539
  "required": true,
509
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
540
+ "summary": "Username or alias of the production org that contains the sandbox license.",
510
541
  "hasDynamicHelp": true,
511
542
  "multiple": false,
512
543
  "type": "option"
513
544
  },
514
545
  "no-prompt": {
515
- "char": "p",
516
546
  "name": "no-prompt",
517
- "summary": "Don't prompt the user to confirm the deletion.",
547
+ "summary": "Don't prompt for confirmation about the sandbox configuration.",
548
+ "allowNo": false,
549
+ "type": "boolean"
550
+ },
551
+ "no-track-source": {
552
+ "description": "We recommend you enable source tracking in Developer and Developer Pro sandbox, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the sandbox, and to detect any conflicts between the two.\n\nTo disable source tracking in the new sandbox, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the sandbox.",
553
+ "name": "no-track-source",
554
+ "summary": "Do not use source tracking for this sandbox.",
518
555
  "allowNo": false,
519
556
  "type": "boolean"
520
557
  }
521
558
  },
522
559
  "hasDynamicHelp": true,
523
560
  "hiddenAliases": [],
524
- "id": "org:delete:scratch",
561
+ "id": "org:create:sandbox",
525
562
  "pluginAlias": "@salesforce/plugin-org",
526
563
  "pluginName": "@salesforce/plugin-org",
527
564
  "pluginType": "core",
528
565
  "strict": true,
529
- "summary": "Delete a scratch org.",
530
- "enableJsonFlag": true,
566
+ "summary": "Create a sandbox org.",
531
567
  "isESM": true,
532
568
  "relativePath": [
533
569
  "lib",
534
570
  "commands",
535
571
  "org",
536
- "delete",
537
- "scratch.js"
572
+ "create",
573
+ "sandbox.js"
538
574
  ],
539
575
  "aliasPermutations": [
540
- "env:delete:scratch",
541
- "delete:env:scratch",
542
- "delete:scratch:env",
543
- "env:scratch:delete",
544
- "scratch:env:delete",
545
- "scratch:delete:env"
576
+ "env:create:sandbox",
577
+ "create:env:sandbox",
578
+ "create:sandbox:env",
579
+ "env:sandbox:create",
580
+ "sandbox:env:create",
581
+ "sandbox:create:env"
546
582
  ],
547
583
  "permutations": [
548
- "org:delete:scratch",
549
- "delete:org:scratch",
550
- "delete:scratch:org",
551
- "org:scratch:delete",
552
- "scratch:org:delete",
553
- "scratch:delete:org"
584
+ "org:create:sandbox",
585
+ "create:org:sandbox",
586
+ "create:sandbox:org",
587
+ "org:sandbox:create",
588
+ "sandbox:org:create",
589
+ "sandbox:create:org"
554
590
  ]
555
591
  },
556
- "org:disable:tracking": {
557
- "aliases": [],
592
+ "org:create:scratch": {
593
+ "aliases": [
594
+ "env:create:scratch"
595
+ ],
558
596
  "args": {},
559
- "description": "Disabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that no source tracking operations are executed when working with the org.",
597
+ "deprecateAliases": true,
598
+ "description": "There are four ways to create a scratch org:\n\n * Specify a definition file that contains the scratch org options.\n * Use the --edition flag to specify the one required option; this method doesn't require a defintion file.\n * Use the --snapshot flag to create a scratch org from a snapshot. Snapshots are a point-in-time copy of a scratch org; you create a snapshot with the \"sf org create snapshot\" command.\n * Use the --source-org flag to create a scratch org from an org shape. Org shapes mimic the baseline setup of a source org without the extraneous data and metadata; you create an org shape with the \"sf org create shape\" command.\n\nThe --edition, --snapshot, and --source-org flags are mutually exclusive, which means if you specify one, you can't also specify the others.\n\nFor any of the methods, you can also use these flags; if you use them with --definition-file, they override their equivalent option in the scratch org definition file:\n\n * --description\n * --name (equivalent to the \"orgName\" option)\n * --username\n * --release\n * --admin-email (equivalent to the \"adminEmail\" option)\n\nIf you want to set options such as org features or settings, you must use a definition file.\n\nYou must specify a Dev Hub to create a scratch org, either with the --target-dev-hub flag or by setting your default Dev Hub with the target-dev-hub configuration variable.",
560
599
  "examples": [
561
- "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
562
- "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
563
- "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
600
+ "Create a Developer edition scratch org using your default Dev Hub and give the scratch org an alias:\n<%= config.bin %> <%= command.id %> --edition developer --alias my-scratch-org",
601
+ "Create a scratch org with a definition file. Specify the Dev Hub using its alias, set the scratch org as your default, and specify that it expires in 3 days:\n<%= config.bin %> <%= command.id %> --target-dev-hub MyHub --definition-file config/project-scratch-def.json --set-default --duration-days 3",
602
+ "Create a preview Enterprise edition scratch org; for use only during Salesforce release transition periods:\n<%= config.bin %> <%= command.id %> --edition enterprise --alias my-scratch-org --target-dev-hub MyHub --release preview",
603
+ "Create a scratch org from a snapshot called \"NightlyBranch\"; be sure you specify the same Dev Hub org associated with the snapshot. We recommend you increase the --wait time because creating a scratch org from a snapshot can take a while:\n<%= config.bin %> <%= command.id %> --alias my-scratch-org --target-dev-hub MyHub --snapshot NightlyBranch --wait 10"
564
604
  ],
565
605
  "flags": {
566
606
  "json": {
@@ -578,180 +618,250 @@
578
618
  "multiple": false,
579
619
  "type": "option"
580
620
  },
581
- "target-org": {
582
- "char": "o",
583
- "name": "target-org",
621
+ "alias": {
622
+ "char": "a",
623
+ "description": "New scratch orgs include one administrator by default. The admin user's username is auto-generated and looks something like test-wvkpnfm5z113@example.com. When you set an alias for a new scratch org, it's assigned this username.",
624
+ "name": "alias",
625
+ "summary": "Alias for the scratch org.",
626
+ "hasDynamicHelp": false,
627
+ "multiple": false,
628
+ "type": "option"
629
+ },
630
+ "async": {
631
+ "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To resume the scratch org creation, run \"<%= config.bin %> org resume scratch\".",
632
+ "name": "async",
633
+ "summary": "Request the org, but don't wait for it to complete.",
634
+ "allowNo": false,
635
+ "type": "boolean"
636
+ },
637
+ "set-default": {
638
+ "char": "d",
639
+ "name": "set-default",
640
+ "summary": "Set the scratch org as your default org",
641
+ "allowNo": false,
642
+ "type": "boolean"
643
+ },
644
+ "definition-file": {
645
+ "char": "f",
646
+ "description": "The scratch org definition file is a blueprint for the scratch org. It mimics the shape of an org that you use in the development life cycle, such as acceptance testing, packaging, or production. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm> for all the option you can specify in the definition file.",
647
+ "name": "definition-file",
648
+ "summary": "Path to a scratch org definition file.",
649
+ "hasDynamicHelp": false,
650
+ "multiple": false,
651
+ "type": "option"
652
+ },
653
+ "target-dev-hub": {
654
+ "char": "v",
655
+ "description": "Overrides the value of the target-dev-hub configuration variable, if set.",
656
+ "name": "target-dev-hub",
584
657
  "noCacheDefault": true,
585
658
  "required": true,
586
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
659
+ "summary": "Username or alias of the Dev Hub org.",
587
660
  "hasDynamicHelp": true,
588
661
  "multiple": false,
589
662
  "type": "option"
590
- }
591
- },
592
- "hasDynamicHelp": true,
593
- "hiddenAliases": [],
594
- "id": "org:disable:tracking",
595
- "pluginAlias": "@salesforce/plugin-org",
596
- "pluginName": "@salesforce/plugin-org",
597
- "pluginType": "core",
598
- "strict": true,
599
- "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
600
- "enableJsonFlag": true,
601
- "isESM": true,
602
- "relativePath": [
603
- "lib",
604
- "commands",
605
- "org",
606
- "disable",
607
- "tracking.js"
608
- ],
609
- "aliasPermutations": [],
610
- "permutations": [
611
- "org:disable:tracking",
612
- "disable:org:tracking",
613
- "disable:tracking:org",
614
- "org:tracking:disable",
615
- "tracking:org:disable",
616
- "tracking:disable:org"
617
- ]
618
- },
619
- "org:list:metadata-types": {
620
- "aliases": [
621
- "force:mdapi:describemetadata"
622
- ],
623
- "args": {},
624
- "deprecateAliases": true,
625
- "description": "The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
626
- "examples": [
627
- "Display information about all known and enabled metadata types in the org with alias \"my-dev-org\" using API version 57.0:\n$ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org",
628
- "Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file:\n$ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known"
629
- ],
630
- "flags": {
631
- "json": {
632
- "description": "Format output as json.",
633
- "helpGroup": "GLOBAL",
634
- "name": "json",
663
+ },
664
+ "no-ancestors": {
665
+ "char": "c",
666
+ "helpGroup": "Packaging",
667
+ "name": "no-ancestors",
668
+ "summary": "Don't include second-generation managed package (2GP) ancestors in the scratch org.",
635
669
  "allowNo": false,
636
670
  "type": "boolean"
637
671
  },
638
- "flags-dir": {
639
- "helpGroup": "GLOBAL",
640
- "name": "flags-dir",
641
- "summary": "Import flag values from a directory.",
672
+ "edition": {
673
+ "char": "e",
674
+ "description": "The editions that begin with \"partner-\" are available only if the Dev Hub org is a Partner Business Org.",
675
+ "exclusive": [
676
+ "snapshot",
677
+ "source-org"
678
+ ],
679
+ "helpGroup": "Definition File Override",
680
+ "name": "edition",
681
+ "summary": "Salesforce edition of the scratch org. Overrides the value of the \"edition\" option in the definition file, if set.",
642
682
  "hasDynamicHelp": false,
643
683
  "multiple": false,
684
+ "options": [
685
+ "developer",
686
+ "enterprise",
687
+ "group",
688
+ "professional",
689
+ "partner-developer",
690
+ "partner-enterprise",
691
+ "partner-group",
692
+ "partner-professional"
693
+ ],
644
694
  "type": "option"
645
695
  },
646
- "api-version": {
647
- "aliases": [
648
- "apiversion",
649
- "a"
696
+ "snapshot": {
697
+ "char": "s",
698
+ "description": "To view the names of the available snapshots for a given Dev Hub org, run the \"sf org list snapshot\" command.",
699
+ "exclusive": [
700
+ "edition",
701
+ "source-org"
650
702
  ],
651
- "deprecateAliases": true,
703
+ "helpGroup": "Definition File Override",
704
+ "name": "snapshot",
705
+ "summary": "Name of the snapshot to use when creating this scratch org. Overrides the value of the \"snapshot\" option in the defintion file, if set.",
706
+ "hasDynamicHelp": false,
707
+ "multiple": false,
708
+ "type": "option"
709
+ },
710
+ "no-namespace": {
711
+ "char": "m",
712
+ "helpGroup": "Packaging",
713
+ "name": "no-namespace",
714
+ "summary": "Create the scratch org with no namespace, even if the Dev Hub has a namespace.",
715
+ "allowNo": false,
716
+ "type": "boolean"
717
+ },
718
+ "duration-days": {
719
+ "char": "y",
720
+ "name": "duration-days",
721
+ "summary": "Number of days before the org expires.",
722
+ "hasDynamicHelp": true,
723
+ "helpValue": "<days>",
724
+ "multiple": false,
725
+ "type": "option"
726
+ },
727
+ "wait": {
728
+ "char": "w",
729
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the job ID. To resume the scratch org creation, run the org resume scratch command and pass it the job ID.",
730
+ "name": "wait",
731
+ "summary": "Number of minutes to wait for the scratch org to be ready.",
732
+ "hasDynamicHelp": true,
733
+ "helpValue": "<minutes>",
734
+ "multiple": false,
735
+ "type": "option"
736
+ },
737
+ "api-version": {
652
738
  "description": "Override the api version used for api requests made by this command",
653
739
  "name": "api-version",
654
- "summary": "API version to use; default is the most recent API version.",
655
740
  "hasDynamicHelp": false,
656
741
  "multiple": false,
657
742
  "type": "option"
658
743
  },
659
- "loglevel": {
660
- "deprecated": {
661
- "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."
662
- },
663
- "hidden": true,
664
- "name": "loglevel",
744
+ "client-id": {
745
+ "char": "i",
746
+ "name": "client-id",
747
+ "summary": "Consumer key of the Dev Hub connected app.",
665
748
  "hasDynamicHelp": false,
666
749
  "multiple": false,
667
750
  "type": "option"
668
751
  },
669
- "target-org": {
670
- "aliases": [
671
- "targetusername",
672
- "u"
673
- ],
674
- "char": "o",
675
- "deprecateAliases": true,
676
- "name": "target-org",
677
- "noCacheDefault": true,
678
- "required": true,
679
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
680
- "hasDynamicHelp": true,
752
+ "track-source": {
753
+ "char": "t",
754
+ "description": "We recommend you enable source tracking in scratch orgs, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the scratch org, and to detect any conflicts between the two.\n\nTo disable source tracking in the new scratch org, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the scratch org.",
755
+ "name": "track-source",
756
+ "summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
757
+ "allowNo": true,
758
+ "type": "boolean"
759
+ },
760
+ "username": {
761
+ "description": "The username must be unique within the entire scratch org and sandbox universe. You must add your own logic to ensure uniqueness.\n\nOmit this flag to have Salesforce generate a unique username for your org.",
762
+ "helpGroup": "Definition File Override",
763
+ "name": "username",
764
+ "summary": "Username of the scratch org admin user. Overrides the value of the \"username\" option in the definition file, if set.",
765
+ "hasDynamicHelp": false,
681
766
  "multiple": false,
682
767
  "type": "option"
683
768
  },
684
- "output-file": {
685
- "aliases": [
686
- "resultfile"
769
+ "description": {
770
+ "helpGroup": "Definition File Override",
771
+ "name": "description",
772
+ "summary": "Description of the scratch org in the Dev Hub. Overrides the value of the \"description\" option in the definition file, if set.",
773
+ "hasDynamicHelp": false,
774
+ "multiple": false,
775
+ "type": "option"
776
+ },
777
+ "name": {
778
+ "helpGroup": "Definition File Override",
779
+ "name": "name",
780
+ "summary": "Name of the org, such as \"Acme Company\". Overrides the value of the \"orgName\" option in the definition file, if set.",
781
+ "hasDynamicHelp": false,
782
+ "multiple": false,
783
+ "type": "option"
784
+ },
785
+ "release": {
786
+ "description": "By default, scratch orgs are on the same release as the Dev Hub. During Salesforce release transition periods, you can override this default behavior and opt in or out of the new release.",
787
+ "helpGroup": "Definition File Override",
788
+ "name": "release",
789
+ "summary": "Release of the scratch org as compared to the Dev Hub release.",
790
+ "hasDynamicHelp": false,
791
+ "multiple": false,
792
+ "options": [
793
+ "preview",
794
+ "previous"
687
795
  ],
688
- "char": "f",
689
- "deprecateAliases": true,
690
- "description": "Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the terminal or command window console.",
691
- "name": "output-file",
692
- "summary": "Pathname of the file in which to write the results.",
796
+ "type": "option"
797
+ },
798
+ "admin-email": {
799
+ "helpGroup": "Definition File Override",
800
+ "name": "admin-email",
801
+ "summary": "Email address that will be applied to the org's admin user. Overrides the value of the \"adminEmail\" option in the definition file, if set.",
693
802
  "hasDynamicHelp": false,
694
803
  "multiple": false,
695
804
  "type": "option"
696
805
  },
697
- "filter-known": {
698
- "aliases": [
699
- "filterknown"
806
+ "source-org": {
807
+ "description": "To view the names of the available org shapes for a given Dev Hub org, run the \"sf org list shape\" command.",
808
+ "exclusive": [
809
+ "edition",
810
+ "snapshot"
700
811
  ],
701
- "char": "k",
702
- "deprecateAliases": true,
703
- "hidden": true,
704
- "name": "filter-known",
705
- "summary": "Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI.\n\nfilter metadata known by the CLI",
706
- "allowNo": false,
707
- "type": "boolean"
812
+ "helpGroup": "Definition File Override",
813
+ "name": "source-org",
814
+ "summary": "15-character ID of the org shape that the new scratch org is based on. Overrides the value of the \"sourceOrg\" option in the definition file, if set.",
815
+ "hasDynamicHelp": false,
816
+ "multiple": false,
817
+ "type": "option"
708
818
  }
709
819
  },
710
820
  "hasDynamicHelp": true,
711
821
  "hiddenAliases": [],
712
- "id": "org:list:metadata-types",
822
+ "id": "org:create:scratch",
713
823
  "pluginAlias": "@salesforce/plugin-org",
714
824
  "pluginName": "@salesforce/plugin-org",
715
825
  "pluginType": "core",
716
826
  "strict": true,
717
- "summary": "Display details about the metadata types that are enabled for your org.",
827
+ "summary": "Create a scratch org.",
718
828
  "enableJsonFlag": true,
719
829
  "isESM": true,
720
830
  "relativePath": [
721
831
  "lib",
722
832
  "commands",
723
833
  "org",
724
- "list",
725
- "metadata-types.js"
834
+ "create",
835
+ "scratch.js"
726
836
  ],
727
837
  "aliasPermutations": [
728
- "force:mdapi:describemetadata",
729
- "mdapi:force:describemetadata",
730
- "mdapi:describemetadata:force",
731
- "force:describemetadata:mdapi",
732
- "describemetadata:force:mdapi",
733
- "describemetadata:mdapi:force"
838
+ "env:create:scratch",
839
+ "create:env:scratch",
840
+ "create:scratch:env",
841
+ "env:scratch:create",
842
+ "scratch:env:create",
843
+ "scratch:create:env"
734
844
  ],
735
845
  "permutations": [
736
- "org:list:metadata-types",
737
- "list:org:metadata-types",
738
- "list:metadata-types:org",
739
- "org:metadata-types:list",
740
- "metadata-types:org:list",
741
- "metadata-types:list:org"
846
+ "org:create:scratch",
847
+ "create:org:scratch",
848
+ "create:scratch:org",
849
+ "org:scratch:create",
850
+ "scratch:org:create",
851
+ "scratch:create:org"
742
852
  ]
743
853
  },
744
- "org:list:metadata": {
854
+ "org:delete:sandbox": {
745
855
  "aliases": [
746
- "force:mdapi:listmetadata"
856
+ "env:delete:sandbox"
747
857
  ],
748
858
  "args": {},
749
859
  "deprecateAliases": true,
750
- "description": "Use this command to identify individual components in your manifest file or if you want a high-level view of particular metadata types in your org. For example, you can use this command to return a list of names of all the CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset of these components.\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
860
+ "description": "Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes all local references to the org from your computer.\nSpecify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including sandboxes, and their aliases.\nBoth the sandbox and the associated production org must already be authenticated with the CLI to successfully delete the sandbox.",
751
861
  "examples": [
752
- "List the CustomObject components, and their properties, in the org with alias \"my-dev-org\":\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --target-org my-dev-org",
753
- "List the CustomObject components in your default org, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --api-version 57.0 --output-file /path/to/outputfilename.txt",
754
- "List the Dashboard components in your default org that are contained in the \"folderSales\" folder, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file /path/to/outputfilename.txt"
862
+ "Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox",
863
+ "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa",
864
+ "Delete the sandbox without prompting to confirm:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt"
755
865
  ],
756
866
  "flags": {
757
867
  "json": {
@@ -769,29 +879,6 @@
769
879
  "multiple": false,
770
880
  "type": "option"
771
881
  },
772
- "api-version": {
773
- "aliases": [
774
- "apiversion",
775
- "a"
776
- ],
777
- "deprecateAliases": true,
778
- "description": "Override the api version used for api requests made by this command",
779
- "name": "api-version",
780
- "summary": "API version to use; default is the most recent API version.",
781
- "hasDynamicHelp": false,
782
- "multiple": false,
783
- "type": "option"
784
- },
785
- "loglevel": {
786
- "deprecated": {
787
- "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."
788
- },
789
- "hidden": true,
790
- "name": "loglevel",
791
- "hasDynamicHelp": false,
792
- "multiple": false,
793
- "type": "option"
794
- },
795
882
  "target-org": {
796
883
  "aliases": [
797
884
  "targetusername",
@@ -800,93 +887,65 @@
800
887
  "char": "o",
801
888
  "deprecateAliases": true,
802
889
  "name": "target-org",
803
- "noCacheDefault": true,
804
890
  "required": true,
805
891
  "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
806
892
  "hasDynamicHelp": true,
807
893
  "multiple": false,
808
894
  "type": "option"
809
895
  },
810
- "output-file": {
811
- "aliases": [
812
- "resultfile"
813
- ],
814
- "char": "f",
815
- "deprecateAliases": true,
816
- "name": "output-file",
817
- "summary": "Pathname of the file in which to write the results.",
818
- "hasDynamicHelp": false,
819
- "multiple": false,
820
- "type": "option"
821
- },
822
- "metadata-type": {
823
- "aliases": [
824
- "metadatatype"
825
- ],
826
- "char": "m",
827
- "deprecateAliases": true,
828
- "name": "metadata-type",
829
- "required": true,
830
- "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
831
- "hasDynamicHelp": false,
832
- "multiple": false,
833
- "type": "option"
834
- },
835
- "folder": {
836
- "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
837
- "name": "folder",
838
- "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
839
- "hasDynamicHelp": false,
840
- "multiple": false,
841
- "type": "option"
896
+ "no-prompt": {
897
+ "char": "p",
898
+ "name": "no-prompt",
899
+ "summary": "Don't prompt the user to confirm the deletion.",
900
+ "allowNo": false,
901
+ "type": "boolean"
842
902
  }
843
903
  },
844
904
  "hasDynamicHelp": true,
845
905
  "hiddenAliases": [],
846
- "id": "org:list:metadata",
906
+ "id": "org:delete:sandbox",
847
907
  "pluginAlias": "@salesforce/plugin-org",
848
908
  "pluginName": "@salesforce/plugin-org",
849
909
  "pluginType": "core",
850
910
  "strict": true,
851
- "summary": "List the metadata components and properties of a specified type.",
911
+ "summary": "Delete a sandbox.",
852
912
  "enableJsonFlag": true,
853
913
  "isESM": true,
854
914
  "relativePath": [
855
915
  "lib",
856
916
  "commands",
857
917
  "org",
858
- "list",
859
- "metadata.js"
918
+ "delete",
919
+ "sandbox.js"
860
920
  ],
861
921
  "aliasPermutations": [
862
- "force:mdapi:listmetadata",
863
- "mdapi:force:listmetadata",
864
- "mdapi:listmetadata:force",
865
- "force:listmetadata:mdapi",
866
- "listmetadata:force:mdapi",
867
- "listmetadata:mdapi:force"
922
+ "env:delete:sandbox",
923
+ "delete:env:sandbox",
924
+ "delete:sandbox:env",
925
+ "env:sandbox:delete",
926
+ "sandbox:env:delete",
927
+ "sandbox:delete:env"
868
928
  ],
869
929
  "permutations": [
870
- "org:list:metadata",
871
- "list:org:metadata",
872
- "list:metadata:org",
873
- "org:metadata:list",
874
- "metadata:org:list",
875
- "metadata:list:org"
930
+ "org:delete:sandbox",
931
+ "delete:org:sandbox",
932
+ "delete:sandbox:org",
933
+ "org:sandbox:delete",
934
+ "sandbox:org:delete",
935
+ "sandbox:delete:org"
876
936
  ]
877
937
  },
878
- "org:create:sandbox": {
938
+ "org:delete:scratch": {
879
939
  "aliases": [
880
- "env:create:sandbox"
940
+ "env:delete:scratch"
881
941
  ],
882
942
  "args": {},
883
943
  "deprecateAliases": true,
884
- "description": "There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.\n\nYou can also use this command to clone an existing sandbox. Use the --source-sandbox-name flag to specify the existing sandbox name and the --name flag to the name of the new sandbox.",
944
+ "description": "Salesforce CLI marks the org for deletion in the Dev Hub org and then deletes all local references to the org from your computer.\nSpecify a scratch org with either the username or the alias you gave the scratch org when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including scratch orgs, and their aliases.",
885
945
  "examples": [
886
- "Create a sandbox org using a definition file and give it the alias \"MyDevSandbox\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg",
887
- "Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.\n<%= config.bin %> <%= command.id %> --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg --set-default",
888
- "Clone the existing sandbox with name \"ExistingSandbox\" and name the new sandbox \"NewClonedSandbox\". Set the new sandbox as your default org. Wait for 30 minutes for the sandbox creation to complete.\n<%= config.bin %> <%= command.id %> --source-sandbox-name ExistingSandbox --name NewClonedSandbox --target-org prodOrg --alias MyDevSandbox --set-default --wait 30",
889
- "Clone the existing sandbox with ID \"0GQB0000000TVobOAG\" and do not wait.\n<%= config.bin %> <%= command.id %> --source-id 0GQB0000000TVobOAG --name SbxClone --target-org prodOrg --async"
946
+ "Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org",
947
+ "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com",
948
+ "Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt"
890
949
  ],
891
950
  "flags": {
892
951
  "json": {
@@ -904,193 +963,70 @@
904
963
  "multiple": false,
905
964
  "type": "option"
906
965
  },
907
- "definition-file": {
908
- "char": "f",
909
- "description": "The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each sandbox type that you use in the development process. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
910
- "name": "definition-file",
911
- "summary": "Path to a sandbox definition file.",
912
- "hasDynamicHelp": false,
913
- "multiple": false,
914
- "type": "option"
915
- },
916
- "set-default": {
917
- "char": "s",
918
- "name": "set-default",
919
- "summary": "Set the sandbox org as your default org.",
920
- "allowNo": false,
921
- "type": "boolean"
922
- },
923
- "alias": {
924
- "char": "a",
925
- "description": "When you create a sandbox, the generated usernames are based on the usernames present in the production org. To ensure uniqueness, the new usernames are appended with the name of the sandbox. For example, the username \"user@example.com\" in the production org results in the username \"user@example.com.mysandbox\" in a sandbox named \"mysandbox\". When you set an alias for a sandbox org, it's assigned to the resulting username of the user running this command.",
926
- "name": "alias",
927
- "summary": "Alias for the sandbox org.",
928
- "hasDynamicHelp": false,
929
- "multiple": false,
930
- "type": "option"
931
- },
932
- "wait": {
933
- "char": "w",
934
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command you run to check the status of the create. The displayed command includes the job ID for the running sandbox creation.",
935
- "exclusive": [
936
- "async"
937
- ],
938
- "name": "wait",
939
- "summary": "Number of minutes to wait for the sandbox org to be ready.",
940
- "hasDynamicHelp": true,
941
- "helpValue": "<minutes>",
942
- "multiple": false,
943
- "type": "option"
944
- },
945
- "poll-interval": {
946
- "char": "i",
947
- "exclusive": [
948
- "async"
949
- ],
950
- "name": "poll-interval",
951
- "summary": "Number of seconds to wait between retries.",
952
- "hasDynamicHelp": true,
953
- "helpValue": "<seconds>",
954
- "multiple": false,
955
- "type": "option"
956
- },
957
- "async": {
958
- "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox creation, run \"<%= config.bin %> org resume sandbox\".",
959
- "exclusive": [
960
- "wait",
961
- "poll-interval"
962
- ],
963
- "name": "async",
964
- "summary": "Request the sandbox creation, but don't wait for it to complete.",
965
- "allowNo": false,
966
- "type": "boolean"
967
- },
968
- "name": {
969
- "char": "n",
970
- "description": "The name must be a unique alphanumeric string (10 or fewer characters) to identify the sandbox. You can’t reuse a name while a sandbox is in the process of being deleted.",
971
- "name": "name",
972
- "summary": "Name of the sandbox org.",
973
- "hasDynamicHelp": false,
974
- "multiple": false,
975
- "type": "option"
976
- },
977
- "source-sandbox-name": {
978
- "aliases": [
979
- "clone",
980
- "c"
981
- ],
982
- "deprecateAliases": true,
983
- "description": "The value of --source-sandbox-name must be an existing sandbox. The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.",
984
- "exclusive": [
985
- "license-type",
986
- "source-id"
987
- ],
988
- "name": "source-sandbox-name",
989
- "summary": "Name of the sandbox org to clone.",
990
- "hasDynamicHelp": false,
991
- "multiple": false,
992
- "type": "option"
993
- },
994
- "source-id": {
995
- "description": "The value of --source-id must be an existing sandbox (SandboxInfo.Id). The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.",
996
- "exclusive": [
997
- "license-type",
998
- "source-sandbox-name"
999
- ],
1000
- "name": "source-id",
1001
- "summary": "ID of the sandbox org to clone.",
1002
- "hasDynamicHelp": false,
1003
- "multiple": false,
1004
- "type": "option"
1005
- },
1006
- "license-type": {
1007
- "char": "l",
1008
- "exclusive": [
1009
- "source-sandbox-name",
1010
- "source-id"
1011
- ],
1012
- "name": "license-type",
1013
- "summary": "Type of sandbox license.",
1014
- "hasDynamicHelp": false,
1015
- "multiple": false,
1016
- "options": [
1017
- "Developer",
1018
- "Developer_Pro",
1019
- "Partial",
1020
- "Full"
1021
- ],
1022
- "type": "option"
1023
- },
1024
966
  "target-org": {
967
+ "aliases": [
968
+ "targetusername",
969
+ "u"
970
+ ],
1025
971
  "char": "o",
1026
- "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
972
+ "deprecateAliases": true,
1027
973
  "name": "target-org",
1028
- "noCacheDefault": true,
1029
974
  "required": true,
1030
- "summary": "Username or alias of the production org that contains the sandbox license.",
975
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1031
976
  "hasDynamicHelp": true,
1032
977
  "multiple": false,
1033
978
  "type": "option"
1034
979
  },
1035
980
  "no-prompt": {
981
+ "char": "p",
1036
982
  "name": "no-prompt",
1037
- "summary": "Don't prompt for confirmation about the sandbox configuration.",
1038
- "allowNo": false,
1039
- "type": "boolean"
1040
- },
1041
- "no-track-source": {
1042
- "description": "We recommend you enable source tracking in Developer and Developer Pro sandbox, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the sandbox, and to detect any conflicts between the two.\n\nTo disable source tracking in the new sandbox, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the sandbox.",
1043
- "name": "no-track-source",
1044
- "summary": "Do not use source tracking for this sandbox.",
983
+ "summary": "Don't prompt the user to confirm the deletion.",
1045
984
  "allowNo": false,
1046
985
  "type": "boolean"
1047
986
  }
1048
987
  },
1049
988
  "hasDynamicHelp": true,
1050
989
  "hiddenAliases": [],
1051
- "id": "org:create:sandbox",
990
+ "id": "org:delete:scratch",
1052
991
  "pluginAlias": "@salesforce/plugin-org",
1053
992
  "pluginName": "@salesforce/plugin-org",
1054
993
  "pluginType": "core",
1055
994
  "strict": true,
1056
- "summary": "Create a sandbox org.",
995
+ "summary": "Delete a scratch org.",
996
+ "enableJsonFlag": true,
1057
997
  "isESM": true,
1058
998
  "relativePath": [
1059
999
  "lib",
1060
1000
  "commands",
1061
1001
  "org",
1062
- "create",
1063
- "sandbox.js"
1002
+ "delete",
1003
+ "scratch.js"
1064
1004
  ],
1065
1005
  "aliasPermutations": [
1066
- "env:create:sandbox",
1067
- "create:env:sandbox",
1068
- "create:sandbox:env",
1069
- "env:sandbox:create",
1070
- "sandbox:env:create",
1071
- "sandbox:create:env"
1006
+ "env:delete:scratch",
1007
+ "delete:env:scratch",
1008
+ "delete:scratch:env",
1009
+ "env:scratch:delete",
1010
+ "scratch:env:delete",
1011
+ "scratch:delete:env"
1072
1012
  ],
1073
1013
  "permutations": [
1074
- "org:create:sandbox",
1075
- "create:org:sandbox",
1076
- "create:sandbox:org",
1077
- "org:sandbox:create",
1078
- "sandbox:org:create",
1079
- "sandbox:create:org"
1014
+ "org:delete:scratch",
1015
+ "delete:org:scratch",
1016
+ "delete:scratch:org",
1017
+ "org:scratch:delete",
1018
+ "scratch:org:delete",
1019
+ "scratch:delete:org"
1080
1020
  ]
1081
1021
  },
1082
- "org:create:scratch": {
1083
- "aliases": [
1084
- "env:create:scratch"
1085
- ],
1022
+ "org:disable:tracking": {
1023
+ "aliases": [],
1086
1024
  "args": {},
1087
- "deprecateAliases": true,
1088
- "description": "There are four ways to create a scratch org:\n\n * Specify a definition file that contains the scratch org options.\n * Use the --edition flag to specify the one required option; this method doesn't require a defintion file.\n * Use the --snapshot flag to create a scratch org from a snapshot. Snapshots are a point-in-time copy of a scratch org; you create a snapshot with the \"sf org create snapshot\" command.\n * Use the --source-org flag to create a scratch org from an org shape. Org shapes mimic the baseline setup of a source org without the extraneous data and metadata; you create an org shape with the \"sf org create shape\" command.\n\nThe --edition, --snapshot, and --source-org flags are mutually exclusive, which means if you specify one, you can't also specify the others.\n\nFor any of the methods, you can also use these flags; if you use them with --definition-file, they override their equivalent option in the scratch org definition file:\n\n * --description\n * --name (equivalent to the \"orgName\" option)\n * --username\n * --release\n * --admin-email (equivalent to the \"adminEmail\" option)\n\nIf you want to set options such as org features or settings, you must use a definition file.\n\nYou must specify a Dev Hub to create a scratch org, either with the --target-dev-hub flag or by setting your default Dev Hub with the target-dev-hub configuration variable.",
1025
+ "description": "Disabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that no source tracking operations are executed when working with the org.",
1089
1026
  "examples": [
1090
- "Create a Developer edition scratch org using your default Dev Hub and give the scratch org an alias:\n<%= config.bin %> <%= command.id %> --edition developer --alias my-scratch-org",
1091
- "Create a scratch org with a definition file. Specify the Dev Hub using its alias, set the scratch org as your default, and specify that it expires in 3 days:\n<%= config.bin %> <%= command.id %> --target-dev-hub MyHub --definition-file config/project-scratch-def.json --set-default --duration-days 3",
1092
- "Create a preview Enterprise edition scratch org; for use only during Salesforce release transition periods:\n<%= config.bin %> <%= command.id %> --edition enterprise --alias my-scratch-org --target-dev-hub MyHub --release preview",
1093
- "Create a scratch org from a snapshot called \"NightlyBranch\"; be sure you specify the same Dev Hub org associated with the snapshot. We recommend you increase the --wait time because creating a scratch org from a snapshot can take a while:\n<%= config.bin %> <%= command.id %> --alias my-scratch-org --target-dev-hub MyHub --snapshot NightlyBranch --wait 10"
1027
+ "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1028
+ "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1029
+ "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1094
1030
  ],
1095
1031
  "flags": {
1096
1032
  "json": {
@@ -1108,247 +1044,243 @@
1108
1044
  "multiple": false,
1109
1045
  "type": "option"
1110
1046
  },
1111
- "alias": {
1112
- "char": "a",
1113
- "description": "New scratch orgs include one administrator by default. The admin user's username is auto-generated and looks something like test-wvkpnfm5z113@example.com. When you set an alias for a new scratch org, it's assigned this username.",
1114
- "name": "alias",
1115
- "summary": "Alias for the scratch org.",
1116
- "hasDynamicHelp": false,
1117
- "multiple": false,
1118
- "type": "option"
1119
- },
1120
- "async": {
1121
- "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To resume the scratch org creation, run \"<%= config.bin %> org resume scratch\".",
1122
- "name": "async",
1123
- "summary": "Request the org, but don't wait for it to complete.",
1124
- "allowNo": false,
1125
- "type": "boolean"
1126
- },
1127
- "set-default": {
1128
- "char": "d",
1129
- "name": "set-default",
1130
- "summary": "Set the scratch org as your default org",
1131
- "allowNo": false,
1132
- "type": "boolean"
1133
- },
1134
- "definition-file": {
1135
- "char": "f",
1136
- "description": "The scratch org definition file is a blueprint for the scratch org. It mimics the shape of an org that you use in the development life cycle, such as acceptance testing, packaging, or production. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm> for all the option you can specify in the definition file.",
1137
- "name": "definition-file",
1138
- "summary": "Path to a scratch org definition file.",
1139
- "hasDynamicHelp": false,
1140
- "multiple": false,
1141
- "type": "option"
1142
- },
1143
- "target-dev-hub": {
1144
- "char": "v",
1145
- "description": "Overrides the value of the target-dev-hub configuration variable, if set.",
1146
- "name": "target-dev-hub",
1047
+ "target-org": {
1048
+ "char": "o",
1049
+ "name": "target-org",
1147
1050
  "noCacheDefault": true,
1148
1051
  "required": true,
1149
- "summary": "Username or alias of the Dev Hub org.",
1052
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1150
1053
  "hasDynamicHelp": true,
1151
1054
  "multiple": false,
1152
1055
  "type": "option"
1153
- },
1154
- "no-ancestors": {
1155
- "char": "c",
1156
- "helpGroup": "Packaging",
1157
- "name": "no-ancestors",
1158
- "summary": "Don't include second-generation managed package (2GP) ancestors in the scratch org.",
1056
+ }
1057
+ },
1058
+ "hasDynamicHelp": true,
1059
+ "hiddenAliases": [],
1060
+ "id": "org:disable:tracking",
1061
+ "pluginAlias": "@salesforce/plugin-org",
1062
+ "pluginName": "@salesforce/plugin-org",
1063
+ "pluginType": "core",
1064
+ "strict": true,
1065
+ "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
1066
+ "enableJsonFlag": true,
1067
+ "isESM": true,
1068
+ "relativePath": [
1069
+ "lib",
1070
+ "commands",
1071
+ "org",
1072
+ "disable",
1073
+ "tracking.js"
1074
+ ],
1075
+ "aliasPermutations": [],
1076
+ "permutations": [
1077
+ "org:disable:tracking",
1078
+ "disable:org:tracking",
1079
+ "disable:tracking:org",
1080
+ "org:tracking:disable",
1081
+ "tracking:org:disable",
1082
+ "tracking:disable:org"
1083
+ ]
1084
+ },
1085
+ "org:enable:tracking": {
1086
+ "aliases": [],
1087
+ "args": {},
1088
+ "description": "Enabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that source tracking operations are executed when working with the org.\n\nThis command throws an error if the org doesn't support tracking. Examples of orgs that don't support source tracking include Developer Edition orgs, production orgs, Partial Copy sandboxes, and Full sandboxes.",
1089
+ "examples": [
1090
+ "Enable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1091
+ "Enable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1092
+ "Enable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1093
+ ],
1094
+ "flags": {
1095
+ "json": {
1096
+ "description": "Format output as json.",
1097
+ "helpGroup": "GLOBAL",
1098
+ "name": "json",
1159
1099
  "allowNo": false,
1160
1100
  "type": "boolean"
1161
1101
  },
1162
- "edition": {
1163
- "char": "e",
1164
- "description": "The editions that begin with \"partner-\" are available only if the Dev Hub org is a Partner Business Org.",
1165
- "exclusive": [
1166
- "snapshot",
1167
- "source-org"
1168
- ],
1169
- "helpGroup": "Definition File Override",
1170
- "name": "edition",
1171
- "summary": "Salesforce edition of the scratch org. Overrides the value of the \"edition\" option in the definition file, if set.",
1172
- "hasDynamicHelp": false,
1173
- "multiple": false,
1174
- "options": [
1175
- "developer",
1176
- "enterprise",
1177
- "group",
1178
- "professional",
1179
- "partner-developer",
1180
- "partner-enterprise",
1181
- "partner-group",
1182
- "partner-professional"
1183
- ],
1184
- "type": "option"
1185
- },
1186
- "snapshot": {
1187
- "char": "s",
1188
- "description": "To view the names of the available snapshots for a given Dev Hub org, run the \"sf org list snapshot\" command.",
1189
- "exclusive": [
1190
- "edition",
1191
- "source-org"
1192
- ],
1193
- "helpGroup": "Definition File Override",
1194
- "name": "snapshot",
1195
- "summary": "Name of the snapshot to use when creating this scratch org. Overrides the value of the \"snapshot\" option in the defintion file, if set.",
1102
+ "flags-dir": {
1103
+ "helpGroup": "GLOBAL",
1104
+ "name": "flags-dir",
1105
+ "summary": "Import flag values from a directory.",
1196
1106
  "hasDynamicHelp": false,
1197
1107
  "multiple": false,
1198
1108
  "type": "option"
1199
1109
  },
1200
- "no-namespace": {
1201
- "char": "m",
1202
- "helpGroup": "Packaging",
1203
- "name": "no-namespace",
1204
- "summary": "Create the scratch org with no namespace, even if the Dev Hub has a namespace.",
1205
- "allowNo": false,
1206
- "type": "boolean"
1207
- },
1208
- "duration-days": {
1209
- "char": "y",
1210
- "name": "duration-days",
1211
- "summary": "Number of days before the org expires.",
1110
+ "target-org": {
1111
+ "char": "o",
1112
+ "name": "target-org",
1113
+ "noCacheDefault": true,
1114
+ "required": true,
1115
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1212
1116
  "hasDynamicHelp": true,
1213
- "helpValue": "<days>",
1214
1117
  "multiple": false,
1215
1118
  "type": "option"
1119
+ }
1120
+ },
1121
+ "hasDynamicHelp": true,
1122
+ "hiddenAliases": [],
1123
+ "id": "org:enable:tracking",
1124
+ "pluginAlias": "@salesforce/plugin-org",
1125
+ "pluginName": "@salesforce/plugin-org",
1126
+ "pluginType": "core",
1127
+ "strict": true,
1128
+ "summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
1129
+ "enableJsonFlag": true,
1130
+ "isESM": true,
1131
+ "relativePath": [
1132
+ "lib",
1133
+ "commands",
1134
+ "org",
1135
+ "enable",
1136
+ "tracking.js"
1137
+ ],
1138
+ "aliasPermutations": [],
1139
+ "permutations": [
1140
+ "org:enable:tracking",
1141
+ "enable:org:tracking",
1142
+ "enable:tracking:org",
1143
+ "org:tracking:enable",
1144
+ "tracking:org:enable",
1145
+ "tracking:enable:org"
1146
+ ]
1147
+ },
1148
+ "org:list:metadata-types": {
1149
+ "aliases": [
1150
+ "force:mdapi:describemetadata"
1151
+ ],
1152
+ "args": {},
1153
+ "deprecateAliases": true,
1154
+ "description": "The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
1155
+ "examples": [
1156
+ "Display information about all known and enabled metadata types in the org with alias \"my-dev-org\" using API version 57.0:\n$ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org",
1157
+ "Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file:\n$ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known"
1158
+ ],
1159
+ "flags": {
1160
+ "json": {
1161
+ "description": "Format output as json.",
1162
+ "helpGroup": "GLOBAL",
1163
+ "name": "json",
1164
+ "allowNo": false,
1165
+ "type": "boolean"
1216
1166
  },
1217
- "wait": {
1218
- "char": "w",
1219
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the job ID. To resume the scratch org creation, run the org resume scratch command and pass it the job ID.",
1220
- "name": "wait",
1221
- "summary": "Number of minutes to wait for the scratch org to be ready.",
1222
- "hasDynamicHelp": true,
1223
- "helpValue": "<minutes>",
1167
+ "flags-dir": {
1168
+ "helpGroup": "GLOBAL",
1169
+ "name": "flags-dir",
1170
+ "summary": "Import flag values from a directory.",
1171
+ "hasDynamicHelp": false,
1224
1172
  "multiple": false,
1225
1173
  "type": "option"
1226
1174
  },
1227
1175
  "api-version": {
1176
+ "aliases": [
1177
+ "apiversion",
1178
+ "a"
1179
+ ],
1180
+ "deprecateAliases": true,
1228
1181
  "description": "Override the api version used for api requests made by this command",
1229
1182
  "name": "api-version",
1183
+ "summary": "API version to use; default is the most recent API version.",
1230
1184
  "hasDynamicHelp": false,
1231
1185
  "multiple": false,
1232
1186
  "type": "option"
1233
1187
  },
1234
- "client-id": {
1235
- "char": "i",
1236
- "name": "client-id",
1237
- "summary": "Consumer key of the Dev Hub connected app.",
1238
- "hasDynamicHelp": false,
1239
- "multiple": false,
1240
- "type": "option"
1241
- },
1242
- "track-source": {
1243
- "char": "t",
1244
- "description": "We recommend you enable source tracking in scratch orgs, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the scratch org, and to detect any conflicts between the two.\n\nTo disable source tracking in the new scratch org, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the scratch org.",
1245
- "name": "track-source",
1246
- "summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
1247
- "allowNo": true,
1248
- "type": "boolean"
1249
- },
1250
- "username": {
1251
- "description": "The username must be unique within the entire scratch org and sandbox universe. You must add your own logic to ensure uniqueness.\n\nOmit this flag to have Salesforce generate a unique username for your org.",
1252
- "helpGroup": "Definition File Override",
1253
- "name": "username",
1254
- "summary": "Username of the scratch org admin user. Overrides the value of the \"username\" option in the definition file, if set.",
1255
- "hasDynamicHelp": false,
1256
- "multiple": false,
1257
- "type": "option"
1258
- },
1259
- "description": {
1260
- "helpGroup": "Definition File Override",
1261
- "name": "description",
1262
- "summary": "Description of the scratch org in the Dev Hub. Overrides the value of the \"description\" option in the definition file, if set.",
1188
+ "loglevel": {
1189
+ "deprecated": {
1190
+ "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."
1191
+ },
1192
+ "hidden": true,
1193
+ "name": "loglevel",
1263
1194
  "hasDynamicHelp": false,
1264
1195
  "multiple": false,
1265
1196
  "type": "option"
1266
1197
  },
1267
- "name": {
1268
- "helpGroup": "Definition File Override",
1269
- "name": "name",
1270
- "summary": "Name of the org, such as \"Acme Company\". Overrides the value of the \"orgName\" option in the definition file, if set.",
1271
- "hasDynamicHelp": false,
1198
+ "target-org": {
1199
+ "aliases": [
1200
+ "targetusername",
1201
+ "u"
1202
+ ],
1203
+ "char": "o",
1204
+ "deprecateAliases": true,
1205
+ "name": "target-org",
1206
+ "noCacheDefault": true,
1207
+ "required": true,
1208
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1209
+ "hasDynamicHelp": true,
1272
1210
  "multiple": false,
1273
1211
  "type": "option"
1274
1212
  },
1275
- "release": {
1276
- "description": "By default, scratch orgs are on the same release as the Dev Hub. During Salesforce release transition periods, you can override this default behavior and opt in or out of the new release.",
1277
- "helpGroup": "Definition File Override",
1278
- "name": "release",
1279
- "summary": "Release of the scratch org as compared to the Dev Hub release.",
1280
- "hasDynamicHelp": false,
1281
- "multiple": false,
1282
- "options": [
1283
- "preview",
1284
- "previous"
1213
+ "output-file": {
1214
+ "aliases": [
1215
+ "resultfile"
1285
1216
  ],
1286
- "type": "option"
1287
- },
1288
- "admin-email": {
1289
- "helpGroup": "Definition File Override",
1290
- "name": "admin-email",
1291
- "summary": "Email address that will be applied to the org's admin user. Overrides the value of the \"adminEmail\" option in the definition file, if set.",
1217
+ "char": "f",
1218
+ "deprecateAliases": true,
1219
+ "description": "Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the terminal or command window console.",
1220
+ "name": "output-file",
1221
+ "summary": "Pathname of the file in which to write the results.",
1292
1222
  "hasDynamicHelp": false,
1293
1223
  "multiple": false,
1294
1224
  "type": "option"
1295
1225
  },
1296
- "source-org": {
1297
- "description": "To view the names of the available org shapes for a given Dev Hub org, run the \"sf org list shape\" command.",
1298
- "exclusive": [
1299
- "edition",
1300
- "snapshot"
1226
+ "filter-known": {
1227
+ "aliases": [
1228
+ "filterknown"
1301
1229
  ],
1302
- "helpGroup": "Definition File Override",
1303
- "name": "source-org",
1304
- "summary": "15-character ID of the org shape that the new scratch org is based on. Overrides the value of the \"sourceOrg\" option in the definition file, if set.",
1305
- "hasDynamicHelp": false,
1306
- "multiple": false,
1307
- "type": "option"
1230
+ "char": "k",
1231
+ "deprecateAliases": true,
1232
+ "hidden": true,
1233
+ "name": "filter-known",
1234
+ "summary": "Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI.\n\nfilter metadata known by the CLI",
1235
+ "allowNo": false,
1236
+ "type": "boolean"
1308
1237
  }
1309
1238
  },
1310
1239
  "hasDynamicHelp": true,
1311
1240
  "hiddenAliases": [],
1312
- "id": "org:create:scratch",
1241
+ "id": "org:list:metadata-types",
1313
1242
  "pluginAlias": "@salesforce/plugin-org",
1314
1243
  "pluginName": "@salesforce/plugin-org",
1315
1244
  "pluginType": "core",
1316
1245
  "strict": true,
1317
- "summary": "Create a scratch org.",
1246
+ "summary": "Display details about the metadata types that are enabled for your org.",
1318
1247
  "enableJsonFlag": true,
1319
1248
  "isESM": true,
1320
1249
  "relativePath": [
1321
1250
  "lib",
1322
1251
  "commands",
1323
1252
  "org",
1324
- "create",
1325
- "scratch.js"
1253
+ "list",
1254
+ "metadata-types.js"
1326
1255
  ],
1327
1256
  "aliasPermutations": [
1328
- "env:create:scratch",
1329
- "create:env:scratch",
1330
- "create:scratch:env",
1331
- "env:scratch:create",
1332
- "scratch:env:create",
1333
- "scratch:create:env"
1257
+ "force:mdapi:describemetadata",
1258
+ "mdapi:force:describemetadata",
1259
+ "mdapi:describemetadata:force",
1260
+ "force:describemetadata:mdapi",
1261
+ "describemetadata:force:mdapi",
1262
+ "describemetadata:mdapi:force"
1334
1263
  ],
1335
1264
  "permutations": [
1336
- "org:create:scratch",
1337
- "create:org:scratch",
1338
- "create:scratch:org",
1339
- "org:scratch:create",
1340
- "scratch:org:create",
1341
- "scratch:create:org"
1265
+ "org:list:metadata-types",
1266
+ "list:org:metadata-types",
1267
+ "list:metadata-types:org",
1268
+ "org:metadata-types:list",
1269
+ "metadata-types:org:list",
1270
+ "metadata-types:list:org"
1342
1271
  ]
1343
1272
  },
1344
- "org:enable:tracking": {
1345
- "aliases": [],
1273
+ "org:list:metadata": {
1274
+ "aliases": [
1275
+ "force:mdapi:listmetadata"
1276
+ ],
1346
1277
  "args": {},
1347
- "description": "Enabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that source tracking operations are executed when working with the org.\n\nThis command throws an error if the org doesn't support tracking. Examples of orgs that don't support source tracking include Developer Edition orgs, production orgs, Partial Copy sandboxes, and Full sandboxes.",
1278
+ "deprecateAliases": true,
1279
+ "description": "Use this command to identify individual components in your manifest file or if you want a high-level view of particular metadata types in your org. For example, you can use this command to return a list of names of all the CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset of these components.\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
1348
1280
  "examples": [
1349
- "Enable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1350
- "Enable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1351
- "Enable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1281
+ "List the CustomObject components, and their properties, in the org with alias \"my-dev-org\":\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --target-org my-dev-org",
1282
+ "List the CustomObject components in your default org, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --api-version 57.0 --output-file /path/to/outputfilename.txt",
1283
+ "List the Dashboard components in your default org that are contained in the \"folderSales\" folder, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file /path/to/outputfilename.txt"
1352
1284
  ],
1353
1285
  "flags": {
1354
1286
  "json": {
@@ -1366,8 +1298,36 @@
1366
1298
  "multiple": false,
1367
1299
  "type": "option"
1368
1300
  },
1301
+ "api-version": {
1302
+ "aliases": [
1303
+ "apiversion",
1304
+ "a"
1305
+ ],
1306
+ "deprecateAliases": true,
1307
+ "description": "Override the api version used for api requests made by this command",
1308
+ "name": "api-version",
1309
+ "summary": "API version to use; default is the most recent API version.",
1310
+ "hasDynamicHelp": false,
1311
+ "multiple": false,
1312
+ "type": "option"
1313
+ },
1314
+ "loglevel": {
1315
+ "deprecated": {
1316
+ "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."
1317
+ },
1318
+ "hidden": true,
1319
+ "name": "loglevel",
1320
+ "hasDynamicHelp": false,
1321
+ "multiple": false,
1322
+ "type": "option"
1323
+ },
1369
1324
  "target-org": {
1325
+ "aliases": [
1326
+ "targetusername",
1327
+ "u"
1328
+ ],
1370
1329
  "char": "o",
1330
+ "deprecateAliases": true,
1371
1331
  "name": "target-org",
1372
1332
  "noCacheDefault": true,
1373
1333
  "required": true,
@@ -1375,33 +1335,73 @@
1375
1335
  "hasDynamicHelp": true,
1376
1336
  "multiple": false,
1377
1337
  "type": "option"
1338
+ },
1339
+ "output-file": {
1340
+ "aliases": [
1341
+ "resultfile"
1342
+ ],
1343
+ "char": "f",
1344
+ "deprecateAliases": true,
1345
+ "name": "output-file",
1346
+ "summary": "Pathname of the file in which to write the results.",
1347
+ "hasDynamicHelp": false,
1348
+ "multiple": false,
1349
+ "type": "option"
1350
+ },
1351
+ "metadata-type": {
1352
+ "aliases": [
1353
+ "metadatatype"
1354
+ ],
1355
+ "char": "m",
1356
+ "deprecateAliases": true,
1357
+ "name": "metadata-type",
1358
+ "required": true,
1359
+ "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1360
+ "hasDynamicHelp": false,
1361
+ "multiple": false,
1362
+ "type": "option"
1363
+ },
1364
+ "folder": {
1365
+ "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1366
+ "name": "folder",
1367
+ "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
1368
+ "hasDynamicHelp": false,
1369
+ "multiple": false,
1370
+ "type": "option"
1378
1371
  }
1379
1372
  },
1380
1373
  "hasDynamicHelp": true,
1381
1374
  "hiddenAliases": [],
1382
- "id": "org:enable:tracking",
1375
+ "id": "org:list:metadata",
1383
1376
  "pluginAlias": "@salesforce/plugin-org",
1384
1377
  "pluginName": "@salesforce/plugin-org",
1385
1378
  "pluginType": "core",
1386
1379
  "strict": true,
1387
- "summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
1380
+ "summary": "List the metadata components and properties of a specified type.",
1388
1381
  "enableJsonFlag": true,
1389
1382
  "isESM": true,
1390
1383
  "relativePath": [
1391
1384
  "lib",
1392
1385
  "commands",
1393
1386
  "org",
1394
- "enable",
1395
- "tracking.js"
1387
+ "list",
1388
+ "metadata.js"
1389
+ ],
1390
+ "aliasPermutations": [
1391
+ "force:mdapi:listmetadata",
1392
+ "mdapi:force:listmetadata",
1393
+ "mdapi:listmetadata:force",
1394
+ "force:listmetadata:mdapi",
1395
+ "listmetadata:force:mdapi",
1396
+ "listmetadata:mdapi:force"
1396
1397
  ],
1397
- "aliasPermutations": [],
1398
1398
  "permutations": [
1399
- "org:enable:tracking",
1400
- "enable:org:tracking",
1401
- "enable:tracking:org",
1402
- "org:tracking:enable",
1403
- "tracking:org:enable",
1404
- "tracking:enable:org"
1399
+ "org:list:metadata",
1400
+ "list:org:metadata",
1401
+ "list:metadata:org",
1402
+ "org:metadata:list",
1403
+ "metadata:org:list",
1404
+ "metadata:list:org"
1405
1405
  ]
1406
1406
  },
1407
1407
  "org:open:agent": {
@@ -1875,5 +1875,5 @@
1875
1875
  ]
1876
1876
  }
1877
1877
  },
1878
- "version": "5.9.0"
1878
+ "version": "5.9.2"
1879
1879
  }