@salesforce/plugin-org 5.8.4 → 5.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -385,17 +385,17 @@
385
385
  "open:org"
386
386
  ]
387
387
  },
388
- "org:create:sandbox": {
388
+ "org:delete:sandbox": {
389
389
  "aliases": [
390
- "env:create:sandbox"
390
+ "env:delete:sandbox"
391
391
  ],
392
392
  "args": {},
393
393
  "deprecateAliases": true,
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.",
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.",
395
395
  "examples": [
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"
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"
399
399
  ],
400
400
  "flags": {
401
401
  "json": {
@@ -413,192 +413,154 @@
413
413
  "multiple": false,
414
414
  "type": "option"
415
415
  },
416
- "definition-file": {
417
- "char": "f",
418
- "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.",
419
- "name": "definition-file",
420
- "summary": "Path to a sandbox definition file.",
421
- "hasDynamicHelp": false,
422
- "multiple": false,
423
- "type": "option"
424
- },
425
- "set-default": {
426
- "char": "s",
427
- "name": "set-default",
428
- "summary": "Set the sandbox org as your default org.",
429
- "allowNo": false,
430
- "type": "boolean"
431
- },
432
- "alias": {
433
- "char": "a",
434
- "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.",
435
- "name": "alias",
436
- "summary": "Alias for the sandbox org.",
437
- "hasDynamicHelp": false,
438
- "multiple": false,
439
- "type": "option"
440
- },
441
- "wait": {
442
- "char": "w",
443
- "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.",
444
- "exclusive": [
445
- "async"
446
- ],
447
- "name": "wait",
448
- "summary": "Number of minutes to wait for the sandbox org to be ready.",
449
- "hasDynamicHelp": true,
450
- "helpValue": "<minutes>",
451
- "multiple": false,
452
- "type": "option"
453
- },
454
- "poll-interval": {
455
- "char": "i",
456
- "exclusive": [
457
- "async"
416
+ "target-org": {
417
+ "aliases": [
418
+ "targetusername",
419
+ "u"
458
420
  ],
459
- "name": "poll-interval",
460
- "summary": "Number of seconds to wait between retries.",
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.",
461
426
  "hasDynamicHelp": true,
462
- "helpValue": "<seconds>",
463
427
  "multiple": false,
464
428
  "type": "option"
465
429
  },
466
- "async": {
467
- "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\".",
468
- "exclusive": [
469
- "wait",
470
- "poll-interval"
471
- ],
472
- "name": "async",
473
- "summary": "Request the sandbox creation, but don't wait for it to complete.",
430
+ "no-prompt": {
431
+ "char": "p",
432
+ "name": "no-prompt",
433
+ "summary": "Don't prompt the user to confirm the deletion.",
434
+ "allowNo": false,
435
+ "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",
474
489
  "allowNo": false,
475
490
  "type": "boolean"
476
491
  },
477
- "name": {
478
- "char": "n",
479
- "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.",
480
- "name": "name",
481
- "summary": "Name of the sandbox org.",
492
+ "flags-dir": {
493
+ "helpGroup": "GLOBAL",
494
+ "name": "flags-dir",
495
+ "summary": "Import flag values from a directory.",
482
496
  "hasDynamicHelp": false,
483
497
  "multiple": false,
484
498
  "type": "option"
485
499
  },
486
- "source-sandbox-name": {
500
+ "target-org": {
487
501
  "aliases": [
488
- "clone",
489
- "c"
490
- ],
491
- "deprecateAliases": true,
492
- "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.",
493
- "exclusive": [
494
- "license-type",
495
- "source-id"
496
- ],
497
- "name": "source-sandbox-name",
498
- "summary": "Name of the sandbox org to clone.",
499
- "hasDynamicHelp": false,
500
- "multiple": false,
501
- "type": "option"
502
- },
503
- "source-id": {
504
- "description": "The value of --source-id 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.",
505
- "exclusive": [
506
- "license-type"
507
- ],
508
- "name": "source-id",
509
- "summary": "ID of the sandbox org to clone.",
510
- "hasDynamicHelp": false,
511
- "multiple": false,
512
- "type": "option"
513
- },
514
- "license-type": {
515
- "char": "l",
516
- "exclusive": [
517
- "source-sandbox-name",
518
- "source-id"
519
- ],
520
- "name": "license-type",
521
- "summary": "Type of sandbox license.",
522
- "hasDynamicHelp": false,
523
- "multiple": false,
524
- "options": [
525
- "Developer",
526
- "Developer_Pro",
527
- "Partial",
528
- "Full"
502
+ "targetusername",
503
+ "u"
529
504
  ],
530
- "type": "option"
531
- },
532
- "target-org": {
533
505
  "char": "o",
534
- "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
506
+ "deprecateAliases": true,
535
507
  "name": "target-org",
536
- "noCacheDefault": true,
537
508
  "required": true,
538
- "summary": "Username or alias of the production org that contains the sandbox license.",
509
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
539
510
  "hasDynamicHelp": true,
540
511
  "multiple": false,
541
512
  "type": "option"
542
513
  },
543
514
  "no-prompt": {
515
+ "char": "p",
544
516
  "name": "no-prompt",
545
- "summary": "Don't prompt for confirmation about the sandbox configuration.",
546
- "allowNo": false,
547
- "type": "boolean"
548
- },
549
- "no-track-source": {
550
- "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.",
551
- "name": "no-track-source",
552
- "summary": "Do not use source tracking for this sandbox.",
517
+ "summary": "Don't prompt the user to confirm the deletion.",
553
518
  "allowNo": false,
554
519
  "type": "boolean"
555
520
  }
556
521
  },
557
522
  "hasDynamicHelp": true,
558
523
  "hiddenAliases": [],
559
- "id": "org:create:sandbox",
524
+ "id": "org:delete:scratch",
560
525
  "pluginAlias": "@salesforce/plugin-org",
561
526
  "pluginName": "@salesforce/plugin-org",
562
527
  "pluginType": "core",
563
528
  "strict": true,
564
- "summary": "Create a sandbox org.",
529
+ "summary": "Delete a scratch org.",
530
+ "enableJsonFlag": true,
565
531
  "isESM": true,
566
532
  "relativePath": [
567
533
  "lib",
568
534
  "commands",
569
535
  "org",
570
- "create",
571
- "sandbox.js"
536
+ "delete",
537
+ "scratch.js"
572
538
  ],
573
539
  "aliasPermutations": [
574
- "env:create:sandbox",
575
- "create:env:sandbox",
576
- "create:sandbox:env",
577
- "env:sandbox:create",
578
- "sandbox:env:create",
579
- "sandbox:create:env"
540
+ "env:delete:scratch",
541
+ "delete:env:scratch",
542
+ "delete:scratch:env",
543
+ "env:scratch:delete",
544
+ "scratch:env:delete",
545
+ "scratch:delete:env"
580
546
  ],
581
547
  "permutations": [
582
- "org:create:sandbox",
583
- "create:org:sandbox",
584
- "create:sandbox:org",
585
- "org:sandbox:create",
586
- "sandbox:org:create",
587
- "sandbox:create:org"
548
+ "org:delete:scratch",
549
+ "delete:org:scratch",
550
+ "delete:scratch:org",
551
+ "org:scratch:delete",
552
+ "scratch:org:delete",
553
+ "scratch:delete:org"
588
554
  ]
589
555
  },
590
- "org:create:scratch": {
591
- "aliases": [
592
- "env:create:scratch"
593
- ],
556
+ "org:disable:tracking": {
557
+ "aliases": [],
594
558
  "args": {},
595
- "deprecateAliases": true,
596
- "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.",
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
560
  "examples": [
598
- "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",
599
- "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",
600
- "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",
601
- "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"
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 %>"
602
564
  ],
603
565
  "flags": {
604
566
  "json": {
@@ -616,250 +578,180 @@
616
578
  "multiple": false,
617
579
  "type": "option"
618
580
  },
619
- "alias": {
620
- "char": "a",
621
- "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.",
622
- "name": "alias",
623
- "summary": "Alias for the scratch org.",
624
- "hasDynamicHelp": false,
625
- "multiple": false,
626
- "type": "option"
627
- },
628
- "async": {
629
- "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\".",
630
- "name": "async",
631
- "summary": "Request the org, but don't wait for it to complete.",
632
- "allowNo": false,
633
- "type": "boolean"
634
- },
635
- "set-default": {
636
- "char": "d",
637
- "name": "set-default",
638
- "summary": "Set the scratch org as your default org",
639
- "allowNo": false,
640
- "type": "boolean"
641
- },
642
- "definition-file": {
643
- "char": "f",
644
- "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.",
645
- "name": "definition-file",
646
- "summary": "Path to a scratch org definition file.",
647
- "hasDynamicHelp": false,
648
- "multiple": false,
649
- "type": "option"
650
- },
651
- "target-dev-hub": {
652
- "char": "v",
653
- "description": "Overrides the value of the target-dev-hub configuration variable, if set.",
654
- "name": "target-dev-hub",
581
+ "target-org": {
582
+ "char": "o",
583
+ "name": "target-org",
655
584
  "noCacheDefault": true,
656
585
  "required": true,
657
- "summary": "Username or alias of the Dev Hub org.",
586
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
658
587
  "hasDynamicHelp": true,
659
588
  "multiple": false,
660
589
  "type": "option"
661
- },
662
- "no-ancestors": {
663
- "char": "c",
664
- "helpGroup": "Packaging",
665
- "name": "no-ancestors",
666
- "summary": "Don't include second-generation managed package (2GP) ancestors in the scratch org.",
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",
667
635
  "allowNo": false,
668
636
  "type": "boolean"
669
637
  },
670
- "edition": {
671
- "char": "e",
672
- "description": "The editions that begin with \"partner-\" are available only if the Dev Hub org is a Partner Business Org.",
673
- "exclusive": [
674
- "snapshot",
675
- "source-org"
676
- ],
677
- "helpGroup": "Definition File Override",
678
- "name": "edition",
679
- "summary": "Salesforce edition of the scratch org. Overrides the value of the \"edition\" option in the definition file, if set.",
680
- "hasDynamicHelp": false,
681
- "multiple": false,
682
- "options": [
683
- "developer",
684
- "enterprise",
685
- "group",
686
- "professional",
687
- "partner-developer",
688
- "partner-enterprise",
689
- "partner-group",
690
- "partner-professional"
691
- ],
692
- "type": "option"
693
- },
694
- "snapshot": {
695
- "char": "s",
696
- "description": "To view the names of the available snapshots for a given Dev Hub org, run the \"sf org list snapshot\" command.",
697
- "exclusive": [
698
- "edition",
699
- "source-org"
700
- ],
701
- "helpGroup": "Definition File Override",
702
- "name": "snapshot",
703
- "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.",
638
+ "flags-dir": {
639
+ "helpGroup": "GLOBAL",
640
+ "name": "flags-dir",
641
+ "summary": "Import flag values from a directory.",
704
642
  "hasDynamicHelp": false,
705
643
  "multiple": false,
706
644
  "type": "option"
707
645
  },
708
- "no-namespace": {
709
- "char": "m",
710
- "helpGroup": "Packaging",
711
- "name": "no-namespace",
712
- "summary": "Create the scratch org with no namespace, even if the Dev Hub has a namespace.",
713
- "allowNo": false,
714
- "type": "boolean"
715
- },
716
- "duration-days": {
717
- "char": "y",
718
- "name": "duration-days",
719
- "summary": "Number of days before the org expires.",
720
- "hasDynamicHelp": true,
721
- "helpValue": "<days>",
722
- "multiple": false,
723
- "type": "option"
724
- },
725
- "wait": {
726
- "char": "w",
727
- "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.",
728
- "name": "wait",
729
- "summary": "Number of minutes to wait for the scratch org to be ready.",
730
- "hasDynamicHelp": true,
731
- "helpValue": "<minutes>",
732
- "multiple": false,
733
- "type": "option"
734
- },
735
646
  "api-version": {
647
+ "aliases": [
648
+ "apiversion",
649
+ "a"
650
+ ],
651
+ "deprecateAliases": true,
736
652
  "description": "Override the api version used for api requests made by this command",
737
653
  "name": "api-version",
654
+ "summary": "API version to use; default is the most recent API version.",
738
655
  "hasDynamicHelp": false,
739
656
  "multiple": false,
740
657
  "type": "option"
741
658
  },
742
- "client-id": {
743
- "char": "i",
744
- "name": "client-id",
745
- "summary": "Consumer key of the Dev Hub connected app.",
746
- "hasDynamicHelp": false,
747
- "multiple": false,
748
- "type": "option"
749
- },
750
- "track-source": {
751
- "char": "t",
752
- "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.",
753
- "name": "track-source",
754
- "summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
755
- "allowNo": true,
756
- "type": "boolean"
757
- },
758
- "username": {
759
- "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.",
760
- "helpGroup": "Definition File Override",
761
- "name": "username",
762
- "summary": "Username of the scratch org admin user. Overrides the value of the \"username\" option in the definition file, if set.",
763
- "hasDynamicHelp": false,
764
- "multiple": false,
765
- "type": "option"
766
- },
767
- "description": {
768
- "helpGroup": "Definition File Override",
769
- "name": "description",
770
- "summary": "Description of the scratch org in the Dev Hub. Overrides the value of the \"description\" option in the definition file, if set.",
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",
771
665
  "hasDynamicHelp": false,
772
666
  "multiple": false,
773
667
  "type": "option"
774
668
  },
775
- "name": {
776
- "helpGroup": "Definition File Override",
777
- "name": "name",
778
- "summary": "Name of the org, such as \"Acme Company\". Overrides the value of the \"orgName\" option in the definition file, if set.",
779
- "hasDynamicHelp": false,
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,
780
681
  "multiple": false,
781
682
  "type": "option"
782
683
  },
783
- "release": {
784
- "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.",
785
- "helpGroup": "Definition File Override",
786
- "name": "release",
787
- "summary": "Release of the scratch org as compared to the Dev Hub release.",
788
- "hasDynamicHelp": false,
789
- "multiple": false,
790
- "options": [
791
- "preview",
792
- "previous"
684
+ "output-file": {
685
+ "aliases": [
686
+ "resultfile"
793
687
  ],
794
- "type": "option"
795
- },
796
- "admin-email": {
797
- "helpGroup": "Definition File Override",
798
- "name": "admin-email",
799
- "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.",
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.",
800
693
  "hasDynamicHelp": false,
801
694
  "multiple": false,
802
695
  "type": "option"
803
696
  },
804
- "source-org": {
805
- "description": "To view the names of the available org shapes for a given Dev Hub org, run the \"sf org list shape\" command.",
806
- "exclusive": [
807
- "edition",
808
- "snapshot"
697
+ "filter-known": {
698
+ "aliases": [
699
+ "filterknown"
809
700
  ],
810
- "helpGroup": "Definition File Override",
811
- "name": "source-org",
812
- "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.",
813
- "hasDynamicHelp": false,
814
- "multiple": false,
815
- "type": "option"
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"
816
708
  }
817
709
  },
818
710
  "hasDynamicHelp": true,
819
711
  "hiddenAliases": [],
820
- "id": "org:create:scratch",
712
+ "id": "org:list:metadata-types",
821
713
  "pluginAlias": "@salesforce/plugin-org",
822
714
  "pluginName": "@salesforce/plugin-org",
823
715
  "pluginType": "core",
824
716
  "strict": true,
825
- "summary": "Create a scratch org.",
717
+ "summary": "Display details about the metadata types that are enabled for your org.",
826
718
  "enableJsonFlag": true,
827
719
  "isESM": true,
828
720
  "relativePath": [
829
721
  "lib",
830
722
  "commands",
831
- "org",
832
- "create",
833
- "scratch.js"
834
- ],
835
- "aliasPermutations": [
836
- "env:create:scratch",
837
- "create:env:scratch",
838
- "create:scratch:env",
839
- "env:scratch:create",
840
- "scratch:env:create",
841
- "scratch:create:env"
723
+ "org",
724
+ "list",
725
+ "metadata-types.js"
726
+ ],
727
+ "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"
842
734
  ],
843
735
  "permutations": [
844
- "org:create:scratch",
845
- "create:org:scratch",
846
- "create:scratch:org",
847
- "org:scratch:create",
848
- "scratch:org:create",
849
- "scratch:create:org"
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"
850
742
  ]
851
743
  },
852
- "org:delete:sandbox": {
744
+ "org:list:metadata": {
853
745
  "aliases": [
854
- "env:delete:sandbox"
746
+ "force:mdapi:listmetadata"
855
747
  ],
856
748
  "args": {},
857
749
  "deprecateAliases": true,
858
- "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.",
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.",
859
751
  "examples": [
860
- "Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox",
861
- "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa",
862
- "Delete the sandbox without prompting to confirm:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt"
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"
863
755
  ],
864
756
  "flags": {
865
757
  "json": {
@@ -877,6 +769,29 @@
877
769
  "multiple": false,
878
770
  "type": "option"
879
771
  },
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
+ },
880
795
  "target-org": {
881
796
  "aliases": [
882
797
  "targetusername",
@@ -885,65 +800,93 @@
885
800
  "char": "o",
886
801
  "deprecateAliases": true,
887
802
  "name": "target-org",
803
+ "noCacheDefault": true,
888
804
  "required": true,
889
805
  "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
890
806
  "hasDynamicHelp": true,
891
807
  "multiple": false,
892
808
  "type": "option"
893
809
  },
894
- "no-prompt": {
895
- "char": "p",
896
- "name": "no-prompt",
897
- "summary": "Don't prompt the user to confirm the deletion.",
898
- "allowNo": false,
899
- "type": "boolean"
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"
900
842
  }
901
843
  },
902
844
  "hasDynamicHelp": true,
903
845
  "hiddenAliases": [],
904
- "id": "org:delete:sandbox",
846
+ "id": "org:list:metadata",
905
847
  "pluginAlias": "@salesforce/plugin-org",
906
848
  "pluginName": "@salesforce/plugin-org",
907
849
  "pluginType": "core",
908
850
  "strict": true,
909
- "summary": "Delete a sandbox.",
851
+ "summary": "List the metadata components and properties of a specified type.",
910
852
  "enableJsonFlag": true,
911
853
  "isESM": true,
912
854
  "relativePath": [
913
855
  "lib",
914
856
  "commands",
915
857
  "org",
916
- "delete",
917
- "sandbox.js"
858
+ "list",
859
+ "metadata.js"
918
860
  ],
919
861
  "aliasPermutations": [
920
- "env:delete:sandbox",
921
- "delete:env:sandbox",
922
- "delete:sandbox:env",
923
- "env:sandbox:delete",
924
- "sandbox:env:delete",
925
- "sandbox:delete:env"
862
+ "force:mdapi:listmetadata",
863
+ "mdapi:force:listmetadata",
864
+ "mdapi:listmetadata:force",
865
+ "force:listmetadata:mdapi",
866
+ "listmetadata:force:mdapi",
867
+ "listmetadata:mdapi:force"
926
868
  ],
927
869
  "permutations": [
928
- "org:delete:sandbox",
929
- "delete:org:sandbox",
930
- "delete:sandbox:org",
931
- "org:sandbox:delete",
932
- "sandbox:org:delete",
933
- "sandbox:delete:org"
870
+ "org:list:metadata",
871
+ "list:org:metadata",
872
+ "list:metadata:org",
873
+ "org:metadata:list",
874
+ "metadata:org:list",
875
+ "metadata:list:org"
934
876
  ]
935
877
  },
936
- "org:delete:scratch": {
878
+ "org:create:sandbox": {
937
879
  "aliases": [
938
- "env:delete:scratch"
880
+ "env:create:sandbox"
939
881
  ],
940
882
  "args": {},
941
883
  "deprecateAliases": true,
942
- "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.",
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.",
943
885
  "examples": [
944
- "Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org",
945
- "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com",
946
- "Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt"
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"
947
890
  ],
948
891
  "flags": {
949
892
  "json": {
@@ -961,70 +904,193 @@
961
904
  "multiple": false,
962
905
  "type": "option"
963
906
  },
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
+ },
964
1024
  "target-org": {
965
- "aliases": [
966
- "targetusername",
967
- "u"
968
- ],
969
1025
  "char": "o",
970
- "deprecateAliases": true,
1026
+ "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
971
1027
  "name": "target-org",
1028
+ "noCacheDefault": true,
972
1029
  "required": true,
973
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1030
+ "summary": "Username or alias of the production org that contains the sandbox license.",
974
1031
  "hasDynamicHelp": true,
975
1032
  "multiple": false,
976
1033
  "type": "option"
977
1034
  },
978
1035
  "no-prompt": {
979
- "char": "p",
980
1036
  "name": "no-prompt",
981
- "summary": "Don't prompt the user to confirm the deletion.",
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.",
982
1045
  "allowNo": false,
983
1046
  "type": "boolean"
984
1047
  }
985
1048
  },
986
1049
  "hasDynamicHelp": true,
987
1050
  "hiddenAliases": [],
988
- "id": "org:delete:scratch",
1051
+ "id": "org:create:sandbox",
989
1052
  "pluginAlias": "@salesforce/plugin-org",
990
1053
  "pluginName": "@salesforce/plugin-org",
991
1054
  "pluginType": "core",
992
1055
  "strict": true,
993
- "summary": "Delete a scratch org.",
994
- "enableJsonFlag": true,
1056
+ "summary": "Create a sandbox org.",
995
1057
  "isESM": true,
996
1058
  "relativePath": [
997
1059
  "lib",
998
1060
  "commands",
999
1061
  "org",
1000
- "delete",
1001
- "scratch.js"
1062
+ "create",
1063
+ "sandbox.js"
1002
1064
  ],
1003
1065
  "aliasPermutations": [
1004
- "env:delete:scratch",
1005
- "delete:env:scratch",
1006
- "delete:scratch:env",
1007
- "env:scratch:delete",
1008
- "scratch:env:delete",
1009
- "scratch:delete:env"
1066
+ "env:create:sandbox",
1067
+ "create:env:sandbox",
1068
+ "create:sandbox:env",
1069
+ "env:sandbox:create",
1070
+ "sandbox:env:create",
1071
+ "sandbox:create:env"
1010
1072
  ],
1011
1073
  "permutations": [
1012
- "org:delete:scratch",
1013
- "delete:org:scratch",
1014
- "delete:scratch:org",
1015
- "org:scratch:delete",
1016
- "scratch:org:delete",
1017
- "scratch:delete:org"
1074
+ "org:create:sandbox",
1075
+ "create:org:sandbox",
1076
+ "create:sandbox:org",
1077
+ "org:sandbox:create",
1078
+ "sandbox:org:create",
1079
+ "sandbox:create:org"
1018
1080
  ]
1019
1081
  },
1020
- "org:disable:tracking": {
1021
- "aliases": [],
1082
+ "org:create:scratch": {
1083
+ "aliases": [
1084
+ "env:create:scratch"
1085
+ ],
1022
1086
  "args": {},
1023
- "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.",
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.",
1024
1089
  "examples": [
1025
- "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1026
- "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1027
- "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
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"
1028
1094
  ],
1029
1095
  "flags": {
1030
1096
  "json": {
@@ -1042,243 +1108,247 @@
1042
1108
  "multiple": false,
1043
1109
  "type": "option"
1044
1110
  },
1045
- "target-org": {
1046
- "char": "o",
1047
- "name": "target-org",
1048
- "noCacheDefault": true,
1049
- "required": true,
1050
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1051
- "hasDynamicHelp": true,
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,
1052
1117
  "multiple": false,
1053
1118
  "type": "option"
1054
- }
1055
- },
1056
- "hasDynamicHelp": true,
1057
- "hiddenAliases": [],
1058
- "id": "org:disable:tracking",
1059
- "pluginAlias": "@salesforce/plugin-org",
1060
- "pluginName": "@salesforce/plugin-org",
1061
- "pluginType": "core",
1062
- "strict": true,
1063
- "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
1064
- "enableJsonFlag": true,
1065
- "isESM": true,
1066
- "relativePath": [
1067
- "lib",
1068
- "commands",
1069
- "org",
1070
- "disable",
1071
- "tracking.js"
1072
- ],
1073
- "aliasPermutations": [],
1074
- "permutations": [
1075
- "org:disable:tracking",
1076
- "disable:org:tracking",
1077
- "disable:tracking:org",
1078
- "org:tracking:disable",
1079
- "tracking:org:disable",
1080
- "tracking:disable:org"
1081
- ]
1082
- },
1083
- "org:enable:tracking": {
1084
- "aliases": [],
1085
- "args": {},
1086
- "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.",
1087
- "examples": [
1088
- "Enable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1089
- "Enable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1090
- "Enable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1091
- ],
1092
- "flags": {
1093
- "json": {
1094
- "description": "Format output as json.",
1095
- "helpGroup": "GLOBAL",
1096
- "name": "json",
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.",
1097
1124
  "allowNo": false,
1098
1125
  "type": "boolean"
1099
1126
  },
1100
- "flags-dir": {
1101
- "helpGroup": "GLOBAL",
1102
- "name": "flags-dir",
1103
- "summary": "Import flag values from a directory.",
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.",
1104
1139
  "hasDynamicHelp": false,
1105
1140
  "multiple": false,
1106
1141
  "type": "option"
1107
1142
  },
1108
- "target-org": {
1109
- "char": "o",
1110
- "name": "target-org",
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",
1111
1147
  "noCacheDefault": true,
1112
1148
  "required": true,
1113
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1149
+ "summary": "Username or alias of the Dev Hub org.",
1114
1150
  "hasDynamicHelp": true,
1115
1151
  "multiple": false,
1116
1152
  "type": "option"
1117
- }
1118
- },
1119
- "hasDynamicHelp": true,
1120
- "hiddenAliases": [],
1121
- "id": "org:enable:tracking",
1122
- "pluginAlias": "@salesforce/plugin-org",
1123
- "pluginName": "@salesforce/plugin-org",
1124
- "pluginType": "core",
1125
- "strict": true,
1126
- "summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
1127
- "enableJsonFlag": true,
1128
- "isESM": true,
1129
- "relativePath": [
1130
- "lib",
1131
- "commands",
1132
- "org",
1133
- "enable",
1134
- "tracking.js"
1135
- ],
1136
- "aliasPermutations": [],
1137
- "permutations": [
1138
- "org:enable:tracking",
1139
- "enable:org:tracking",
1140
- "enable:tracking:org",
1141
- "org:tracking:enable",
1142
- "tracking:org:enable",
1143
- "tracking:enable:org"
1144
- ]
1145
- },
1146
- "org:list:metadata-types": {
1147
- "aliases": [
1148
- "force:mdapi:describemetadata"
1149
- ],
1150
- "args": {},
1151
- "deprecateAliases": true,
1152
- "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.",
1153
- "examples": [
1154
- "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",
1155
- "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"
1156
- ],
1157
- "flags": {
1158
- "json": {
1159
- "description": "Format output as json.",
1160
- "helpGroup": "GLOBAL",
1161
- "name": "json",
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.",
1159
+ "allowNo": false,
1160
+ "type": "boolean"
1161
+ },
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.",
1196
+ "hasDynamicHelp": false,
1197
+ "multiple": false,
1198
+ "type": "option"
1199
+ },
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.",
1162
1205
  "allowNo": false,
1163
1206
  "type": "boolean"
1164
1207
  },
1165
- "flags-dir": {
1166
- "helpGroup": "GLOBAL",
1167
- "name": "flags-dir",
1168
- "summary": "Import flag values from a directory.",
1169
- "hasDynamicHelp": false,
1208
+ "duration-days": {
1209
+ "char": "y",
1210
+ "name": "duration-days",
1211
+ "summary": "Number of days before the org expires.",
1212
+ "hasDynamicHelp": true,
1213
+ "helpValue": "<days>",
1214
+ "multiple": false,
1215
+ "type": "option"
1216
+ },
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>",
1170
1224
  "multiple": false,
1171
1225
  "type": "option"
1172
1226
  },
1173
1227
  "api-version": {
1174
- "aliases": [
1175
- "apiversion",
1176
- "a"
1177
- ],
1178
- "deprecateAliases": true,
1179
1228
  "description": "Override the api version used for api requests made by this command",
1180
1229
  "name": "api-version",
1181
- "summary": "API version to use; default is the most recent API version.",
1182
1230
  "hasDynamicHelp": false,
1183
1231
  "multiple": false,
1184
1232
  "type": "option"
1185
1233
  },
1186
- "loglevel": {
1187
- "deprecated": {
1188
- "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."
1189
- },
1190
- "hidden": true,
1191
- "name": "loglevel",
1234
+ "client-id": {
1235
+ "char": "i",
1236
+ "name": "client-id",
1237
+ "summary": "Consumer key of the Dev Hub connected app.",
1192
1238
  "hasDynamicHelp": false,
1193
1239
  "multiple": false,
1194
1240
  "type": "option"
1195
1241
  },
1196
- "target-org": {
1197
- "aliases": [
1198
- "targetusername",
1199
- "u"
1200
- ],
1201
- "char": "o",
1202
- "deprecateAliases": true,
1203
- "name": "target-org",
1204
- "noCacheDefault": true,
1205
- "required": true,
1206
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1207
- "hasDynamicHelp": true,
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,
1208
1256
  "multiple": false,
1209
1257
  "type": "option"
1210
1258
  },
1211
- "output-file": {
1212
- "aliases": [
1213
- "resultfile"
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.",
1263
+ "hasDynamicHelp": false,
1264
+ "multiple": false,
1265
+ "type": "option"
1266
+ },
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,
1272
+ "multiple": false,
1273
+ "type": "option"
1274
+ },
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"
1214
1285
  ],
1215
- "char": "f",
1216
- "deprecateAliases": true,
1217
- "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.",
1218
- "name": "output-file",
1219
- "summary": "Pathname of the file in which to write the results.",
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.",
1220
1292
  "hasDynamicHelp": false,
1221
1293
  "multiple": false,
1222
1294
  "type": "option"
1223
1295
  },
1224
- "filter-known": {
1225
- "aliases": [
1226
- "filterknown"
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"
1227
1301
  ],
1228
- "char": "k",
1229
- "deprecateAliases": true,
1230
- "hidden": true,
1231
- "name": "filter-known",
1232
- "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",
1233
- "allowNo": false,
1234
- "type": "boolean"
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"
1235
1308
  }
1236
1309
  },
1237
1310
  "hasDynamicHelp": true,
1238
1311
  "hiddenAliases": [],
1239
- "id": "org:list:metadata-types",
1312
+ "id": "org:create:scratch",
1240
1313
  "pluginAlias": "@salesforce/plugin-org",
1241
1314
  "pluginName": "@salesforce/plugin-org",
1242
1315
  "pluginType": "core",
1243
1316
  "strict": true,
1244
- "summary": "Display details about the metadata types that are enabled for your org.",
1317
+ "summary": "Create a scratch org.",
1245
1318
  "enableJsonFlag": true,
1246
1319
  "isESM": true,
1247
1320
  "relativePath": [
1248
1321
  "lib",
1249
1322
  "commands",
1250
1323
  "org",
1251
- "list",
1252
- "metadata-types.js"
1324
+ "create",
1325
+ "scratch.js"
1253
1326
  ],
1254
1327
  "aliasPermutations": [
1255
- "force:mdapi:describemetadata",
1256
- "mdapi:force:describemetadata",
1257
- "mdapi:describemetadata:force",
1258
- "force:describemetadata:mdapi",
1259
- "describemetadata:force:mdapi",
1260
- "describemetadata:mdapi:force"
1328
+ "env:create:scratch",
1329
+ "create:env:scratch",
1330
+ "create:scratch:env",
1331
+ "env:scratch:create",
1332
+ "scratch:env:create",
1333
+ "scratch:create:env"
1261
1334
  ],
1262
1335
  "permutations": [
1263
- "org:list:metadata-types",
1264
- "list:org:metadata-types",
1265
- "list:metadata-types:org",
1266
- "org:metadata-types:list",
1267
- "metadata-types:org:list",
1268
- "metadata-types:list:org"
1336
+ "org:create:scratch",
1337
+ "create:org:scratch",
1338
+ "create:scratch:org",
1339
+ "org:scratch:create",
1340
+ "scratch:org:create",
1341
+ "scratch:create:org"
1269
1342
  ]
1270
1343
  },
1271
- "org:list:metadata": {
1272
- "aliases": [
1273
- "force:mdapi:listmetadata"
1274
- ],
1344
+ "org:enable:tracking": {
1345
+ "aliases": [],
1275
1346
  "args": {},
1276
- "deprecateAliases": true,
1277
- "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.",
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
1348
  "examples": [
1279
- "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",
1280
- "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",
1281
- "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"
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 %>"
1282
1352
  ],
1283
1353
  "flags": {
1284
1354
  "json": {
@@ -1296,36 +1366,8 @@
1296
1366
  "multiple": false,
1297
1367
  "type": "option"
1298
1368
  },
1299
- "api-version": {
1300
- "aliases": [
1301
- "apiversion",
1302
- "a"
1303
- ],
1304
- "deprecateAliases": true,
1305
- "description": "Override the api version used for api requests made by this command",
1306
- "name": "api-version",
1307
- "summary": "API version to use; default is the most recent API version.",
1308
- "hasDynamicHelp": false,
1309
- "multiple": false,
1310
- "type": "option"
1311
- },
1312
- "loglevel": {
1313
- "deprecated": {
1314
- "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."
1315
- },
1316
- "hidden": true,
1317
- "name": "loglevel",
1318
- "hasDynamicHelp": false,
1319
- "multiple": false,
1320
- "type": "option"
1321
- },
1322
1369
  "target-org": {
1323
- "aliases": [
1324
- "targetusername",
1325
- "u"
1326
- ],
1327
1370
  "char": "o",
1328
- "deprecateAliases": true,
1329
1371
  "name": "target-org",
1330
1372
  "noCacheDefault": true,
1331
1373
  "required": true,
@@ -1333,73 +1375,33 @@
1333
1375
  "hasDynamicHelp": true,
1334
1376
  "multiple": false,
1335
1377
  "type": "option"
1336
- },
1337
- "output-file": {
1338
- "aliases": [
1339
- "resultfile"
1340
- ],
1341
- "char": "f",
1342
- "deprecateAliases": true,
1343
- "name": "output-file",
1344
- "summary": "Pathname of the file in which to write the results.",
1345
- "hasDynamicHelp": false,
1346
- "multiple": false,
1347
- "type": "option"
1348
- },
1349
- "metadata-type": {
1350
- "aliases": [
1351
- "metadatatype"
1352
- ],
1353
- "char": "m",
1354
- "deprecateAliases": true,
1355
- "name": "metadata-type",
1356
- "required": true,
1357
- "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1358
- "hasDynamicHelp": false,
1359
- "multiple": false,
1360
- "type": "option"
1361
- },
1362
- "folder": {
1363
- "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1364
- "name": "folder",
1365
- "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
1366
- "hasDynamicHelp": false,
1367
- "multiple": false,
1368
- "type": "option"
1369
1378
  }
1370
1379
  },
1371
1380
  "hasDynamicHelp": true,
1372
1381
  "hiddenAliases": [],
1373
- "id": "org:list:metadata",
1382
+ "id": "org:enable:tracking",
1374
1383
  "pluginAlias": "@salesforce/plugin-org",
1375
1384
  "pluginName": "@salesforce/plugin-org",
1376
1385
  "pluginType": "core",
1377
1386
  "strict": true,
1378
- "summary": "List the metadata components and properties of a specified type.",
1387
+ "summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
1379
1388
  "enableJsonFlag": true,
1380
1389
  "isESM": true,
1381
1390
  "relativePath": [
1382
1391
  "lib",
1383
1392
  "commands",
1384
1393
  "org",
1385
- "list",
1386
- "metadata.js"
1387
- ],
1388
- "aliasPermutations": [
1389
- "force:mdapi:listmetadata",
1390
- "mdapi:force:listmetadata",
1391
- "mdapi:listmetadata:force",
1392
- "force:listmetadata:mdapi",
1393
- "listmetadata:force:mdapi",
1394
- "listmetadata:mdapi:force"
1394
+ "enable",
1395
+ "tracking.js"
1395
1396
  ],
1397
+ "aliasPermutations": [],
1396
1398
  "permutations": [
1397
- "org:list:metadata",
1398
- "list:org:metadata",
1399
- "list:metadata:org",
1400
- "org:metadata:list",
1401
- "metadata:org:list",
1402
- "metadata:list:org"
1399
+ "org:enable:tracking",
1400
+ "enable:org:tracking",
1401
+ "enable:tracking:org",
1402
+ "org:tracking:enable",
1403
+ "tracking:org:enable",
1404
+ "tracking:enable:org"
1403
1405
  ]
1404
1406
  },
1405
1407
  "org:open:agent": {
@@ -1873,5 +1875,5 @@
1873
1875
  ]
1874
1876
  }
1875
1877
  },
1876
- "version": "5.8.4"
1878
+ "version": "5.9.0"
1877
1879
  }