@salesforce/plugin-org 5.2.26 → 5.2.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +15 -15
  2. package/oclif.manifest.json +436 -436
  3. package/package.json +4 -4
package/README.md CHANGED
@@ -242,7 +242,7 @@ FLAG DESCRIPTIONS
242
242
  You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
243
243
  ```
244
244
 
245
- _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/create/sandbox.ts)_
245
+ _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/create/sandbox.ts)_
246
246
 
247
247
  ## `sf org create scratch`
248
248
 
@@ -396,7 +396,7 @@ FLAG DESCRIPTIONS
396
396
  Omit this flag to have Salesforce generate a unique username for your org.
397
397
  ```
398
398
 
399
- _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/create/scratch.ts)_
399
+ _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/create/scratch.ts)_
400
400
 
401
401
  ## `sf org delete sandbox`
402
402
 
@@ -442,7 +442,7 @@ EXAMPLES
442
442
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
443
443
  ```
444
444
 
445
- _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/delete/sandbox.ts)_
445
+ _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/delete/sandbox.ts)_
446
446
 
447
447
  ## `sf org delete scratch`
448
448
 
@@ -486,7 +486,7 @@ EXAMPLES
486
486
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
487
487
  ```
488
488
 
489
- _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/delete/scratch.ts)_
489
+ _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/delete/scratch.ts)_
490
490
 
491
491
  ## `sf org disable tracking`
492
492
 
@@ -525,7 +525,7 @@ EXAMPLES
525
525
  $ sf org disable tracking
526
526
  ```
527
527
 
528
- _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/disable/tracking.ts)_
528
+ _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/disable/tracking.ts)_
529
529
 
530
530
  ## `sf org display`
531
531
 
@@ -570,7 +570,7 @@ EXAMPLES
570
570
  $ sf org display --target-org TestOrg1 --verbose
571
571
  ```
572
572
 
573
- _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/display.ts)_
573
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/display.ts)_
574
574
 
575
575
  ## `sf org enable tracking`
576
576
 
@@ -612,7 +612,7 @@ EXAMPLES
612
612
  $ sf org enable tracking
613
613
  ```
614
614
 
615
- _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/enable/tracking.ts)_
615
+ _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/enable/tracking.ts)_
616
616
 
617
617
  ## `sf org list`
618
618
 
@@ -651,7 +651,7 @@ EXAMPLES
651
651
  $ sf org list --clean
652
652
  ```
653
653
 
654
- _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/list.ts)_
654
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/list.ts)_
655
655
 
656
656
  ## `sf org list metadata`
657
657
 
@@ -718,7 +718,7 @@ FLAG DESCRIPTIONS
718
718
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
719
719
  ```
720
720
 
721
- _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/list/metadata.ts)_
721
+ _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/list/metadata.ts)_
722
722
 
723
723
  ## `sf org list metadata-types`
724
724
 
@@ -773,7 +773,7 @@ FLAG DESCRIPTIONS
773
773
  Override the api version used for api requests made by this command
774
774
  ```
775
775
 
776
- _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/list/metadata-types.ts)_
776
+ _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/list/metadata-types.ts)_
777
777
 
778
778
  ## `sf org open`
779
779
 
@@ -849,7 +849,7 @@ EXAMPLES
849
849
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
850
850
  ```
851
851
 
852
- _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/open.ts)_
852
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/open.ts)_
853
853
 
854
854
  ## `sf org open agent`
855
855
 
@@ -900,7 +900,7 @@ EXAMPLES
900
900
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --name Coral_Cloud_Agent
901
901
  ```
902
902
 
903
- _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/open/agent.ts)_
903
+ _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/open/agent.ts)_
904
904
 
905
905
  ## `sf org refresh sandbox`
906
906
 
@@ -977,7 +977,7 @@ FLAG DESCRIPTIONS
977
977
  By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.
978
978
  ```
979
979
 
980
- _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/refresh/sandbox.ts)_
980
+ _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/refresh/sandbox.ts)_
981
981
 
982
982
  ## `sf org resume sandbox`
983
983
 
@@ -1040,7 +1040,7 @@ FLAG DESCRIPTIONS
1040
1040
  returns the job ID. To resume checking the sandbox creation, rerun this command.
1041
1041
  ```
1042
1042
 
1043
- _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/resume/sandbox.ts)_
1043
+ _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/resume/sandbox.ts)_
1044
1044
 
1045
1045
  ## `sf org resume scratch`
1046
1046
 
@@ -1087,6 +1087,6 @@ FLAG DESCRIPTIONS
1087
1087
  The job ID is valid for 24 hours after you start the scratch org creation.
