@salesforce/plugin-org 5.11.18 → 5.11.20

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 +20 -20
  2. package/oclif.manifest.json +649 -649
  3. package/package.json +6 -6
@@ -61,7 +61,7 @@
61
61
  },
62
62
  "loglevel": {
63
63
  "deprecated": {
64
- "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."
64
+ "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 `SF_LOG_LEVEL` environment variable."
65
65
  },
66
66
  "hidden": true,
67
67
  "name": "loglevel",
@@ -177,7 +177,7 @@
177
177
  },
178
178
  "loglevel": {
179
179
  "deprecated": {
180
- "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."
180
+ "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 `SF_LOG_LEVEL` environment variable."
181
181
  },
182
182
  "hidden": true,
183
183
  "name": "loglevel",
@@ -326,7 +326,7 @@
326
326
  },
327
327
  "loglevel": {
328
328
  "deprecated": {
329
- "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."
329
+ "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 `SF_LOG_LEVEL` environment variable."
330
330
  },
331
331
  "hidden": true,
332
332
  "name": "loglevel",
@@ -385,15 +385,14 @@
385
385
  "open:org"
386
386
  ]
387
387
  },
388
- "org:auth:show-access-token": {
388
+ "org:create:agent-user": {
389
389
  "aliases": [],
390
390
  "args": {},
391
- "description": "Because access tokens are sensitive credentials that grant full access to an org, this command prompts for confirmation before revealing the token. Skip confirmation by specifying either the --no-prompt or --json flag.",
391
+ "description": "You specify this user in the agent's Agent Script file using the \"default_agent_user\" parameter in the \"config\" block.\n\nBy default, this command:\n\n- Generates a user called \"Agent User\" with a globally unique username. Use flags to change these default names.\n- Sets the user's email to the new username.\n- Assigns the user the \"Einstein Agent User\" profile.\n- Assigns the user these required permission sets: AgentforceServiceAgentBase, AgentforceServiceAgentUser,\n EinsteinGPTPromptTemplateUser\n- Checks that the user licenses required by the profile and permission sets are available in your org.\n\nThe generated user doesn't have a password. You can’t log into Salesforce using the agent user's username. Only\nSalesforce users with admin permissions can view or edit an agent user in Setup.\n\nTo assign additional permission sets or licenses after the user was created, use the \"org assign permset\" or \"org assign\npermsetlicense\" commands.\n\nWhen the command completes, it displays a summary of what it did, including the new agent user's username and ID, the\navailable licenses associated with the Einstein Agent User profile, and the profile and permission sets assigned to the\nagent user.",
392
392
  "examples": [
393
- "Show the access token for the default org:\n<%= config.bin %> <%= command.id %>",
394
- "Show the access token for an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --target-org my-org",
395
- "Show the access token without the confirmation prompt:\n<%= config.bin %> <%= command.id %> --target-org my-org --no-prompt",
396
- "Get the access token as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json"
393
+ "Create an agent user with an auto-generated username; create the user in the org with alias \"myorg\":\n<%= config.bin %> <%= command.id %> --target-org myorg",
394
+ "Create an agent user by specifying a base username pattern; to make the username unique, the command appends a unique\nidentifier:\n<%= config.bin %> <%= command.id %> --base-username service-agent@corp.com --target-org myorg",
395
+ "Create an agent user with an auto-generated username but the custom name \"Service Agent\"; create the user in your\ndefault org:\n<%= config.bin %> <%= command.id %> --first-name Service --last-name Agent"
397
396
  ],
398
397
  "flags": {
399
398
  "json": {
@@ -421,50 +420,77 @@
421
420
  "multiple": false,
422
421
  "type": "option"
423
422
  },
424
- "no-prompt": {
425
- "char": "p",
426
- "name": "no-prompt",
427
- "summary": "Skip the security warning and reveal the access token without confirmation.",
428
- "allowNo": false,
429
- "type": "boolean"
423
+ "api-version": {
424
+ "description": "Override the api version used for api requests made by this command",
425
+ "name": "api-version",
426
+ "hasDynamicHelp": false,
427
+ "multiple": false,
428
+ "type": "option"
429
+ },
430
+ "base-username": {
431
+ "description": "Specify a base username in email format, such as \"service-agent@corp.com\". The command then appends a 12-character\nglobally unique ID (GUID) to the name before the \"@\" sign, which ensures that the username is globally unique across all\nSalesforce orgs and sandboxes.\n\nFor example, if you specify \"service-agent@corp.com\", then the username might be \"service-agent.a1b2c3d4e5f6@corp.com\".\n\nIf not specified, the command auto-generates the username using this pattern: \"agent.user.<GUID>@your-org-domain.com\".",
432
+ "name": "base-username",
433
+ "summary": "Base username pattern. A unique ID is appended to ensure global uniqueness of the usename.",
434
+ "hasDynamicHelp": false,
435
+ "multiple": false,
436
+ "type": "option"
437
+ },
438
+ "first-name": {
439
+ "name": "first-name",
440
+ "summary": "First name for the agent user.",
441
+ "default": "Agent",
442
+ "hasDynamicHelp": false,
443
+ "multiple": false,
444
+ "type": "option"
445
+ },
446
+ "last-name": {
447
+ "name": "last-name",
448
+ "summary": "Last name for the agent user.",
449
+ "default": "User",
450
+ "hasDynamicHelp": false,
451
+ "multiple": false,
452
+ "type": "option"
430
453
  }
431
454
  },
432
455
  "hasDynamicHelp": true,
433
456
  "hiddenAliases": [],
434
- "id": "org:auth:show-access-token",
457
+ "id": "org:create:agent-user",
435
458
  "pluginAlias": "@salesforce/plugin-org",
436
459
  "pluginName": "@salesforce/plugin-org",
437
460
  "pluginType": "core",
438
461
  "strict": true,
439
- "summary": "Show the current access token for an org.",
462
+ "summary": "Create the default Salesforce user that is used to run an agent.",
440
463
  "enableJsonFlag": true,
441
464
  "isESM": true,
442
465
  "relativePath": [
443
466
  "lib",
444
467
  "commands",
445
468
  "org",
446
- "auth",
447
- "show-access-token.js"
469
+ "create",
470
+ "agent-user.js"
448
471
  ],
449
472
  "aliasPermutations": [],
450
473
  "permutations": [
451
- "org:auth:show-access-token",
452
- "auth:org:show-access-token",
453
- "auth:show-access-token:org",
454
- "org:show-access-token:auth",
455
- "show-access-token:org:auth",
456
- "show-access-token:auth:org"
474
+ "org:create:agent-user",
475
+ "create:org:agent-user",
476
+ "create:agent-user:org",
477
+ "org:agent-user:create",
478
+ "agent-user:org:create",
479
+ "agent-user:create:org"
457
480
  ]
458
481
  },
459
- "org:auth:show-sfdx-auth-url": {
460
- "aliases": [],
482
+ "org:create:sandbox": {
483
+ "aliases": [
484
+ "env:create:sandbox"
485
+ ],
461
486
  "args": {},
462
- "description": "Shows the SFDX Auth URL for an org. This URL is only available for orgs authenticated via a web-based OAuth flow. This command prompts for confirmation before revealing it. Skip confirmation by specifying either the --no-prompt or --json flag.",
487
+ "deprecateAliases": true,
488
+ "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.",
463
489
  "examples": [
464
- "Show the SFDX Auth URL for the default org:\n<%= config.bin %> <%= command.id %>",
465
- "Show the SFDX Auth URL for an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --target-org my-org",
466
- "Show the SFDX Auth URL without the confirmation prompt:\n<%= config.bin %> <%= command.id %> --target-org my-org --no-prompt",
467
- "Get the SFDX Auth URL as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json"
490
+ "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",
491
+ "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",
492
+ "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",
493
+ "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"
468
494
  ],
469
495
  "flags": {
470
496
  "json": {
@@ -482,60 +508,193 @@
482
508
  "multiple": false,
483
509
  "type": "option"
484
510
  },
511
+ "definition-file": {
512
+ "char": "f",
513
+ "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.",
514
+ "name": "definition-file",
515
+ "summary": "Path to a sandbox definition file.",
516
+ "hasDynamicHelp": false,
517
+ "multiple": false,
518
+ "type": "option"
519
+ },
520
+ "set-default": {
521
+ "char": "s",
522
+ "name": "set-default",
523
+ "summary": "Set the sandbox org as your default org.",
524
+ "allowNo": false,
525
+ "type": "boolean"
526
+ },
527
+ "alias": {
528
+ "char": "a",
529
+ "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.",
530
+ "name": "alias",
531
+ "summary": "Alias for the sandbox org.",
532
+ "hasDynamicHelp": false,
533
+ "multiple": false,
534
+ "type": "option"
535
+ },
536
+ "wait": {
537
+ "char": "w",
538
+ "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.",
539
+ "exclusive": [
540
+ "async"
541
+ ],
542
+ "name": "wait",
543
+ "summary": "Number of minutes to wait for the sandbox org to be ready.",
544
+ "hasDynamicHelp": true,
545
+ "helpValue": "<minutes>",
546
+ "multiple": false,
547
+ "type": "option"
548
+ },
549
+ "poll-interval": {
550
+ "char": "i",
551
+ "exclusive": [
552
+ "async"
553
+ ],
554
+ "name": "poll-interval",
555
+ "summary": "Number of seconds to wait between retries.",
556
+ "hasDynamicHelp": true,
557
+ "helpValue": "<seconds>",
558
+ "multiple": false,
559
+ "type": "option"
560
+ },
561
+ "async": {
562
+ "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\".",
563
+ "exclusive": [
564
+ "wait",
565
+ "poll-interval"
566
+ ],
567
+ "name": "async",
568
+ "summary": "Request the sandbox creation, but don't wait for it to complete.",
569
+ "allowNo": false,
570
+ "type": "boolean"
571
+ },
572
+ "name": {
573
+ "char": "n",
574
+ "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.",
575
+ "name": "name",
576
+ "summary": "Name of the sandbox org.",
577
+ "hasDynamicHelp": false,
578
+ "multiple": false,
579
+ "type": "option"
580
+ },
581
+ "source-sandbox-name": {
582
+ "aliases": [
583
+ "clone",
584
+ "c"
585
+ ],
586
+ "deprecateAliases": true,
587
+ "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.",
588
+ "exclusive": [
589
+ "license-type",
590
+ "source-id"
591
+ ],
592
+ "name": "source-sandbox-name",
593
+ "summary": "Name of the sandbox org to clone.",
594
+ "hasDynamicHelp": false,
595
+ "multiple": false,
596
+ "type": "option"
597
+ },
598
+ "source-id": {
599
+ "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.",
600
+ "exclusive": [
601
+ "license-type",
602
+ "source-sandbox-name"
603
+ ],
604
+ "name": "source-id",
605
+ "summary": "ID of the sandbox org to clone.",
606
+ "hasDynamicHelp": false,
607
+ "multiple": false,
608
+ "type": "option"
609
+ },
610
+ "license-type": {
611
+ "char": "l",
612
+ "exclusive": [
613
+ "source-sandbox-name",
614
+ "source-id"
615
+ ],
616
+ "name": "license-type",
617
+ "summary": "Type of sandbox license.",
618
+ "hasDynamicHelp": false,
619
+ "multiple": false,
620
+ "options": [
621
+ "Developer",
622
+ "Developer_Pro",
623
+ "Partial",
624
+ "Full"
625
+ ],
626
+ "type": "option"
627
+ },
485
628
  "target-org": {
486
629
  "char": "o",
630
+ "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
487
631
  "name": "target-org",
488
632
  "noCacheDefault": true,
489
633
  "required": true,
490
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
634
+ "summary": "Username or alias of the production org that contains the sandbox license.",
491
635
  "hasDynamicHelp": true,
492
636
  "multiple": false,
493
637
  "type": "option"
494
638
  },
495
639
  "no-prompt": {
496
- "char": "p",
497
640
  "name": "no-prompt",
498
- "summary": "Skip the security warning and reveal the SFDX Auth URL without confirmation.",
641
+ "summary": "Don't prompt for confirmation about the sandbox configuration.",
642
+ "allowNo": false,
643
+ "type": "boolean"
644
+ },
645
+ "no-track-source": {
646
+ "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.",
647
+ "name": "no-track-source",
648
+ "summary": "Do not use source tracking for this sandbox.",
499
649
  "allowNo": false,
500
650
  "type": "boolean"
501
651
  }
502
652
  },
503
653
  "hasDynamicHelp": true,
504
654
  "hiddenAliases": [],
505
- "id": "org:auth:show-sfdx-auth-url",
655
+ "id": "org:create:sandbox",
506
656
  "pluginAlias": "@salesforce/plugin-org",
507
657
  "pluginName": "@salesforce/plugin-org",
508
658
  "pluginType": "core",
509
659
  "strict": true,
510
- "summary": "Show the SFDX Auth URL for an org.",
511
- "enableJsonFlag": true,
660
+ "summary": "Create a sandbox org.",
512
661
  "isESM": true,
513
662
  "relativePath": [
514
663
  "lib",
515
664
  "commands",
516
665
  "org",
517
- "auth",
518
- "show-sfdx-auth-url.js"
666
+ "create",
667
+ "sandbox.js"
668
+ ],
669
+ "aliasPermutations": [
670
+ "env:create:sandbox",
671
+ "create:env:sandbox",
672
+ "create:sandbox:env",
673
+ "env:sandbox:create",
674
+ "sandbox:env:create",
675
+ "sandbox:create:env"
519
676
  ],
520
- "aliasPermutations": [],
521
677
  "permutations": [
522
- "org:auth:show-sfdx-auth-url",
523
- "auth:org:show-sfdx-auth-url",
524
- "auth:show-sfdx-auth-url:org",
525
- "org:show-sfdx-auth-url:auth",
526
- "show-sfdx-auth-url:org:auth",
527
- "show-sfdx-auth-url:auth:org"
678
+ "org:create:sandbox",
679
+ "create:org:sandbox",
680
+ "create:sandbox:org",
681
+ "org:sandbox:create",
682
+ "sandbox:org:create",
683
+ "sandbox:create:org"
528
684
  ]
529
685
  },
530
- "org:auth:show-user-password": {
531
- "aliases": [],
686
+ "org:create:scratch": {
687
+ "aliases": [
688
+ "env:create:scratch"
689
+ ],
532
690
  "args": {},
533
- "description": "This command shows only passwords that were generated locally in your DX project with either the \"org generate password\" or \"org create user\" CLI command. If you generated a password for a user in Setup in your org, you can't show it with this command.\n\nBecause passwords are sensitive credentials, this command prompts for confirmation before revealing it. Skip confirmation by specifying either the --no-prompt or --json flag.",
691
+ "deprecateAliases": true,
692
+ "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.",
534
693
  "examples": [
535
- "Show the password for the default org's user:\n<%= config.bin %> <%= command.id %>",
536
- "Show the password for an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --target-org my-org",
537
- "Show the password without the confirmation prompt:\n<%= config.bin %> <%= command.id %> --target-org my-org --no-prompt",
538
- "Get the password as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json"
694
+ "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",
695
+ "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",
696
+ "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",
697
+ "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"
539
698
  ],
540
699
  "flags": {
541
700
  "json": {
@@ -553,62 +712,248 @@
553
712
  "multiple": false,
554
713
  "type": "option"
555
714
  },
556
- "target-org": {
557
- "char": "o",
558
- "name": "target-org",
715
+ "alias": {
716
+ "char": "a",
717
+ "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.",
718
+ "name": "alias",
719
+ "summary": "Alias for the scratch org.",
720
+ "hasDynamicHelp": false,
721
+ "multiple": false,
722
+ "type": "option"
723
+ },
724
+ "async": {
725
+ "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\".",
726
+ "name": "async",
727
+ "summary": "Request the org, but don't wait for it to complete.",
728
+ "allowNo": false,
729
+ "type": "boolean"
730
+ },
731
+ "set-default": {
732
+ "char": "d",
733
+ "name": "set-default",
734
+ "summary": "Set the scratch org as your default org",
735
+ "allowNo": false,
736
+ "type": "boolean"
737
+ },
738
+ "definition-file": {
739
+ "char": "f",
740
+ "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.",
741
+ "name": "definition-file",
742
+ "summary": "Path to a scratch org definition file.",
743
+ "hasDynamicHelp": false,
744
+ "multiple": false,
745
+ "type": "option"
746
+ },
747
+ "target-dev-hub": {
748
+ "char": "v",
749
+ "description": "Overrides the value of the target-dev-hub configuration variable, if set.",
750
+ "name": "target-dev-hub",
559
751
  "noCacheDefault": true,
560
752
  "required": true,
561
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
753
+ "summary": "Username or alias of the Dev Hub org.",
562
754
  "hasDynamicHelp": true,
563
755
  "multiple": false,
564
756
  "type": "option"
565
757
  },
566
- "no-prompt": {
567
- "char": "p",
568
- "name": "no-prompt",
569
- "summary": "Skip the security warning and reveal the password without confirmation.",
758
+ "no-ancestors": {
759
+ "char": "c",
760
+ "helpGroup": "Packaging",
761
+ "name": "no-ancestors",
762
+ "summary": "Don't include second-generation managed package (2GP) ancestors in the scratch org.",
763
+ "allowNo": false,
764
+ "type": "boolean"
765
+ },
766
+ "edition": {
767
+ "char": "e",
768
+ "description": "The editions that begin with \"partner-\" are available only if the Dev Hub org is a Partner Business Org.",
769
+ "exclusive": [
770
+ "snapshot",
771
+ "source-org"
772
+ ],
773
+ "helpGroup": "Definition File Override",
774
+ "name": "edition",
775
+ "summary": "Salesforce edition of the scratch org. Overrides the value of the \"edition\" option in the definition file, if set.",
776
+ "hasDynamicHelp": false,
777
+ "multiple": false,
778
+ "options": [
779
+ "developer",
780
+ "enterprise",
781
+ "group",
782
+ "professional",
783
+ "partner-developer",
784
+ "partner-enterprise",
785
+ "partner-group",
786
+ "partner-professional"
787
+ ],
788
+ "type": "option"
789
+ },
790
+ "snapshot": {
791
+ "char": "s",
792
+ "description": "To view the names of the available snapshots for a given Dev Hub org, run the \"sf org list snapshot\" command.",
793
+ "exclusive": [
794
+ "edition",
795
+ "source-org"
796
+ ],
797
+ "helpGroup": "Definition File Override",
798
+ "name": "snapshot",
799
+ "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.",
800
+ "hasDynamicHelp": false,
801
+ "multiple": false,
802
+ "type": "option"
803
+ },
804
+ "no-namespace": {
805
+ "char": "m",
806
+ "helpGroup": "Packaging",
807
+ "name": "no-namespace",
808
+ "summary": "Create the scratch org with no namespace, even if the Dev Hub has a namespace.",
570
809
  "allowNo": false,
571
810
  "type": "boolean"
811
+ },
812
+ "duration-days": {
813
+ "char": "y",
814
+ "name": "duration-days",
815
+ "summary": "Number of days before the org expires.",
816
+ "hasDynamicHelp": true,
817
+ "helpValue": "<days>",
818
+ "multiple": false,
819
+ "type": "option"
820
+ },
821
+ "wait": {
822
+ "char": "w",
823
+ "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.",
824
+ "name": "wait",
825
+ "summary": "Number of minutes to wait for the scratch org to be ready.",
826
+ "hasDynamicHelp": true,
827
+ "helpValue": "<minutes>",
828
+ "multiple": false,
829
+ "type": "option"
830
+ },
831
+ "api-version": {
832
+ "description": "Override the api version used for api requests made by this command",
833
+ "name": "api-version",
834
+ "hasDynamicHelp": false,
835
+ "multiple": false,
836
+ "type": "option"
837
+ },
838
+ "client-id": {
839
+ "char": "i",
840
+ "name": "client-id",
841
+ "summary": "Consumer key of the Dev Hub connected app.",
842
+ "hasDynamicHelp": false,
843
+ "multiple": false,
844
+ "type": "option"
845
+ },
846
+ "track-source": {
847
+ "char": "t",
848
+ "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.",
849
+ "name": "track-source",
850
+ "summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
851
+ "allowNo": true,
852
+ "type": "boolean"
853
+ },
854
+ "username": {
855
+ "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.",
856
+ "helpGroup": "Definition File Override",
857
+ "name": "username",
858
+ "summary": "Username of the scratch org admin user. Overrides the value of the \"username\" option in the definition file, if set.",
859
+ "hasDynamicHelp": false,
860
+ "multiple": false,
861
+ "type": "option"
862
+ },
863
+ "description": {
864
+ "helpGroup": "Definition File Override",
865
+ "name": "description",
866
+ "summary": "Description of the scratch org in the Dev Hub. Overrides the value of the \"description\" option in the definition file, if set.",
867
+ "hasDynamicHelp": false,
868
+ "multiple": false,
869
+ "type": "option"
870
+ },
871
+ "name": {
872
+ "helpGroup": "Definition File Override",
873
+ "name": "name",
874
+ "summary": "Name of the org, such as \"Acme Company\". Overrides the value of the \"orgName\" option in the definition file, if set.",
875
+ "hasDynamicHelp": false,
876
+ "multiple": false,
877
+ "type": "option"
878
+ },
879
+ "release": {
880
+ "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.",
881
+ "helpGroup": "Definition File Override",
882
+ "name": "release",
883
+ "summary": "Release of the scratch org as compared to the Dev Hub release.",
884
+ "hasDynamicHelp": false,
885
+ "multiple": false,
886
+ "options": [
887
+ "preview",
888
+ "previous"
889
+ ],
890
+ "type": "option"
891
+ },
892
+ "admin-email": {
893
+ "helpGroup": "Definition File Override",
894
+ "name": "admin-email",
895
+ "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.",
896
+ "hasDynamicHelp": false,
897
+ "multiple": false,
898
+ "type": "option"
899
+ },
900
+ "source-org": {
901
+ "description": "To view the names of the available org shapes for a given Dev Hub org, run the \"sf org list shape\" command.",
902
+ "exclusive": [
903
+ "edition",
904
+ "snapshot"
905
+ ],
906
+ "helpGroup": "Definition File Override",
907
+ "name": "source-org",
908
+ "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.",
909
+ "hasDynamicHelp": false,
910
+ "multiple": false,
911
+ "type": "option"
572
912
  }
573
913
  },
574
914
  "hasDynamicHelp": true,
575
915
  "hiddenAliases": [],
576
- "id": "org:auth:show-user-password",
916
+ "id": "org:create:scratch",
577
917
  "pluginAlias": "@salesforce/plugin-org",
578
918
  "pluginName": "@salesforce/plugin-org",
579
919
  "pluginType": "core",
580
920
  "strict": true,
581
- "summary": "Show the stored password for an org's user.",
921
+ "summary": "Create a scratch org.",
582
922
  "enableJsonFlag": true,
583
923
  "isESM": true,
584
924
  "relativePath": [
585
925
  "lib",
586
926
  "commands",
587
927
  "org",
588
- "auth",
589
- "show-user-password.js"
928
+ "create",
929
+ "scratch.js"
930
+ ],
931
+ "aliasPermutations": [
932
+ "env:create:scratch",
933
+ "create:env:scratch",
934
+ "create:scratch:env",
935
+ "env:scratch:create",
936
+ "scratch:env:create",
937
+ "scratch:create:env"
590
938
  ],
591
- "aliasPermutations": [],
592
939
  "permutations": [
593
- "org:auth:show-user-password",
594
- "auth:org:show-user-password",
595
- "auth:show-user-password:org",
596
- "org:show-user-password:auth",
597
- "show-user-password:org:auth",
598
- "show-user-password:auth:org"
940
+ "org:create:scratch",
941
+ "create:org:scratch",
942
+ "create:scratch:org",
943
+ "org:scratch:create",
944
+ "scratch:org:create",
945
+ "scratch:create:org"
599
946
  ]
600
947
  },
601
- "org:delete:sandbox": {
602
- "aliases": [
603
- "env:delete:sandbox"
604
- ],
948
+ "org:auth:show-access-token": {
949
+ "aliases": [],
605
950
  "args": {},
606
- "deprecateAliases": true,
607
- "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.",
951
+ "description": "Because access tokens are sensitive credentials that grant full access to an org, this command prompts for confirmation before revealing the token. Skip confirmation by specifying either the --no-prompt or --json flag.",
608
952
  "examples": [
609
- "Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox",
610
- "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa",
611
- "Delete the sandbox without prompting to confirm:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt"
953
+ "Show the access token for the default org:\n<%= config.bin %> <%= command.id %>",
954
+ "Show the access token for an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --target-org my-org",
955
+ "Show the access token without the confirmation prompt:\n<%= config.bin %> <%= command.id %> --target-org my-org --no-prompt",
956
+ "Get the access token as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json"
612
957
  ],
613
958
  "flags": {
614
959
  "json": {
@@ -627,13 +972,9 @@
627
972
  "type": "option"
628
973
  },
629
974
  "target-org": {
630
- "aliases": [
631
- "targetusername",
632
- "u"
633
- ],
634
975
  "char": "o",
635
- "deprecateAliases": true,
636
976
  "name": "target-org",
977
+ "noCacheDefault": true,
637
978
  "required": true,
638
979
  "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
639
980
  "hasDynamicHelp": true,
@@ -643,56 +984,47 @@
643
984
  "no-prompt": {
644
985
  "char": "p",
645
986
  "name": "no-prompt",
646
- "summary": "Don't prompt the user to confirm the deletion.",
987
+ "summary": "Skip the security warning and reveal the access token without confirmation.",
647
988
  "allowNo": false,
648
989
  "type": "boolean"
649
990
  }
650
991
  },
651
992
  "hasDynamicHelp": true,
652
993
  "hiddenAliases": [],
653
- "id": "org:delete:sandbox",
994
+ "id": "org:auth:show-access-token",
654
995
  "pluginAlias": "@salesforce/plugin-org",
655
996
  "pluginName": "@salesforce/plugin-org",
656
997
  "pluginType": "core",
657
998
  "strict": true,
658
- "summary": "Delete a sandbox.",
999
+ "summary": "Show the current access token for an org.",
659
1000
  "enableJsonFlag": true,
660
1001
  "isESM": true,
661
1002
  "relativePath": [
662
1003
  "lib",
663
1004
  "commands",
664
1005
  "org",
665
- "delete",
666
- "sandbox.js"
667
- ],
668
- "aliasPermutations": [
669
- "env:delete:sandbox",
670
- "delete:env:sandbox",
671
- "delete:sandbox:env",
672
- "env:sandbox:delete",
673
- "sandbox:env:delete",
674
- "sandbox:delete:env"
1006
+ "auth",
1007
+ "show-access-token.js"
675
1008
  ],
1009
+ "aliasPermutations": [],
676
1010
  "permutations": [
677
- "org:delete:sandbox",
678
- "delete:org:sandbox",
679
- "delete:sandbox:org",
680
- "org:sandbox:delete",
681
- "sandbox:org:delete",
682
- "sandbox:delete:org"
1011
+ "org:auth:show-access-token",
1012
+ "auth:org:show-access-token",
1013
+ "auth:show-access-token:org",
1014
+ "org:show-access-token:auth",
1015
+ "show-access-token:org:auth",
1016
+ "show-access-token:auth:org"
683
1017
  ]
684
1018
  },
685
- "org:delete:scratch": {
686
- "aliases": [
687
- "env:delete:scratch"
688
- ],
1019
+ "org:auth:show-sfdx-auth-url": {
1020
+ "aliases": [],
689
1021
  "args": {},
690
- "deprecateAliases": true,
691
- "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.",
1022
+ "description": "Shows the SFDX Auth URL for an org. This URL is only available for orgs authenticated via a web-based OAuth flow. This command prompts for confirmation before revealing it. Skip confirmation by specifying either the --no-prompt or --json flag.",
692
1023
  "examples": [
693
- "Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org",
694
- "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com",
695
- "Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt"
1024
+ "Show the SFDX Auth URL for the default org:\n<%= config.bin %> <%= command.id %>",
1025
+ "Show the SFDX Auth URL for an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --target-org my-org",
1026
+ "Show the SFDX Auth URL without the confirmation prompt:\n<%= config.bin %> <%= command.id %> --target-org my-org --no-prompt",
1027
+ "Get the SFDX Auth URL as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json"
696
1028
  ],
697
1029
  "flags": {
698
1030
  "json": {
@@ -711,13 +1043,9 @@
711
1043
  "type": "option"
712
1044
  },
713
1045
  "target-org": {
714
- "aliases": [
715
- "targetusername",
716
- "u"
717
- ],
718
1046
  "char": "o",
719
- "deprecateAliases": true,
720
1047
  "name": "target-org",
1048
+ "noCacheDefault": true,
721
1049
  "required": true,
722
1050
  "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
723
1051
  "hasDynamicHelp": true,
@@ -727,53 +1055,47 @@
727
1055
  "no-prompt": {
728
1056
  "char": "p",
729
1057
  "name": "no-prompt",
730
- "summary": "Don't prompt the user to confirm the deletion.",
1058
+ "summary": "Skip the security warning and reveal the SFDX Auth URL without confirmation.",
731
1059
  "allowNo": false,
732
1060
  "type": "boolean"
733
1061
  }
734
1062
  },
735
1063
  "hasDynamicHelp": true,
736
1064
  "hiddenAliases": [],
737
- "id": "org:delete:scratch",
1065
+ "id": "org:auth:show-sfdx-auth-url",
738
1066
  "pluginAlias": "@salesforce/plugin-org",
739
1067
  "pluginName": "@salesforce/plugin-org",
740
1068
  "pluginType": "core",
741
1069
  "strict": true,
742
- "summary": "Delete a scratch org.",
1070
+ "summary": "Show the SFDX Auth URL for an org.",
743
1071
  "enableJsonFlag": true,
744
1072
  "isESM": true,
745
1073
  "relativePath": [
746
1074
  "lib",
747
1075
  "commands",
748
1076
  "org",
749
- "delete",
750
- "scratch.js"
751
- ],
752
- "aliasPermutations": [
753
- "env:delete:scratch",
754
- "delete:env:scratch",
755
- "delete:scratch:env",
756
- "env:scratch:delete",
757
- "scratch:env:delete",
758
- "scratch:delete:env"
1077
+ "auth",
1078
+ "show-sfdx-auth-url.js"
759
1079
  ],
1080
+ "aliasPermutations": [],
760
1081
  "permutations": [
761
- "org:delete:scratch",
762
- "delete:org:scratch",
763
- "delete:scratch:org",
764
- "org:scratch:delete",
765
- "scratch:org:delete",
766
- "scratch:delete:org"
1082
+ "org:auth:show-sfdx-auth-url",
1083
+ "auth:org:show-sfdx-auth-url",
1084
+ "auth:show-sfdx-auth-url:org",
1085
+ "org:show-sfdx-auth-url:auth",
1086
+ "show-sfdx-auth-url:org:auth",
1087
+ "show-sfdx-auth-url:auth:org"
767
1088
  ]
768
1089
  },
769
- "org:create:agent-user": {
1090
+ "org:auth:show-user-password": {
770
1091
  "aliases": [],
771
1092
  "args": {},
772
- "description": "You specify this user in the agent's Agent Script file using the \"default_agent_user\" parameter in the \"config\" block.\n\nBy default, this command:\n\n- Generates a user called \"Agent User\" with a globally unique username. Use flags to change these default names.\n- Sets the user's email to the new username.\n- Assigns the user the \"Einstein Agent User\" profile.\n- Assigns the user these required permission sets: AgentforceServiceAgentBase, AgentforceServiceAgentUser,\n EinsteinGPTPromptTemplateUser\n- Checks that the user licenses required by the profile and permission sets are available in your org.\n\nThe generated user doesn't have a password. You can’t log into Salesforce using the agent user's username. Only\nSalesforce users with admin permissions can view or edit an agent user in Setup.\n\nTo assign additional permission sets or licenses after the user was created, use the \"org assign permset\" or \"org assign\npermsetlicense\" commands.\n\nWhen the command completes, it displays a summary of what it did, including the new agent user's username and ID, the\navailable licenses associated with the Einstein Agent User profile, and the profile and permission sets assigned to the\nagent user.",
1093
+ "description": "This command shows only passwords that were generated locally in your DX project with either the \"org generate password\" or \"org create user\" CLI command. If you generated a password for a user in Setup in your org, you can't show it with this command.\n\nBecause passwords are sensitive credentials, this command prompts for confirmation before revealing it. Skip confirmation by specifying either the --no-prompt or --json flag.",
773
1094
  "examples": [
774
- "Create an agent user with an auto-generated username; create the user in the org with alias \"myorg\":\n<%= config.bin %> <%= command.id %> --target-org myorg",
775
- "Create an agent user by specifying a base username pattern; to make the username unique, the command appends a unique\nidentifier:\n<%= config.bin %> <%= command.id %> --base-username service-agent@corp.com --target-org myorg",
776
- "Create an agent user with an auto-generated username but the custom name \"Service Agent\"; create the user in your\ndefault org:\n<%= config.bin %> <%= command.id %> --first-name Service --last-name Agent"
1095
+ "Show the password for the default org's user:\n<%= config.bin %> <%= command.id %>",
1096
+ "Show the password for an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --target-org my-org",
1097
+ "Show the password without the confirmation prompt:\n<%= config.bin %> <%= command.id %> --target-org my-org --no-prompt",
1098
+ "Get the password as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json"
777
1099
  ],
778
1100
  "flags": {
779
1101
  "json": {
@@ -801,539 +1123,136 @@
801
1123
  "multiple": false,
802
1124
  "type": "option"
803
1125
  },
804
- "api-version": {
805
- "description": "Override the api version used for api requests made by this command",
806
- "name": "api-version",
807
- "hasDynamicHelp": false,
808
- "multiple": false,
809
- "type": "option"
810
- },
811
- "base-username": {
812
- "description": "Specify a base username in email format, such as \"service-agent@corp.com\". The command then appends a 12-character\nglobally unique ID (GUID) to the name before the \"@\" sign, which ensures that the username is globally unique across all\nSalesforce orgs and sandboxes.\n\nFor example, if you specify \"service-agent@corp.com\", then the username might be \"service-agent.a1b2c3d4e5f6@corp.com\".\n\nIf not specified, the command auto-generates the username using this pattern: \"agent.user.<GUID>@your-org-domain.com\".",
813
- "name": "base-username",
814
- "summary": "Base username pattern. A unique ID is appended to ensure global uniqueness of the usename.",
815
- "hasDynamicHelp": false,
816
- "multiple": false,
817
- "type": "option"
818
- },
819
- "first-name": {
820
- "name": "first-name",
821
- "summary": "First name for the agent user.",
822
- "default": "Agent",
823
- "hasDynamicHelp": false,
824
- "multiple": false,
825
- "type": "option"
826
- },
827
- "last-name": {
828
- "name": "last-name",
829
- "summary": "Last name for the agent user.",
830
- "default": "User",
831
- "hasDynamicHelp": false,
832
- "multiple": false,
833
- "type": "option"
1126
+ "no-prompt": {
1127
+ "char": "p",
1128
+ "name": "no-prompt",
1129
+ "summary": "Skip the security warning and reveal the password without confirmation.",
1130
+ "allowNo": false,
1131
+ "type": "boolean"
834
1132
  }
835
1133
  },
836
1134
  "hasDynamicHelp": true,
837
1135
  "hiddenAliases": [],
838
- "id": "org:create:agent-user",
1136
+ "id": "org:auth:show-user-password",
839
1137
  "pluginAlias": "@salesforce/plugin-org",
840
1138
  "pluginName": "@salesforce/plugin-org",
841
1139
  "pluginType": "core",
842
1140
  "strict": true,
843
- "summary": "Create the default Salesforce user that is used to run an agent.",
1141
+ "summary": "Show the stored password for an org's user.",
844
1142
  "enableJsonFlag": true,
845
1143
  "isESM": true,
846
1144
  "relativePath": [
847
1145
  "lib",
848
1146
  "commands",
849
1147
  "org",
850
- "create",
851
- "agent-user.js"
1148
+ "auth",
1149
+ "show-user-password.js"
852
1150
  ],
853
1151
  "aliasPermutations": [],
854
1152
  "permutations": [
855
- "org:create:agent-user",
856
- "create:org:agent-user",
857
- "create:agent-user:org",
858
- "org:agent-user:create",
859
- "agent-user:org:create",
860
- "agent-user:create:org"
1153
+ "org:auth:show-user-password",
1154
+ "auth:org:show-user-password",
1155
+ "auth:show-user-password:org",
1156
+ "org:show-user-password:auth",
1157
+ "show-user-password:org:auth",
1158
+ "show-user-password:auth:org"
861
1159
  ]
862
1160
  },
863
- "org:create:sandbox": {
1161
+ "org:delete:sandbox": {
864
1162
  "aliases": [
865
- "env:create:sandbox"
1163
+ "env:delete:sandbox"
866
1164
  ],
867
1165
  "args": {},
868
1166
  "deprecateAliases": true,
869
- "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.",
1167
+ "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.",
870
1168
  "examples": [
871
- "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",
872
- "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",
873
- "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",
874
- "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"
1169
+ "Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox",
1170
+ "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa",
1171
+ "Delete the sandbox without prompting to confirm:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt"
875
1172
  ],
876
- "flags": {
877
- "json": {
878
- "description": "Format output as json.",
879
- "helpGroup": "GLOBAL",
880
- "name": "json",
881
- "allowNo": false,
882
- "type": "boolean"
883
- },
884
- "flags-dir": {
885
- "helpGroup": "GLOBAL",
886
- "name": "flags-dir",
887
- "summary": "Import flag values from a directory.",
888
- "hasDynamicHelp": false,
889
- "multiple": false,
890
- "type": "option"
891
- },
892
- "definition-file": {
893
- "char": "f",
894
- "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.",
895
- "name": "definition-file",
896
- "summary": "Path to a sandbox definition file.",
897
- "hasDynamicHelp": false,
898
- "multiple": false,
899
- "type": "option"
900
- },
901
- "set-default": {
902
- "char": "s",
903
- "name": "set-default",
904
- "summary": "Set the sandbox org as your default org.",
905
- "allowNo": false,
906
- "type": "boolean"
907
- },
908
- "alias": {
909
- "char": "a",
910
- "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.",
911
- "name": "alias",
912
- "summary": "Alias for the sandbox org.",
913
- "hasDynamicHelp": false,
914
- "multiple": false,
915
- "type": "option"
916
- },
917
- "wait": {
918
- "char": "w",
919
- "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.",
920
- "exclusive": [
921
- "async"
922
- ],
923
- "name": "wait",
924
- "summary": "Number of minutes to wait for the sandbox org to be ready.",
925
- "hasDynamicHelp": true,
926
- "helpValue": "<minutes>",
927
- "multiple": false,
928
- "type": "option"
929
- },
930
- "poll-interval": {
931
- "char": "i",
932
- "exclusive": [
933
- "async"
934
- ],
935
- "name": "poll-interval",
936
- "summary": "Number of seconds to wait between retries.",
937
- "hasDynamicHelp": true,
938
- "helpValue": "<seconds>",
939
- "multiple": false,
940
- "type": "option"
941
- },
942
- "async": {
943
- "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\".",
944
- "exclusive": [
945
- "wait",
946
- "poll-interval"
947
- ],
948
- "name": "async",
949
- "summary": "Request the sandbox creation, but don't wait for it to complete.",
950
- "allowNo": false,
951
- "type": "boolean"
952
- },
953
- "name": {
954
- "char": "n",
955
- "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.",
956
- "name": "name",
957
- "summary": "Name of the sandbox org.",
958
- "hasDynamicHelp": false,
959
- "multiple": false,
960
- "type": "option"
961
- },
962
- "source-sandbox-name": {
963
- "aliases": [
964
- "clone",
965
- "c"
966
- ],
967
- "deprecateAliases": true,
968
- "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.",
969
- "exclusive": [
970
- "license-type",
971
- "source-id"
972
- ],
973
- "name": "source-sandbox-name",
974
- "summary": "Name of the sandbox org to clone.",
975
- "hasDynamicHelp": false,
976
- "multiple": false,
977
- "type": "option"
978
- },
979
- "source-id": {
980
- "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.",
981
- "exclusive": [
982
- "license-type",
983
- "source-sandbox-name"
984
- ],
985
- "name": "source-id",
986
- "summary": "ID of the sandbox org to clone.",
987
- "hasDynamicHelp": false,
988
- "multiple": false,
989
- "type": "option"
990
- },
991
- "license-type": {
992
- "char": "l",
993
- "exclusive": [
994
- "source-sandbox-name",
995
- "source-id"
996
- ],
997
- "name": "license-type",
998
- "summary": "Type of sandbox license.",
999
- "hasDynamicHelp": false,
1000
- "multiple": false,
1001
- "options": [
1002
- "Developer",
1003
- "Developer_Pro",
1004
- "Partial",
1005
- "Full"
1006
- ],
1007
- "type": "option"
1008
- },
1009
- "target-org": {
1010
- "char": "o",
1011
- "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1012
- "name": "target-org",
1013
- "noCacheDefault": true,
1014
- "required": true,
1015
- "summary": "Username or alias of the production org that contains the sandbox license.",
1016
- "hasDynamicHelp": true,
1017
- "multiple": false,
1018
- "type": "option"
1019
- },
1020
- "no-prompt": {
1021
- "name": "no-prompt",
1022
- "summary": "Don't prompt for confirmation about the sandbox configuration.",
1023
- "allowNo": false,
1024
- "type": "boolean"
1025
- },
1026
- "no-track-source": {
1027
- "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.",
1028
- "name": "no-track-source",
1029
- "summary": "Do not use source tracking for this sandbox.",
1030
- "allowNo": false,
1031
- "type": "boolean"
1032
- }
1033
- },
1034
- "hasDynamicHelp": true,
1035
- "hiddenAliases": [],
1036
- "id": "org:create:sandbox",
1037
- "pluginAlias": "@salesforce/plugin-org",
1038
- "pluginName": "@salesforce/plugin-org",
1039
- "pluginType": "core",
1040
- "strict": true,
1041
- "summary": "Create a sandbox org.",
1042
- "isESM": true,
1043
- "relativePath": [
1044
- "lib",
1045
- "commands",
1046
- "org",
1047
- "create",
1048
- "sandbox.js"
1049
- ],
1050
- "aliasPermutations": [
1051
- "env:create:sandbox",
1052
- "create:env:sandbox",
1053
- "create:sandbox:env",
1054
- "env:sandbox:create",
1055
- "sandbox:env:create",
1056
- "sandbox:create:env"
1057
- ],
1058
- "permutations": [
1059
- "org:create:sandbox",
1060
- "create:org:sandbox",
1061
- "create:sandbox:org",
1062
- "org:sandbox:create",
1063
- "sandbox:org:create",
1064
- "sandbox:create:org"
1065
- ]
1066
- },
1067
- "org:create:scratch": {
1068
- "aliases": [
1069
- "env:create:scratch"
1070
- ],
1071
- "args": {},
1072
- "deprecateAliases": true,
1073
- "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.",
1074
- "examples": [
1075
- "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",
1076
- "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",
1077
- "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",
1078
- "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"
1079
- ],
1080
- "flags": {
1081
- "json": {
1082
- "description": "Format output as json.",
1083
- "helpGroup": "GLOBAL",
1084
- "name": "json",
1085
- "allowNo": false,
1086
- "type": "boolean"
1087
- },
1088
- "flags-dir": {
1089
- "helpGroup": "GLOBAL",
1090
- "name": "flags-dir",
1091
- "summary": "Import flag values from a directory.",
1092
- "hasDynamicHelp": false,
1093
- "multiple": false,
1094
- "type": "option"
1095
- },
1096
- "alias": {
1097
- "char": "a",
1098
- "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.",
1099
- "name": "alias",
1100
- "summary": "Alias for the scratch org.",
1101
- "hasDynamicHelp": false,
1102
- "multiple": false,
1103
- "type": "option"
1104
- },
1105
- "async": {
1106
- "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\".",
1107
- "name": "async",
1108
- "summary": "Request the org, but don't wait for it to complete.",
1109
- "allowNo": false,
1110
- "type": "boolean"
1111
- },
1112
- "set-default": {
1113
- "char": "d",
1114
- "name": "set-default",
1115
- "summary": "Set the scratch org as your default org",
1116
- "allowNo": false,
1117
- "type": "boolean"
1118
- },
1119
- "definition-file": {
1120
- "char": "f",
1121
- "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.",
1122
- "name": "definition-file",
1123
- "summary": "Path to a scratch org definition file.",
1124
- "hasDynamicHelp": false,
1125
- "multiple": false,
1126
- "type": "option"
1127
- },
1128
- "target-dev-hub": {
1129
- "char": "v",
1130
- "description": "Overrides the value of the target-dev-hub configuration variable, if set.",
1131
- "name": "target-dev-hub",
1132
- "noCacheDefault": true,
1133
- "required": true,
1134
- "summary": "Username or alias of the Dev Hub org.",
1135
- "hasDynamicHelp": true,
1136
- "multiple": false,
1137
- "type": "option"
1138
- },
1139
- "no-ancestors": {
1140
- "char": "c",
1141
- "helpGroup": "Packaging",
1142
- "name": "no-ancestors",
1143
- "summary": "Don't include second-generation managed package (2GP) ancestors in the scratch org.",
1144
- "allowNo": false,
1145
- "type": "boolean"
1146
- },
1147
- "edition": {
1148
- "char": "e",
1149
- "description": "The editions that begin with \"partner-\" are available only if the Dev Hub org is a Partner Business Org.",
1150
- "exclusive": [
1151
- "snapshot",
1152
- "source-org"
1153
- ],
1154
- "helpGroup": "Definition File Override",
1155
- "name": "edition",
1156
- "summary": "Salesforce edition of the scratch org. Overrides the value of the \"edition\" option in the definition file, if set.",
1157
- "hasDynamicHelp": false,
1158
- "multiple": false,
1159
- "options": [
1160
- "developer",
1161
- "enterprise",
1162
- "group",
1163
- "professional",
1164
- "partner-developer",
1165
- "partner-enterprise",
1166
- "partner-group",
1167
- "partner-professional"
1168
- ],
1169
- "type": "option"
1170
- },
1171
- "snapshot": {
1172
- "char": "s",
1173
- "description": "To view the names of the available snapshots for a given Dev Hub org, run the \"sf org list snapshot\" command.",
1174
- "exclusive": [
1175
- "edition",
1176
- "source-org"
1177
- ],
1178
- "helpGroup": "Definition File Override",
1179
- "name": "snapshot",
1180
- "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.",
1181
- "hasDynamicHelp": false,
1182
- "multiple": false,
1183
- "type": "option"
1184
- },
1185
- "no-namespace": {
1186
- "char": "m",
1187
- "helpGroup": "Packaging",
1188
- "name": "no-namespace",
1189
- "summary": "Create the scratch org with no namespace, even if the Dev Hub has a namespace.",
1190
- "allowNo": false,
1191
- "type": "boolean"
1192
- },
1193
- "duration-days": {
1194
- "char": "y",
1195
- "name": "duration-days",
1196
- "summary": "Number of days before the org expires.",
1197
- "hasDynamicHelp": true,
1198
- "helpValue": "<days>",
1199
- "multiple": false,
1200
- "type": "option"
1201
- },
1202
- "wait": {
1203
- "char": "w",
1204
- "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.",
1205
- "name": "wait",
1206
- "summary": "Number of minutes to wait for the scratch org to be ready.",
1207
- "hasDynamicHelp": true,
1208
- "helpValue": "<minutes>",
1209
- "multiple": false,
1210
- "type": "option"
1211
- },
1212
- "api-version": {
1213
- "description": "Override the api version used for api requests made by this command",
1214
- "name": "api-version",
1215
- "hasDynamicHelp": false,
1216
- "multiple": false,
1217
- "type": "option"
1218
- },
1219
- "client-id": {
1220
- "char": "i",
1221
- "name": "client-id",
1222
- "summary": "Consumer key of the Dev Hub connected app.",
1223
- "hasDynamicHelp": false,
1224
- "multiple": false,
1225
- "type": "option"
1226
- },
1227
- "track-source": {
1228
- "char": "t",
1229
- "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.",
1230
- "name": "track-source",
1231
- "summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
1232
- "allowNo": true,
1173
+ "flags": {
1174
+ "json": {
1175
+ "description": "Format output as json.",
1176
+ "helpGroup": "GLOBAL",
1177
+ "name": "json",
1178
+ "allowNo": false,
1233
1179
  "type": "boolean"
1234
1180
  },
1235
- "username": {
1236
- "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.",
1237
- "helpGroup": "Definition File Override",
1238
- "name": "username",
1239
- "summary": "Username of the scratch org admin user. Overrides the value of the \"username\" option in the definition file, if set.",
1240
- "hasDynamicHelp": false,
1241
- "multiple": false,
1242
- "type": "option"
1243
- },
1244
- "description": {
1245
- "helpGroup": "Definition File Override",
1246
- "name": "description",
1247
- "summary": "Description of the scratch org in the Dev Hub. Overrides the value of the \"description\" option in the definition file, if set.",
1248
- "hasDynamicHelp": false,
1249
- "multiple": false,
1250
- "type": "option"
1251
- },
1252
- "name": {
1253
- "helpGroup": "Definition File Override",
1254
- "name": "name",
1255
- "summary": "Name of the org, such as \"Acme Company\". Overrides the value of the \"orgName\" option in the definition file, if set.",
1181
+ "flags-dir": {
1182
+ "helpGroup": "GLOBAL",
1183
+ "name": "flags-dir",
1184
+ "summary": "Import flag values from a directory.",
1256
1185
  "hasDynamicHelp": false,
1257
1186
  "multiple": false,
1258
1187
  "type": "option"
1259
1188
  },
1260
- "release": {
1261
- "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.",
1262
- "helpGroup": "Definition File Override",
1263
- "name": "release",
1264
- "summary": "Release of the scratch org as compared to the Dev Hub release.",
1265
- "hasDynamicHelp": false,
1266
- "multiple": false,
1267
- "options": [
1268
- "preview",
1269
- "previous"
1189
+ "target-org": {
1190
+ "aliases": [
1191
+ "targetusername",
1192
+ "u"
1270
1193
  ],
1271
- "type": "option"
1272
- },
1273
- "admin-email": {
1274
- "helpGroup": "Definition File Override",
1275
- "name": "admin-email",
1276
- "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.",
1277
- "hasDynamicHelp": false,
1194
+ "char": "o",
1195
+ "deprecateAliases": true,
1196
+ "name": "target-org",
1197
+ "required": true,
1198
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1199
+ "hasDynamicHelp": true,
1278
1200
  "multiple": false,
1279
1201
  "type": "option"
1280
1202
  },
1281
- "source-org": {
1282
- "description": "To view the names of the available org shapes for a given Dev Hub org, run the \"sf org list shape\" command.",
1283
- "exclusive": [
1284
- "edition",
1285
- "snapshot"
1286
- ],
1287
- "helpGroup": "Definition File Override",
1288
- "name": "source-org",
1289
- "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.",
1290
- "hasDynamicHelp": false,
1291
- "multiple": false,
1292
- "type": "option"
1203
+ "no-prompt": {
1204
+ "char": "p",
1205
+ "name": "no-prompt",
1206
+ "summary": "Don't prompt the user to confirm the deletion.",
1207
+ "allowNo": false,
1208
+ "type": "boolean"
1293
1209
  }
1294
1210
  },
1295
1211
  "hasDynamicHelp": true,
1296
1212
  "hiddenAliases": [],
1297
- "id": "org:create:scratch",
1213
+ "id": "org:delete:sandbox",
1298
1214
  "pluginAlias": "@salesforce/plugin-org",
1299
1215
  "pluginName": "@salesforce/plugin-org",
1300
1216
  "pluginType": "core",
1301
1217
  "strict": true,
1302
- "summary": "Create a scratch org.",
1218
+ "summary": "Delete a sandbox.",
1303
1219
  "enableJsonFlag": true,
1304
1220
  "isESM": true,
1305
1221
  "relativePath": [
1306
1222
  "lib",
1307
1223
  "commands",
1308
1224
  "org",
1309
- "create",
1310
- "scratch.js"
1225
+ "delete",
1226
+ "sandbox.js"
1311
1227
  ],
1312
1228
  "aliasPermutations": [
1313
- "env:create:scratch",
1314
- "create:env:scratch",
1315
- "create:scratch:env",
1316
- "env:scratch:create",
1317
- "scratch:env:create",
1318
- "scratch:create:env"
1229
+ "env:delete:sandbox",
1230
+ "delete:env:sandbox",
1231
+ "delete:sandbox:env",
1232
+ "env:sandbox:delete",
1233
+ "sandbox:env:delete",
1234
+ "sandbox:delete:env"
1319
1235
  ],
1320
1236
  "permutations": [
1321
- "org:create:scratch",
1322
- "create:org:scratch",
1323
- "create:scratch:org",
1324
- "org:scratch:create",
1325
- "scratch:org:create",
1326
- "scratch:create:org"
1237
+ "org:delete:sandbox",
1238
+ "delete:org:sandbox",
1239
+ "delete:sandbox:org",
1240
+ "org:sandbox:delete",
1241
+ "sandbox:org:delete",
1242
+ "sandbox:delete:org"
1327
1243
  ]
1328
1244
  },
1329
- "org:disable:tracking": {
1330
- "aliases": [],
1245
+ "org:delete:scratch": {
1246
+ "aliases": [
1247
+ "env:delete:scratch"
1248
+ ],
1331
1249
  "args": {},
1332
- "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.",
1250
+ "deprecateAliases": true,
1251
+ "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.",
1333
1252
  "examples": [
1334
- "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1335
- "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1336
- "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1253
+ "Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org",
1254
+ "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com",
1255
+ "Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt"
1337
1256
  ],
1338
1257
  "flags": {
1339
1258
  "json": {
@@ -1352,51 +1271,69 @@
1352
1271
  "type": "option"
1353
1272
  },
1354
1273
  "target-org": {
1274
+ "aliases": [
1275
+ "targetusername",
1276
+ "u"
1277
+ ],
1355
1278
  "char": "o",
1279
+ "deprecateAliases": true,
1356
1280
  "name": "target-org",
1357
- "noCacheDefault": true,
1358
1281
  "required": true,
1359
1282
  "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1360
1283
  "hasDynamicHelp": true,
1361
1284
  "multiple": false,
1362
1285
  "type": "option"
1286
+ },
1287
+ "no-prompt": {
1288
+ "char": "p",
1289
+ "name": "no-prompt",
1290
+ "summary": "Don't prompt the user to confirm the deletion.",
1291
+ "allowNo": false,
1292
+ "type": "boolean"
1363
1293
  }
1364
1294
  },
1365
1295
  "hasDynamicHelp": true,
1366
1296
  "hiddenAliases": [],
1367
- "id": "org:disable:tracking",
1297
+ "id": "org:delete:scratch",
1368
1298
  "pluginAlias": "@salesforce/plugin-org",
1369
1299
  "pluginName": "@salesforce/plugin-org",
1370
1300
  "pluginType": "core",
1371
1301
  "strict": true,
1372
- "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
1302
+ "summary": "Delete a scratch org.",
1373
1303
  "enableJsonFlag": true,
1374
1304
  "isESM": true,
1375
1305
  "relativePath": [
1376
1306
  "lib",
1377
1307
  "commands",
1378
1308
  "org",
1379
- "disable",
1380
- "tracking.js"
1309
+ "delete",
1310
+ "scratch.js"
1311
+ ],
1312
+ "aliasPermutations": [
1313
+ "env:delete:scratch",
1314
+ "delete:env:scratch",
1315
+ "delete:scratch:env",
1316
+ "env:scratch:delete",
1317
+ "scratch:env:delete",
1318
+ "scratch:delete:env"
1381
1319
  ],
1382
- "aliasPermutations": [],
1383
1320
  "permutations": [
1384
- "org:disable:tracking",
1385
- "disable:org:tracking",
1386
- "disable:tracking:org",
1387
- "org:tracking:disable",
1388
- "tracking:org:disable",
1389
- "tracking:disable:org"
1321
+ "org:delete:scratch",
1322
+ "delete:org:scratch",
1323
+ "delete:scratch:org",
1324
+ "org:scratch:delete",
1325
+ "scratch:org:delete",
1326
+ "scratch:delete:org"
1390
1327
  ]
1391
1328
  },
1392
- "org:enable:tracking": {
1329
+ "org:disable:tracking": {
1393
1330
  "aliases": [],
1394
1331
  "args": {},
1395
- "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.",
1332
+ "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.",
1396
1333
  "examples": [
1397
- "Enable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1398
- "Enable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1399
- "Enable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1334
+ "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1335
+ "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1336
+ "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1400
1337
  ],
1401
1338
  "flags": {
1402
1339
  "json": {
@@ -1427,29 +1364,29 @@
1427
1364
  },
1428
1365
  "hasDynamicHelp": true,
1429
1366
  "hiddenAliases": [],
1430
- "id": "org:enable:tracking",
1367
+ "id": "org:disable:tracking",
1431
1368
  "pluginAlias": "@salesforce/plugin-org",
1432
1369
  "pluginName": "@salesforce/plugin-org",
1433
1370
  "pluginType": "core",
1434
1371
  "strict": true,
1435
- "summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
1372
+ "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
1436
1373
  "enableJsonFlag": true,
1437
1374
  "isESM": true,
1438
1375
  "relativePath": [
1439
1376
  "lib",
1440
1377
  "commands",
1441
1378
  "org",
1442
- "enable",
1379
+ "disable",
1443
1380
  "tracking.js"
1444
1381
  ],
1445
1382
  "aliasPermutations": [],
1446
1383
  "permutations": [
1447
- "org:enable:tracking",
1448
- "enable:org:tracking",
1449
- "enable:tracking:org",
1450
- "org:tracking:enable",
1451
- "tracking:org:enable",
1452
- "tracking:enable:org"
1384
+ "org:disable:tracking",
1385
+ "disable:org:tracking",
1386
+ "disable:tracking:org",
1387
+ "org:tracking:disable",
1388
+ "tracking:org:disable",
1389
+ "tracking:disable:org"
1453
1390
  ]
1454
1391
  },
1455
1392
  "org:list:metadata-types": {
@@ -1494,7 +1431,7 @@
1494
1431
  },
1495
1432
  "loglevel": {
1496
1433
  "deprecated": {
1497
- "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."
1434
+ "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 `SF_LOG_LEVEL` environment variable."
1498
1435
  },
1499
1436
  "hidden": true,
1500
1437
  "name": "loglevel",
@@ -1620,7 +1557,7 @@
1620
1557
  },
1621
1558
  "loglevel": {
1622
1559
  "deprecated": {
1623
- "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."
1560
+ "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 `SF_LOG_LEVEL` environment variable."
1624
1561
  },
1625
1562
  "hidden": true,
1626
1563
  "name": "loglevel",
@@ -1711,6 +1648,69 @@
1711
1648
  "metadata:list:org"
1712
1649
  ]
1713
1650
  },
1651
+ "org:enable:tracking": {
1652
+ "aliases": [],
1653
+ "args": {},
1654
+ "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.",
1655
+ "examples": [
1656
+ "Enable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1657
+ "Enable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1658
+ "Enable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1659
+ ],
1660
+ "flags": {
1661
+ "json": {
1662
+ "description": "Format output as json.",
1663
+ "helpGroup": "GLOBAL",
1664
+ "name": "json",
1665
+ "allowNo": false,
1666
+ "type": "boolean"
1667
+ },
1668
+ "flags-dir": {
1669
+ "helpGroup": "GLOBAL",
1670
+ "name": "flags-dir",
1671
+ "summary": "Import flag values from a directory.",
1672
+ "hasDynamicHelp": false,
1673
+ "multiple": false,
1674
+ "type": "option"
1675
+ },
1676
+ "target-org": {
1677
+ "char": "o",
1678
+ "name": "target-org",
1679
+ "noCacheDefault": true,
1680
+ "required": true,
1681
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1682
+ "hasDynamicHelp": true,
1683
+ "multiple": false,
1684
+ "type": "option"
1685
+ }
1686
+ },
1687
+ "hasDynamicHelp": true,
1688
+ "hiddenAliases": [],
1689
+ "id": "org:enable:tracking",
1690
+ "pluginAlias": "@salesforce/plugin-org",
1691
+ "pluginName": "@salesforce/plugin-org",
1692
+ "pluginType": "core",
1693
+ "strict": true,
1694
+ "summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
1695
+ "enableJsonFlag": true,
1696
+ "isESM": true,
1697
+ "relativePath": [
1698
+ "lib",
1699
+ "commands",
1700
+ "org",
1701
+ "enable",
1702
+ "tracking.js"
1703
+ ],
1704
+ "aliasPermutations": [],
1705
+ "permutations": [
1706
+ "org:enable:tracking",
1707
+ "enable:org:tracking",
1708
+ "enable:tracking:org",
1709
+ "org:tracking:enable",
1710
+ "tracking:org:enable",
1711
+ "tracking:enable:org"
1712
+ ]
1713
+ },
1714
1714
  "org:open:agent": {
1715
1715
  "aliases": [],
1716
1716
  "args": {},
@@ -2309,5 +2309,5 @@
2309
2309
  ]
2310
2310
  }
2311
2311
  },
2312
- "version": "5.11.18"
2312
+ "version": "5.11.20"
2313
2313
  }