@salesforce/plugin-org 5.11.23-eca.1 → 5.11.23
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.
- package/README.md +20 -20
- package/oclif.manifest.json +590 -590
- package/package.json +4 -7
package/oclif.manifest.json
CHANGED
|
@@ -385,14 +385,15 @@
|
|
|
385
385
|
"open:org"
|
|
386
386
|
]
|
|
387
387
|
},
|
|
388
|
-
"org:
|
|
388
|
+
"org:auth:show-access-token": {
|
|
389
389
|
"aliases": [],
|
|
390
390
|
"args": {},
|
|
391
|
-
"description": "
|
|
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.",
|
|
392
392
|
"examples": [
|
|
393
|
-
"
|
|
394
|
-
"
|
|
395
|
-
"
|
|
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"
|
|
396
397
|
],
|
|
397
398
|
"flags": {
|
|
398
399
|
"json": {
|
|
@@ -420,77 +421,50 @@
|
|
|
420
421
|
"multiple": false,
|
|
421
422
|
"type": "option"
|
|
422
423
|
},
|
|
423
|
-
"
|
|
424
|
-
"
|
|
425
|
-
"name": "
|
|
426
|
-
"
|
|
427
|
-
"
|
|
428
|
-
"type": "
|
|
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"
|
|
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"
|
|
453
430
|
}
|
|
454
431
|
},
|
|
455
432
|
"hasDynamicHelp": true,
|
|
456
433
|
"hiddenAliases": [],
|
|
457
|
-
"id": "org:
|
|
434
|
+
"id": "org:auth:show-access-token",
|
|
458
435
|
"pluginAlias": "@salesforce/plugin-org",
|
|
459
436
|
"pluginName": "@salesforce/plugin-org",
|
|
460
437
|
"pluginType": "core",
|
|
461
438
|
"strict": true,
|
|
462
|
-
"summary": "
|
|
439
|
+
"summary": "Show the current access token for an org.",
|
|
463
440
|
"enableJsonFlag": true,
|
|
464
441
|
"isESM": true,
|
|
465
442
|
"relativePath": [
|
|
466
443
|
"lib",
|
|
467
444
|
"commands",
|
|
468
445
|
"org",
|
|
469
|
-
"
|
|
470
|
-
"
|
|
446
|
+
"auth",
|
|
447
|
+
"show-access-token.js"
|
|
471
448
|
],
|
|
472
449
|
"aliasPermutations": [],
|
|
473
450
|
"permutations": [
|
|
474
|
-
"org:
|
|
475
|
-
"
|
|
476
|
-
"
|
|
477
|
-
"org:
|
|
478
|
-
"
|
|
479
|
-
"
|
|
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"
|
|
480
457
|
]
|
|
481
458
|
},
|
|
482
|
-
"org:
|
|
483
|
-
"aliases": [
|
|
484
|
-
"env:create:sandbox"
|
|
485
|
-
],
|
|
459
|
+
"org:auth:show-sfdx-auth-url": {
|
|
460
|
+
"aliases": [],
|
|
486
461
|
"args": {},
|
|
487
|
-
"
|
|
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.",
|
|
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.",
|
|
489
463
|
"examples": [
|
|
490
|
-
"
|
|
491
|
-
"
|
|
492
|
-
"
|
|
493
|
-
"
|
|
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"
|
|
494
468
|
],
|
|
495
469
|
"flags": {
|
|
496
470
|
"json": {
|
|
@@ -508,193 +482,60 @@
|
|
|
508
482
|
"multiple": false,
|
|
509
483
|
"type": "option"
|
|
510
484
|
},
|
|
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
|
-
},
|
|
628
485
|
"target-org": {
|
|
629
486
|
"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.",
|
|
631
487
|
"name": "target-org",
|
|
632
488
|
"noCacheDefault": true,
|
|
633
489
|
"required": true,
|
|
634
|
-
"summary": "Username or alias of the
|
|
490
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
635
491
|
"hasDynamicHelp": true,
|
|
636
492
|
"multiple": false,
|
|
637
493
|
"type": "option"
|
|
638
494
|
},
|
|
639
495
|
"no-prompt": {
|
|
496
|
+
"char": "p",
|
|
640
497
|
"name": "no-prompt",
|
|
641
|
-
"summary": "
|
|
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.",
|
|
498
|
+
"summary": "Skip the security warning and reveal the SFDX Auth URL without confirmation.",
|
|
649
499
|
"allowNo": false,
|
|
650
500
|
"type": "boolean"
|
|
651
501
|
}
|
|
652
502
|
},
|
|
653
503
|
"hasDynamicHelp": true,
|
|
654
504
|
"hiddenAliases": [],
|
|
655
|
-
"id": "org:
|
|
505
|
+
"id": "org:auth:show-sfdx-auth-url",
|
|
656
506
|
"pluginAlias": "@salesforce/plugin-org",
|
|
657
507
|
"pluginName": "@salesforce/plugin-org",
|
|
658
508
|
"pluginType": "core",
|
|
659
509
|
"strict": true,
|
|
660
|
-
"summary": "
|
|
510
|
+
"summary": "Show the SFDX Auth URL for an org.",
|
|
511
|
+
"enableJsonFlag": true,
|
|
661
512
|
"isESM": true,
|
|
662
513
|
"relativePath": [
|
|
663
514
|
"lib",
|
|
664
515
|
"commands",
|
|
665
516
|
"org",
|
|
666
|
-
"
|
|
667
|
-
"
|
|
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"
|
|
517
|
+
"auth",
|
|
518
|
+
"show-sfdx-auth-url.js"
|
|
676
519
|
],
|
|
520
|
+
"aliasPermutations": [],
|
|
677
521
|
"permutations": [
|
|
678
|
-
"org:
|
|
679
|
-
"
|
|
680
|
-
"
|
|
681
|
-
"org:
|
|
682
|
-
"
|
|
683
|
-
"
|
|
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"
|
|
684
528
|
]
|
|
685
529
|
},
|
|
686
|
-
"org:
|
|
687
|
-
"aliases": [
|
|
688
|
-
"env:create:scratch"
|
|
689
|
-
],
|
|
530
|
+
"org:auth:show-user-password": {
|
|
531
|
+
"aliases": [],
|
|
690
532
|
"args": {},
|
|
691
|
-
"
|
|
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.",
|
|
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.",
|
|
693
534
|
"examples": [
|
|
694
|
-
"
|
|
695
|
-
"
|
|
696
|
-
"
|
|
697
|
-
"
|
|
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"
|
|
698
539
|
],
|
|
699
540
|
"flags": {
|
|
700
541
|
"json": {
|
|
@@ -712,237 +553,49 @@
|
|
|
712
553
|
"multiple": false,
|
|
713
554
|
"type": "option"
|
|
714
555
|
},
|
|
715
|
-
"
|
|
716
|
-
"char": "
|
|
717
|
-
"
|
|
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",
|
|
556
|
+
"target-org": {
|
|
557
|
+
"char": "o",
|
|
558
|
+
"name": "target-org",
|
|
751
559
|
"noCacheDefault": true,
|
|
752
560
|
"required": true,
|
|
753
|
-
"summary": "Username or alias of the
|
|
561
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
754
562
|
"hasDynamicHelp": true,
|
|
755
563
|
"multiple": false,
|
|
756
564
|
"type": "option"
|
|
757
565
|
},
|
|
758
|
-
"no-
|
|
759
|
-
"char": "
|
|
760
|
-
"
|
|
761
|
-
"
|
|
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.",
|
|
566
|
+
"no-prompt": {
|
|
567
|
+
"char": "p",
|
|
568
|
+
"name": "no-prompt",
|
|
569
|
+
"summary": "Skip the security warning and reveal the password without confirmation.",
|
|
809
570
|
"allowNo": false,
|
|
810
571
|
"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"
|
|
912
572
|
}
|
|
913
573
|
},
|
|
914
574
|
"hasDynamicHelp": true,
|
|
915
575
|
"hiddenAliases": [],
|
|
916
|
-
"id": "org:
|
|
576
|
+
"id": "org:auth:show-user-password",
|
|
917
577
|
"pluginAlias": "@salesforce/plugin-org",
|
|
918
578
|
"pluginName": "@salesforce/plugin-org",
|
|
919
579
|
"pluginType": "core",
|
|
920
580
|
"strict": true,
|
|
921
|
-
"summary": "
|
|
581
|
+
"summary": "Show the stored password for an org's user.",
|
|
922
582
|
"enableJsonFlag": true,
|
|
923
583
|
"isESM": true,
|
|
924
584
|
"relativePath": [
|
|
925
585
|
"lib",
|
|
926
586
|
"commands",
|
|
927
587
|
"org",
|
|
928
|
-
"
|
|
929
|
-
"
|
|
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"
|
|
588
|
+
"auth",
|
|
589
|
+
"show-user-password.js"
|
|
938
590
|
],
|
|
591
|
+
"aliasPermutations": [],
|
|
939
592
|
"permutations": [
|
|
940
|
-
"org:
|
|
941
|
-
"
|
|
942
|
-
"
|
|
943
|
-
"org:
|
|
944
|
-
"
|
|
945
|
-
"
|
|
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"
|
|
946
599
|
]
|
|
947
600
|
},
|
|
948
601
|
"org:delete:sandbox": {
|
|
@@ -1113,14 +766,14 @@
|
|
|
1113
766
|
"scratch:delete:org"
|
|
1114
767
|
]
|
|
1115
768
|
},
|
|
1116
|
-
"org:
|
|
769
|
+
"org:create:agent-user": {
|
|
1117
770
|
"aliases": [],
|
|
1118
771
|
"args": {},
|
|
1119
|
-
"description": "
|
|
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.",
|
|
1120
773
|
"examples": [
|
|
1121
|
-
"
|
|
1122
|
-
"
|
|
1123
|
-
"
|
|
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"
|
|
1124
777
|
],
|
|
1125
778
|
"flags": {
|
|
1126
779
|
"json": {
|
|
@@ -1147,44 +800,282 @@
|
|
|
1147
800
|
"hasDynamicHelp": true,
|
|
1148
801
|
"multiple": false,
|
|
1149
802
|
"type": "option"
|
|
1150
|
-
}
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
803
|
+
},
|
|
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"
|
|
834
|
+
}
|
|
835
|
+
},
|
|
836
|
+
"hasDynamicHelp": true,
|
|
837
|
+
"hiddenAliases": [],
|
|
838
|
+
"id": "org:create:agent-user",
|
|
839
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
840
|
+
"pluginName": "@salesforce/plugin-org",
|
|
841
|
+
"pluginType": "core",
|
|
842
|
+
"strict": true,
|
|
843
|
+
"summary": "Create the default Salesforce user that is used to run an agent.",
|
|
844
|
+
"enableJsonFlag": true,
|
|
845
|
+
"isESM": true,
|
|
846
|
+
"relativePath": [
|
|
847
|
+
"lib",
|
|
848
|
+
"commands",
|
|
1165
849
|
"org",
|
|
1166
|
-
"
|
|
1167
|
-
"
|
|
850
|
+
"create",
|
|
851
|
+
"agent-user.js"
|
|
1168
852
|
],
|
|
1169
853
|
"aliasPermutations": [],
|
|
1170
854
|
"permutations": [
|
|
1171
|
-
"org:
|
|
1172
|
-
"
|
|
1173
|
-
"
|
|
1174
|
-
"org:
|
|
1175
|
-
"
|
|
1176
|
-
"
|
|
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"
|
|
1177
861
|
]
|
|
1178
862
|
},
|
|
1179
|
-
"org:
|
|
1180
|
-
"aliases": [
|
|
863
|
+
"org:create:sandbox": {
|
|
864
|
+
"aliases": [
|
|
865
|
+
"env:create:sandbox"
|
|
866
|
+
],
|
|
1181
867
|
"args": {},
|
|
1182
|
-
"
|
|
868
|
+
"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.",
|
|
1183
870
|
"examples": [
|
|
1184
|
-
"
|
|
1185
|
-
"
|
|
1186
|
-
"
|
|
1187
|
-
"
|
|
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"
|
|
875
|
+
],
|
|
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"
|
|
1188
1079
|
],
|
|
1189
1080
|
"flags": {
|
|
1190
1081
|
"json": {
|
|
@@ -1194,68 +1085,255 @@
|
|
|
1194
1085
|
"allowNo": false,
|
|
1195
1086
|
"type": "boolean"
|
|
1196
1087
|
},
|
|
1197
|
-
"flags-dir": {
|
|
1198
|
-
"helpGroup": "GLOBAL",
|
|
1199
|
-
"name": "flags-dir",
|
|
1200
|
-
"summary": "Import flag values from a directory.",
|
|
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,
|
|
1233
|
+
"type": "boolean"
|
|
1234
|
+
},
|
|
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.",
|
|
1201
1240
|
"hasDynamicHelp": false,
|
|
1202
1241
|
"multiple": false,
|
|
1203
1242
|
"type": "option"
|
|
1204
1243
|
},
|
|
1205
|
-
"
|
|
1206
|
-
"
|
|
1207
|
-
"name": "
|
|
1208
|
-
"
|
|
1209
|
-
"
|
|
1210
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1211
|
-
"hasDynamicHelp": true,
|
|
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,
|
|
1212
1249
|
"multiple": false,
|
|
1213
1250
|
"type": "option"
|
|
1214
1251
|
},
|
|
1215
|
-
"
|
|
1216
|
-
"
|
|
1217
|
-
"name": "
|
|
1218
|
-
"summary": "
|
|
1219
|
-
"
|
|
1220
|
-
"
|
|
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.",
|
|
1256
|
+
"hasDynamicHelp": false,
|
|
1257
|
+
"multiple": false,
|
|
1258
|
+
"type": "option"
|
|
1259
|
+
},
|
|
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"
|
|
1270
|
+
],
|
|
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,
|
|
1278
|
+
"multiple": false,
|
|
1279
|
+
"type": "option"
|
|
1280
|
+
},
|
|
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"
|
|
1221
1293
|
}
|
|
1222
1294
|
},
|
|
1223
1295
|
"hasDynamicHelp": true,
|
|
1224
1296
|
"hiddenAliases": [],
|
|
1225
|
-
"id": "org:
|
|
1297
|
+
"id": "org:create:scratch",
|
|
1226
1298
|
"pluginAlias": "@salesforce/plugin-org",
|
|
1227
1299
|
"pluginName": "@salesforce/plugin-org",
|
|
1228
1300
|
"pluginType": "core",
|
|
1229
1301
|
"strict": true,
|
|
1230
|
-
"summary": "
|
|
1302
|
+
"summary": "Create a scratch org.",
|
|
1231
1303
|
"enableJsonFlag": true,
|
|
1232
1304
|
"isESM": true,
|
|
1233
1305
|
"relativePath": [
|
|
1234
1306
|
"lib",
|
|
1235
1307
|
"commands",
|
|
1236
1308
|
"org",
|
|
1237
|
-
"
|
|
1238
|
-
"
|
|
1309
|
+
"create",
|
|
1310
|
+
"scratch.js"
|
|
1311
|
+
],
|
|
1312
|
+
"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"
|
|
1239
1319
|
],
|
|
1240
|
-
"aliasPermutations": [],
|
|
1241
1320
|
"permutations": [
|
|
1242
|
-
"org:
|
|
1243
|
-
"
|
|
1244
|
-
"
|
|
1245
|
-
"org:
|
|
1246
|
-
"
|
|
1247
|
-
"
|
|
1321
|
+
"org:create:scratch",
|
|
1322
|
+
"create:org:scratch",
|
|
1323
|
+
"create:scratch:org",
|
|
1324
|
+
"org:scratch:create",
|
|
1325
|
+
"scratch:org:create",
|
|
1326
|
+
"scratch:create:org"
|
|
1248
1327
|
]
|
|
1249
1328
|
},
|
|
1250
|
-
"org:
|
|
1329
|
+
"org:disable:tracking": {
|
|
1251
1330
|
"aliases": [],
|
|
1252
1331
|
"args": {},
|
|
1253
|
-
"description": "
|
|
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.",
|
|
1254
1333
|
"examples": [
|
|
1255
|
-
"
|
|
1256
|
-
"
|
|
1257
|
-
"
|
|
1258
|
-
"Get the SFDX Auth URL as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json"
|
|
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 %>"
|
|
1259
1337
|
],
|
|
1260
1338
|
"flags": {
|
|
1261
1339
|
"json": {
|
|
@@ -1282,51 +1360,43 @@
|
|
|
1282
1360
|
"hasDynamicHelp": true,
|
|
1283
1361
|
"multiple": false,
|
|
1284
1362
|
"type": "option"
|
|
1285
|
-
},
|
|
1286
|
-
"no-prompt": {
|
|
1287
|
-
"char": "p",
|
|
1288
|
-
"name": "no-prompt",
|
|
1289
|
-
"summary": "Skip the security warning and reveal the SFDX Auth URL without confirmation.",
|
|
1290
|
-
"allowNo": false,
|
|
1291
|
-
"type": "boolean"
|
|
1292
1363
|
}
|
|
1293
1364
|
},
|
|
1294
1365
|
"hasDynamicHelp": true,
|
|
1295
1366
|
"hiddenAliases": [],
|
|
1296
|
-
"id": "org:
|
|
1367
|
+
"id": "org:disable:tracking",
|
|
1297
1368
|
"pluginAlias": "@salesforce/plugin-org",
|
|
1298
1369
|
"pluginName": "@salesforce/plugin-org",
|
|
1299
1370
|
"pluginType": "core",
|
|
1300
1371
|
"strict": true,
|
|
1301
|
-
"summary": "
|
|
1372
|
+
"summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
|
|
1302
1373
|
"enableJsonFlag": true,
|
|
1303
1374
|
"isESM": true,
|
|
1304
1375
|
"relativePath": [
|
|
1305
1376
|
"lib",
|
|
1306
1377
|
"commands",
|
|
1307
1378
|
"org",
|
|
1308
|
-
"
|
|
1309
|
-
"
|
|
1379
|
+
"disable",
|
|
1380
|
+
"tracking.js"
|
|
1310
1381
|
],
|
|
1311
1382
|
"aliasPermutations": [],
|
|
1312
1383
|
"permutations": [
|
|
1313
|
-
"org:
|
|
1314
|
-
"
|
|
1315
|
-
"
|
|
1316
|
-
"org:
|
|
1317
|
-
"
|
|
1318
|
-
"
|
|
1384
|
+
"org:disable:tracking",
|
|
1385
|
+
"disable:org:tracking",
|
|
1386
|
+
"disable:tracking:org",
|
|
1387
|
+
"org:tracking:disable",
|
|
1388
|
+
"tracking:org:disable",
|
|
1389
|
+
"tracking:disable:org"
|
|
1319
1390
|
]
|
|
1320
1391
|
},
|
|
1321
|
-
"org:
|
|
1392
|
+
"org:enable:tracking": {
|
|
1322
1393
|
"aliases": [],
|
|
1323
1394
|
"args": {},
|
|
1324
|
-
"description": "
|
|
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.",
|
|
1325
1396
|
"examples": [
|
|
1326
|
-
"
|
|
1327
|
-
"
|
|
1328
|
-
"
|
|
1329
|
-
"Get the password as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json"
|
|
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 %>"
|
|
1330
1400
|
],
|
|
1331
1401
|
"flags": {
|
|
1332
1402
|
"json": {
|
|
@@ -1353,40 +1423,33 @@
|
|
|
1353
1423
|
"hasDynamicHelp": true,
|
|
1354
1424
|
"multiple": false,
|
|
1355
1425
|
"type": "option"
|
|
1356
|
-
},
|
|
1357
|
-
"no-prompt": {
|
|
1358
|
-
"char": "p",
|
|
1359
|
-
"name": "no-prompt",
|
|
1360
|
-
"summary": "Skip the security warning and reveal the password without confirmation.",
|
|
1361
|
-
"allowNo": false,
|
|
1362
|
-
"type": "boolean"
|
|
1363
1426
|
}
|
|
1364
1427
|
},
|
|
1365
1428
|
"hasDynamicHelp": true,
|
|
1366
1429
|
"hiddenAliases": [],
|
|
1367
|
-
"id": "org:
|
|
1430
|
+
"id": "org:enable:tracking",
|
|
1368
1431
|
"pluginAlias": "@salesforce/plugin-org",
|
|
1369
1432
|
"pluginName": "@salesforce/plugin-org",
|
|
1370
1433
|
"pluginType": "core",
|
|
1371
1434
|
"strict": true,
|
|
1372
|
-
"summary": "
|
|
1435
|
+
"summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
|
|
1373
1436
|
"enableJsonFlag": true,
|
|
1374
1437
|
"isESM": true,
|
|
1375
1438
|
"relativePath": [
|
|
1376
1439
|
"lib",
|
|
1377
1440
|
"commands",
|
|
1378
1441
|
"org",
|
|
1379
|
-
"
|
|
1380
|
-
"
|
|
1442
|
+
"enable",
|
|
1443
|
+
"tracking.js"
|
|
1381
1444
|
],
|
|
1382
1445
|
"aliasPermutations": [],
|
|
1383
1446
|
"permutations": [
|
|
1384
|
-
"org:
|
|
1385
|
-
"
|
|
1386
|
-
"
|
|
1387
|
-
"org:
|
|
1388
|
-
"
|
|
1389
|
-
"
|
|
1447
|
+
"org:enable:tracking",
|
|
1448
|
+
"enable:org:tracking",
|
|
1449
|
+
"enable:tracking:org",
|
|
1450
|
+
"org:tracking:enable",
|
|
1451
|
+
"tracking:org:enable",
|
|
1452
|
+
"tracking:enable:org"
|
|
1390
1453
|
]
|
|
1391
1454
|
},
|
|
1392
1455
|
"org:list:metadata-types": {
|
|
@@ -1648,69 +1711,6 @@
|
|
|
1648
1711
|
"metadata:list:org"
|
|
1649
1712
|
]
|
|
1650
1713
|
},
|
|
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.23
|
|
2312
|
+
"version": "5.11.23"
|
|
2313
2313
|
}
|