1088
1088
  ```
1089
1089
 
1090
- _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.26/src/commands/org/resume/scratch.ts)_
1090
+ _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.27/src/commands/org/resume/scratch.ts)_
1091
1091
 
1092
1092
  <!-- commandsstop -->
@@ -385,6 +385,237 @@
385
385
  "open:org"
386
386
  ]
387
387
  },
388
+ "org:disable:tracking": {
389
+ "aliases": [],
390
+ "args": {},
391
+ "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.",
392
+ "examples": [
393
+ "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
394
+ "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
395
+ "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
396
+ ],
397
+ "flags": {
398
+ "json": {
399
+ "description": "Format output as json.",
400
+ "helpGroup": "GLOBAL",
401
+ "name": "json",
402
+ "allowNo": false,
403
+ "type": "boolean"
404
+ },
405
+ "flags-dir": {
406
+ "helpGroup": "GLOBAL",
407
+ "name": "flags-dir",
408
+ "summary": "Import flag values from a directory.",
409
+ "hasDynamicHelp": false,
410
+ "multiple": false,
411
+ "type": "option"
412
+ },
413
+ "target-org": {
414
+ "char": "o",
415
+ "name": "target-org",
416
+ "noCacheDefault": true,
417
+ "required": true,
418
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
419
+ "hasDynamicHelp": true,
420
+ "multiple": false,
421
+ "type": "option"
422
+ }
423
+ },
424
+ "hasDynamicHelp": true,
425
+ "hiddenAliases": [],
426
+ "id": "org:disable:tracking",
427
+ "pluginAlias": "@salesforce/plugin-org",
428
+ "pluginName": "@salesforce/plugin-org",
429
+ "pluginType": "core",
430
+ "strict": true,
431
+ "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
432
+ "enableJsonFlag": true,
433
+ "isESM": true,
434
+ "relativePath": [
435
+ "lib",
436
+ "commands",
437
+ "org",
438
+ "disable",
439
+ "tracking.js"
440
+ ],
441
+ "aliasPermutations": [],
442
+ "permutations": [
443
+ "org:disable:tracking",
444
+ "disable:org:tracking",
445
+ "disable:tracking:org",
446
+ "org:tracking:disable",
447
+ "tracking:org:disable",
448
+ "tracking:disable:org"
449
+ ]
450
+ },
451
+ "org:delete:sandbox": {
452
+ "aliases": [
453
+ "env:delete:sandbox"
454
+ ],
455
+ "args": {},
456
+ "deprecateAliases": true,
457
+ "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.",
458
+ "examples": [
459
+ "Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox",
460
+ "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa",
461
+ "Delete the sandbox without prompting to confirm:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt"
462
+ ],
463
+ "flags": {
464
+ "json": {
465
+ "description": "Format output as json.",
466
+ "helpGroup": "GLOBAL",
467
+ "name": "json",
468
+ "allowNo": false,
469
+ "type": "boolean"
470
+ },
471
+ "flags-dir": {
472
+ "helpGroup": "GLOBAL",
473
+ "name": "flags-dir",
474
+ "summary": "Import flag values from a directory.",
475
+ "hasDynamicHelp": false,
476
+ "multiple": false,
477
+ "type": "option"
478
+ },
479
+ "target-org": {
480
+ "aliases": [
481
+ "targetusername",
482
+ "u"
483
+ ],
484
+ "char": "o",
485
+ "deprecateAliases": true,
486
+ "name": "target-org",
487
+ "required": true,
488
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
489
+ "hasDynamicHelp": true,
490
+ "multiple": false,
491
+ "type": "option"
492
+ },
493
+ "no-prompt": {
494
+ "char": "p",
495
+ "name": "no-prompt",
496
+ "summary": "Don't prompt the user to confirm the deletion.",
497
+ "allowNo": false,
498
+ "type": "boolean"
499
+ }
500
+ },
501
+ "hasDynamicHelp": true,
502
+ "hiddenAliases": [],
503
+ "id": "org:delete:sandbox",
504
+ "pluginAlias": "@salesforce/plugin-org",
505
+ "pluginName": "@salesforce/plugin-org",
506
+ "pluginType": "core",
507
+ "strict": true,
508
+ "summary": "Delete a sandbox.",
509
+ "enableJsonFlag": true,
510
+ "isESM": true,
511
+ "relativePath": [
512
+ "lib",
513
+ "commands",
514
+ "org",
515
+ "delete",
516
+ "sandbox.js"
517
+ ],
518
+ "aliasPermutations": [
519
+ "env:delete:sandbox",
520
+ "delete:env:sandbox",
521
+ "delete:sandbox:env",
522
+ "env:sandbox:delete",
523
+ "sandbox:env:delete",
524
+ "sandbox:delete:env"
525
+ ],
526
+ "permutations": [
527
+ "org:delete:sandbox",
528
+ "delete:org:sandbox",
529
+ "delete:sandbox:org",
530
+ "org:sandbox:delete",
531
+ "sandbox:org:delete",
532
+ "sandbox:delete:org"
533
+ ]
534
+ },
535
+ "org:delete:scratch": {
536
+ "aliases": [
537
+ "env:delete:scratch"
538
+ ],
539
+ "args": {},
540
+ "deprecateAliases": true,
541
+ "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.",
542
+ "examples": [
543
+ "Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org",
544
+ "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com",
545
+ "Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt"
546
+ ],
547
+ "flags": {
548
+ "json": {
549
+ "description": "Format output as json.",
550
+ "helpGroup": "GLOBAL",
551
+ "name": "json",
552
+ "allowNo": false,
553
+ "type": "boolean"
554
+ },
555
+ "flags-dir": {
556
+ "helpGroup": "GLOBAL",
557
+ "name": "flags-dir",
558
+ "summary": "Import flag values from a directory.",
559
+ "hasDynamicHelp": false,
560
+ "multiple": false,
561
+ "type": "option"
562
+ },
563
+ "target-org": {
564
+ "aliases": [
565
+ "targetusername",
566
+ "u"
567
+ ],
568
+ "char": "o",
569
+ "deprecateAliases": true,
570
+ "name": "target-org",
571
+ "required": true,
572
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
573
+ "hasDynamicHelp": true,
574
+ "multiple": false,
575
+ "type": "option"
576
+ },
577
+ "no-prompt": {
578
+ "char": "p",
579
+ "name": "no-prompt",
580
+ "summary": "Don't prompt the user to confirm the deletion.",
581
+ "allowNo": false,
582
+ "type": "boolean"
583
+ }
584
+ },
585
+ "hasDynamicHelp": true,
586
+ "hiddenAliases": [],
587
+ "id": "org:delete:scratch",
588
+ "pluginAlias": "@salesforce/plugin-org",
589
+ "pluginName": "@salesforce/plugin-org",
590
+ "pluginType": "core",
591
+ "strict": true,
592
+ "summary": "Delete a scratch org.",
593
+ "enableJsonFlag": true,
594
+ "isESM": true,
595
+ "relativePath": [
596
+ "lib",
597
+ "commands",
598
+ "org",
599
+ "delete",
600
+ "scratch.js"
601
+ ],
602
+ "aliasPermutations": [
603
+ "env:delete:scratch",
604
+ "delete:env:scratch",
605
+ "delete:scratch:env",
606
+ "env:scratch:delete",
607
+ "scratch:env:delete",
608
+ "scratch:delete:env"
609
+ ],
610
+ "permutations": [
611
+ "org:delete:scratch",
612
+ "delete:org:scratch",
613
+ "delete:scratch:org",
614
+ "org:scratch:delete",
615
+ "scratch:org:delete",
616
+ "scratch:delete:org"
617
+ ]
618
+ },
388
619
  "org:create:sandbox": {
389
620
  "aliases": [
390
621
  "env:create:sandbox"
@@ -695,399 +926,21 @@
695
926
  "type": "boolean"
696
927
  },
697
928
  "duration-days": {
698
- "char": "y",
699
- "name": "duration-days",
700
- "summary": "Number of days before the org expires.",
701
- "hasDynamicHelp": true,
702
- "helpValue": "<days>",
703
- "multiple": false,
704
- "type": "option"
705
- },
706
- "wait": {
707
- "char": "w",
708
- "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.",
709
- "name": "wait",
710
- "summary": "Number of minutes to wait for the scratch org to be ready.",
711
- "hasDynamicHelp": true,
712
- "helpValue": "<minutes>",
713
- "multiple": false,
714
- "type": "option"
715
- },
716
- "api-version": {
717
- "description": "Override the api version used for api requests made by this command",
718
- "name": "api-version",
719
- "hasDynamicHelp": false,
720
- "multiple": false,
721
- "type": "option"
722
- },
723
- "client-id": {
724
- "char": "i",
725
- "name": "client-id",
726
- "summary": "Consumer key of the Dev Hub connected app.",
727
- "hasDynamicHelp": false,
728
- "multiple": false,
729
- "type": "option"
730
- },
731
- "track-source": {
732
- "char": "t",
733
- "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.",
734
- "name": "track-source",
735
- "summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
736
- "allowNo": true,
737
- "type": "boolean"
738
- },
739
- "username": {
740
- "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.",
741
- "helpGroup": "Definition File Override",
742
- "name": "username",
743
- "summary": "Username of the scratch org admin user. Overrides the value of the \"username\" option in the definition file, if set.",
744
- "hasDynamicHelp": false,
745
- "multiple": false,
746
- "type": "option"
747
- },
748
- "description": {
749
- "helpGroup": "Definition File Override",
750
- "name": "description",
751
- "summary": "Description of the scratch org in the Dev Hub. Overrides the value of the \"description\" option in the definition file, if set.",
752
- "hasDynamicHelp": false,
753
- "multiple": false,
754
- "type": "option"
755
- },
756
- "name": {
757
- "helpGroup": "Definition File Override",
758
- "name": "name",
759
- "summary": "Name of the org, such as \"Acme Company\". Overrides the value of the \"orgName\" option in the definition file, if set.",
760
- "hasDynamicHelp": false,
761
- "multiple": false,
762
- "type": "option"
763
- },
764
- "release": {
765
- "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.",
766
- "helpGroup": "Definition File Override",
767
- "name": "release",
768
- "summary": "Release of the scratch org as compared to the Dev Hub release.",
769
- "hasDynamicHelp": false,
770
- "multiple": false,
771
- "options": [
772
- "preview",
773
- "previous"
774
- ],
775
- "type": "option"
776
- },
777
- "admin-email": {
778
- "helpGroup": "Definition File Override",
779
- "name": "admin-email",
780
- "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.",
781
- "hasDynamicHelp": false,
782
- "multiple": false,
783
- "type": "option"
784
- },
785
- "source-org": {
786
- "helpGroup": "Definition File Override",
787
- "name": "source-org",
788
- "summary": "15-character ID of the org whose shape the new scratch org will be based on. Overrides the value of the \"sourceOrg\" option in the definition file, if set.",
789
- "hasDynamicHelp": false,
790
- "multiple": false,
791
- "type": "option"
792
- }
793
- },
794
- "hasDynamicHelp": true,
795
- "hiddenAliases": [],
796
- "id": "org:create:scratch",
797
- "pluginAlias": "@salesforce/plugin-org",
798
- "pluginName": "@salesforce/plugin-org",
799
- "pluginType": "core",
800
- "strict": true,
801
- "summary": "Create a scratch org.",
802
- "enableJsonFlag": true,
803
- "isESM": true,
804
- "relativePath": [
805
- "lib",
806
- "commands",
807
- "org",
808
- "create",
809
- "scratch.js"
810
- ],
811
- "aliasPermutations": [
812
- "env:create:scratch",
813
- "create:env:scratch",
814
- "create:scratch:env",
815
- "env:scratch:create",
816
- "scratch:env:create",
817
- "scratch:create:env"
818
- ],
819
- "permutations": [
820
- "org:create:scratch",
821
- "create:org:scratch",
822
- "create:scratch:org",
823
- "org:scratch:create",
824
- "scratch:org:create",
825
- "scratch:create:org"
826
- ]
827
- },
828
- "org:delete:sandbox": {
829
- "aliases": [
830
- "env:delete:sandbox"
831
- ],
832
- "args": {},
833
- "deprecateAliases": true,
834
- "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.",
835
- "examples": [
836
- "Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox",
837
- "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa",
838
- "Delete the sandbox without prompting to confirm:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt"
839
- ],
840
- "flags": {
841
- "json": {
842
- "description": "Format output as json.",
843
- "helpGroup": "GLOBAL",
844
- "name": "json",
845
- "allowNo": false,
846
- "type": "boolean"
847
- },
848
- "flags-dir": {
849
- "helpGroup": "GLOBAL",
850
- "name": "flags-dir",
851
- "summary": "Import flag values from a directory.",
852
- "hasDynamicHelp": false,
853
- "multiple": false,
854
- "type": "option"
855
- },
856
- "target-org": {
857
- "aliases": [
858
- "targetusername",
859
- "u"
860
- ],
861
- "char": "o",
862
- "deprecateAliases": true,
863
- "name": "target-org",
864
- "required": true,
865
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
866
- "hasDynamicHelp": true,
867
- "multiple": false,
868
- "type": "option"
869
- },
870
- "no-prompt": {
871
- "char": "p",
872
- "name": "no-prompt",
873
- "summary": "Don't prompt the user to confirm the deletion.",
874
- "allowNo": false,
875
- "type": "boolean"
876
- }
877
- },
878
- "hasDynamicHelp": true,
879
- "hiddenAliases": [],
880
- "id": "org:delete:sandbox",
881
- "pluginAlias": "@salesforce/plugin-org",
882
- "pluginName": "@salesforce/plugin-org",
883
- "pluginType": "core",
884
- "strict": true,
885
- "summary": "Delete a sandbox.",
886
- "enableJsonFlag": true,
887
- "isESM": true,
888
- "relativePath": [
889
- "lib",
890
- "commands",
891
- "org",
892
- "delete",
893
- "sandbox.js"
894
- ],
895
- "aliasPermutations": [
896
- "env:delete:sandbox",
897
- "delete:env:sandbox",
898
- "delete:sandbox:env",
899
- "env:sandbox:delete",
900
- "sandbox:env:delete",
901
- "sandbox:delete:env"
902
- ],
903
- "permutations": [
904
- "org:delete:sandbox",
905
- "delete:org:sandbox",
906
- "delete:sandbox:org",
907
- "org:sandbox:delete",
908
- "sandbox:org:delete",
909
- "sandbox:delete:org"
910
- ]
911
- },
912
- "org:delete:scratch": {
913
- "aliases": [
914
- "env:delete:scratch"
915
- ],
916
- "args": {},
917
- "deprecateAliases": true,
918
- "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.",
919
- "examples": [
920
- "Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org",
921
- "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com",
922
- "Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt"
923
- ],
924
- "flags": {
925
- "json": {
926
- "description": "Format output as json.",
927
- "helpGroup": "GLOBAL",
928
- "name": "json",
929
- "allowNo": false,
930
- "type": "boolean"
931
- },
932
- "flags-dir": {
933
- "helpGroup": "GLOBAL",
934
- "name": "flags-dir",
935
- "summary": "Import flag values from a directory.",
936
- "hasDynamicHelp": false,
937
- "multiple": false,
938
- "type": "option"
939
- },
940
- "target-org": {
941
- "aliases": [
942
- "targetusername",
943
- "u"
944
- ],
945
- "char": "o",
946
- "deprecateAliases": true,
947
- "name": "target-org",
948
- "required": true,
949
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
950
- "hasDynamicHelp": true,
951
- "multiple": false,
952
- "type": "option"
953
- },
954
- "no-prompt": {
955
- "char": "p",
956
- "name": "no-prompt",
957
- "summary": "Don't prompt the user to confirm the deletion.",
958
- "allowNo": false,
959
- "type": "boolean"
960
- }
961
- },
962
- "hasDynamicHelp": true,
963
- "hiddenAliases": [],
964
- "id": "org:delete:scratch",
965
- "pluginAlias": "@salesforce/plugin-org",
966
- "pluginName": "@salesforce/plugin-org",
967
- "pluginType": "core",
968
- "strict": true,
969
- "summary": "Delete a scratch org.",
970
- "enableJsonFlag": true,
971
- "isESM": true,
972
- "relativePath": [
973
- "lib",
974
- "commands",
975
- "org",
976
- "delete",
977
- "scratch.js"
978
- ],
979
- "aliasPermutations": [
980
- "env:delete:scratch",
981
- "delete:env:scratch",
982
- "delete:scratch:env",
983
- "env:scratch:delete",
984
- "scratch:env:delete",
985
- "scratch:delete:env"
986
- ],
987
- "permutations": [
988
- "org:delete:scratch",
989
- "delete:org:scratch",
990
- "delete:scratch:org",
991
- "org:scratch:delete",
992
- "scratch:org:delete",
993
- "scratch:delete:org"
994
- ]
995
- },
996
- "org:disable:tracking": {
997
- "aliases": [],
998
- "args": {},
999
- "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.",
1000
- "examples": [
1001
- "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1002
- "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1003
- "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1004
- ],
1005
- "flags": {
1006
- "json": {
1007
- "description": "Format output as json.",
1008
- "helpGroup": "GLOBAL",
1009
- "name": "json",
1010
- "allowNo": false,
1011
- "type": "boolean"
1012
- },
1013
- "flags-dir": {
1014
- "helpGroup": "GLOBAL",
1015
- "name": "flags-dir",
1016
- "summary": "Import flag values from a directory.",
1017
- "hasDynamicHelp": false,
1018
- "multiple": false,
1019
- "type": "option"
1020
- },
1021
- "target-org": {
1022
- "char": "o",
1023
- "name": "target-org",
1024
- "noCacheDefault": true,
1025
- "required": true,
1026
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1027
- "hasDynamicHelp": true,
1028
- "multiple": false,
1029
- "type": "option"
1030
- }
1031
- },
1032
- "hasDynamicHelp": true,
1033
- "hiddenAliases": [],
1034
- "id": "org:disable:tracking",
1035
- "pluginAlias": "@salesforce/plugin-org",
1036
- "pluginName": "@salesforce/plugin-org",
1037
- "pluginType": "core",
1038
- "strict": true,
1039
- "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
1040
- "enableJsonFlag": true,
1041
- "isESM": true,
1042
- "relativePath": [
1043
- "lib",
1044
- "commands",
1045
- "org",
1046
- "disable",
1047
- "tracking.js"
1048
- ],
1049
- "aliasPermutations": [],
1050
- "permutations": [
1051
- "org:disable:tracking",
1052
- "disable:org:tracking",
1053
- "disable:tracking:org",
1054
- "org:tracking:disable",
1055
- "tracking:org:disable",
1056
- "tracking:disable:org"
1057
- ]
1058
- },
1059
- "org:open:agent": {
1060
- "aliases": [],
1061
- "args": {},
1062
- "description": "Use the --name flag to open an agent using its API name in the Agent Builder UI of your org. To find the agent's API name, go to Setup in your org and navigate to the agent's details page.\n\nTo generate the URL but not launch it in your browser, specify --url-only.\n\nTo open Agent Builder in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
1063
- "examples": [
1064
- "Open the agent with API name Coral_Cloud_Agent in your default org using your default browser:\n$ <%= config.bin %> <%= command.id %> --name Coral_Cloud_Agent",
1065
- "Open the agent in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:",
1066
- "Open the agent in an org with alias MyTestOrg1 using the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox --name Coral_Cloud_Agent"
1067
- ],
1068
- "flags": {
1069
- "json": {
1070
- "description": "Format output as json.",
1071
- "helpGroup": "GLOBAL",
1072
- "name": "json",
1073
- "allowNo": false,
1074
- "type": "boolean"
1075
- },
1076
- "flags-dir": {
1077
- "helpGroup": "GLOBAL",
1078
- "name": "flags-dir",
1079
- "summary": "Import flag values from a directory.",
1080
- "hasDynamicHelp": false,
929
+ "char": "y",
930
+ "name": "duration-days",
931
+ "summary": "Number of days before the org expires.",
932
+ "hasDynamicHelp": true,
933
+ "helpValue": "<days>",
1081
934
  "multiple": false,
1082
935
  "type": "option"
1083
936
  },
1084
- "target-org": {
1085
- "char": "o",
1086
- "name": "target-org",
1087
- "noCacheDefault": true,
1088
- "required": true,
1089
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
937
+ "wait": {
938
+ "char": "w",
939
+ "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.",
940
+ "name": "wait",
941
+ "summary": "Number of minutes to wait for the scratch org to be ready.",
1090
942
  "hasDynamicHelp": true,
943
+ "helpValue": "<minutes>",
1091
944
  "multiple": false,
1092
945
  "type": "option"
1093
946
  },
@@ -1098,80 +951,109 @@
1098
951
  "multiple": false,
1099
952
  "type": "option"
1100
953
  },
1101
- "name": {
1102
- "char": "n",
1103
- "name": "name",
1104
- "required": true,
1105
- "summary": "API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.",
954
+ "client-id": {
955
+ "char": "i",
956
+ "name": "client-id",
957
+ "summary": "Consumer key of the Dev Hub connected app.",
1106
958
  "hasDynamicHelp": false,
1107
959
  "multiple": false,
1108
960
  "type": "option"
1109
961
  },
1110
- "private": {
1111
- "exclusive": [
1112
- "url-only",
1113
- "browser"
1114
- ],
1115
- "name": "private",
1116
- "summary": "Open the org in the default browser using private (incognito) mode.",
1117
- "allowNo": false,
962
+ "track-source": {
963
+ "char": "t",
964
+ "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.",
965
+ "name": "track-source",
966
+ "summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
967
+ "allowNo": true,
1118
968
  "type": "boolean"
1119
969
  },
1120
- "browser": {
1121
- "char": "b",
1122
- "exclusive": [
1123
- "url-only",
1124
- "private"
1125
- ],
1126
- "name": "browser",
1127
- "summary": "Browser where the org opens.",
970
+ "username": {
971
+ "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.",
972
+ "helpGroup": "Definition File Override",
973
+ "name": "username",
974
+ "summary": "Username of the scratch org admin user. Overrides the value of the \"username\" option in the definition file, if set.",
975
+ "hasDynamicHelp": false,
976
+ "multiple": false,
977
+ "type": "option"
978
+ },
979
+ "description": {
980
+ "helpGroup": "Definition File Override",
981
+ "name": "description",
982
+ "summary": "Description of the scratch org in the Dev Hub. Overrides the value of the \"description\" option in the definition file, if set.",
983
+ "hasDynamicHelp": false,
984
+ "multiple": false,
985
+ "type": "option"
986
+ },
987
+ "name": {
988
+ "helpGroup": "Definition File Override",
989
+ "name": "name",
990
+ "summary": "Name of the org, such as \"Acme Company\". Overrides the value of the \"orgName\" option in the definition file, if set.",
991
+ "hasDynamicHelp": false,
992
+ "multiple": false,
993
+ "type": "option"
994
+ },
995
+ "release": {
996
+ "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.",
997
+ "helpGroup": "Definition File Override",
998
+ "name": "release",
999
+ "summary": "Release of the scratch org as compared to the Dev Hub release.",
1128
1000
  "hasDynamicHelp": false,
1129
1001
  "multiple": false,
1130
1002
  "options": [
1131
- "chrome",
1132
- "edge",
1133
- "firefox"
1003
+ "preview",
1004
+ "previous"
1134
1005
  ],
1135
1006
  "type": "option"
1136
1007
  },
1137
- "url-only": {
1138
- "aliases": [
1139
- "urlonly"
1140
- ],
1141
- "char": "r",
1142
- "deprecateAliases": true,
1143
- "name": "url-only",
1144
- "summary": "Display navigation URL, but don’t launch browser.",
1145
- "allowNo": false,
1146
- "type": "boolean"
1008
+ "admin-email": {
1009
+ "helpGroup": "Definition File Override",
1010
+ "name": "admin-email",
1011
+ "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.",
1012
+ "hasDynamicHelp": false,
1013
+ "multiple": false,
1014
+ "type": "option"
1015
+ },
1016
+ "source-org": {
1017
+ "helpGroup": "Definition File Override",
1018
+ "name": "source-org",
1019
+ "summary": "15-character ID of the org whose shape the new scratch org will be based on. Overrides the value of the \"sourceOrg\" option in the definition file, if set.",
1020
+ "hasDynamicHelp": false,
1021
+ "multiple": false,
1022
+ "type": "option"
1147
1023
  }
1148
1024
  },
1149
1025
  "hasDynamicHelp": true,
1150
1026
  "hiddenAliases": [],
1151
- "id": "org:open:agent",
1027
+ "id": "org:create:scratch",
1152
1028
  "pluginAlias": "@salesforce/plugin-org",
1153
1029
  "pluginName": "@salesforce/plugin-org",
1154
1030
  "pluginType": "core",
1155
- "state": "beta",
1156
1031
  "strict": true,
1157
- "summary": "Open an agent in your org's Agent Builder UI in a browser.",
1032
+ "summary": "Create a scratch org.",
1158
1033
  "enableJsonFlag": true,
1159
1034
  "isESM": true,
1160
1035
  "relativePath": [
1161
1036
  "lib",
1162
1037
  "commands",
1163
1038
  "org",
1164
- "open",
1165
- "agent.js"
1039
+ "create",
1040
+ "scratch.js"
1041
+ ],
1042
+ "aliasPermutations": [
1043
+ "env:create:scratch",
1044
+ "create:env:scratch",
1045
+ "create:scratch:env",
1046
+ "env:scratch:create",
1047
+ "scratch:env:create",
1048
+ "scratch:create:env"
1166
1049
  ],
1167
- "aliasPermutations": [],
1168
1050
  "permutations": [
1169
- "org:open:agent",
1170
- "open:org:agent",
1171
- "open:agent:org",
1172
- "org:agent:open",
1173
- "agent:org:open",
1174
- "agent:open:org"
1051
+ "org:create:scratch",
1052
+ "create:org:scratch",
1053
+ "create:scratch:org",
1054
+ "org:scratch:create",
1055
+ "scratch:org:create",
1056
+ "scratch:create:org"
1175
1057
  ]
1176
1058
  },
1177
1059
  "org:list:metadata-types": {
@@ -1624,6 +1506,124 @@
1624
1506
  "sandbox:refresh:org"
1625
1507
  ]
1626
1508
  },
1509
+ "org:open:agent": {
1510
+ "aliases": [],
1511
+ "args": {},
1512
+ "description": "Use the --name flag to open an agent using its API name in the Agent Builder UI of your org. To find the agent's API name, go to Setup in your org and navigate to the agent's details page.\n\nTo generate the URL but not launch it in your browser, specify --url-only.\n\nTo open Agent Builder in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
1513
+ "examples": [
1514
+ "Open the agent with API name Coral_Cloud_Agent in your default org using your default browser:\n$ <%= config.bin %> <%= command.id %> --name Coral_Cloud_Agent",
1515
+ "Open the agent in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:",
1516
+ "Open the agent in an org with alias MyTestOrg1 using the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox --name Coral_Cloud_Agent"
1517
+ ],
1518
+ "flags": {
1519
+ "json": {
1520
+ "description": "Format output as json.",
1521
+ "helpGroup": "GLOBAL",
1522
+ "name": "json",
1523
+ "allowNo": false,
1524
+ "type": "boolean"
1525
+ },
1526
+ "flags-dir": {
1527
+ "helpGroup": "GLOBAL",
1528
+ "name": "flags-dir",
1529
+ "summary": "Import flag values from a directory.",
1530
+ "hasDynamicHelp": false,
1531
+ "multiple": false,
1532
+ "type": "option"
1533
+ },
1534
+ "target-org": {
1535
+ "char": "o",
1536
+ "name": "target-org",
1537
+ "noCacheDefault": true,
1538
+ "required": true,
1539
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1540
+ "hasDynamicHelp": true,
1541
+ "multiple": false,
1542
+ "type": "option"
1543
+ },
1544
+ "api-version": {
1545
+ "description": "Override the api version used for api requests made by this command",
1546
+ "name": "api-version",
1547
+ "hasDynamicHelp": false,
1548
+ "multiple": false,
1549
+ "type": "option"
1550
+ },
1551
+ "name": {
1552
+ "char": "n",
1553
+ "name": "name",
1554
+ "required": true,
1555
+ "summary": "API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.",
1556
+ "hasDynamicHelp": false,
1557
+ "multiple": false,
1558
+ "type": "option"
1559
+ },
1560
+ "private": {
1561
+ "exclusive": [
1562
+ "url-only",
1563
+ "browser"
1564
+ ],
1565
+ "name": "private",
1566
+ "summary": "Open the org in the default browser using private (incognito) mode.",
1567
+ "allowNo": false,
1568
+ "type": "boolean"
1569
+ },
1570
+ "browser": {
1571
+ "char": "b",
1572
+ "exclusive": [
1573
+ "url-only",
1574
+ "private"
1575
+ ],
1576
+ "name": "browser",
1577
+ "summary": "Browser where the org opens.",
1578
+ "hasDynamicHelp": false,
1579
+ "multiple": false,
1580
+ "options": [
1581
+ "chrome",
1582
+ "edge",
1583
+ "firefox"
1584
+ ],
1585
+ "type": "option"
1586
+ },
1587
+ "url-only": {
1588
+ "aliases": [
1589
+ "urlonly"
1590
+ ],
1591
+ "char": "r",
1592
+ "deprecateAliases": true,
1593
+ "name": "url-only",
1594
+ "summary": "Display navigation URL, but don’t launch browser.",
1595
+ "allowNo": false,
1596
+ "type": "boolean"
1597
+ }
1598
+ },
1599
+ "hasDynamicHelp": true,
1600
+ "hiddenAliases": [],
1601
+ "id": "org:open:agent",
1602
+ "pluginAlias": "@salesforce/plugin-org",
1603
+ "pluginName": "@salesforce/plugin-org",
1604
+ "pluginType": "core",
1605
+ "state": "beta",
1606
+ "strict": true,
1607
+ "summary": "Open an agent in your org's Agent Builder UI in a browser.",
1608
+ "enableJsonFlag": true,
1609
+ "isESM": true,
1610
+ "relativePath": [
1611
+ "lib",
1612
+ "commands",
1613
+ "org",
1614
+ "open",
1615
+ "agent.js"
1616
+ ],
1617
+ "aliasPermutations": [],
1618
+ "permutations": [
1619
+ "org:open:agent",
1620
+ "open:org:agent",
1621
+ "open:agent:org",
1622
+ "org:agent:open",
1623
+ "agent:org:open",
1624
+ "agent:open:org"
1625
+ ]
1626
+ },
1627
1627
  "org:resume:sandbox": {
1628
1628
  "aliases": [
1629
1629
  "env:resume:sandbox"
@@ -1816,5 +1816,5 @@
1816
1816
  ]
1817
1817
  }
1818
1818
  },
1819
- "version": "5.2.26"
1819
+ "version": "5.2.27"
1820
1820
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-org",
3
3
  "description": "Commands to interact with Salesforce orgs",
4
- "version": "5.2.26",
4
+ "version": "5.2.27",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -9,7 +9,7 @@
9
9
  "@oclif/multi-stage-output": "^0.8.5",
10
10
  "@salesforce/core": "^8.8.2",
11
11
  "@salesforce/kit": "^3.2.3",
12
- "@salesforce/sf-plugins-core": "^12.1.2",
12
+ "@salesforce/sf-plugins-core": "^12.1.3",
13
13
  "@salesforce/source-deploy-retrieve": "^12.14.0",
14
14
  "@salesforce/ts-types": "^2.0.12",
15
15
  "ansis": "^3.9.0",
@@ -227,7 +227,7 @@
227
227
  "exports": "./lib/index.js",
228
228
  "type": "module",
229
229
  "sfdx": {
230
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.26.crt",
231
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.26.sig"
230
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.27.crt",
231
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.27.sig"
232
232
  }
233
233
  }