@salesforce/plugin-agent 2.2.3 → 2.2.4
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 +41 -41
- package/oclif.manifest.json +1688 -1688
- package/package.json +9 -4
package/oclif.manifest.json
CHANGED
|
@@ -426,16 +426,14 @@
|
|
|
426
426
|
"preview:agent"
|
|
427
427
|
]
|
|
428
428
|
},
|
|
429
|
-
"agent:
|
|
429
|
+
"agent:adl:create": {
|
|
430
430
|
"aliases": [],
|
|
431
431
|
"args": {},
|
|
432
|
-
"description": "
|
|
432
|
+
"description": "Creates a new data library in the target org. The --source-type flag determines the type of library: SFDRIVE (file upload), KNOWLEDGE (Salesforce Knowledge articles), or RETRIEVER (existing active Custom Retriever).\n\nFor SFDRIVE libraries, creation provisions the full Data Cloud pipeline (DLO → DMO → SearchIndex → Retriever). Upload files with `sf agent adl upload` after creation.",
|
|
433
433
|
"examples": [
|
|
434
|
-
"
|
|
435
|
-
"
|
|
436
|
-
"
|
|
437
|
-
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
438
|
-
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
434
|
+
"Create an SFDRIVE library:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"My Docs\" --developer-name My_Docs --source-type sfdrive",
|
|
435
|
+
"Create a KNOWLEDGE library with index fields:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"KB Library\" --developer-name KB_Library --source-type knowledge --primary-index-field1 Title --primary-index-field2 Summary",
|
|
436
|
+
"Create a RETRIEVER library:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"Existing Retriever\" --developer-name Existing_Retriever --source-type retriever --retriever-id 0ppXX0000000001"
|
|
439
437
|
],
|
|
440
438
|
"flags": {
|
|
441
439
|
"json": {
|
|
@@ -470,164 +468,138 @@
|
|
|
470
468
|
"multiple": false,
|
|
471
469
|
"type": "option"
|
|
472
470
|
},
|
|
473
|
-
"
|
|
474
|
-
"
|
|
475
|
-
"
|
|
476
|
-
"
|
|
477
|
-
"
|
|
478
|
-
"options": [
|
|
479
|
-
"customer",
|
|
480
|
-
"internal"
|
|
481
|
-
],
|
|
482
|
-
"type": "option"
|
|
483
|
-
},
|
|
484
|
-
"role": {
|
|
485
|
-
"name": "role",
|
|
486
|
-
"summary": "Role of the agent.",
|
|
471
|
+
"name": {
|
|
472
|
+
"char": "n",
|
|
473
|
+
"name": "name",
|
|
474
|
+
"required": true,
|
|
475
|
+
"summary": "Display name for the data library (max 80 characters).",
|
|
487
476
|
"hasDynamicHelp": false,
|
|
488
477
|
"multiple": false,
|
|
489
478
|
"type": "option"
|
|
490
479
|
},
|
|
491
|
-
"
|
|
492
|
-
"name": "
|
|
493
|
-
"
|
|
480
|
+
"developer-name": {
|
|
481
|
+
"name": "developer-name",
|
|
482
|
+
"required": true,
|
|
483
|
+
"summary": "API name for the data library (max 80 characters, alphanumeric and underscores only, must start with a letter).",
|
|
494
484
|
"hasDynamicHelp": false,
|
|
495
485
|
"multiple": false,
|
|
496
486
|
"type": "option"
|
|
497
487
|
},
|
|
498
|
-
"
|
|
499
|
-
"name": "
|
|
500
|
-
"
|
|
488
|
+
"source-type": {
|
|
489
|
+
"name": "source-type",
|
|
490
|
+
"required": true,
|
|
491
|
+
"summary": "Type of grounding source: sfdrive (file upload), knowledge (Salesforce Knowledge articles), or retriever (existing active Custom Retriever).",
|
|
501
492
|
"hasDynamicHelp": false,
|
|
502
493
|
"multiple": false,
|
|
494
|
+
"options": [
|
|
495
|
+
"sfdrive",
|
|
496
|
+
"knowledge",
|
|
497
|
+
"retriever"
|
|
498
|
+
],
|
|
503
499
|
"type": "option"
|
|
504
500
|
},
|
|
505
|
-
"
|
|
506
|
-
"name": "
|
|
507
|
-
"summary": "
|
|
501
|
+
"description": {
|
|
502
|
+
"name": "description",
|
|
503
|
+
"summary": "Description of the data library (max 255 characters).",
|
|
508
504
|
"hasDynamicHelp": false,
|
|
509
505
|
"multiple": false,
|
|
510
506
|
"type": "option"
|
|
511
507
|
},
|
|
512
|
-
"
|
|
513
|
-
"name": "
|
|
514
|
-
"summary": "
|
|
508
|
+
"index-mode": {
|
|
509
|
+
"name": "index-mode",
|
|
510
|
+
"summary": "Index mode for SFDRIVE libraries: basic or enhanced.",
|
|
515
511
|
"hasDynamicHelp": false,
|
|
516
512
|
"multiple": false,
|
|
513
|
+
"options": [
|
|
514
|
+
"basic",
|
|
515
|
+
"enhanced"
|
|
516
|
+
],
|
|
517
517
|
"type": "option"
|
|
518
518
|
},
|
|
519
|
-
"
|
|
520
|
-
"name": "
|
|
521
|
-
"summary": "
|
|
519
|
+
"retriever-id": {
|
|
520
|
+
"name": "retriever-id",
|
|
521
|
+
"summary": "ID of an active Custom Retriever (required for RETRIEVER source type; retriever must be active).",
|
|
522
522
|
"hasDynamicHelp": false,
|
|
523
523
|
"multiple": false,
|
|
524
524
|
"type": "option"
|
|
525
525
|
},
|
|
526
|
-
"
|
|
527
|
-
"name": "
|
|
528
|
-
"summary": "
|
|
526
|
+
"primary-index-field1": {
|
|
527
|
+
"name": "primary-index-field1",
|
|
528
|
+
"summary": "Primary index field 1 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
529
529
|
"hasDynamicHelp": false,
|
|
530
530
|
"multiple": false,
|
|
531
|
-
"options": [
|
|
532
|
-
"true",
|
|
533
|
-
"false"
|
|
534
|
-
],
|
|
535
531
|
"type": "option"
|
|
536
532
|
},
|
|
537
|
-
"
|
|
538
|
-
"name": "
|
|
539
|
-
"summary": "
|
|
533
|
+
"primary-index-field2": {
|
|
534
|
+
"name": "primary-index-field2",
|
|
535
|
+
"summary": "Primary index field 2 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
540
536
|
"hasDynamicHelp": false,
|
|
541
537
|
"multiple": false,
|
|
542
|
-
"options": [
|
|
543
|
-
"formal",
|
|
544
|
-
"casual",
|
|
545
|
-
"neutral"
|
|
546
|
-
],
|
|
547
538
|
"type": "option"
|
|
548
539
|
},
|
|
549
|
-
"
|
|
550
|
-
"name": "
|
|
551
|
-
"summary": "
|
|
540
|
+
"content-fields": {
|
|
541
|
+
"name": "content-fields",
|
|
542
|
+
"summary": "Comma-separated list of content fields for KNOWLEDGE libraries (optional, mutable after creation).",
|
|
552
543
|
"hasDynamicHelp": false,
|
|
553
544
|
"multiple": false,
|
|
554
545
|
"type": "option"
|
|
555
546
|
},
|
|
556
|
-
"
|
|
557
|
-
"name": "
|
|
558
|
-
"summary": "
|
|
559
|
-
"default": "specs/agentSpec.yaml",
|
|
547
|
+
"data-category-ids": {
|
|
548
|
+
"name": "data-category-ids",
|
|
549
|
+
"summary": "Comma-separated list of data category selection IDs for KNOWLEDGE libraries. Mutually exclusive with --data-category-names (provide one or the other, not both).",
|
|
560
550
|
"hasDynamicHelp": false,
|
|
561
551
|
"multiple": false,
|
|
562
552
|
"type": "option"
|
|
563
553
|
},
|
|
564
|
-
"
|
|
565
|
-
"name": "
|
|
566
|
-
"summary": "
|
|
567
|
-
"allowNo": false,
|
|
568
|
-
"type": "boolean"
|
|
569
|
-
},
|
|
570
|
-
"prompt-template": {
|
|
571
|
-
"name": "prompt-template",
|
|
572
|
-
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
554
|
+
"data-category-names": {
|
|
555
|
+
"name": "data-category-names",
|
|
556
|
+
"summary": "Comma-separated list of data category names in qualified format (e.g., \"Group_API_Name.Category\"). Mutually exclusive with --data-category-ids (provide one or the other, not both).",
|
|
573
557
|
"hasDynamicHelp": false,
|
|
574
558
|
"multiple": false,
|
|
575
559
|
"type": "option"
|
|
576
560
|
},
|
|
577
|
-
"
|
|
578
|
-
"
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
"
|
|
582
|
-
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
583
|
-
"hasDynamicHelp": false,
|
|
561
|
+
"wait": {
|
|
562
|
+
"char": "w",
|
|
563
|
+
"name": "wait",
|
|
564
|
+
"summary": "Wait N minutes for indexing to complete (KNOWLEDGE libraries). SFDRIVE libraries require upload before indexing; RETRIEVER libraries are ready immediately.",
|
|
565
|
+
"hasDynamicHelp": true,
|
|
584
566
|
"multiple": false,
|
|
585
567
|
"type": "option"
|
|
586
|
-
},
|
|
587
|
-
"force-overwrite": {
|
|
588
|
-
"name": "force-overwrite",
|
|
589
|
-
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
590
|
-
"allowNo": false,
|
|
591
|
-
"type": "boolean"
|
|
592
568
|
}
|
|
593
569
|
},
|
|
594
570
|
"hasDynamicHelp": true,
|
|
595
571
|
"hiddenAliases": [],
|
|
596
|
-
"id": "agent:
|
|
572
|
+
"id": "agent:adl:create",
|
|
597
573
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
598
574
|
"pluginName": "@salesforce/plugin-agent",
|
|
599
575
|
"pluginType": "core",
|
|
600
576
|
"strict": true,
|
|
601
|
-
"summary": "
|
|
577
|
+
"summary": "Create an Agentforce Data Library.",
|
|
602
578
|
"enableJsonFlag": true,
|
|
603
|
-
"requiresProject": true,
|
|
604
579
|
"isESM": true,
|
|
605
580
|
"relativePath": [
|
|
606
581
|
"lib",
|
|
607
582
|
"commands",
|
|
608
583
|
"agent",
|
|
609
|
-
"
|
|
610
|
-
"
|
|
584
|
+
"adl",
|
|
585
|
+
"create.js"
|
|
611
586
|
],
|
|
612
587
|
"aliasPermutations": [],
|
|
613
588
|
"permutations": [
|
|
614
|
-
"agent:
|
|
615
|
-
"
|
|
616
|
-
"
|
|
617
|
-
"agent:
|
|
618
|
-
"
|
|
619
|
-
"
|
|
589
|
+
"agent:adl:create",
|
|
590
|
+
"adl:agent:create",
|
|
591
|
+
"adl:create:agent",
|
|
592
|
+
"agent:create:adl",
|
|
593
|
+
"create:agent:adl",
|
|
594
|
+
"create:adl:agent"
|
|
620
595
|
]
|
|
621
596
|
},
|
|
622
|
-
"agent:
|
|
597
|
+
"agent:adl:delete": {
|
|
623
598
|
"aliases": [],
|
|
624
599
|
"args": {},
|
|
625
|
-
"description": "
|
|
600
|
+
"description": "Permanently deletes a data library and all associated files and indexing data.",
|
|
626
601
|
"examples": [
|
|
627
|
-
"
|
|
628
|
-
"Generate an authoring bundle without using an agent spec file; give the bundle the label \"My Authoring Bundle\" and use your default org:\n<%= config.bin %> <%= command.id %> --no-spec --name \"My Authoring Bundle\"",
|
|
629
|
-
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\"; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
630
|
-
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
602
|
+
"Delete a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
631
603
|
],
|
|
632
604
|
"flags": {
|
|
633
605
|
"json": {
|
|
@@ -655,13 +627,6 @@
|
|
|
655
627
|
"multiple": false,
|
|
656
628
|
"type": "option"
|
|
657
629
|
},
|
|
658
|
-
"api-name": {
|
|
659
|
-
"name": "api-name",
|
|
660
|
-
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
661
|
-
"hasDynamicHelp": false,
|
|
662
|
-
"multiple": false,
|
|
663
|
-
"type": "option"
|
|
664
|
-
},
|
|
665
630
|
"api-version": {
|
|
666
631
|
"description": "Override the api version used for api requests made by this command",
|
|
667
632
|
"name": "api-version",
|
|
@@ -669,77 +634,49 @@
|
|
|
669
634
|
"multiple": false,
|
|
670
635
|
"type": "option"
|
|
671
636
|
},
|
|
672
|
-
"
|
|
673
|
-
"char": "
|
|
674
|
-
"name": "
|
|
675
|
-
"
|
|
676
|
-
"
|
|
677
|
-
"multiple": false,
|
|
678
|
-
"type": "option"
|
|
679
|
-
},
|
|
680
|
-
"no-spec": {
|
|
681
|
-
"name": "no-spec",
|
|
682
|
-
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
683
|
-
"allowNo": false,
|
|
684
|
-
"type": "boolean"
|
|
685
|
-
},
|
|
686
|
-
"output-dir": {
|
|
687
|
-
"char": "d",
|
|
688
|
-
"name": "output-dir",
|
|
689
|
-
"summary": "Directory where the authoring bundle files are generated.",
|
|
690
|
-
"hasDynamicHelp": false,
|
|
691
|
-
"multiple": false,
|
|
692
|
-
"type": "option"
|
|
693
|
-
},
|
|
694
|
-
"name": {
|
|
695
|
-
"char": "n",
|
|
696
|
-
"name": "name",
|
|
697
|
-
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
637
|
+
"library-id": {
|
|
638
|
+
"char": "i",
|
|
639
|
+
"name": "library-id",
|
|
640
|
+
"required": true,
|
|
641
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
698
642
|
"hasDynamicHelp": false,
|
|
699
643
|
"multiple": false,
|
|
700
644
|
"type": "option"
|
|
701
|
-
},
|
|
702
|
-
"force-overwrite": {
|
|
703
|
-
"name": "force-overwrite",
|
|
704
|
-
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
705
|
-
"allowNo": false,
|
|
706
|
-
"type": "boolean"
|
|
707
645
|
}
|
|
708
646
|
},
|
|
709
647
|
"hasDynamicHelp": true,
|
|
710
648
|
"hiddenAliases": [],
|
|
711
|
-
"id": "agent:
|
|
649
|
+
"id": "agent:adl:delete",
|
|
712
650
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
713
651
|
"pluginName": "@salesforce/plugin-agent",
|
|
714
652
|
"pluginType": "core",
|
|
715
653
|
"strict": true,
|
|
716
|
-
"summary": "
|
|
654
|
+
"summary": "Delete an Agentforce Data Library.",
|
|
717
655
|
"enableJsonFlag": true,
|
|
718
|
-
"requiresProject": true,
|
|
719
656
|
"isESM": true,
|
|
720
657
|
"relativePath": [
|
|
721
658
|
"lib",
|
|
722
659
|
"commands",
|
|
723
660
|
"agent",
|
|
724
|
-
"
|
|
725
|
-
"
|
|
661
|
+
"adl",
|
|
662
|
+
"delete.js"
|
|
726
663
|
],
|
|
727
664
|
"aliasPermutations": [],
|
|
728
665
|
"permutations": [
|
|
729
|
-
"agent:
|
|
730
|
-
"
|
|
731
|
-
"
|
|
732
|
-
"agent:
|
|
733
|
-
"
|
|
734
|
-
"
|
|
666
|
+
"agent:adl:delete",
|
|
667
|
+
"adl:agent:delete",
|
|
668
|
+
"adl:delete:agent",
|
|
669
|
+
"agent:delete:adl",
|
|
670
|
+
"delete:agent:adl",
|
|
671
|
+
"delete:adl:agent"
|
|
735
672
|
]
|
|
736
673
|
},
|
|
737
|
-
"agent:
|
|
674
|
+
"agent:adl:get": {
|
|
738
675
|
"aliases": [],
|
|
739
676
|
"args": {},
|
|
740
|
-
"description": "
|
|
677
|
+
"description": "Returns the full detail of a data library including its grounding source configuration, status, and retriever ID.",
|
|
741
678
|
"examples": [
|
|
742
|
-
"
|
|
679
|
+
"Get details of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
743
680
|
],
|
|
744
681
|
"flags": {
|
|
745
682
|
"json": {
|
|
@@ -757,6 +694,16 @@
|
|
|
757
694
|
"multiple": false,
|
|
758
695
|
"type": "option"
|
|
759
696
|
},
|
|
697
|
+
"target-org": {
|
|
698
|
+
"char": "o",
|
|
699
|
+
"name": "target-org",
|
|
700
|
+
"noCacheDefault": true,
|
|
701
|
+
"required": true,
|
|
702
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
703
|
+
"hasDynamicHelp": true,
|
|
704
|
+
"multiple": false,
|
|
705
|
+
"type": "option"
|
|
706
|
+
},
|
|
760
707
|
"api-version": {
|
|
761
708
|
"description": "Override the api version used for api requests made by this command",
|
|
762
709
|
"name": "api-version",
|
|
@@ -764,37 +711,11 @@
|
|
|
764
711
|
"multiple": false,
|
|
765
712
|
"type": "option"
|
|
766
713
|
},
|
|
767
|
-
"
|
|
768
|
-
"char": "
|
|
769
|
-
"name": "
|
|
770
|
-
"noCacheDefault": true,
|
|
714
|
+
"library-id": {
|
|
715
|
+
"char": "i",
|
|
716
|
+
"name": "library-id",
|
|
771
717
|
"required": true,
|
|
772
|
-
"summary": "
|
|
773
|
-
"hasDynamicHelp": true,
|
|
774
|
-
"multiple": false,
|
|
775
|
-
"type": "option"
|
|
776
|
-
},
|
|
777
|
-
"agent-version": {
|
|
778
|
-
"name": "agent-version",
|
|
779
|
-
"required": true,
|
|
780
|
-
"summary": "Version of the agent (BotVersion).",
|
|
781
|
-
"hasDynamicHelp": false,
|
|
782
|
-
"multiple": false,
|
|
783
|
-
"type": "option"
|
|
784
|
-
},
|
|
785
|
-
"agent-file": {
|
|
786
|
-
"char": "f",
|
|
787
|
-
"name": "agent-file",
|
|
788
|
-
"required": true,
|
|
789
|
-
"summary": "Path to an agent (Bot) metadata file.",
|
|
790
|
-
"hasDynamicHelp": false,
|
|
791
|
-
"multiple": false,
|
|
792
|
-
"type": "option"
|
|
793
|
-
},
|
|
794
|
-
"output-dir": {
|
|
795
|
-
"char": "r",
|
|
796
|
-
"name": "output-dir",
|
|
797
|
-
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
718
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
798
719
|
"hasDynamicHelp": false,
|
|
799
720
|
"multiple": false,
|
|
800
721
|
"type": "option"
|
|
@@ -802,122 +723,38 @@
|
|
|
802
723
|
},
|
|
803
724
|
"hasDynamicHelp": true,
|
|
804
725
|
"hiddenAliases": [],
|
|
805
|
-
"id": "agent:
|
|
726
|
+
"id": "agent:adl:get",
|
|
806
727
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
807
728
|
"pluginName": "@salesforce/plugin-agent",
|
|
808
729
|
"pluginType": "core",
|
|
809
730
|
"strict": true,
|
|
810
|
-
"summary": "
|
|
731
|
+
"summary": "Get details of an Agentforce Data Library.",
|
|
811
732
|
"enableJsonFlag": true,
|
|
812
|
-
"requiresProject": true,
|
|
813
|
-
"isESM": true,
|
|
814
|
-
"relativePath": [
|
|
815
|
-
"lib",
|
|
816
|
-
"commands",
|
|
817
|
-
"agent",
|
|
818
|
-
"generate",
|
|
819
|
-
"template.js"
|
|
820
|
-
],
|
|
821
|
-
"aliasPermutations": [],
|
|
822
|
-
"permutations": [
|
|
823
|
-
"agent:generate:template",
|
|
824
|
-
"generate:agent:template",
|
|
825
|
-
"generate:template:agent",
|
|
826
|
-
"agent:template:generate",
|
|
827
|
-
"template:agent:generate",
|
|
828
|
-
"template:generate:agent"
|
|
829
|
-
]
|
|
830
|
-
},
|
|
831
|
-
"agent:generate:test-spec": {
|
|
832
|
-
"aliases": [],
|
|
833
|
-
"args": {},
|
|
834
|
-
"description": "The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX project when prompting for information, such as the agent API name; it doesn't look in your org.\n\nTo generate a specific agent test case, this command prompts you for this information; when possible, the command provides a list of options for you to choose from:\n\n- Utterance: Natural language statement, question, or command used to test the agent.\n- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.\n- Expected actions: One or more API names of the expection actions the agent takes.\n- Expected outcome: Natural language description of the outcome you expect.\n- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.\n- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.\n\nYou can manually add contextVariables to test cases in the generated YAML file to inject contextual data (such as CaseId or RoutableId) into agent sessions. This is useful for testing agent behavior with different contextual information.\n\nWhen your test spec is ready, you then run the \"agent test create\" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is `AiEvaluationDefinition` (legacy testing-center) or `AiTestingDefinition` (Agentforce Studio / NGT), selected via --test-runner.\n\nIf you have an existing AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag. The runner is inferred from the file extension; pass --test-runner to override.",
|
|
835
|
-
"examples": [
|
|
836
|
-
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
837
|
-
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
838
|
-
"Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without confirmation:\n<%= config.bin %> <%= command.id %> --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite",
|
|
839
|
-
"Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml",
|
|
840
|
-
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
841
|
-
],
|
|
842
|
-
"flags": {
|
|
843
|
-
"flags-dir": {
|
|
844
|
-
"helpGroup": "GLOBAL",
|
|
845
|
-
"name": "flags-dir",
|
|
846
|
-
"summary": "Import flag values from a directory.",
|
|
847
|
-
"hasDynamicHelp": false,
|
|
848
|
-
"multiple": false,
|
|
849
|
-
"type": "option"
|
|
850
|
-
},
|
|
851
|
-
"from-definition": {
|
|
852
|
-
"char": "d",
|
|
853
|
-
"name": "from-definition",
|
|
854
|
-
"summary": "Filepath to an AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project that you want to convert to a test spec YAML file.",
|
|
855
|
-
"hasDynamicHelp": false,
|
|
856
|
-
"multiple": false,
|
|
857
|
-
"type": "option"
|
|
858
|
-
},
|
|
859
|
-
"force-overwrite": {
|
|
860
|
-
"name": "force-overwrite",
|
|
861
|
-
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
862
|
-
"allowNo": false,
|
|
863
|
-
"type": "boolean"
|
|
864
|
-
},
|
|
865
|
-
"output-file": {
|
|
866
|
-
"char": "f",
|
|
867
|
-
"name": "output-file",
|
|
868
|
-
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\" (legacy) or \"specs/<AGENT_API_NAME>-ngtTestSpec.yaml\" (Agentforce Studio).",
|
|
869
|
-
"hasDynamicHelp": false,
|
|
870
|
-
"multiple": false,
|
|
871
|
-
"type": "option"
|
|
872
|
-
},
|
|
873
|
-
"test-runner": {
|
|
874
|
-
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
875
|
-
"name": "test-runner",
|
|
876
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
877
|
-
"hasDynamicHelp": false,
|
|
878
|
-
"multiple": false,
|
|
879
|
-
"options": [
|
|
880
|
-
"agentforce-studio",
|
|
881
|
-
"testing-center"
|
|
882
|
-
],
|
|
883
|
-
"type": "option"
|
|
884
|
-
}
|
|
885
|
-
},
|
|
886
|
-
"hasDynamicHelp": false,
|
|
887
|
-
"hiddenAliases": [],
|
|
888
|
-
"id": "agent:generate:test-spec",
|
|
889
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
890
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
891
|
-
"pluginType": "core",
|
|
892
|
-
"strict": true,
|
|
893
|
-
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
894
|
-
"enableJsonFlag": false,
|
|
895
733
|
"isESM": true,
|
|
896
734
|
"relativePath": [
|
|
897
735
|
"lib",
|
|
898
736
|
"commands",
|
|
899
737
|
"agent",
|
|
900
|
-
"
|
|
901
|
-
"
|
|
738
|
+
"adl",
|
|
739
|
+
"get.js"
|
|
902
740
|
],
|
|
903
741
|
"aliasPermutations": [],
|
|
904
742
|
"permutations": [
|
|
905
|
-
"agent:
|
|
906
|
-
"
|
|
907
|
-
"
|
|
908
|
-
"agent:
|
|
909
|
-
"
|
|
910
|
-
"
|
|
743
|
+
"agent:adl:get",
|
|
744
|
+
"adl:agent:get",
|
|
745
|
+
"adl:get:agent",
|
|
746
|
+
"agent:get:adl",
|
|
747
|
+
"get:agent:adl",
|
|
748
|
+
"get:adl:agent"
|
|
911
749
|
]
|
|
912
750
|
},
|
|
913
|
-
"agent:adl:
|
|
751
|
+
"agent:adl:list": {
|
|
914
752
|
"aliases": [],
|
|
915
753
|
"args": {},
|
|
916
|
-
"description": "
|
|
754
|
+
"description": "Returns all data libraries in the target org, including their source type, status, and library ID.",
|
|
917
755
|
"examples": [
|
|
918
|
-
"
|
|
919
|
-
"
|
|
920
|
-
"Create a RETRIEVER library:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"Existing Retriever\" --developer-name Existing_Retriever --source-type retriever --retriever-id 0ppXX0000000001"
|
|
756
|
+
"List all data libraries in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
757
|
+
"List data libraries and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --json"
|
|
921
758
|
],
|
|
922
759
|
"flags": {
|
|
923
760
|
"json": {
|
|
@@ -952,27 +789,9 @@
|
|
|
952
789
|
"multiple": false,
|
|
953
790
|
"type": "option"
|
|
954
791
|
},
|
|
955
|
-
"name": {
|
|
956
|
-
"char": "n",
|
|
957
|
-
"name": "name",
|
|
958
|
-
"required": true,
|
|
959
|
-
"summary": "Display name for the data library (max 80 characters).",
|
|
960
|
-
"hasDynamicHelp": false,
|
|
961
|
-
"multiple": false,
|
|
962
|
-
"type": "option"
|
|
963
|
-
},
|
|
964
|
-
"developer-name": {
|
|
965
|
-
"name": "developer-name",
|
|
966
|
-
"required": true,
|
|
967
|
-
"summary": "API name for the data library (max 80 characters, alphanumeric and underscores only, must start with a letter).",
|
|
968
|
-
"hasDynamicHelp": false,
|
|
969
|
-
"multiple": false,
|
|
970
|
-
"type": "option"
|
|
971
|
-
},
|
|
972
792
|
"source-type": {
|
|
973
793
|
"name": "source-type",
|
|
974
|
-
"
|
|
975
|
-
"summary": "Type of grounding source: sfdrive (file upload), knowledge (Salesforce Knowledge articles), or retriever (existing active Custom Retriever).",
|
|
794
|
+
"summary": "Filter by source type: sfdrive, knowledge, or retriever.",
|
|
976
795
|
"hasDynamicHelp": false,
|
|
977
796
|
"multiple": false,
|
|
978
797
|
"options": [
|
|
@@ -981,84 +800,16 @@
|
|
|
981
800
|
"retriever"
|
|
982
801
|
],
|
|
983
802
|
"type": "option"
|
|
984
|
-
},
|
|
985
|
-
"description": {
|
|
986
|
-
"name": "description",
|
|
987
|
-
"summary": "Description of the data library (max 255 characters).",
|
|
988
|
-
"hasDynamicHelp": false,
|
|
989
|
-
"multiple": false,
|
|
990
|
-
"type": "option"
|
|
991
|
-
},
|
|
992
|
-
"index-mode": {
|
|
993
|
-
"name": "index-mode",
|
|
994
|
-
"summary": "Index mode for SFDRIVE libraries: basic or enhanced.",
|
|
995
|
-
"hasDynamicHelp": false,
|
|
996
|
-
"multiple": false,
|
|
997
|
-
"options": [
|
|
998
|
-
"basic",
|
|
999
|
-
"enhanced"
|
|
1000
|
-
],
|
|
1001
|
-
"type": "option"
|
|
1002
|
-
},
|
|
1003
|
-
"retriever-id": {
|
|
1004
|
-
"name": "retriever-id",
|
|
1005
|
-
"summary": "ID of an active Custom Retriever (required for RETRIEVER source type; retriever must be active).",
|
|
1006
|
-
"hasDynamicHelp": false,
|
|
1007
|
-
"multiple": false,
|
|
1008
|
-
"type": "option"
|
|
1009
|
-
},
|
|
1010
|
-
"primary-index-field1": {
|
|
1011
|
-
"name": "primary-index-field1",
|
|
1012
|
-
"summary": "Primary index field 1 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
1013
|
-
"hasDynamicHelp": false,
|
|
1014
|
-
"multiple": false,
|
|
1015
|
-
"type": "option"
|
|
1016
|
-
},
|
|
1017
|
-
"primary-index-field2": {
|
|
1018
|
-
"name": "primary-index-field2",
|
|
1019
|
-
"summary": "Primary index field 2 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
1020
|
-
"hasDynamicHelp": false,
|
|
1021
|
-
"multiple": false,
|
|
1022
|
-
"type": "option"
|
|
1023
|
-
},
|
|
1024
|
-
"content-fields": {
|
|
1025
|
-
"name": "content-fields",
|
|
1026
|
-
"summary": "Comma-separated list of content fields for KNOWLEDGE libraries (optional, mutable after creation).",
|
|
1027
|
-
"hasDynamicHelp": false,
|
|
1028
|
-
"multiple": false,
|
|
1029
|
-
"type": "option"
|
|
1030
|
-
},
|
|
1031
|
-
"data-category-ids": {
|
|
1032
|
-
"name": "data-category-ids",
|
|
1033
|
-
"summary": "Comma-separated list of data category selection IDs for KNOWLEDGE libraries. Mutually exclusive with --data-category-names (provide one or the other, not both).",
|
|
1034
|
-
"hasDynamicHelp": false,
|
|
1035
|
-
"multiple": false,
|
|
1036
|
-
"type": "option"
|
|
1037
|
-
},
|
|
1038
|
-
"data-category-names": {
|
|
1039
|
-
"name": "data-category-names",
|
|
1040
|
-
"summary": "Comma-separated list of data category names in qualified format (e.g., \"Group_API_Name.Category\"). Mutually exclusive with --data-category-ids (provide one or the other, not both).",
|
|
1041
|
-
"hasDynamicHelp": false,
|
|
1042
|
-
"multiple": false,
|
|
1043
|
-
"type": "option"
|
|
1044
|
-
},
|
|
1045
|
-
"wait": {
|
|
1046
|
-
"char": "w",
|
|
1047
|
-
"name": "wait",
|
|
1048
|
-
"summary": "Wait N minutes for indexing to complete (KNOWLEDGE libraries). SFDRIVE libraries require upload before indexing; RETRIEVER libraries are ready immediately.",
|
|
1049
|
-
"hasDynamicHelp": true,
|
|
1050
|
-
"multiple": false,
|
|
1051
|
-
"type": "option"
|
|
1052
803
|
}
|
|
1053
804
|
},
|
|
1054
805
|
"hasDynamicHelp": true,
|
|
1055
806
|
"hiddenAliases": [],
|
|
1056
|
-
"id": "agent:adl:
|
|
807
|
+
"id": "agent:adl:list",
|
|
1057
808
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1058
809
|
"pluginName": "@salesforce/plugin-agent",
|
|
1059
810
|
"pluginType": "core",
|
|
1060
811
|
"strict": true,
|
|
1061
|
-
"summary": "
|
|
812
|
+
"summary": "List Agentforce Data Libraries in an org.",
|
|
1062
813
|
"enableJsonFlag": true,
|
|
1063
814
|
"isESM": true,
|
|
1064
815
|
"relativePath": [
|
|
@@ -1066,24 +817,24 @@
|
|
|
1066
817
|
"commands",
|
|
1067
818
|
"agent",
|
|
1068
819
|
"adl",
|
|
1069
|
-
"
|
|
820
|
+
"list.js"
|
|
1070
821
|
],
|
|
1071
822
|
"aliasPermutations": [],
|
|
1072
823
|
"permutations": [
|
|
1073
|
-
"agent:adl:
|
|
1074
|
-
"adl:agent:
|
|
1075
|
-
"adl:
|
|
1076
|
-
"agent:
|
|
1077
|
-
"
|
|
1078
|
-
"
|
|
824
|
+
"agent:adl:list",
|
|
825
|
+
"adl:agent:list",
|
|
826
|
+
"adl:list:agent",
|
|
827
|
+
"agent:list:adl",
|
|
828
|
+
"list:agent:adl",
|
|
829
|
+
"list:adl:agent"
|
|
1079
830
|
]
|
|
1080
831
|
},
|
|
1081
|
-
"agent:adl:
|
|
832
|
+
"agent:adl:status": {
|
|
1082
833
|
"aliases": [],
|
|
1083
834
|
"args": {},
|
|
1084
|
-
"description": "
|
|
835
|
+
"description": "Returns the current indexing status including stage details (DATA_STREAM, DATA_LAKE_OBJECT, DATA_MODEL_OBJECT, SEARCH_INDEX, RETRIEVER) and any errors.",
|
|
1085
836
|
"examples": [
|
|
1086
|
-
"
|
|
837
|
+
"Get status of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
1087
838
|
],
|
|
1088
839
|
"flags": {
|
|
1089
840
|
"json": {
|
|
@@ -1126,247 +877,12 @@
|
|
|
1126
877
|
"hasDynamicHelp": false,
|
|
1127
878
|
"multiple": false,
|
|
1128
879
|
"type": "option"
|
|
1129
|
-
}
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1136
|
-
"pluginType": "core",
|
|
1137
|
-
"strict": true,
|
|
1138
|
-
"summary": "Delete an Agentforce Data Library.",
|
|
1139
|
-
"enableJsonFlag": true,
|
|
1140
|
-
"isESM": true,
|
|
1141
|
-
"relativePath": [
|
|
1142
|
-
"lib",
|
|
1143
|
-
"commands",
|
|
1144
|
-
"agent",
|
|
1145
|
-
"adl",
|
|
1146
|
-
"delete.js"
|
|
1147
|
-
],
|
|
1148
|
-
"aliasPermutations": [],
|
|
1149
|
-
"permutations": [
|
|
1150
|
-
"agent:adl:delete",
|
|
1151
|
-
"adl:agent:delete",
|
|
1152
|
-
"adl:delete:agent",
|
|
1153
|
-
"agent:delete:adl",
|
|
1154
|
-
"delete:agent:adl",
|
|
1155
|
-
"delete:adl:agent"
|
|
1156
|
-
]
|
|
1157
|
-
},
|
|
1158
|
-
"agent:adl:get": {
|
|
1159
|
-
"aliases": [],
|
|
1160
|
-
"args": {},
|
|
1161
|
-
"description": "Returns the full detail of a data library including its grounding source configuration, status, and retriever ID.",
|
|
1162
|
-
"examples": [
|
|
1163
|
-
"Get details of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
1164
|
-
],
|
|
1165
|
-
"flags": {
|
|
1166
|
-
"json": {
|
|
1167
|
-
"description": "Format output as json.",
|
|
1168
|
-
"helpGroup": "GLOBAL",
|
|
1169
|
-
"name": "json",
|
|
1170
|
-
"allowNo": false,
|
|
1171
|
-
"type": "boolean"
|
|
1172
|
-
},
|
|
1173
|
-
"flags-dir": {
|
|
1174
|
-
"helpGroup": "GLOBAL",
|
|
1175
|
-
"name": "flags-dir",
|
|
1176
|
-
"summary": "Import flag values from a directory.",
|
|
1177
|
-
"hasDynamicHelp": false,
|
|
1178
|
-
"multiple": false,
|
|
1179
|
-
"type": "option"
|
|
1180
|
-
},
|
|
1181
|
-
"target-org": {
|
|
1182
|
-
"char": "o",
|
|
1183
|
-
"name": "target-org",
|
|
1184
|
-
"noCacheDefault": true,
|
|
1185
|
-
"required": true,
|
|
1186
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1187
|
-
"hasDynamicHelp": true,
|
|
1188
|
-
"multiple": false,
|
|
1189
|
-
"type": "option"
|
|
1190
|
-
},
|
|
1191
|
-
"api-version": {
|
|
1192
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1193
|
-
"name": "api-version",
|
|
1194
|
-
"hasDynamicHelp": false,
|
|
1195
|
-
"multiple": false,
|
|
1196
|
-
"type": "option"
|
|
1197
|
-
},
|
|
1198
|
-
"library-id": {
|
|
1199
|
-
"char": "i",
|
|
1200
|
-
"name": "library-id",
|
|
1201
|
-
"required": true,
|
|
1202
|
-
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
1203
|
-
"hasDynamicHelp": false,
|
|
1204
|
-
"multiple": false,
|
|
1205
|
-
"type": "option"
|
|
1206
|
-
}
|
|
1207
|
-
},
|
|
1208
|
-
"hasDynamicHelp": true,
|
|
1209
|
-
"hiddenAliases": [],
|
|
1210
|
-
"id": "agent:adl:get",
|
|
1211
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1212
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1213
|
-
"pluginType": "core",
|
|
1214
|
-
"strict": true,
|
|
1215
|
-
"summary": "Get details of an Agentforce Data Library.",
|
|
1216
|
-
"enableJsonFlag": true,
|
|
1217
|
-
"isESM": true,
|
|
1218
|
-
"relativePath": [
|
|
1219
|
-
"lib",
|
|
1220
|
-
"commands",
|
|
1221
|
-
"agent",
|
|
1222
|
-
"adl",
|
|
1223
|
-
"get.js"
|
|
1224
|
-
],
|
|
1225
|
-
"aliasPermutations": [],
|
|
1226
|
-
"permutations": [
|
|
1227
|
-
"agent:adl:get",
|
|
1228
|
-
"adl:agent:get",
|
|
1229
|
-
"adl:get:agent",
|
|
1230
|
-
"agent:get:adl",
|
|
1231
|
-
"get:agent:adl",
|
|
1232
|
-
"get:adl:agent"
|
|
1233
|
-
]
|
|
1234
|
-
},
|
|
1235
|
-
"agent:adl:list": {
|
|
1236
|
-
"aliases": [],
|
|
1237
|
-
"args": {},
|
|
1238
|
-
"description": "Returns all data libraries in the target org, including their source type, status, and library ID.",
|
|
1239
|
-
"examples": [
|
|
1240
|
-
"List all data libraries in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
1241
|
-
"List data libraries and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --json"
|
|
1242
|
-
],
|
|
1243
|
-
"flags": {
|
|
1244
|
-
"json": {
|
|
1245
|
-
"description": "Format output as json.",
|
|
1246
|
-
"helpGroup": "GLOBAL",
|
|
1247
|
-
"name": "json",
|
|
1248
|
-
"allowNo": false,
|
|
1249
|
-
"type": "boolean"
|
|
1250
|
-
},
|
|
1251
|
-
"flags-dir": {
|
|
1252
|
-
"helpGroup": "GLOBAL",
|
|
1253
|
-
"name": "flags-dir",
|
|
1254
|
-
"summary": "Import flag values from a directory.",
|
|
1255
|
-
"hasDynamicHelp": false,
|
|
1256
|
-
"multiple": false,
|
|
1257
|
-
"type": "option"
|
|
1258
|
-
},
|
|
1259
|
-
"target-org": {
|
|
1260
|
-
"char": "o",
|
|
1261
|
-
"name": "target-org",
|
|
1262
|
-
"noCacheDefault": true,
|
|
1263
|
-
"required": true,
|
|
1264
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1265
|
-
"hasDynamicHelp": true,
|
|
1266
|
-
"multiple": false,
|
|
1267
|
-
"type": "option"
|
|
1268
|
-
},
|
|
1269
|
-
"api-version": {
|
|
1270
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1271
|
-
"name": "api-version",
|
|
1272
|
-
"hasDynamicHelp": false,
|
|
1273
|
-
"multiple": false,
|
|
1274
|
-
"type": "option"
|
|
1275
|
-
},
|
|
1276
|
-
"source-type": {
|
|
1277
|
-
"name": "source-type",
|
|
1278
|
-
"summary": "Filter by source type: sfdrive, knowledge, or retriever.",
|
|
1279
|
-
"hasDynamicHelp": false,
|
|
1280
|
-
"multiple": false,
|
|
1281
|
-
"options": [
|
|
1282
|
-
"sfdrive",
|
|
1283
|
-
"knowledge",
|
|
1284
|
-
"retriever"
|
|
1285
|
-
],
|
|
1286
|
-
"type": "option"
|
|
1287
|
-
}
|
|
1288
|
-
},
|
|
1289
|
-
"hasDynamicHelp": true,
|
|
1290
|
-
"hiddenAliases": [],
|
|
1291
|
-
"id": "agent:adl:list",
|
|
1292
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1293
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1294
|
-
"pluginType": "core",
|
|
1295
|
-
"strict": true,
|
|
1296
|
-
"summary": "List Agentforce Data Libraries in an org.",
|
|
1297
|
-
"enableJsonFlag": true,
|
|
1298
|
-
"isESM": true,
|
|
1299
|
-
"relativePath": [
|
|
1300
|
-
"lib",
|
|
1301
|
-
"commands",
|
|
1302
|
-
"agent",
|
|
1303
|
-
"adl",
|
|
1304
|
-
"list.js"
|
|
1305
|
-
],
|
|
1306
|
-
"aliasPermutations": [],
|
|
1307
|
-
"permutations": [
|
|
1308
|
-
"agent:adl:list",
|
|
1309
|
-
"adl:agent:list",
|
|
1310
|
-
"adl:list:agent",
|
|
1311
|
-
"agent:list:adl",
|
|
1312
|
-
"list:agent:adl",
|
|
1313
|
-
"list:adl:agent"
|
|
1314
|
-
]
|
|
1315
|
-
},
|
|
1316
|
-
"agent:adl:status": {
|
|
1317
|
-
"aliases": [],
|
|
1318
|
-
"args": {},
|
|
1319
|
-
"description": "Returns the current indexing status including stage details (DATA_STREAM, DATA_LAKE_OBJECT, DATA_MODEL_OBJECT, SEARCH_INDEX, RETRIEVER) and any errors.",
|
|
1320
|
-
"examples": [
|
|
1321
|
-
"Get status of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
1322
|
-
],
|
|
1323
|
-
"flags": {
|
|
1324
|
-
"json": {
|
|
1325
|
-
"description": "Format output as json.",
|
|
1326
|
-
"helpGroup": "GLOBAL",
|
|
1327
|
-
"name": "json",
|
|
1328
|
-
"allowNo": false,
|
|
1329
|
-
"type": "boolean"
|
|
1330
|
-
},
|
|
1331
|
-
"flags-dir": {
|
|
1332
|
-
"helpGroup": "GLOBAL",
|
|
1333
|
-
"name": "flags-dir",
|
|
1334
|
-
"summary": "Import flag values from a directory.",
|
|
1335
|
-
"hasDynamicHelp": false,
|
|
1336
|
-
"multiple": false,
|
|
1337
|
-
"type": "option"
|
|
1338
|
-
},
|
|
1339
|
-
"target-org": {
|
|
1340
|
-
"char": "o",
|
|
1341
|
-
"name": "target-org",
|
|
1342
|
-
"noCacheDefault": true,
|
|
1343
|
-
"required": true,
|
|
1344
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1345
|
-
"hasDynamicHelp": true,
|
|
1346
|
-
"multiple": false,
|
|
1347
|
-
"type": "option"
|
|
1348
|
-
},
|
|
1349
|
-
"api-version": {
|
|
1350
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1351
|
-
"name": "api-version",
|
|
1352
|
-
"hasDynamicHelp": false,
|
|
1353
|
-
"multiple": false,
|
|
1354
|
-
"type": "option"
|
|
1355
|
-
},
|
|
1356
|
-
"library-id": {
|
|
1357
|
-
"char": "i",
|
|
1358
|
-
"name": "library-id",
|
|
1359
|
-
"required": true,
|
|
1360
|
-
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
1361
|
-
"hasDynamicHelp": false,
|
|
1362
|
-
"multiple": false,
|
|
1363
|
-
"type": "option"
|
|
1364
|
-
},
|
|
1365
|
-
"include-artifacts": {
|
|
1366
|
-
"name": "include-artifacts",
|
|
1367
|
-
"summary": "Resolve DC asset artifacts (DataStream, DLO, DMO, SearchIndex, Retriever) with entity IDs and names on each stage. Slower — requires additional queries.",
|
|
1368
|
-
"allowNo": false,
|
|
1369
|
-
"type": "boolean"
|
|
880
|
+
},
|
|
881
|
+
"include-artifacts": {
|
|
882
|
+
"name": "include-artifacts",
|
|
883
|
+
"summary": "Resolve DC asset artifacts (DataStream, DLO, DMO, SearchIndex, Retriever) with entity IDs and names on each stage. Slower — requires additional queries.",
|
|
884
|
+
"allowNo": false,
|
|
885
|
+
"type": "boolean"
|
|
1370
886
|
}
|
|
1371
887
|
},
|
|
1372
888
|
"hasDynamicHelp": true,
|
|
@@ -1612,13 +1128,16 @@
|
|
|
1612
1128
|
"upload:adl:agent"
|
|
1613
1129
|
]
|
|
1614
1130
|
},
|
|
1615
|
-
"agent:
|
|
1131
|
+
"agent:generate:agent-spec": {
|
|
1616
1132
|
"aliases": [],
|
|
1617
1133
|
"args": {},
|
|
1618
|
-
"description": "
|
|
1134
|
+
"description": "An agent spec is a YAML-formatted file that contains basic information about the agent, such as its role, company description, and an AI-generated list of topics based on this information. Topics define the range of jobs your agent can handle.\n\nUse flags, such as --role and --company-description, to provide details about your company and the role that the agent plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be prompted for all required and optional properties. Upon command execution, the large language model (LLM) associated with your org uses the provided information to generate a list of topics for the agent. Because the LLM uses the company and role information to generate the topics, we recommend that you provide accurate, complete, and specific details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for example, you can remove topics that don't apply or change a topic's description.\n\nYou can also iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively improving the description of your agent allows the LLM to generate progressively better topics.\n\nYou can also specify other agent properties, such as a custom prompt template, how to ground the prompt template to add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the agent.\n\nWhen your agent spec is ready, generate an authoring bundle from it by passing the spec file to the --spec flag of the \"agent generate authoring-bundle\" CLI command. An authoring bundle is a metadata type that contains an Agent Script file, which is the blueprint for an agent. (While not recommended, you can also use the agent spec file to immediately create an agent with the \"agent create\" command. We don't recommend this workflow because these types of agents don't use Agent Script, and are thus less flexible and more difficult to maintain.)",
|
|
1619
1135
|
"examples": [
|
|
1620
|
-
"
|
|
1621
|
-
"
|
|
1136
|
+
"Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and your company details; use your default org:\n<%= config.bin %> <%= command.id %> --type customer --role \"Field customer complaints and manage employee schedules.\" --company-name \"Coral Cloud Resorts\" --company-description \"Provide customers with exceptional destination activities, unforgettable experiences, and reservation services.\"",
|
|
1137
|
+
"Generate an agent spec by being prompted for the required agent properties and generate a maxiumum of 5 topics; write the generated file to the \"specs/resortManagerSpec.yaml\" file and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org",
|
|
1138
|
+
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1139
|
+
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
1140
|
+
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
1622
1141
|
],
|
|
1623
1142
|
"flags": {
|
|
1624
1143
|
"json": {
|
|
@@ -1653,113 +1172,164 @@
|
|
|
1653
1172
|
"multiple": false,
|
|
1654
1173
|
"type": "option"
|
|
1655
1174
|
},
|
|
1656
|
-
"
|
|
1657
|
-
"
|
|
1658
|
-
"
|
|
1659
|
-
"required": true,
|
|
1660
|
-
"summary": "Unique name of the MCP server.",
|
|
1175
|
+
"type": {
|
|
1176
|
+
"name": "type",
|
|
1177
|
+
"summary": "Type of agent to create. Internal types are copilots used internally by your company and customer types are the agents you create for your customers.",
|
|
1661
1178
|
"hasDynamicHelp": false,
|
|
1662
1179
|
"multiple": false,
|
|
1180
|
+
"options": [
|
|
1181
|
+
"customer",
|
|
1182
|
+
"internal"
|
|
1183
|
+
],
|
|
1663
1184
|
"type": "option"
|
|
1664
1185
|
},
|
|
1665
|
-
"
|
|
1666
|
-
"name": "
|
|
1667
|
-
"summary": "
|
|
1186
|
+
"role": {
|
|
1187
|
+
"name": "role",
|
|
1188
|
+
"summary": "Role of the agent.",
|
|
1668
1189
|
"hasDynamicHelp": false,
|
|
1669
1190
|
"multiple": false,
|
|
1670
1191
|
"type": "option"
|
|
1671
1192
|
},
|
|
1672
|
-
"
|
|
1673
|
-
"name": "
|
|
1674
|
-
"summary": "
|
|
1193
|
+
"company-name": {
|
|
1194
|
+
"name": "company-name",
|
|
1195
|
+
"summary": "Name of your company.",
|
|
1675
1196
|
"hasDynamicHelp": false,
|
|
1676
1197
|
"multiple": false,
|
|
1677
1198
|
"type": "option"
|
|
1678
1199
|
},
|
|
1679
|
-
"
|
|
1680
|
-
"name": "
|
|
1681
|
-
"
|
|
1682
|
-
"summary": "URL of the external MCP server.",
|
|
1200
|
+
"company-description": {
|
|
1201
|
+
"name": "company-description",
|
|
1202
|
+
"summary": "Description of your company.",
|
|
1683
1203
|
"hasDynamicHelp": false,
|
|
1684
1204
|
"multiple": false,
|
|
1685
1205
|
"type": "option"
|
|
1686
1206
|
},
|
|
1687
|
-
"
|
|
1688
|
-
"name": "
|
|
1689
|
-
"summary": "
|
|
1690
|
-
"
|
|
1207
|
+
"company-website": {
|
|
1208
|
+
"name": "company-website",
|
|
1209
|
+
"summary": "Website URL of your company.",
|
|
1210
|
+
"hasDynamicHelp": false,
|
|
1211
|
+
"multiple": false,
|
|
1212
|
+
"type": "option"
|
|
1213
|
+
},
|
|
1214
|
+
"max-topics": {
|
|
1215
|
+
"name": "max-topics",
|
|
1216
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
1217
|
+
"hasDynamicHelp": false,
|
|
1218
|
+
"multiple": false,
|
|
1219
|
+
"type": "option"
|
|
1220
|
+
},
|
|
1221
|
+
"agent-user": {
|
|
1222
|
+
"name": "agent-user",
|
|
1223
|
+
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
1224
|
+
"hasDynamicHelp": false,
|
|
1225
|
+
"multiple": false,
|
|
1226
|
+
"type": "option"
|
|
1227
|
+
},
|
|
1228
|
+
"enrich-logs": {
|
|
1229
|
+
"name": "enrich-logs",
|
|
1230
|
+
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
1691
1231
|
"hasDynamicHelp": false,
|
|
1692
1232
|
"multiple": false,
|
|
1693
1233
|
"options": [
|
|
1694
|
-
"
|
|
1695
|
-
"
|
|
1234
|
+
"true",
|
|
1235
|
+
"false"
|
|
1696
1236
|
],
|
|
1697
1237
|
"type": "option"
|
|
1698
1238
|
},
|
|
1699
|
-
"
|
|
1700
|
-
"name": "
|
|
1701
|
-
"summary": "
|
|
1239
|
+
"tone": {
|
|
1240
|
+
"name": "tone",
|
|
1241
|
+
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
1702
1242
|
"hasDynamicHelp": false,
|
|
1703
1243
|
"multiple": false,
|
|
1244
|
+
"options": [
|
|
1245
|
+
"formal",
|
|
1246
|
+
"casual",
|
|
1247
|
+
"neutral"
|
|
1248
|
+
],
|
|
1704
1249
|
"type": "option"
|
|
1705
1250
|
},
|
|
1706
|
-
"
|
|
1707
|
-
"name": "
|
|
1708
|
-
"summary": "
|
|
1251
|
+
"spec": {
|
|
1252
|
+
"name": "spec",
|
|
1253
|
+
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
1709
1254
|
"hasDynamicHelp": false,
|
|
1710
1255
|
"multiple": false,
|
|
1711
1256
|
"type": "option"
|
|
1712
1257
|
},
|
|
1713
|
-
"
|
|
1714
|
-
"name": "
|
|
1715
|
-
"summary": "
|
|
1258
|
+
"output-file": {
|
|
1259
|
+
"name": "output-file",
|
|
1260
|
+
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
1261
|
+
"default": "specs/agentSpec.yaml",
|
|
1716
1262
|
"hasDynamicHelp": false,
|
|
1717
1263
|
"multiple": false,
|
|
1718
1264
|
"type": "option"
|
|
1719
1265
|
},
|
|
1720
|
-
"
|
|
1721
|
-
"name": "
|
|
1722
|
-
"summary": "
|
|
1266
|
+
"full-interview": {
|
|
1267
|
+
"name": "full-interview",
|
|
1268
|
+
"summary": "Prompt for both required and optional flags.",
|
|
1269
|
+
"allowNo": false,
|
|
1270
|
+
"type": "boolean"
|
|
1271
|
+
},
|
|
1272
|
+
"prompt-template": {
|
|
1273
|
+
"name": "prompt-template",
|
|
1274
|
+
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1275
|
+
"hasDynamicHelp": false,
|
|
1276
|
+
"multiple": false,
|
|
1277
|
+
"type": "option"
|
|
1278
|
+
},
|
|
1279
|
+
"grounding-context": {
|
|
1280
|
+
"dependsOn": [
|
|
1281
|
+
"prompt-template"
|
|
1282
|
+
],
|
|
1283
|
+
"name": "grounding-context",
|
|
1284
|
+
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1723
1285
|
"hasDynamicHelp": false,
|
|
1724
1286
|
"multiple": false,
|
|
1725
1287
|
"type": "option"
|
|
1288
|
+
},
|
|
1289
|
+
"force-overwrite": {
|
|
1290
|
+
"name": "force-overwrite",
|
|
1291
|
+
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1292
|
+
"allowNo": false,
|
|
1293
|
+
"type": "boolean"
|
|
1726
1294
|
}
|
|
1727
1295
|
},
|
|
1728
1296
|
"hasDynamicHelp": true,
|
|
1729
1297
|
"hiddenAliases": [],
|
|
1730
|
-
"id": "agent:
|
|
1298
|
+
"id": "agent:generate:agent-spec",
|
|
1731
1299
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1732
1300
|
"pluginName": "@salesforce/plugin-agent",
|
|
1733
1301
|
"pluginType": "core",
|
|
1734
|
-
"state": "preview",
|
|
1735
1302
|
"strict": true,
|
|
1736
|
-
"summary": "
|
|
1303
|
+
"summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
|
|
1737
1304
|
"enableJsonFlag": true,
|
|
1305
|
+
"requiresProject": true,
|
|
1738
1306
|
"isESM": true,
|
|
1739
1307
|
"relativePath": [
|
|
1740
1308
|
"lib",
|
|
1741
1309
|
"commands",
|
|
1742
1310
|
"agent",
|
|
1743
|
-
"
|
|
1744
|
-
"
|
|
1311
|
+
"generate",
|
|
1312
|
+
"agent-spec.js"
|
|
1745
1313
|
],
|
|
1746
1314
|
"aliasPermutations": [],
|
|
1747
1315
|
"permutations": [
|
|
1748
|
-
"agent:
|
|
1749
|
-
"
|
|
1750
|
-
"
|
|
1751
|
-
"agent:
|
|
1752
|
-
"
|
|
1753
|
-
"
|
|
1316
|
+
"agent:generate:agent-spec",
|
|
1317
|
+
"generate:agent:agent-spec",
|
|
1318
|
+
"generate:agent-spec:agent",
|
|
1319
|
+
"agent:agent-spec:generate",
|
|
1320
|
+
"agent-spec:agent:generate",
|
|
1321
|
+
"agent-spec:generate:agent"
|
|
1754
1322
|
]
|
|
1755
1323
|
},
|
|
1756
|
-
"agent:
|
|
1324
|
+
"agent:generate:authoring-bundle": {
|
|
1757
1325
|
"aliases": [],
|
|
1758
1326
|
"args": {},
|
|
1759
|
-
"description": "
|
|
1327
|
+
"description": "Authoring bundles are metadata components that contain an agent's Agent Script file. The Agent Script file is the agent's blueprint; it fully describes what the agent can do using the Agent Script language.\n\nUse this command to generate a new authoring bundle based on an agent spec YAML file, which you create with the \"agent generate agent-spec\" command. The agent spec YAML file is a high-level description of the agent; it describes its essence rather than exactly what it can do. The resulting Agent Script file is customized to reflect what's in the agent spec file. You can also create an authoring bundle without an agent spec file by specifying the \"--no-spec\" flag; in this case, the resulting Agent Script file is just the default boilerplate.\n\nThe metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard \"<bundle-api-name>.bundle-meta.xml\" metadata file and the Agent Script file (with extension \".agent\"). When you run this command, the new authoring bundle is generated in the force-app/main/default/aiAuthoringBundles/<bundle-api-name> directory. Use the --output-dir flag to generate them elsewhere.\n\nAfter you generate the initial authoring bundle, code the Agent Script file so your agent behaves exactly as you want. The Agent Script file generated by this command is just a first draft of your agent! Interactively test the agent by conversing with it using the \"agent preview\" command. Then publish the agent to your org with the \"agent publish authoring-bundle\" command.\n\nThis command requires an org because it uses it to access an LLM for generating the Agent Script file.",
|
|
1760
1328
|
"examples": [
|
|
1761
|
-
"
|
|
1762
|
-
"
|
|
1329
|
+
"Generate an authoring bundle by being prompted for all required values, such as the agent spec YAML file, the bundle name, and the API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1330
|
+
"Generate an authoring bundle without using an agent spec file; give the bundle the label \"My Authoring Bundle\" and use your default org:\n<%= config.bin %> <%= command.id %> --no-spec --name \"My Authoring Bundle\"",
|
|
1331
|
+
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\"; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
1332
|
+
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
1763
1333
|
],
|
|
1764
1334
|
"flags": {
|
|
1765
1335
|
"json": {
|
|
@@ -1787,6 +1357,13 @@
|
|
|
1787
1357
|
"multiple": false,
|
|
1788
1358
|
"type": "option"
|
|
1789
1359
|
},
|
|
1360
|
+
"api-name": {
|
|
1361
|
+
"name": "api-name",
|
|
1362
|
+
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
1363
|
+
"hasDynamicHelp": false,
|
|
1364
|
+
"multiple": false,
|
|
1365
|
+
"type": "option"
|
|
1366
|
+
},
|
|
1790
1367
|
"api-version": {
|
|
1791
1368
|
"description": "Override the api version used for api requests made by this command",
|
|
1792
1369
|
"name": "api-version",
|
|
@@ -1794,57 +1371,77 @@
|
|
|
1794
1371
|
"multiple": false,
|
|
1795
1372
|
"type": "option"
|
|
1796
1373
|
},
|
|
1797
|
-
"
|
|
1798
|
-
"char": "
|
|
1799
|
-
"name": "
|
|
1800
|
-
"
|
|
1801
|
-
"summary": "ID of the MCP server to delete.",
|
|
1374
|
+
"spec": {
|
|
1375
|
+
"char": "f",
|
|
1376
|
+
"name": "spec",
|
|
1377
|
+
"summary": "Path to the agent spec YAML file. If you don't specify the flag, the command provides a list that you can choose from. Use the --no-spec flag to skip using an agent spec entirely.",
|
|
1802
1378
|
"hasDynamicHelp": false,
|
|
1803
1379
|
"multiple": false,
|
|
1804
1380
|
"type": "option"
|
|
1805
1381
|
},
|
|
1806
|
-
"no-
|
|
1807
|
-
"name": "no-
|
|
1808
|
-
"summary": "Skip
|
|
1382
|
+
"no-spec": {
|
|
1383
|
+
"name": "no-spec",
|
|
1384
|
+
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
1385
|
+
"allowNo": false,
|
|
1386
|
+
"type": "boolean"
|
|
1387
|
+
},
|
|
1388
|
+
"output-dir": {
|
|
1389
|
+
"char": "d",
|
|
1390
|
+
"name": "output-dir",
|
|
1391
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
1392
|
+
"hasDynamicHelp": false,
|
|
1393
|
+
"multiple": false,
|
|
1394
|
+
"type": "option"
|
|
1395
|
+
},
|
|
1396
|
+
"name": {
|
|
1397
|
+
"char": "n",
|
|
1398
|
+
"name": "name",
|
|
1399
|
+
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1400
|
+
"hasDynamicHelp": false,
|
|
1401
|
+
"multiple": false,
|
|
1402
|
+
"type": "option"
|
|
1403
|
+
},
|
|
1404
|
+
"force-overwrite": {
|
|
1405
|
+
"name": "force-overwrite",
|
|
1406
|
+
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
1809
1407
|
"allowNo": false,
|
|
1810
1408
|
"type": "boolean"
|
|
1811
1409
|
}
|
|
1812
1410
|
},
|
|
1813
1411
|
"hasDynamicHelp": true,
|
|
1814
1412
|
"hiddenAliases": [],
|
|
1815
|
-
"id": "agent:
|
|
1413
|
+
"id": "agent:generate:authoring-bundle",
|
|
1816
1414
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1817
1415
|
"pluginName": "@salesforce/plugin-agent",
|
|
1818
1416
|
"pluginType": "core",
|
|
1819
|
-
"state": "preview",
|
|
1820
1417
|
"strict": true,
|
|
1821
|
-
"summary": "
|
|
1418
|
+
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
1822
1419
|
"enableJsonFlag": true,
|
|
1420
|
+
"requiresProject": true,
|
|
1823
1421
|
"isESM": true,
|
|
1824
1422
|
"relativePath": [
|
|
1825
1423
|
"lib",
|
|
1826
1424
|
"commands",
|
|
1827
1425
|
"agent",
|
|
1828
|
-
"
|
|
1829
|
-
"
|
|
1426
|
+
"generate",
|
|
1427
|
+
"authoring-bundle.js"
|
|
1830
1428
|
],
|
|
1831
1429
|
"aliasPermutations": [],
|
|
1832
1430
|
"permutations": [
|
|
1833
|
-
"agent:
|
|
1834
|
-
"
|
|
1835
|
-
"
|
|
1836
|
-
"agent:
|
|
1837
|
-
"
|
|
1838
|
-
"
|
|
1431
|
+
"agent:generate:authoring-bundle",
|
|
1432
|
+
"generate:agent:authoring-bundle",
|
|
1433
|
+
"generate:authoring-bundle:agent",
|
|
1434
|
+
"agent:authoring-bundle:generate",
|
|
1435
|
+
"authoring-bundle:agent:generate",
|
|
1436
|
+
"authoring-bundle:generate:agent"
|
|
1839
1437
|
]
|
|
1840
1438
|
},
|
|
1841
|
-
"agent:
|
|
1439
|
+
"agent:generate:template": {
|
|
1842
1440
|
"aliases": [],
|
|
1843
1441
|
"args": {},
|
|
1844
|
-
"description": "
|
|
1442
|
+
"description": "WARNING: This command doesn't work for agents that were created from an Agent Script file. In other words, you can't currently package an agent template for agents that use Agent Script.\n\nAt a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these three types, located in your local DX project, to generate a BotTemplate metadata file for a specific agent (Bot). You then use the BotTemplate metadata file, along with the GenAiPlannerBundle metadata file that references the BotTemplate, to package the template in a managed package that you can share between orgs or on AppExchange.\n\nUse the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple BotVersions, so use the --agent-version flag to specify the version. The corresponding BotVersion metadata file must exist locally. For example, if you specify \"--agent-version 4\", then the file force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.\n\nThe new BotTemplate metadata file is generated in the \"botTemplates\" directory in the output directory specified with the --output-dir flag, and has the name <Agent_API_name>\\_v<Version>\\_Template.botTemplate-meta.xml, such as my-package/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.\n\nSee \"Develop and Package Agent Templates Using Scratch Orgs\" (https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/dev2gp_package_agent_templates.htm) for details about the complete process, which includes using a scratch org to create and test the agent, retrieving the agent metadata to your DX project, running this command to create the agent template, and then packaging the template.",
|
|
1845
1443
|
"examples": [
|
|
1846
|
-
"
|
|
1847
|
-
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1444
|
+
"Generate an agent template from the My_Awesome_Agent Bot metadata file in your DX project and save the BotTemplate and GenAiPlannerBundle to the specified directory; use version 1 of the agent. The agent that the template is based on is in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1 --output-dir my-package --source-org my-scratch-org"
|
|
1848
1445
|
],
|
|
1849
1446
|
"flags": {
|
|
1850
1447
|
"json": {
|
|
@@ -1862,28 +1459,44 @@
|
|
|
1862
1459
|
"multiple": false,
|
|
1863
1460
|
"type": "option"
|
|
1864
1461
|
},
|
|
1865
|
-
"
|
|
1866
|
-
"
|
|
1867
|
-
"name": "
|
|
1462
|
+
"api-version": {
|
|
1463
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1464
|
+
"name": "api-version",
|
|
1465
|
+
"hasDynamicHelp": false,
|
|
1466
|
+
"multiple": false,
|
|
1467
|
+
"type": "option"
|
|
1468
|
+
},
|
|
1469
|
+
"source-org": {
|
|
1470
|
+
"char": "s",
|
|
1471
|
+
"name": "source-org",
|
|
1868
1472
|
"noCacheDefault": true,
|
|
1869
1473
|
"required": true,
|
|
1870
|
-
"summary": "Username or alias of the
|
|
1474
|
+
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
1871
1475
|
"hasDynamicHelp": true,
|
|
1872
1476
|
"multiple": false,
|
|
1873
1477
|
"type": "option"
|
|
1874
1478
|
},
|
|
1875
|
-
"
|
|
1876
|
-
"
|
|
1877
|
-
"
|
|
1479
|
+
"agent-version": {
|
|
1480
|
+
"name": "agent-version",
|
|
1481
|
+
"required": true,
|
|
1482
|
+
"summary": "Version of the agent (BotVersion).",
|
|
1878
1483
|
"hasDynamicHelp": false,
|
|
1879
1484
|
"multiple": false,
|
|
1880
1485
|
"type": "option"
|
|
1881
1486
|
},
|
|
1882
|
-
"
|
|
1883
|
-
"char": "
|
|
1884
|
-
"name": "
|
|
1487
|
+
"agent-file": {
|
|
1488
|
+
"char": "f",
|
|
1489
|
+
"name": "agent-file",
|
|
1885
1490
|
"required": true,
|
|
1886
|
-
"summary": "
|
|
1491
|
+
"summary": "Path to an agent (Bot) metadata file.",
|
|
1492
|
+
"hasDynamicHelp": false,
|
|
1493
|
+
"multiple": false,
|
|
1494
|
+
"type": "option"
|
|
1495
|
+
},
|
|
1496
|
+
"output-dir": {
|
|
1497
|
+
"char": "r",
|
|
1498
|
+
"name": "output-dir",
|
|
1499
|
+
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
1887
1500
|
"hasDynamicHelp": false,
|
|
1888
1501
|
"multiple": false,
|
|
1889
1502
|
"type": "option"
|
|
@@ -1891,48 +1504,44 @@
|
|
|
1891
1504
|
},
|
|
1892
1505
|
"hasDynamicHelp": true,
|
|
1893
1506
|
"hiddenAliases": [],
|
|
1894
|
-
"id": "agent:
|
|
1507
|
+
"id": "agent:generate:template",
|
|
1895
1508
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1896
1509
|
"pluginName": "@salesforce/plugin-agent",
|
|
1897
1510
|
"pluginType": "core",
|
|
1898
|
-
"state": "preview",
|
|
1899
1511
|
"strict": true,
|
|
1900
|
-
"summary": "
|
|
1512
|
+
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a second-generation managed package.",
|
|
1901
1513
|
"enableJsonFlag": true,
|
|
1514
|
+
"requiresProject": true,
|
|
1902
1515
|
"isESM": true,
|
|
1903
1516
|
"relativePath": [
|
|
1904
1517
|
"lib",
|
|
1905
1518
|
"commands",
|
|
1906
1519
|
"agent",
|
|
1907
|
-
"
|
|
1908
|
-
"
|
|
1520
|
+
"generate",
|
|
1521
|
+
"template.js"
|
|
1909
1522
|
],
|
|
1910
1523
|
"aliasPermutations": [],
|
|
1911
1524
|
"permutations": [
|
|
1912
|
-
"agent:
|
|
1913
|
-
"
|
|
1914
|
-
"
|
|
1915
|
-
"agent:
|
|
1916
|
-
"
|
|
1917
|
-
"
|
|
1525
|
+
"agent:generate:template",
|
|
1526
|
+
"generate:agent:template",
|
|
1527
|
+
"generate:template:agent",
|
|
1528
|
+
"agent:template:generate",
|
|
1529
|
+
"template:agent:generate",
|
|
1530
|
+
"template:generate:agent"
|
|
1918
1531
|
]
|
|
1919
1532
|
},
|
|
1920
|
-
"agent:
|
|
1533
|
+
"agent:generate:test-spec": {
|
|
1921
1534
|
"aliases": [],
|
|
1922
1535
|
"args": {},
|
|
1923
|
-
"description": "
|
|
1536
|
+
"description": "The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX project when prompting for information, such as the agent API name; it doesn't look in your org.\n\nTo generate a specific agent test case, this command prompts you for this information; when possible, the command provides a list of options for you to choose from:\n\n- Utterance: Natural language statement, question, or command used to test the agent.\n- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.\n- Expected actions: One or more API names of the expection actions the agent takes.\n- Expected outcome: Natural language description of the outcome you expect.\n- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.\n- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.\n\nYou can manually add contextVariables to test cases in the generated YAML file to inject contextual data (such as CaseId or RoutableId) into agent sessions. This is useful for testing agent behavior with different contextual information.\n\nWhen your test spec is ready, you then run the \"agent test create\" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is `AiEvaluationDefinition` (legacy testing-center) or `AiTestingDefinition` (Agentforce Studio / NGT), selected via --test-runner.\n\nIf you have an existing AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag. The runner is inferred from the file extension; pass --test-runner to override.",
|
|
1924
1537
|
"examples": [
|
|
1925
|
-
"
|
|
1926
|
-
"
|
|
1538
|
+
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
1539
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
1540
|
+
"Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without confirmation:\n<%= config.bin %> <%= command.id %> --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite",
|
|
1541
|
+
"Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml",
|
|
1542
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
1927
1543
|
],
|
|
1928
1544
|
"flags": {
|
|
1929
|
-
"json": {
|
|
1930
|
-
"description": "Format output as json.",
|
|
1931
|
-
"helpGroup": "GLOBAL",
|
|
1932
|
-
"name": "json",
|
|
1933
|
-
"allowNo": false,
|
|
1934
|
-
"type": "boolean"
|
|
1935
|
-
},
|
|
1936
1545
|
"flags-dir": {
|
|
1937
1546
|
"helpGroup": "GLOBAL",
|
|
1938
1547
|
"name": "flags-dir",
|
|
@@ -1941,166 +1550,75 @@
|
|
|
1941
1550
|
"multiple": false,
|
|
1942
1551
|
"type": "option"
|
|
1943
1552
|
},
|
|
1944
|
-
"
|
|
1945
|
-
"char": "
|
|
1946
|
-
"name": "
|
|
1947
|
-
"
|
|
1948
|
-
"required": true,
|
|
1949
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1950
|
-
"hasDynamicHelp": true,
|
|
1951
|
-
"multiple": false,
|
|
1952
|
-
"type": "option"
|
|
1953
|
-
},
|
|
1954
|
-
"api-version": {
|
|
1955
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1956
|
-
"name": "api-version",
|
|
1553
|
+
"from-definition": {
|
|
1554
|
+
"char": "d",
|
|
1555
|
+
"name": "from-definition",
|
|
1556
|
+
"summary": "Filepath to an AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project that you want to convert to a test spec YAML file.",
|
|
1957
1557
|
"hasDynamicHelp": false,
|
|
1958
1558
|
"multiple": false,
|
|
1959
1559
|
"type": "option"
|
|
1960
1560
|
},
|
|
1961
|
-
"
|
|
1962
|
-
"
|
|
1963
|
-
"
|
|
1964
|
-
"required": true,
|
|
1965
|
-
"summary": "The identifier of the MCP server to retrieve.",
|
|
1966
|
-
"hasDynamicHelp": false,
|
|
1967
|
-
"multiple": false,
|
|
1968
|
-
"type": "option"
|
|
1969
|
-
}
|
|
1970
|
-
},
|
|
1971
|
-
"hasDynamicHelp": true,
|
|
1972
|
-
"hiddenAliases": [],
|
|
1973
|
-
"id": "agent:mcp:get",
|
|
1974
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1975
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1976
|
-
"pluginType": "core",
|
|
1977
|
-
"state": "preview",
|
|
1978
|
-
"strict": true,
|
|
1979
|
-
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
1980
|
-
"enableJsonFlag": true,
|
|
1981
|
-
"isESM": true,
|
|
1982
|
-
"relativePath": [
|
|
1983
|
-
"lib",
|
|
1984
|
-
"commands",
|
|
1985
|
-
"agent",
|
|
1986
|
-
"mcp",
|
|
1987
|
-
"get.js"
|
|
1988
|
-
],
|
|
1989
|
-
"aliasPermutations": [],
|
|
1990
|
-
"permutations": [
|
|
1991
|
-
"agent:mcp:get",
|
|
1992
|
-
"mcp:agent:get",
|
|
1993
|
-
"mcp:get:agent",
|
|
1994
|
-
"agent:get:mcp",
|
|
1995
|
-
"get:agent:mcp",
|
|
1996
|
-
"get:mcp:agent"
|
|
1997
|
-
]
|
|
1998
|
-
},
|
|
1999
|
-
"agent:mcp:list": {
|
|
2000
|
-
"aliases": [],
|
|
2001
|
-
"args": {},
|
|
2002
|
-
"description": "Returns the Model Context Protocol (MCP) servers registered in the API Catalog, optionally filtered by label, type, or status. Use this to discover which MCP servers are available and inspect their server URLs and current status.",
|
|
2003
|
-
"examples": [
|
|
2004
|
-
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
2005
|
-
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
2006
|
-
],
|
|
2007
|
-
"flags": {
|
|
2008
|
-
"json": {
|
|
2009
|
-
"description": "Format output as json.",
|
|
2010
|
-
"helpGroup": "GLOBAL",
|
|
2011
|
-
"name": "json",
|
|
1561
|
+
"force-overwrite": {
|
|
1562
|
+
"name": "force-overwrite",
|
|
1563
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
2012
1564
|
"allowNo": false,
|
|
2013
1565
|
"type": "boolean"
|
|
2014
1566
|
},
|
|
2015
|
-
"
|
|
2016
|
-
"
|
|
2017
|
-
"name": "
|
|
2018
|
-
"summary": "
|
|
2019
|
-
"hasDynamicHelp": false,
|
|
2020
|
-
"multiple": false,
|
|
2021
|
-
"type": "option"
|
|
2022
|
-
},
|
|
2023
|
-
"target-org": {
|
|
2024
|
-
"char": "o",
|
|
2025
|
-
"name": "target-org",
|
|
2026
|
-
"noCacheDefault": true,
|
|
2027
|
-
"required": true,
|
|
2028
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2029
|
-
"hasDynamicHelp": true,
|
|
2030
|
-
"multiple": false,
|
|
2031
|
-
"type": "option"
|
|
2032
|
-
},
|
|
2033
|
-
"api-version": {
|
|
2034
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2035
|
-
"name": "api-version",
|
|
2036
|
-
"hasDynamicHelp": false,
|
|
2037
|
-
"multiple": false,
|
|
2038
|
-
"type": "option"
|
|
2039
|
-
},
|
|
2040
|
-
"label": {
|
|
2041
|
-
"name": "label",
|
|
2042
|
-
"summary": "Filter the MCP servers by label.",
|
|
2043
|
-
"hasDynamicHelp": false,
|
|
2044
|
-
"multiple": false,
|
|
2045
|
-
"type": "option"
|
|
2046
|
-
},
|
|
2047
|
-
"type": {
|
|
2048
|
-
"name": "type",
|
|
2049
|
-
"summary": "Filter the MCP servers by type.",
|
|
1567
|
+
"output-file": {
|
|
1568
|
+
"char": "f",
|
|
1569
|
+
"name": "output-file",
|
|
1570
|
+
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\" (legacy) or \"specs/<AGENT_API_NAME>-ngtTestSpec.yaml\" (Agentforce Studio).",
|
|
2050
1571
|
"hasDynamicHelp": false,
|
|
2051
1572
|
"multiple": false,
|
|
2052
|
-
"options": [
|
|
2053
|
-
"EXTERNAL"
|
|
2054
|
-
],
|
|
2055
1573
|
"type": "option"
|
|
2056
1574
|
},
|
|
2057
|
-
"
|
|
2058
|
-
"
|
|
2059
|
-
"
|
|
1575
|
+
"test-runner": {
|
|
1576
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
1577
|
+
"name": "test-runner",
|
|
1578
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2060
1579
|
"hasDynamicHelp": false,
|
|
2061
1580
|
"multiple": false,
|
|
2062
1581
|
"options": [
|
|
2063
|
-
"
|
|
2064
|
-
"
|
|
1582
|
+
"agentforce-studio",
|
|
1583
|
+
"testing-center"
|
|
2065
1584
|
],
|
|
2066
1585
|
"type": "option"
|
|
2067
1586
|
}
|
|
2068
1587
|
},
|
|
2069
|
-
"hasDynamicHelp":
|
|
1588
|
+
"hasDynamicHelp": false,
|
|
2070
1589
|
"hiddenAliases": [],
|
|
2071
|
-
"id": "agent:
|
|
1590
|
+
"id": "agent:generate:test-spec",
|
|
2072
1591
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2073
1592
|
"pluginName": "@salesforce/plugin-agent",
|
|
2074
1593
|
"pluginType": "core",
|
|
2075
|
-
"state": "preview",
|
|
2076
1594
|
"strict": true,
|
|
2077
|
-
"summary": "
|
|
2078
|
-
"enableJsonFlag":
|
|
1595
|
+
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
1596
|
+
"enableJsonFlag": false,
|
|
2079
1597
|
"isESM": true,
|
|
2080
1598
|
"relativePath": [
|
|
2081
1599
|
"lib",
|
|
2082
1600
|
"commands",
|
|
2083
1601
|
"agent",
|
|
2084
|
-
"
|
|
2085
|
-
"
|
|
1602
|
+
"generate",
|
|
1603
|
+
"test-spec.js"
|
|
2086
1604
|
],
|
|
2087
1605
|
"aliasPermutations": [],
|
|
2088
1606
|
"permutations": [
|
|
2089
|
-
"agent:
|
|
2090
|
-
"
|
|
2091
|
-
"
|
|
2092
|
-
"agent:
|
|
2093
|
-
"
|
|
2094
|
-
"
|
|
1607
|
+
"agent:generate:test-spec",
|
|
1608
|
+
"generate:agent:test-spec",
|
|
1609
|
+
"generate:test-spec:agent",
|
|
1610
|
+
"agent:test-spec:generate",
|
|
1611
|
+
"test-spec:agent:generate",
|
|
1612
|
+
"test-spec:generate:agent"
|
|
2095
1613
|
]
|
|
2096
1614
|
},
|
|
2097
|
-
"agent:mcp:
|
|
1615
|
+
"agent:mcp:create": {
|
|
2098
1616
|
"aliases": [],
|
|
2099
1617
|
"args": {},
|
|
2100
|
-
"description": "
|
|
1618
|
+
"description": "Registers an external Model Context Protocol (MCP) server with the API Catalog and discovers its assets (tools, prompts, and resources). Provide the server URL and, when the server requires it, OAuth authorization details. When the authorization type is OAUTH you must supply the identity provider, client ID, client secret, and scope.",
|
|
2101
1619
|
"examples": [
|
|
2102
|
-
"
|
|
2103
|
-
"
|
|
1620
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
1621
|
+
"Create an MCP server that uses OAuth authentication, piping the client secret from stdin to keep it out of shell history:\ncat secret.txt | <%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --auth-type OAUTH --identity-provider myIdp --client-id abc123 --client-secret - --scope \"read write\" --target-org myOrg"
|
|
2104
1622
|
],
|
|
2105
1623
|
"flags": {
|
|
2106
1624
|
"json": {
|
|
@@ -2135,39 +1653,41 @@
|
|
|
2135
1653
|
"multiple": false,
|
|
2136
1654
|
"type": "option"
|
|
2137
1655
|
},
|
|
2138
|
-
"
|
|
2139
|
-
"char": "
|
|
2140
|
-
"name": "
|
|
1656
|
+
"name": {
|
|
1657
|
+
"char": "n",
|
|
1658
|
+
"name": "name",
|
|
2141
1659
|
"required": true,
|
|
2142
|
-
"summary": "
|
|
1660
|
+
"summary": "Unique name of the MCP server.",
|
|
2143
1661
|
"hasDynamicHelp": false,
|
|
2144
1662
|
"multiple": false,
|
|
2145
1663
|
"type": "option"
|
|
2146
1664
|
},
|
|
2147
1665
|
"label": {
|
|
2148
1666
|
"name": "label",
|
|
2149
|
-
"summary": "
|
|
1667
|
+
"summary": "Human-readable label for the MCP server.",
|
|
2150
1668
|
"hasDynamicHelp": false,
|
|
2151
1669
|
"multiple": false,
|
|
2152
1670
|
"type": "option"
|
|
2153
1671
|
},
|
|
2154
1672
|
"description": {
|
|
2155
1673
|
"name": "description",
|
|
2156
|
-
"summary": "
|
|
1674
|
+
"summary": "Description of the MCP server.",
|
|
2157
1675
|
"hasDynamicHelp": false,
|
|
2158
1676
|
"multiple": false,
|
|
2159
1677
|
"type": "option"
|
|
2160
1678
|
},
|
|
2161
1679
|
"server-url": {
|
|
2162
1680
|
"name": "server-url",
|
|
2163
|
-
"
|
|
1681
|
+
"required": true,
|
|
1682
|
+
"summary": "URL of the external MCP server.",
|
|
2164
1683
|
"hasDynamicHelp": false,
|
|
2165
1684
|
"multiple": false,
|
|
2166
1685
|
"type": "option"
|
|
2167
1686
|
},
|
|
2168
1687
|
"auth-type": {
|
|
2169
1688
|
"name": "auth-type",
|
|
2170
|
-
"summary": "Authorization type to
|
|
1689
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
1690
|
+
"default": "NO_AUTH",
|
|
2171
1691
|
"hasDynamicHelp": false,
|
|
2172
1692
|
"multiple": false,
|
|
2173
1693
|
"options": [
|
|
@@ -2178,28 +1698,28 @@
|
|
|
2178
1698
|
},
|
|
2179
1699
|
"identity-provider": {
|
|
2180
1700
|
"name": "identity-provider",
|
|
2181
|
-
"summary": "Identity provider
|
|
1701
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
2182
1702
|
"hasDynamicHelp": false,
|
|
2183
1703
|
"multiple": false,
|
|
2184
1704
|
"type": "option"
|
|
2185
1705
|
},
|
|
2186
1706
|
"client-id": {
|
|
2187
1707
|
"name": "client-id",
|
|
2188
|
-
"summary": "OAuth client ID
|
|
1708
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
2189
1709
|
"hasDynamicHelp": false,
|
|
2190
1710
|
"multiple": false,
|
|
2191
1711
|
"type": "option"
|
|
2192
1712
|
},
|
|
2193
1713
|
"client-secret": {
|
|
2194
1714
|
"name": "client-secret",
|
|
2195
|
-
"summary": "OAuth client secret
|
|
1715
|
+
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2196
1716
|
"hasDynamicHelp": false,
|
|
2197
1717
|
"multiple": false,
|
|
2198
1718
|
"type": "option"
|
|
2199
1719
|
},
|
|
2200
1720
|
"scope": {
|
|
2201
1721
|
"name": "scope",
|
|
2202
|
-
"summary": "OAuth scope
|
|
1722
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
2203
1723
|
"hasDynamicHelp": false,
|
|
2204
1724
|
"multiple": false,
|
|
2205
1725
|
"type": "option"
|
|
@@ -2207,13 +1727,13 @@
|
|
|
2207
1727
|
},
|
|
2208
1728
|
"hasDynamicHelp": true,
|
|
2209
1729
|
"hiddenAliases": [],
|
|
2210
|
-
"id": "agent:mcp:
|
|
1730
|
+
"id": "agent:mcp:create",
|
|
2211
1731
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2212
1732
|
"pluginName": "@salesforce/plugin-agent",
|
|
2213
1733
|
"pluginType": "core",
|
|
2214
1734
|
"state": "preview",
|
|
2215
1735
|
"strict": true,
|
|
2216
|
-
"summary": "
|
|
1736
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
2217
1737
|
"enableJsonFlag": true,
|
|
2218
1738
|
"isESM": true,
|
|
2219
1739
|
"relativePath": [
|
|
@@ -2221,28 +1741,25 @@
|
|
|
2221
1741
|
"commands",
|
|
2222
1742
|
"agent",
|
|
2223
1743
|
"mcp",
|
|
2224
|
-
"
|
|
1744
|
+
"create.js"
|
|
2225
1745
|
],
|
|
2226
1746
|
"aliasPermutations": [],
|
|
2227
1747
|
"permutations": [
|
|
2228
|
-
"agent:mcp:
|
|
2229
|
-
"mcp:agent:
|
|
2230
|
-
"mcp:
|
|
2231
|
-
"agent:
|
|
2232
|
-
"
|
|
2233
|
-
"
|
|
1748
|
+
"agent:mcp:create",
|
|
1749
|
+
"mcp:agent:create",
|
|
1750
|
+
"mcp:create:agent",
|
|
1751
|
+
"agent:create:mcp",
|
|
1752
|
+
"create:agent:mcp",
|
|
1753
|
+
"create:mcp:agent"
|
|
2234
1754
|
]
|
|
2235
1755
|
},
|
|
2236
|
-
"agent:
|
|
1756
|
+
"agent:mcp:delete": {
|
|
2237
1757
|
"aliases": [],
|
|
2238
1758
|
"args": {},
|
|
2239
|
-
"description": "
|
|
1759
|
+
"description": "Permanently removes an MCP (Model Context Protocol) server registration from the API Catalog, identified by its ID. By default you are prompted to confirm the deletion; pass --no-prompt to skip the confirmation (for example in scripts and CI).",
|
|
2240
1760
|
"examples": [
|
|
2241
|
-
"
|
|
2242
|
-
"
|
|
2243
|
-
"End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent",
|
|
2244
|
-
"End all active preview sessions for a specific agent without prompting:\n<%= config.bin %> <%= command.id %> --all --authoring-bundle My_Local_Agent --target-org <target_org> --no-prompt",
|
|
2245
|
-
"End all active preview sessions across every agent in the local session cache for an org:\n<%= config.bin %> <%= command.id %> --all --target-org <target_org>"
|
|
1761
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
1762
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
2246
1763
|
],
|
|
2247
1764
|
"flags": {
|
|
2248
1765
|
"json": {
|
|
@@ -2277,129 +1794,57 @@
|
|
|
2277
1794
|
"multiple": false,
|
|
2278
1795
|
"type": "option"
|
|
2279
1796
|
},
|
|
2280
|
-
"
|
|
2281
|
-
"
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
"
|
|
2285
|
-
"required": false,
|
|
2286
|
-
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
|
|
2287
|
-
"hasDynamicHelp": false,
|
|
2288
|
-
"multiple": false,
|
|
2289
|
-
"type": "option"
|
|
2290
|
-
},
|
|
2291
|
-
"api-name": {
|
|
2292
|
-
"char": "n",
|
|
2293
|
-
"exclusive": [
|
|
2294
|
-
"authoring-bundle"
|
|
2295
|
-
],
|
|
2296
|
-
"name": "api-name",
|
|
2297
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2298
|
-
"hasDynamicHelp": false,
|
|
2299
|
-
"multiple": false,
|
|
2300
|
-
"type": "option"
|
|
2301
|
-
},
|
|
2302
|
-
"authoring-bundle": {
|
|
2303
|
-
"exclusive": [
|
|
2304
|
-
"api-name"
|
|
2305
|
-
],
|
|
2306
|
-
"name": "authoring-bundle",
|
|
2307
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1797
|
+
"mcp-server-id": {
|
|
1798
|
+
"char": "i",
|
|
1799
|
+
"name": "mcp-server-id",
|
|
1800
|
+
"required": true,
|
|
1801
|
+
"summary": "ID of the MCP server to delete.",
|
|
2308
1802
|
"hasDynamicHelp": false,
|
|
2309
1803
|
"multiple": false,
|
|
2310
1804
|
"type": "option"
|
|
2311
1805
|
},
|
|
2312
|
-
"all": {
|
|
2313
|
-
"exclusive": [
|
|
2314
|
-
"session-id"
|
|
2315
|
-
],
|
|
2316
|
-
"name": "all",
|
|
2317
|
-
"summary": "End all active preview sessions. Combine with --api-name or --authoring-bundle to limit to a specific agent, or use with only --target-org to end sessions for all agents found in the local session cache. Requires --target-org.",
|
|
2318
|
-
"allowNo": false,
|
|
2319
|
-
"type": "boolean"
|
|
2320
|
-
},
|
|
2321
1806
|
"no-prompt": {
|
|
2322
|
-
"char": "p",
|
|
2323
1807
|
"name": "no-prompt",
|
|
2324
|
-
"summary": "
|
|
1808
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
2325
1809
|
"allowNo": false,
|
|
2326
1810
|
"type": "boolean"
|
|
2327
1811
|
}
|
|
2328
1812
|
},
|
|
2329
1813
|
"hasDynamicHelp": true,
|
|
2330
1814
|
"hiddenAliases": [],
|
|
2331
|
-
"id": "agent:
|
|
1815
|
+
"id": "agent:mcp:delete",
|
|
2332
1816
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2333
1817
|
"pluginName": "@salesforce/plugin-agent",
|
|
2334
1818
|
"pluginType": "core",
|
|
1819
|
+
"state": "preview",
|
|
2335
1820
|
"strict": true,
|
|
2336
|
-
"summary": "
|
|
1821
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
2337
1822
|
"enableJsonFlag": true,
|
|
2338
|
-
"requiresProject": true,
|
|
2339
|
-
"envVariablesSection": {
|
|
2340
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2341
|
-
"body": [
|
|
2342
|
-
{
|
|
2343
|
-
"name": "SF_TARGET_ORG",
|
|
2344
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2345
|
-
}
|
|
2346
|
-
]
|
|
2347
|
-
},
|
|
2348
|
-
"errorCodes": {
|
|
2349
|
-
"header": "ERROR CODES",
|
|
2350
|
-
"body": [
|
|
2351
|
-
{
|
|
2352
|
-
"name": "Succeeded (0)",
|
|
2353
|
-
"description": "Preview session ended successfully and traces saved."
|
|
2354
|
-
},
|
|
2355
|
-
{
|
|
2356
|
-
"name": "ExactlyOneRequired (2)",
|
|
2357
|
-
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
2358
|
-
},
|
|
2359
|
-
{
|
|
2360
|
-
"name": "NotFound (2)",
|
|
2361
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
2362
|
-
},
|
|
2363
|
-
{
|
|
2364
|
-
"name": "PreviewEndFailed (4)",
|
|
2365
|
-
"description": "Failed to end the preview session."
|
|
2366
|
-
},
|
|
2367
|
-
{
|
|
2368
|
-
"name": "PreviewEndPartialFailure (68)",
|
|
2369
|
-
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
2370
|
-
},
|
|
2371
|
-
{
|
|
2372
|
-
"name": "SessionAmbiguous (5)",
|
|
2373
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2374
|
-
}
|
|
2375
|
-
]
|
|
2376
|
-
},
|
|
2377
1823
|
"isESM": true,
|
|
2378
1824
|
"relativePath": [
|
|
2379
1825
|
"lib",
|
|
2380
1826
|
"commands",
|
|
2381
1827
|
"agent",
|
|
2382
|
-
"
|
|
2383
|
-
"
|
|
1828
|
+
"mcp",
|
|
1829
|
+
"delete.js"
|
|
2384
1830
|
],
|
|
2385
1831
|
"aliasPermutations": [],
|
|
2386
1832
|
"permutations": [
|
|
2387
|
-
"agent:
|
|
2388
|
-
"
|
|
2389
|
-
"
|
|
2390
|
-
"agent:
|
|
2391
|
-
"
|
|
2392
|
-
"
|
|
1833
|
+
"agent:mcp:delete",
|
|
1834
|
+
"mcp:agent:delete",
|
|
1835
|
+
"mcp:delete:agent",
|
|
1836
|
+
"agent:delete:mcp",
|
|
1837
|
+
"delete:agent:mcp",
|
|
1838
|
+
"delete:mcp:agent"
|
|
2393
1839
|
]
|
|
2394
1840
|
},
|
|
2395
|
-
"agent:
|
|
1841
|
+
"agent:mcp:fetch": {
|
|
2396
1842
|
"aliases": [],
|
|
2397
1843
|
"args": {},
|
|
2398
|
-
"description": "
|
|
1844
|
+
"description": "Performs a live fetch against the configured MCP server identified by its ID, returning the assets (MCP tools, prompts, and resources) it currently advertises along with their status and activation state. Use this to refresh the view of what an MCP server exposes before activating its assets as agent actions.",
|
|
2399
1845
|
"examples": [
|
|
2400
|
-
"
|
|
2401
|
-
"
|
|
2402
|
-
"Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
|
|
1846
|
+
"Fetch the assets advertised by an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001",
|
|
1847
|
+
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
2403
1848
|
],
|
|
2404
1849
|
"flags": {
|
|
2405
1850
|
"json": {
|
|
@@ -2434,34 +1879,11 @@
|
|
|
2434
1879
|
"multiple": false,
|
|
2435
1880
|
"type": "option"
|
|
2436
1881
|
},
|
|
2437
|
-
"
|
|
2438
|
-
"
|
|
2439
|
-
"
|
|
2440
|
-
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see list of all sessions.",
|
|
2441
|
-
"hasDynamicHelp": false,
|
|
2442
|
-
"multiple": false,
|
|
2443
|
-
"type": "option"
|
|
2444
|
-
},
|
|
2445
|
-
"utterance": {
|
|
2446
|
-
"char": "u",
|
|
2447
|
-
"name": "utterance",
|
|
1882
|
+
"mcp-server-id": {
|
|
1883
|
+
"char": "i",
|
|
1884
|
+
"name": "mcp-server-id",
|
|
2448
1885
|
"required": true,
|
|
2449
|
-
"summary": "
|
|
2450
|
-
"hasDynamicHelp": false,
|
|
2451
|
-
"multiple": false,
|
|
2452
|
-
"type": "option"
|
|
2453
|
-
},
|
|
2454
|
-
"api-name": {
|
|
2455
|
-
"char": "n",
|
|
2456
|
-
"name": "api-name",
|
|
2457
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2458
|
-
"hasDynamicHelp": false,
|
|
2459
|
-
"multiple": false,
|
|
2460
|
-
"type": "option"
|
|
2461
|
-
},
|
|
2462
|
-
"authoring-bundle": {
|
|
2463
|
-
"name": "authoring-bundle",
|
|
2464
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1886
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
2465
1887
|
"hasDynamicHelp": false,
|
|
2466
1888
|
"multiple": false,
|
|
2467
1889
|
"type": "option"
|
|
@@ -2469,68 +1891,39 @@
|
|
|
2469
1891
|
},
|
|
2470
1892
|
"hasDynamicHelp": true,
|
|
2471
1893
|
"hiddenAliases": [],
|
|
2472
|
-
"id": "agent:
|
|
1894
|
+
"id": "agent:mcp:fetch",
|
|
2473
1895
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2474
1896
|
"pluginName": "@salesforce/plugin-agent",
|
|
2475
1897
|
"pluginType": "core",
|
|
1898
|
+
"state": "preview",
|
|
2476
1899
|
"strict": true,
|
|
2477
|
-
"summary": "
|
|
1900
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
2478
1901
|
"enableJsonFlag": true,
|
|
2479
|
-
"requiresProject": true,
|
|
2480
|
-
"envVariablesSection": {
|
|
2481
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2482
|
-
"body": [
|
|
2483
|
-
{
|
|
2484
|
-
"name": "SF_TARGET_ORG",
|
|
2485
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2486
|
-
}
|
|
2487
|
-
]
|
|
2488
|
-
},
|
|
2489
|
-
"errorCodes": {
|
|
2490
|
-
"header": "ERROR CODES",
|
|
2491
|
-
"body": [
|
|
2492
|
-
{
|
|
2493
|
-
"name": "Succeeded (0)",
|
|
2494
|
-
"description": "Message sent successfully and agent response received."
|
|
2495
|
-
},
|
|
2496
|
-
{
|
|
2497
|
-
"name": "NotFound (2)",
|
|
2498
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
2499
|
-
},
|
|
2500
|
-
{
|
|
2501
|
-
"name": "PreviewSendFailed (4)",
|
|
2502
|
-
"description": "Failed to send message or receive response from the preview session."
|
|
2503
|
-
},
|
|
2504
|
-
{
|
|
2505
|
-
"name": "SessionAmbiguous (5)",
|
|
2506
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2507
|
-
}
|
|
2508
|
-
]
|
|
2509
|
-
},
|
|
2510
1902
|
"isESM": true,
|
|
2511
1903
|
"relativePath": [
|
|
2512
1904
|
"lib",
|
|
2513
1905
|
"commands",
|
|
2514
1906
|
"agent",
|
|
2515
|
-
"
|
|
2516
|
-
"
|
|
1907
|
+
"mcp",
|
|
1908
|
+
"fetch.js"
|
|
2517
1909
|
],
|
|
2518
1910
|
"aliasPermutations": [],
|
|
2519
1911
|
"permutations": [
|
|
2520
|
-
"agent:
|
|
2521
|
-
"
|
|
2522
|
-
"
|
|
2523
|
-
"agent:
|
|
2524
|
-
"
|
|
2525
|
-
"
|
|
1912
|
+
"agent:mcp:fetch",
|
|
1913
|
+
"mcp:agent:fetch",
|
|
1914
|
+
"mcp:fetch:agent",
|
|
1915
|
+
"agent:fetch:mcp",
|
|
1916
|
+
"fetch:agent:mcp",
|
|
1917
|
+
"fetch:mcp:agent"
|
|
2526
1918
|
]
|
|
2527
1919
|
},
|
|
2528
|
-
"agent:
|
|
1920
|
+
"agent:mcp:get": {
|
|
2529
1921
|
"aliases": [],
|
|
2530
1922
|
"args": {},
|
|
2531
|
-
"description": "
|
|
1923
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
2532
1924
|
"examples": [
|
|
2533
|
-
"
|
|
1925
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1926
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
2534
1927
|
],
|
|
2535
1928
|
"flags": {
|
|
2536
1929
|
"json": {
|
|
@@ -2547,53 +1940,69 @@
|
|
|
2547
1940
|
"hasDynamicHelp": false,
|
|
2548
1941
|
"multiple": false,
|
|
2549
1942
|
"type": "option"
|
|
1943
|
+
},
|
|
1944
|
+
"target-org": {
|
|
1945
|
+
"char": "o",
|
|
1946
|
+
"name": "target-org",
|
|
1947
|
+
"noCacheDefault": true,
|
|
1948
|
+
"required": true,
|
|
1949
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1950
|
+
"hasDynamicHelp": true,
|
|
1951
|
+
"multiple": false,
|
|
1952
|
+
"type": "option"
|
|
1953
|
+
},
|
|
1954
|
+
"api-version": {
|
|
1955
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1956
|
+
"name": "api-version",
|
|
1957
|
+
"hasDynamicHelp": false,
|
|
1958
|
+
"multiple": false,
|
|
1959
|
+
"type": "option"
|
|
1960
|
+
},
|
|
1961
|
+
"mcp-server-id": {
|
|
1962
|
+
"char": "i",
|
|
1963
|
+
"name": "mcp-server-id",
|
|
1964
|
+
"required": true,
|
|
1965
|
+
"summary": "The identifier of the MCP server to retrieve.",
|
|
1966
|
+
"hasDynamicHelp": false,
|
|
1967
|
+
"multiple": false,
|
|
1968
|
+
"type": "option"
|
|
2550
1969
|
}
|
|
2551
1970
|
},
|
|
2552
|
-
"hasDynamicHelp":
|
|
1971
|
+
"hasDynamicHelp": true,
|
|
2553
1972
|
"hiddenAliases": [],
|
|
2554
|
-
"id": "agent:
|
|
1973
|
+
"id": "agent:mcp:get",
|
|
2555
1974
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2556
1975
|
"pluginName": "@salesforce/plugin-agent",
|
|
2557
1976
|
"pluginType": "core",
|
|
1977
|
+
"state": "preview",
|
|
2558
1978
|
"strict": true,
|
|
2559
|
-
"summary": "
|
|
1979
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
2560
1980
|
"enableJsonFlag": true,
|
|
2561
|
-
"requiresProject": true,
|
|
2562
|
-
"errorCodes": {
|
|
2563
|
-
"header": "ERROR CODES",
|
|
2564
|
-
"body": [
|
|
2565
|
-
{
|
|
2566
|
-
"name": "Succeeded (0)",
|
|
2567
|
-
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
2568
|
-
}
|
|
2569
|
-
]
|
|
2570
|
-
},
|
|
2571
1981
|
"isESM": true,
|
|
2572
1982
|
"relativePath": [
|
|
2573
1983
|
"lib",
|
|
2574
1984
|
"commands",
|
|
2575
1985
|
"agent",
|
|
2576
|
-
"
|
|
2577
|
-
"
|
|
1986
|
+
"mcp",
|
|
1987
|
+
"get.js"
|
|
2578
1988
|
],
|
|
2579
1989
|
"aliasPermutations": [],
|
|
2580
1990
|
"permutations": [
|
|
2581
|
-
"agent:
|
|
2582
|
-
"
|
|
2583
|
-
"
|
|
2584
|
-
"agent:
|
|
2585
|
-
"
|
|
2586
|
-
"
|
|
1991
|
+
"agent:mcp:get",
|
|
1992
|
+
"mcp:agent:get",
|
|
1993
|
+
"mcp:get:agent",
|
|
1994
|
+
"agent:get:mcp",
|
|
1995
|
+
"get:agent:mcp",
|
|
1996
|
+
"get:mcp:agent"
|
|
2587
1997
|
]
|
|
2588
1998
|
},
|
|
2589
|
-
"agent:
|
|
1999
|
+
"agent:mcp:list": {
|
|
2590
2000
|
"aliases": [],
|
|
2591
2001
|
"args": {},
|
|
2592
|
-
"description": "
|
|
2002
|
+
"description": "Returns the Model Context Protocol (MCP) servers registered in the API Catalog, optionally filtered by label, type, or status. Use this to discover which MCP servers are available and inspect their server URLs and current status.",
|
|
2593
2003
|
"examples": [
|
|
2594
|
-
"
|
|
2595
|
-
"
|
|
2596
|
-
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
2004
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
2005
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
2597
2006
|
],
|
|
2598
2007
|
"flags": {
|
|
2599
2008
|
"json": {
|
|
@@ -2628,139 +2037,70 @@
|
|
|
2628
2037
|
"multiple": false,
|
|
2629
2038
|
"type": "option"
|
|
2630
2039
|
},
|
|
2631
|
-
"
|
|
2632
|
-
"
|
|
2633
|
-
"
|
|
2634
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2040
|
+
"label": {
|
|
2041
|
+
"name": "label",
|
|
2042
|
+
"summary": "Filter the MCP servers by label.",
|
|
2635
2043
|
"hasDynamicHelp": false,
|
|
2636
2044
|
"multiple": false,
|
|
2637
2045
|
"type": "option"
|
|
2638
2046
|
},
|
|
2639
|
-
"
|
|
2640
|
-
"name": "
|
|
2641
|
-
"summary": "
|
|
2047
|
+
"type": {
|
|
2048
|
+
"name": "type",
|
|
2049
|
+
"summary": "Filter the MCP servers by type.",
|
|
2642
2050
|
"hasDynamicHelp": false,
|
|
2643
2051
|
"multiple": false,
|
|
2644
|
-
"
|
|
2645
|
-
|
|
2646
|
-
"use-live-actions": {
|
|
2647
|
-
"exclusive": [
|
|
2648
|
-
"simulate-actions"
|
|
2649
|
-
],
|
|
2650
|
-
"name": "use-live-actions",
|
|
2651
|
-
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2652
|
-
"allowNo": false,
|
|
2653
|
-
"type": "boolean"
|
|
2654
|
-
},
|
|
2655
|
-
"simulate-actions": {
|
|
2656
|
-
"exclusive": [
|
|
2657
|
-
"use-live-actions"
|
|
2052
|
+
"options": [
|
|
2053
|
+
"EXTERNAL"
|
|
2658
2054
|
],
|
|
2659
|
-
"name": "simulate-actions",
|
|
2660
|
-
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2661
|
-
"allowNo": false,
|
|
2662
|
-
"type": "boolean"
|
|
2663
|
-
},
|
|
2664
|
-
"context-variables": {
|
|
2665
|
-
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type is always Text; to send a typed variable, use --context-variables-json.",
|
|
2666
|
-
"name": "context-variables",
|
|
2667
|
-
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2668
|
-
"delimiter": ",",
|
|
2669
|
-
"hasDynamicHelp": false,
|
|
2670
|
-
"multiple": true,
|
|
2671
2055
|
"type": "option"
|
|
2672
2056
|
},
|
|
2673
|
-
"
|
|
2674
|
-
"
|
|
2675
|
-
"
|
|
2676
|
-
"summary": "Typed session variables for the agent preview session, as a JSON array.",
|
|
2057
|
+
"status": {
|
|
2058
|
+
"name": "status",
|
|
2059
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
2677
2060
|
"hasDynamicHelp": false,
|
|
2678
2061
|
"multiple": false,
|
|
2679
|
-
"
|
|
2680
|
-
|
|
2681
|
-
|
|
2682
|
-
"dependsOn": [
|
|
2683
|
-
"authoring-bundle"
|
|
2062
|
+
"options": [
|
|
2063
|
+
"ACTIVE",
|
|
2064
|
+
"DISCONNECTED"
|
|
2684
2065
|
],
|
|
2685
|
-
"hidden": true,
|
|
2686
|
-
"name": "agent-json",
|
|
2687
|
-
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
2688
|
-
"hasDynamicHelp": false,
|
|
2689
|
-
"multiple": false,
|
|
2690
2066
|
"type": "option"
|
|
2691
2067
|
}
|
|
2692
2068
|
},
|
|
2693
2069
|
"hasDynamicHelp": true,
|
|
2694
2070
|
"hiddenAliases": [],
|
|
2695
|
-
"id": "agent:
|
|
2071
|
+
"id": "agent:mcp:list",
|
|
2696
2072
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2697
2073
|
"pluginName": "@salesforce/plugin-agent",
|
|
2698
2074
|
"pluginType": "core",
|
|
2075
|
+
"state": "preview",
|
|
2699
2076
|
"strict": true,
|
|
2700
|
-
"summary": "
|
|
2077
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
2701
2078
|
"enableJsonFlag": true,
|
|
2702
|
-
"requiresProject": true,
|
|
2703
|
-
"envVariablesSection": {
|
|
2704
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2705
|
-
"body": [
|
|
2706
|
-
{
|
|
2707
|
-
"name": "SF_TARGET_ORG",
|
|
2708
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2709
|
-
}
|
|
2710
|
-
]
|
|
2711
|
-
},
|
|
2712
|
-
"errorCodes": {
|
|
2713
|
-
"header": "ERROR CODES",
|
|
2714
|
-
"body": [
|
|
2715
|
-
{
|
|
2716
|
-
"name": "Succeeded (0)",
|
|
2717
|
-
"description": "Preview session started successfully."
|
|
2718
|
-
},
|
|
2719
|
-
{
|
|
2720
|
-
"name": "Failed (1)",
|
|
2721
|
-
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2722
|
-
},
|
|
2723
|
-
{
|
|
2724
|
-
"name": "NotFound (2)",
|
|
2725
|
-
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2726
|
-
},
|
|
2727
|
-
{
|
|
2728
|
-
"name": "ServerError (3)",
|
|
2729
|
-
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2730
|
-
},
|
|
2731
|
-
{
|
|
2732
|
-
"name": "PreviewStartFailed (4)",
|
|
2733
|
-
"description": "Preview session failed to start due to API or network errors."
|
|
2734
|
-
}
|
|
2735
|
-
]
|
|
2736
|
-
},
|
|
2737
2079
|
"isESM": true,
|
|
2738
2080
|
"relativePath": [
|
|
2739
2081
|
"lib",
|
|
2740
2082
|
"commands",
|
|
2741
2083
|
"agent",
|
|
2742
|
-
"
|
|
2743
|
-
"
|
|
2084
|
+
"mcp",
|
|
2085
|
+
"list.js"
|
|
2744
2086
|
],
|
|
2745
2087
|
"aliasPermutations": [],
|
|
2746
2088
|
"permutations": [
|
|
2747
|
-
"agent:
|
|
2748
|
-
"
|
|
2749
|
-
"
|
|
2750
|
-
"agent:
|
|
2751
|
-
"
|
|
2752
|
-
"
|
|
2089
|
+
"agent:mcp:list",
|
|
2090
|
+
"mcp:agent:list",
|
|
2091
|
+
"mcp:list:agent",
|
|
2092
|
+
"agent:list:mcp",
|
|
2093
|
+
"list:agent:mcp",
|
|
2094
|
+
"list:mcp:agent"
|
|
2753
2095
|
]
|
|
2754
2096
|
},
|
|
2755
|
-
"agent:
|
|
2097
|
+
"agent:mcp:update": {
|
|
2756
2098
|
"aliases": [],
|
|
2757
2099
|
"args": {},
|
|
2758
|
-
"description": "
|
|
2100
|
+
"description": "Updates an existing MCP server in the API Catalog. Only the fields you provide are changed; omitted fields are left untouched. You can update the label, description, and server URL, and replace the authorization configuration. When setting `--auth-type OAUTH`, you must also provide `--identity-provider`, `--client-id`, `--client-secret`, and `--scope`. When setting `--auth-type NO_AUTH`, no authorization credentials are required. At least one updatable field must be supplied.",
|
|
2759
2101
|
"examples": [
|
|
2760
|
-
"
|
|
2761
|
-
"
|
|
2762
|
-
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
2763
|
-
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
2102
|
+
"Update the label and description of an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --label \"Orders MCP\" --description \"Order tooling\" --target-org myOrg",
|
|
2103
|
+
"Update the server URL and switch the authorization to OAuth, piping the client secret from stdin and outputting as JSON:\ncat secret.txt | <%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --server-url https://mcp.example.com --auth-type OAUTH --identity-provider MyIdp --client-id abc --client-secret - --scope \"read write\" --target-org myOrg --json"
|
|
2764
2104
|
],
|
|
2765
2105
|
"flags": {
|
|
2766
2106
|
"json": {
|
|
@@ -2795,96 +2135,114 @@
|
|
|
2795
2135
|
"multiple": false,
|
|
2796
2136
|
"type": "option"
|
|
2797
2137
|
},
|
|
2798
|
-
"
|
|
2799
|
-
"char": "
|
|
2800
|
-
"name": "
|
|
2801
|
-
"
|
|
2138
|
+
"mcp-server-id": {
|
|
2139
|
+
"char": "i",
|
|
2140
|
+
"name": "mcp-server-id",
|
|
2141
|
+
"required": true,
|
|
2142
|
+
"summary": "ID of the MCP server to update.",
|
|
2802
2143
|
"hasDynamicHelp": false,
|
|
2803
2144
|
"multiple": false,
|
|
2804
2145
|
"type": "option"
|
|
2805
2146
|
},
|
|
2806
|
-
"
|
|
2807
|
-
"name": "
|
|
2808
|
-
"summary": "
|
|
2809
|
-
"
|
|
2810
|
-
"
|
|
2147
|
+
"label": {
|
|
2148
|
+
"name": "label",
|
|
2149
|
+
"summary": "New display label for the MCP server.",
|
|
2150
|
+
"hasDynamicHelp": false,
|
|
2151
|
+
"multiple": false,
|
|
2152
|
+
"type": "option"
|
|
2811
2153
|
},
|
|
2812
|
-
"
|
|
2813
|
-
"
|
|
2814
|
-
"
|
|
2815
|
-
|
|
2816
|
-
|
|
2817
|
-
"
|
|
2818
|
-
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
2819
|
-
"allowNo": false,
|
|
2820
|
-
"type": "boolean"
|
|
2154
|
+
"description": {
|
|
2155
|
+
"name": "description",
|
|
2156
|
+
"summary": "New description for the MCP server.",
|
|
2157
|
+
"hasDynamicHelp": false,
|
|
2158
|
+
"multiple": false,
|
|
2159
|
+
"type": "option"
|
|
2821
2160
|
},
|
|
2822
|
-
"
|
|
2823
|
-
"
|
|
2824
|
-
|
|
2161
|
+
"server-url": {
|
|
2162
|
+
"name": "server-url",
|
|
2163
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
2164
|
+
"hasDynamicHelp": false,
|
|
2165
|
+
"multiple": false,
|
|
2166
|
+
"type": "option"
|
|
2167
|
+
},
|
|
2168
|
+
"auth-type": {
|
|
2169
|
+
"name": "auth-type",
|
|
2170
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
2171
|
+
"hasDynamicHelp": false,
|
|
2172
|
+
"multiple": false,
|
|
2173
|
+
"options": [
|
|
2174
|
+
"OAUTH",
|
|
2175
|
+
"NO_AUTH"
|
|
2825
2176
|
],
|
|
2826
|
-
"
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
"
|
|
2177
|
+
"type": "option"
|
|
2178
|
+
},
|
|
2179
|
+
"identity-provider": {
|
|
2180
|
+
"name": "identity-provider",
|
|
2181
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2182
|
+
"hasDynamicHelp": false,
|
|
2183
|
+
"multiple": false,
|
|
2184
|
+
"type": "option"
|
|
2185
|
+
},
|
|
2186
|
+
"client-id": {
|
|
2187
|
+
"name": "client-id",
|
|
2188
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2189
|
+
"hasDynamicHelp": false,
|
|
2190
|
+
"multiple": false,
|
|
2191
|
+
"type": "option"
|
|
2192
|
+
},
|
|
2193
|
+
"client-secret": {
|
|
2194
|
+
"name": "client-secret",
|
|
2195
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2196
|
+
"hasDynamicHelp": false,
|
|
2197
|
+
"multiple": false,
|
|
2198
|
+
"type": "option"
|
|
2199
|
+
},
|
|
2200
|
+
"scope": {
|
|
2201
|
+
"name": "scope",
|
|
2202
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2203
|
+
"hasDynamicHelp": false,
|
|
2204
|
+
"multiple": false,
|
|
2205
|
+
"type": "option"
|
|
2830
2206
|
}
|
|
2831
2207
|
},
|
|
2832
2208
|
"hasDynamicHelp": true,
|
|
2833
2209
|
"hiddenAliases": [],
|
|
2834
|
-
"id": "agent:
|
|
2210
|
+
"id": "agent:mcp:update",
|
|
2835
2211
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2836
2212
|
"pluginName": "@salesforce/plugin-agent",
|
|
2837
2213
|
"pluginType": "core",
|
|
2214
|
+
"state": "preview",
|
|
2838
2215
|
"strict": true,
|
|
2839
|
-
"summary": "
|
|
2216
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
2840
2217
|
"enableJsonFlag": true,
|
|
2841
|
-
"requiresProject": true,
|
|
2842
|
-
"errorCodes": {
|
|
2843
|
-
"header": "ERROR CODES",
|
|
2844
|
-
"body": [
|
|
2845
|
-
{
|
|
2846
|
-
"name": "Succeeded (0)",
|
|
2847
|
-
"description": "Agent published successfully without errors."
|
|
2848
|
-
},
|
|
2849
|
-
{
|
|
2850
|
-
"name": "Failed (1)",
|
|
2851
|
-
"description": "Compilation errors found in the Agent Script file."
|
|
2852
|
-
}
|
|
2853
|
-
]
|
|
2854
|
-
},
|
|
2855
|
-
"FLAGGABLE_PROMPTS": {
|
|
2856
|
-
"api-name": {
|
|
2857
|
-
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2858
|
-
"promptMessage": "API name of the authoring bundle to publish"
|
|
2859
|
-
}
|
|
2860
|
-
},
|
|
2861
2218
|
"isESM": true,
|
|
2862
2219
|
"relativePath": [
|
|
2863
2220
|
"lib",
|
|
2864
2221
|
"commands",
|
|
2865
2222
|
"agent",
|
|
2866
|
-
"
|
|
2867
|
-
"
|
|
2223
|
+
"mcp",
|
|
2224
|
+
"update.js"
|
|
2868
2225
|
],
|
|
2869
2226
|
"aliasPermutations": [],
|
|
2870
2227
|
"permutations": [
|
|
2871
|
-
"agent:
|
|
2872
|
-
"
|
|
2873
|
-
"
|
|
2874
|
-
"agent:
|
|
2875
|
-
"
|
|
2876
|
-
"
|
|
2228
|
+
"agent:mcp:update",
|
|
2229
|
+
"mcp:agent:update",
|
|
2230
|
+
"mcp:update:agent",
|
|
2231
|
+
"agent:update:mcp",
|
|
2232
|
+
"update:agent:mcp",
|
|
2233
|
+
"update:mcp:agent"
|
|
2877
2234
|
]
|
|
2878
2235
|
},
|
|
2879
|
-
"agent:
|
|
2236
|
+
"agent:preview:end": {
|
|
2880
2237
|
"aliases": [],
|
|
2881
2238
|
"args": {},
|
|
2882
|
-
"description": "
|
|
2239
|
+
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to end it. This command also displays the local directory where the session trace files are stored.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respectively. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nUse the --all flag to end all active preview sessions at once. You can combine --all with --api-name or --authoring-bundle to end only sessions for a specific agent, or use --all on its own to end every session across all agents in the project.",
|
|
2883
2240
|
"examples": [
|
|
2884
|
-
"
|
|
2885
|
-
"
|
|
2886
|
-
"
|
|
2887
|
-
"
|
|
2241
|
+
"End a preview session of a published agent by specifying its session ID and API name; use the default org:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --api-name My_Published_Agent",
|
|
2242
|
+
"Similar to previous example, but don't specify a session ID; you get an error if the published agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent --target-org my-dev-org",
|
|
2243
|
+
"End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent",
|
|
2244
|
+
"End all active preview sessions for a specific agent without prompting:\n<%= config.bin %> <%= command.id %> --all --authoring-bundle My_Local_Agent --target-org <target_org> --no-prompt",
|
|
2245
|
+
"End all active preview sessions across every agent in the local session cache for an org:\n<%= config.bin %> <%= command.id %> --all --target-org <target_org>"
|
|
2888
2246
|
],
|
|
2889
2247
|
"flags": {
|
|
2890
2248
|
"json": {
|
|
@@ -2902,20 +2260,6 @@
|
|
|
2902
2260
|
"multiple": false,
|
|
2903
2261
|
"type": "option"
|
|
2904
2262
|
},
|
|
2905
|
-
"api-name": {
|
|
2906
|
-
"name": "api-name",
|
|
2907
|
-
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
2908
|
-
"hasDynamicHelp": false,
|
|
2909
|
-
"multiple": false,
|
|
2910
|
-
"type": "option"
|
|
2911
|
-
},
|
|
2912
|
-
"spec": {
|
|
2913
|
-
"name": "spec",
|
|
2914
|
-
"summary": "Path to the test spec YAML file.",
|
|
2915
|
-
"hasDynamicHelp": false,
|
|
2916
|
-
"multiple": false,
|
|
2917
|
-
"type": "option"
|
|
2918
|
-
},
|
|
2919
2263
|
"target-org": {
|
|
2920
2264
|
"char": "o",
|
|
2921
2265
|
"name": "target-org",
|
|
@@ -2933,40 +2277,65 @@
|
|
|
2933
2277
|
"multiple": false,
|
|
2934
2278
|
"type": "option"
|
|
2935
2279
|
},
|
|
2936
|
-
"
|
|
2937
|
-
"
|
|
2938
|
-
|
|
2939
|
-
|
|
2940
|
-
"
|
|
2941
|
-
|
|
2942
|
-
|
|
2943
|
-
"
|
|
2944
|
-
"
|
|
2945
|
-
"
|
|
2946
|
-
"type": "boolean"
|
|
2280
|
+
"session-id": {
|
|
2281
|
+
"exclusive": [
|
|
2282
|
+
"all"
|
|
2283
|
+
],
|
|
2284
|
+
"name": "session-id",
|
|
2285
|
+
"required": false,
|
|
2286
|
+
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
|
|
2287
|
+
"hasDynamicHelp": false,
|
|
2288
|
+
"multiple": false,
|
|
2289
|
+
"type": "option"
|
|
2947
2290
|
},
|
|
2948
|
-
"
|
|
2949
|
-
"
|
|
2950
|
-
"
|
|
2951
|
-
|
|
2291
|
+
"api-name": {
|
|
2292
|
+
"char": "n",
|
|
2293
|
+
"exclusive": [
|
|
2294
|
+
"authoring-bundle"
|
|
2295
|
+
],
|
|
2296
|
+
"name": "api-name",
|
|
2297
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2952
2298
|
"hasDynamicHelp": false,
|
|
2953
2299
|
"multiple": false,
|
|
2954
|
-
"
|
|
2955
|
-
|
|
2956
|
-
|
|
2300
|
+
"type": "option"
|
|
2301
|
+
},
|
|
2302
|
+
"authoring-bundle": {
|
|
2303
|
+
"exclusive": [
|
|
2304
|
+
"api-name"
|
|
2957
2305
|
],
|
|
2306
|
+
"name": "authoring-bundle",
|
|
2307
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2308
|
+
"hasDynamicHelp": false,
|
|
2309
|
+
"multiple": false,
|
|
2958
2310
|
"type": "option"
|
|
2311
|
+
},
|
|
2312
|
+
"all": {
|
|
2313
|
+
"exclusive": [
|
|
2314
|
+
"session-id"
|
|
2315
|
+
],
|
|
2316
|
+
"name": "all",
|
|
2317
|
+
"summary": "End all active preview sessions. Combine with --api-name or --authoring-bundle to limit to a specific agent, or use with only --target-org to end sessions for all agents found in the local session cache. Requires --target-org.",
|
|
2318
|
+
"allowNo": false,
|
|
2319
|
+
"type": "boolean"
|
|
2320
|
+
},
|
|
2321
|
+
"no-prompt": {
|
|
2322
|
+
"char": "p",
|
|
2323
|
+
"name": "no-prompt",
|
|
2324
|
+
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
2325
|
+
"allowNo": false,
|
|
2326
|
+
"type": "boolean"
|
|
2959
2327
|
}
|
|
2960
2328
|
},
|
|
2961
2329
|
"hasDynamicHelp": true,
|
|
2962
2330
|
"hiddenAliases": [],
|
|
2963
|
-
"id": "agent:
|
|
2331
|
+
"id": "agent:preview:end",
|
|
2964
2332
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2965
2333
|
"pluginName": "@salesforce/plugin-agent",
|
|
2966
2334
|
"pluginType": "core",
|
|
2967
2335
|
"strict": true,
|
|
2968
|
-
"summary": "
|
|
2336
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
2969
2337
|
"enableJsonFlag": true,
|
|
2338
|
+
"requiresProject": true,
|
|
2970
2339
|
"envVariablesSection": {
|
|
2971
2340
|
"header": "ENVIRONMENT VARIABLES",
|
|
2972
2341
|
"body": [
|
|
@@ -2981,19 +2350,27 @@
|
|
|
2981
2350
|
"body": [
|
|
2982
2351
|
{
|
|
2983
2352
|
"name": "Succeeded (0)",
|
|
2984
|
-
"description": "
|
|
2353
|
+
"description": "Preview session ended successfully and traces saved."
|
|
2985
2354
|
},
|
|
2986
2355
|
{
|
|
2987
|
-
"name": "
|
|
2988
|
-
"description": "
|
|
2356
|
+
"name": "ExactlyOneRequired (2)",
|
|
2357
|
+
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
2989
2358
|
},
|
|
2990
2359
|
{
|
|
2991
2360
|
"name": "NotFound (2)",
|
|
2992
|
-
"description": "
|
|
2361
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
2993
2362
|
},
|
|
2994
2363
|
{
|
|
2995
|
-
"name": "
|
|
2996
|
-
"description": "
|
|
2364
|
+
"name": "PreviewEndFailed (4)",
|
|
2365
|
+
"description": "Failed to end the preview session."
|
|
2366
|
+
},
|
|
2367
|
+
{
|
|
2368
|
+
"name": "PreviewEndPartialFailure (68)",
|
|
2369
|
+
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
2370
|
+
},
|
|
2371
|
+
{
|
|
2372
|
+
"name": "SessionAmbiguous (5)",
|
|
2373
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2997
2374
|
}
|
|
2998
2375
|
]
|
|
2999
2376
|
},
|
|
@@ -3002,26 +2379,27 @@
|
|
|
3002
2379
|
"lib",
|
|
3003
2380
|
"commands",
|
|
3004
2381
|
"agent",
|
|
3005
|
-
"
|
|
3006
|
-
"
|
|
2382
|
+
"preview",
|
|
2383
|
+
"end.js"
|
|
3007
2384
|
],
|
|
3008
2385
|
"aliasPermutations": [],
|
|
3009
2386
|
"permutations": [
|
|
3010
|
-
"agent:
|
|
3011
|
-
"
|
|
3012
|
-
"
|
|
3013
|
-
"agent:
|
|
3014
|
-
"
|
|
3015
|
-
"
|
|
2387
|
+
"agent:preview:end",
|
|
2388
|
+
"preview:agent:end",
|
|
2389
|
+
"preview:end:agent",
|
|
2390
|
+
"agent:end:preview",
|
|
2391
|
+
"end:agent:preview",
|
|
2392
|
+
"end:preview:agent"
|
|
3016
2393
|
]
|
|
3017
2394
|
},
|
|
3018
|
-
"agent:
|
|
2395
|
+
"agent:preview:send": {
|
|
3019
2396
|
"aliases": [],
|
|
3020
2397
|
"args": {},
|
|
3021
|
-
"description": "
|
|
2398
|
+
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to send the agent a message (utterance). This command then displays the agent's response.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.",
|
|
3022
2399
|
"examples": [
|
|
3023
|
-
"
|
|
3024
|
-
"
|
|
2400
|
+
"Send a message to an activated published agent using its API name and session ID; use the default org:\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --session-id <SESSION_ID>",
|
|
2401
|
+
"Similar to previous example, but don't specify a session ID; you get an error if the agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --target-org my-dev-org",
|
|
2402
|
+
"Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
|
|
3025
2403
|
],
|
|
3026
2404
|
"flags": {
|
|
3027
2405
|
"json": {
|
|
@@ -3055,17 +2433,50 @@
|
|
|
3055
2433
|
"hasDynamicHelp": false,
|
|
3056
2434
|
"multiple": false,
|
|
3057
2435
|
"type": "option"
|
|
2436
|
+
},
|
|
2437
|
+
"session-id": {
|
|
2438
|
+
"name": "session-id",
|
|
2439
|
+
"required": false,
|
|
2440
|
+
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see list of all sessions.",
|
|
2441
|
+
"hasDynamicHelp": false,
|
|
2442
|
+
"multiple": false,
|
|
2443
|
+
"type": "option"
|
|
2444
|
+
},
|
|
2445
|
+
"utterance": {
|
|
2446
|
+
"char": "u",
|
|
2447
|
+
"name": "utterance",
|
|
2448
|
+
"required": true,
|
|
2449
|
+
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
2450
|
+
"hasDynamicHelp": false,
|
|
2451
|
+
"multiple": false,
|
|
2452
|
+
"type": "option"
|
|
2453
|
+
},
|
|
2454
|
+
"api-name": {
|
|
2455
|
+
"char": "n",
|
|
2456
|
+
"name": "api-name",
|
|
2457
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2458
|
+
"hasDynamicHelp": false,
|
|
2459
|
+
"multiple": false,
|
|
2460
|
+
"type": "option"
|
|
2461
|
+
},
|
|
2462
|
+
"authoring-bundle": {
|
|
2463
|
+
"name": "authoring-bundle",
|
|
2464
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2465
|
+
"hasDynamicHelp": false,
|
|
2466
|
+
"multiple": false,
|
|
2467
|
+
"type": "option"
|
|
3058
2468
|
}
|
|
3059
2469
|
},
|
|
3060
2470
|
"hasDynamicHelp": true,
|
|
3061
2471
|
"hiddenAliases": [],
|
|
3062
|
-
"id": "agent:
|
|
2472
|
+
"id": "agent:preview:send",
|
|
3063
2473
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3064
2474
|
"pluginName": "@salesforce/plugin-agent",
|
|
3065
2475
|
"pluginType": "core",
|
|
3066
2476
|
"strict": true,
|
|
3067
|
-
"summary": "
|
|
2477
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
3068
2478
|
"enableJsonFlag": true,
|
|
2479
|
+
"requiresProject": true,
|
|
3069
2480
|
"envVariablesSection": {
|
|
3070
2481
|
"header": "ENVIRONMENT VARIABLES",
|
|
3071
2482
|
"body": [
|
|
@@ -3080,11 +2491,19 @@
|
|
|
3080
2491
|
"body": [
|
|
3081
2492
|
{
|
|
3082
2493
|
"name": "Succeeded (0)",
|
|
3083
|
-
"description": "
|
|
2494
|
+
"description": "Message sent successfully and agent response received."
|
|
3084
2495
|
},
|
|
3085
2496
|
{
|
|
3086
|
-
"name": "
|
|
3087
|
-
"description": "
|
|
2497
|
+
"name": "NotFound (2)",
|
|
2498
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
2499
|
+
},
|
|
2500
|
+
{
|
|
2501
|
+
"name": "PreviewSendFailed (4)",
|
|
2502
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
2503
|
+
},
|
|
2504
|
+
{
|
|
2505
|
+
"name": "SessionAmbiguous (5)",
|
|
2506
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
3088
2507
|
}
|
|
3089
2508
|
]
|
|
3090
2509
|
},
|
|
@@ -3093,27 +2512,25 @@
|
|
|
3093
2512
|
"lib",
|
|
3094
2513
|
"commands",
|
|
3095
2514
|
"agent",
|
|
3096
|
-
"
|
|
3097
|
-
"
|
|
2515
|
+
"preview",
|
|
2516
|
+
"send.js"
|
|
3098
2517
|
],
|
|
3099
2518
|
"aliasPermutations": [],
|
|
3100
2519
|
"permutations": [
|
|
3101
|
-
"agent:
|
|
3102
|
-
"
|
|
3103
|
-
"
|
|
3104
|
-
"agent:
|
|
3105
|
-
"
|
|
3106
|
-
"
|
|
2520
|
+
"agent:preview:send",
|
|
2521
|
+
"preview:agent:send",
|
|
2522
|
+
"preview:send:agent",
|
|
2523
|
+
"agent:send:preview",
|
|
2524
|
+
"send:agent:preview",
|
|
2525
|
+
"send:preview:agent"
|
|
3107
2526
|
]
|
|
3108
2527
|
},
|
|
3109
|
-
"agent:
|
|
2528
|
+
"agent:preview:sessions": {
|
|
3110
2529
|
"aliases": [],
|
|
3111
2530
|
"args": {},
|
|
3112
|
-
"description": "This command
|
|
2531
|
+
"description": "This command lists the agent preview sessions that were started with the \"agent preview start\" command and are still in the local cache. Use this command to discover specific session IDs that you can pass to the \"agent preview send\" or \"agent preview end\" commands with the --session-id flag.\n\nProgrammatic agent preview sessions can be started for both published activated agents and by using an agent's local authoring bundle, which contains its Agent Script file. In this command's output table, the Agent column contains either the API name of the authoring bundle or the published agent, whichever was used when starting the session. In the table, if the same API name has multiple rows with different session IDs, then it means that you previously started multiple preview sessions with the associated agent.",
|
|
3113
2532
|
"examples": [
|
|
3114
|
-
"
|
|
3115
|
-
"Get the results of the most recently run agent test in an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-org",
|
|
3116
|
-
"Get the results of the most recently run agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
2533
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
3117
2534
|
],
|
|
3118
2535
|
"flags": {
|
|
3119
2536
|
"json": {
|
|
@@ -3130,108 +2547,24 @@
|
|
|
3130
2547
|
"hasDynamicHelp": false,
|
|
3131
2548
|
"multiple": false,
|
|
3132
2549
|
"type": "option"
|
|
3133
|
-
},
|
|
3134
|
-
"target-org": {
|
|
3135
|
-
"char": "o",
|
|
3136
|
-
"name": "target-org",
|
|
3137
|
-
"noCacheDefault": true,
|
|
3138
|
-
"required": true,
|
|
3139
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3140
|
-
"hasDynamicHelp": true,
|
|
3141
|
-
"multiple": false,
|
|
3142
|
-
"type": "option"
|
|
3143
|
-
},
|
|
3144
|
-
"api-version": {
|
|
3145
|
-
"description": "Override the api version used for api requests made by this command",
|
|
3146
|
-
"name": "api-version",
|
|
3147
|
-
"hasDynamicHelp": false,
|
|
3148
|
-
"multiple": false,
|
|
3149
|
-
"type": "option"
|
|
3150
|
-
},
|
|
3151
|
-
"job-id": {
|
|
3152
|
-
"char": "i",
|
|
3153
|
-
"name": "job-id",
|
|
3154
|
-
"required": true,
|
|
3155
|
-
"summary": "Job ID of the completed agent test run.",
|
|
3156
|
-
"hasDynamicHelp": false,
|
|
3157
|
-
"multiple": false,
|
|
3158
|
-
"type": "option"
|
|
3159
|
-
},
|
|
3160
|
-
"result-format": {
|
|
3161
|
-
"name": "result-format",
|
|
3162
|
-
"summary": "Format of the agent test run results.",
|
|
3163
|
-
"default": "human",
|
|
3164
|
-
"hasDynamicHelp": false,
|
|
3165
|
-
"multiple": false,
|
|
3166
|
-
"options": [
|
|
3167
|
-
"json",
|
|
3168
|
-
"human",
|
|
3169
|
-
"junit",
|
|
3170
|
-
"tap"
|
|
3171
|
-
],
|
|
3172
|
-
"type": "option"
|
|
3173
|
-
},
|
|
3174
|
-
"output-dir": {
|
|
3175
|
-
"char": "d",
|
|
3176
|
-
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3177
|
-
"name": "output-dir",
|
|
3178
|
-
"summary": "Directory to write the agent test results into.",
|
|
3179
|
-
"hasDynamicHelp": false,
|
|
3180
|
-
"multiple": false,
|
|
3181
|
-
"type": "option"
|
|
3182
|
-
},
|
|
3183
|
-
"test-runner": {
|
|
3184
|
-
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3185
|
-
"name": "test-runner",
|
|
3186
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3187
|
-
"hasDynamicHelp": false,
|
|
3188
|
-
"multiple": false,
|
|
3189
|
-
"options": [
|
|
3190
|
-
"agentforce-studio",
|
|
3191
|
-
"testing-center"
|
|
3192
|
-
],
|
|
3193
|
-
"type": "option"
|
|
3194
|
-
},
|
|
3195
|
-
"verbose": {
|
|
3196
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3197
|
-
"name": "verbose",
|
|
3198
|
-
"summary": "Show generated data in the test results output.",
|
|
3199
|
-
"allowNo": false,
|
|
3200
|
-
"type": "boolean"
|
|
3201
2550
|
}
|
|
3202
2551
|
},
|
|
3203
|
-
"hasDynamicHelp":
|
|
2552
|
+
"hasDynamicHelp": false,
|
|
3204
2553
|
"hiddenAliases": [],
|
|
3205
|
-
"id": "agent:
|
|
2554
|
+
"id": "agent:preview:sessions",
|
|
3206
2555
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3207
2556
|
"pluginName": "@salesforce/plugin-agent",
|
|
3208
2557
|
"pluginType": "core",
|
|
3209
2558
|
"strict": true,
|
|
3210
|
-
"summary": "
|
|
2559
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
3211
2560
|
"enableJsonFlag": true,
|
|
3212
|
-
"
|
|
3213
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
3214
|
-
"body": [
|
|
3215
|
-
{
|
|
3216
|
-
"name": "SF_TARGET_ORG",
|
|
3217
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3218
|
-
}
|
|
3219
|
-
]
|
|
3220
|
-
},
|
|
2561
|
+
"requiresProject": true,
|
|
3221
2562
|
"errorCodes": {
|
|
3222
2563
|
"header": "ERROR CODES",
|
|
3223
2564
|
"body": [
|
|
3224
2565
|
{
|
|
3225
2566
|
"name": "Succeeded (0)",
|
|
3226
|
-
"description": "
|
|
3227
|
-
},
|
|
3228
|
-
{
|
|
3229
|
-
"name": "NotFound (2)",
|
|
3230
|
-
"description": "Job ID not found or invalid."
|
|
3231
|
-
},
|
|
3232
|
-
{
|
|
3233
|
-
"name": "Failed (4)",
|
|
3234
|
-
"description": "Failed to retrieve results due to API or network errors."
|
|
2567
|
+
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
3235
2568
|
}
|
|
3236
2569
|
]
|
|
3237
2570
|
},
|
|
@@ -3240,27 +2573,27 @@
|
|
|
3240
2573
|
"lib",
|
|
3241
2574
|
"commands",
|
|
3242
2575
|
"agent",
|
|
3243
|
-
"
|
|
3244
|
-
"
|
|
2576
|
+
"preview",
|
|
2577
|
+
"sessions.js"
|
|
3245
2578
|
],
|
|
3246
2579
|
"aliasPermutations": [],
|
|
3247
2580
|
"permutations": [
|
|
3248
|
-
"agent:
|
|
3249
|
-
"
|
|
3250
|
-
"
|
|
3251
|
-
"agent:
|
|
3252
|
-
"
|
|
3253
|
-
"
|
|
2581
|
+
"agent:preview:sessions",
|
|
2582
|
+
"preview:agent:sessions",
|
|
2583
|
+
"preview:sessions:agent",
|
|
2584
|
+
"agent:sessions:preview",
|
|
2585
|
+
"sessions:agent:preview",
|
|
2586
|
+
"sessions:preview:agent"
|
|
3254
2587
|
]
|
|
3255
2588
|
},
|
|
3256
|
-
"agent:
|
|
2589
|
+
"agent:preview:start": {
|
|
3257
2590
|
"aliases": [],
|
|
3258
2591
|
"args": {},
|
|
3259
|
-
"description": "This command
|
|
2592
|
+
"description": "This command outputs a session ID that you then use with the \"agent preview send\" command to send an utterance to the agent. Use the \"agent preview sessions\" command to list all active sessions and the \"agent preview end\" command to end a specific session.\n\nIdentify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nWhen starting a preview session with --authoring-bundle, you must explicitly specify the execution mode using one of these flags:\n\n- --use-live-actions: Executes real Apex classes, flows, and other actions in the org. This surfaces compile and validation errors during preview.\n- --simulate-actions: Uses AI to simulate action execution without calling real implementations.\n\nPublished agents (--api-name) always use live actions. The mode flags are optional and have no effect for published agents.",
|
|
3260
2593
|
"examples": [
|
|
3261
|
-
"
|
|
3262
|
-
"
|
|
3263
|
-
"
|
|
2594
|
+
"Start a programmatic agent preview session by specifying an authoring bundle; use simulated actions. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org --simulate-actions",
|
|
2595
|
+
"Similar to previous example but use live actions and the default org:\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --use-live-actions",
|
|
2596
|
+
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
3264
2597
|
],
|
|
3265
2598
|
"flags": {
|
|
3266
2599
|
"json": {
|
|
@@ -3295,82 +2628,78 @@
|
|
|
3295
2628
|
"multiple": false,
|
|
3296
2629
|
"type": "option"
|
|
3297
2630
|
},
|
|
3298
|
-
"
|
|
3299
|
-
"char": "
|
|
3300
|
-
"name": "
|
|
3301
|
-
"summary": "
|
|
2631
|
+
"api-name": {
|
|
2632
|
+
"char": "n",
|
|
2633
|
+
"name": "api-name",
|
|
2634
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
3302
2635
|
"hasDynamicHelp": false,
|
|
3303
2636
|
"multiple": false,
|
|
3304
2637
|
"type": "option"
|
|
3305
2638
|
},
|
|
3306
|
-
"
|
|
3307
|
-
"
|
|
3308
|
-
"
|
|
3309
|
-
"
|
|
2639
|
+
"authoring-bundle": {
|
|
2640
|
+
"name": "authoring-bundle",
|
|
2641
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2642
|
+
"hasDynamicHelp": false,
|
|
2643
|
+
"multiple": false,
|
|
2644
|
+
"type": "option"
|
|
2645
|
+
},
|
|
2646
|
+
"use-live-actions": {
|
|
2647
|
+
"exclusive": [
|
|
2648
|
+
"simulate-actions"
|
|
2649
|
+
],
|
|
2650
|
+
"name": "use-live-actions",
|
|
2651
|
+
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
3310
2652
|
"allowNo": false,
|
|
3311
2653
|
"type": "boolean"
|
|
3312
2654
|
},
|
|
3313
|
-
"
|
|
3314
|
-
"
|
|
3315
|
-
|
|
3316
|
-
|
|
3317
|
-
"
|
|
3318
|
-
"
|
|
3319
|
-
"
|
|
3320
|
-
"type": "
|
|
2655
|
+
"simulate-actions": {
|
|
2656
|
+
"exclusive": [
|
|
2657
|
+
"use-live-actions"
|
|
2658
|
+
],
|
|
2659
|
+
"name": "simulate-actions",
|
|
2660
|
+
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2661
|
+
"allowNo": false,
|
|
2662
|
+
"type": "boolean"
|
|
3321
2663
|
},
|
|
3322
|
-
"
|
|
3323
|
-
"
|
|
3324
|
-
"
|
|
3325
|
-
"
|
|
2664
|
+
"context-variables": {
|
|
2665
|
+
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type is always Text; to send a typed variable, use --context-variables-json.",
|
|
2666
|
+
"name": "context-variables",
|
|
2667
|
+
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2668
|
+
"delimiter": ",",
|
|
3326
2669
|
"hasDynamicHelp": false,
|
|
3327
|
-
"multiple":
|
|
3328
|
-
"options": [
|
|
3329
|
-
"json",
|
|
3330
|
-
"human",
|
|
3331
|
-
"junit",
|
|
3332
|
-
"tap"
|
|
3333
|
-
],
|
|
2670
|
+
"multiple": true,
|
|
3334
2671
|
"type": "option"
|
|
3335
2672
|
},
|
|
3336
|
-
"
|
|
3337
|
-
"
|
|
3338
|
-
"
|
|
3339
|
-
"
|
|
3340
|
-
"summary": "Directory to write the agent test results into.",
|
|
2673
|
+
"context-variables-json": {
|
|
2674
|
+
"description": "Sets typed variables on the agent preview session. Use this instead of --context-variables when a variable is not Text, for example a boolean-gated route (available when @variables.myFlag == True) that needs a real Boolean, or a Number, Object, List, or Json value.\n\nThe value is a JSON array of objects, each with a \"name\", a \"type\", and an optional \"value\". The \"type\" is one of Text, Date, DateTime, Money, Ref, Boolean, Number, Object, List, or Json. The JSON type of \"value\" must match \"type\": Boolean takes a boolean, Number takes a number, the string types take a string, Object and List take an array, and Json takes an object.\n\nExample: --context-variables-json '[{\"name\":\"probeGate\",\"type\":\"Boolean\",\"value\":true},{\"name\":\"retryCount\",\"type\":\"Number\",\"value\":3}]'.\n\nYou can pass both --context-variables and --context-variables-json in the same command. When the same variable name appears in both, the --context-variables-json value wins.\n\nTip: names follow the same rules as --context-variables. Use the \"$Context.\" prefix for linked context variables, and a bare name for state variables.",
|
|
2675
|
+
"name": "context-variables-json",
|
|
2676
|
+
"summary": "Typed session variables for the agent preview session, as a JSON array.",
|
|
3341
2677
|
"hasDynamicHelp": false,
|
|
3342
2678
|
"multiple": false,
|
|
3343
2679
|
"type": "option"
|
|
3344
2680
|
},
|
|
3345
|
-
"
|
|
3346
|
-
"
|
|
3347
|
-
|
|
3348
|
-
|
|
2681
|
+
"agent-json": {
|
|
2682
|
+
"dependsOn": [
|
|
2683
|
+
"authoring-bundle"
|
|
2684
|
+
],
|
|
2685
|
+
"hidden": true,
|
|
2686
|
+
"name": "agent-json",
|
|
2687
|
+
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
3349
2688
|
"hasDynamicHelp": false,
|
|
3350
2689
|
"multiple": false,
|
|
3351
|
-
"options": [
|
|
3352
|
-
"agentforce-studio",
|
|
3353
|
-
"testing-center"
|
|
3354
|
-
],
|
|
3355
2690
|
"type": "option"
|
|
3356
|
-
},
|
|
3357
|
-
"verbose": {
|
|
3358
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3359
|
-
"name": "verbose",
|
|
3360
|
-
"summary": "Show generated data in the test results output.",
|
|
3361
|
-
"allowNo": false,
|
|
3362
|
-
"type": "boolean"
|
|
3363
2691
|
}
|
|
3364
2692
|
},
|
|
3365
2693
|
"hasDynamicHelp": true,
|
|
3366
2694
|
"hiddenAliases": [],
|
|
3367
|
-
"id": "agent:
|
|
2695
|
+
"id": "agent:preview:start",
|
|
3368
2696
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3369
2697
|
"pluginName": "@salesforce/plugin-agent",
|
|
3370
2698
|
"pluginType": "core",
|
|
3371
2699
|
"strict": true,
|
|
3372
|
-
"summary": "
|
|
2700
|
+
"summary": "Start a programmatic agent preview session.",
|
|
3373
2701
|
"enableJsonFlag": true,
|
|
2702
|
+
"requiresProject": true,
|
|
3374
2703
|
"envVariablesSection": {
|
|
3375
2704
|
"header": "ENVIRONMENT VARIABLES",
|
|
3376
2705
|
"body": [
|
|
@@ -3385,19 +2714,23 @@
|
|
|
3385
2714
|
"body": [
|
|
3386
2715
|
{
|
|
3387
2716
|
"name": "Succeeded (0)",
|
|
3388
|
-
"description": "
|
|
2717
|
+
"description": "Preview session started successfully."
|
|
3389
2718
|
},
|
|
3390
2719
|
{
|
|
3391
2720
|
"name": "Failed (1)",
|
|
3392
|
-
"description": "
|
|
2721
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
3393
2722
|
},
|
|
3394
2723
|
{
|
|
3395
2724
|
"name": "NotFound (2)",
|
|
3396
|
-
"description": "
|
|
2725
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
3397
2726
|
},
|
|
3398
2727
|
{
|
|
3399
|
-
"name": "
|
|
3400
|
-
"description": "
|
|
2728
|
+
"name": "ServerError (3)",
|
|
2729
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2730
|
+
},
|
|
2731
|
+
{
|
|
2732
|
+
"name": "PreviewStartFailed (4)",
|
|
2733
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
3401
2734
|
}
|
|
3402
2735
|
]
|
|
3403
2736
|
},
|
|
@@ -3406,30 +2739,28 @@
|
|
|
3406
2739
|
"lib",
|
|
3407
2740
|
"commands",
|
|
3408
2741
|
"agent",
|
|
3409
|
-
"
|
|
3410
|
-
"
|
|
2742
|
+
"preview",
|
|
2743
|
+
"start.js"
|
|
3411
2744
|
],
|
|
3412
2745
|
"aliasPermutations": [],
|
|
3413
2746
|
"permutations": [
|
|
3414
|
-
"agent:
|
|
3415
|
-
"
|
|
3416
|
-
"
|
|
3417
|
-
"agent:
|
|
3418
|
-
"
|
|
3419
|
-
"
|
|
2747
|
+
"agent:preview:start",
|
|
2748
|
+
"preview:agent:start",
|
|
2749
|
+
"preview:start:agent",
|
|
2750
|
+
"agent:start:preview",
|
|
2751
|
+
"start:agent:preview",
|
|
2752
|
+
"start:preview:agent"
|
|
3420
2753
|
]
|
|
3421
2754
|
},
|
|
3422
|
-
"agent:
|
|
2755
|
+
"agent:publish:authoring-bundle": {
|
|
3423
2756
|
"aliases": [],
|
|
3424
2757
|
"args": {},
|
|
3425
|
-
"description": "
|
|
2758
|
+
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nWhen you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.\n\nThis command uses the API name of the authoring bundle.",
|
|
3426
2759
|
"examples": [
|
|
3427
|
-
"
|
|
3428
|
-
"
|
|
3429
|
-
"
|
|
3430
|
-
"
|
|
3431
|
-
"Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in your YAML spec):\n<%= config.bin %> <%= command.id %> --spec specs/agent-with-context.yaml --target-org my-org",
|
|
3432
|
-
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
2760
|
+
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2761
|
+
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org",
|
|
2762
|
+
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
2763
|
+
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
3433
2764
|
],
|
|
3434
2765
|
"flags": {
|
|
3435
2766
|
"json": {
|
|
@@ -3464,266 +2795,85 @@
|
|
|
3464
2795
|
"multiple": false,
|
|
3465
2796
|
"type": "option"
|
|
3466
2797
|
},
|
|
3467
|
-
"spec": {
|
|
3468
|
-
"char": "s",
|
|
3469
|
-
"name": "spec",
|
|
3470
|
-
"required": true,
|
|
3471
|
-
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
3472
|
-
"hasDynamicHelp": false,
|
|
3473
|
-
"multiple": false,
|
|
3474
|
-
"type": "option"
|
|
3475
|
-
},
|
|
3476
2798
|
"api-name": {
|
|
3477
2799
|
"char": "n",
|
|
3478
2800
|
"name": "api-name",
|
|
3479
|
-
"summary": "
|
|
2801
|
+
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
3480
2802
|
"hasDynamicHelp": false,
|
|
3481
2803
|
"multiple": false,
|
|
3482
2804
|
"type": "option"
|
|
3483
2805
|
},
|
|
3484
|
-
"
|
|
3485
|
-
"name": "
|
|
3486
|
-
"summary": "
|
|
3487
|
-
"
|
|
3488
|
-
"
|
|
3489
|
-
"multiple": false,
|
|
3490
|
-
"options": [
|
|
3491
|
-
"json",
|
|
3492
|
-
"human",
|
|
3493
|
-
"junit",
|
|
3494
|
-
"tap"
|
|
3495
|
-
],
|
|
3496
|
-
"type": "option"
|
|
2806
|
+
"skip-retrieve": {
|
|
2807
|
+
"name": "skip-retrieve",
|
|
2808
|
+
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
2809
|
+
"allowNo": false,
|
|
2810
|
+
"type": "boolean"
|
|
3497
2811
|
},
|
|
3498
|
-
"
|
|
3499
|
-
"
|
|
3500
|
-
"
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
"
|
|
3504
|
-
"
|
|
3505
|
-
},
|
|
3506
|
-
"no-normalize": {
|
|
3507
|
-
"name": "no-normalize",
|
|
3508
|
-
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
3509
|
-
"allowNo": false,
|
|
3510
|
-
"type": "boolean"
|
|
3511
|
-
}
|
|
3512
|
-
},
|
|
3513
|
-
"hasDynamicHelp": true,
|
|
3514
|
-
"hiddenAliases": [],
|
|
3515
|
-
"id": "agent:test:run-eval",
|
|
3516
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
3517
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
3518
|
-
"pluginType": "core",
|
|
3519
|
-
"state": "beta",
|
|
3520
|
-
"strict": true,
|
|
3521
|
-
"summary": "Run rich evaluation tests against an Agentforce agent.",
|
|
3522
|
-
"enableJsonFlag": true,
|
|
3523
|
-
"envVariablesSection": {
|
|
3524
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
3525
|
-
"body": [
|
|
3526
|
-
{
|
|
3527
|
-
"name": "SF_TARGET_ORG",
|
|
3528
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3529
|
-
}
|
|
3530
|
-
]
|
|
3531
|
-
},
|
|
3532
|
-
"errorCodes": {
|
|
3533
|
-
"header": "ERROR CODES",
|
|
3534
|
-
"body": [
|
|
3535
|
-
{
|
|
3536
|
-
"name": "Succeeded (0)",
|
|
3537
|
-
"description": "Tests completed successfully. Test results (passed/failed) are in the JSON output."
|
|
3538
|
-
},
|
|
3539
|
-
{
|
|
3540
|
-
"name": "Failed (1)",
|
|
3541
|
-
"description": "Tests encountered execution errors (tests couldn't run properly)."
|
|
3542
|
-
},
|
|
3543
|
-
{
|
|
3544
|
-
"name": "NotFound (2)",
|
|
3545
|
-
"description": "Agent not found, spec file not found, or invalid agent name."
|
|
3546
|
-
},
|
|
3547
|
-
{
|
|
3548
|
-
"name": "OperationFailed (4)",
|
|
3549
|
-
"description": "Failed to execute tests due to API or network errors."
|
|
3550
|
-
}
|
|
3551
|
-
]
|
|
3552
|
-
},
|
|
3553
|
-
"isESM": true,
|
|
3554
|
-
"relativePath": [
|
|
3555
|
-
"lib",
|
|
3556
|
-
"commands",
|
|
3557
|
-
"agent",
|
|
3558
|
-
"test",
|
|
3559
|
-
"run-eval.js"
|
|
3560
|
-
],
|
|
3561
|
-
"aliasPermutations": [],
|
|
3562
|
-
"permutations": [
|
|
3563
|
-
"agent:test:run-eval",
|
|
3564
|
-
"test:agent:run-eval",
|
|
3565
|
-
"test:run-eval:agent",
|
|
3566
|
-
"agent:run-eval:test",
|
|
3567
|
-
"run-eval:agent:test",
|
|
3568
|
-
"run-eval:test:agent"
|
|
3569
|
-
]
|
|
3570
|
-
},
|
|
3571
|
-
"agent:test:run": {
|
|
3572
|
-
"aliases": [],
|
|
3573
|
-
"args": {},
|
|
3574
|
-
"description": "Use the --api-name flag to specify the name of the agent test you want to run. Use the output of the \"agent test list\" command to get the names of all the available agent tests in your org.\n\nBy default, this command starts the agent test in your org, but it doesn't wait for the test to finish. Instead, it displays the \"agent test resume\" command, with a job ID, that you execute to see the results of the test run, and then returns control of the terminal window to you. Use the --wait flag to specify the number of minutes for the command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, run \"agent test resume\".\n\nBy default, this command outputs test results in human-readable tables for each test case, if the test completes in time. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
3575
|
-
"examples": [
|
|
3576
|
-
"Start an agent test called Resort_Manager_Test for an agent in your default org, don't wait for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test",
|
|
3577
|
-
"Start an agent test for an agent in an org with alias \"my-org\" and wait for 10 minutes for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --target-org my-org",
|
|
3578
|
-
"Start an agent test and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --output-dir ./test-results --result-format json"
|
|
3579
|
-
],
|
|
3580
|
-
"flags": {
|
|
3581
|
-
"json": {
|
|
3582
|
-
"description": "Format output as json.",
|
|
3583
|
-
"helpGroup": "GLOBAL",
|
|
3584
|
-
"name": "json",
|
|
2812
|
+
"verbose": {
|
|
2813
|
+
"char": "v",
|
|
2814
|
+
"exclusive": [
|
|
2815
|
+
"concise"
|
|
2816
|
+
],
|
|
2817
|
+
"name": "verbose",
|
|
2818
|
+
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
3585
2819
|
"allowNo": false,
|
|
3586
2820
|
"type": "boolean"
|
|
3587
2821
|
},
|
|
3588
|
-
"
|
|
3589
|
-
"
|
|
3590
|
-
|
|
3591
|
-
"summary": "Import flag values from a directory.",
|
|
3592
|
-
"hasDynamicHelp": false,
|
|
3593
|
-
"multiple": false,
|
|
3594
|
-
"type": "option"
|
|
3595
|
-
},
|
|
3596
|
-
"target-org": {
|
|
3597
|
-
"char": "o",
|
|
3598
|
-
"name": "target-org",
|
|
3599
|
-
"noCacheDefault": true,
|
|
3600
|
-
"required": true,
|
|
3601
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3602
|
-
"hasDynamicHelp": true,
|
|
3603
|
-
"multiple": false,
|
|
3604
|
-
"type": "option"
|
|
3605
|
-
},
|
|
3606
|
-
"api-version": {
|
|
3607
|
-
"description": "Override the api version used for api requests made by this command",
|
|
3608
|
-
"name": "api-version",
|
|
3609
|
-
"hasDynamicHelp": false,
|
|
3610
|
-
"multiple": false,
|
|
3611
|
-
"type": "option"
|
|
3612
|
-
},
|
|
3613
|
-
"api-name": {
|
|
3614
|
-
"char": "n",
|
|
3615
|
-
"name": "api-name",
|
|
3616
|
-
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
3617
|
-
"hasDynamicHelp": false,
|
|
3618
|
-
"multiple": false,
|
|
3619
|
-
"type": "option"
|
|
3620
|
-
},
|
|
3621
|
-
"wait": {
|
|
3622
|
-
"char": "w",
|
|
3623
|
-
"name": "wait",
|
|
3624
|
-
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3625
|
-
"hasDynamicHelp": true,
|
|
3626
|
-
"multiple": false,
|
|
3627
|
-
"type": "option"
|
|
3628
|
-
},
|
|
3629
|
-
"result-format": {
|
|
3630
|
-
"name": "result-format",
|
|
3631
|
-
"summary": "Format of the agent test run results.",
|
|
3632
|
-
"default": "human",
|
|
3633
|
-
"hasDynamicHelp": false,
|
|
3634
|
-
"multiple": false,
|
|
3635
|
-
"options": [
|
|
3636
|
-
"json",
|
|
3637
|
-
"human",
|
|
3638
|
-
"junit",
|
|
3639
|
-
"tap"
|
|
3640
|
-
],
|
|
3641
|
-
"type": "option"
|
|
3642
|
-
},
|
|
3643
|
-
"output-dir": {
|
|
3644
|
-
"char": "d",
|
|
3645
|
-
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3646
|
-
"name": "output-dir",
|
|
3647
|
-
"summary": "Directory to write the agent test results into.",
|
|
3648
|
-
"hasDynamicHelp": false,
|
|
3649
|
-
"multiple": false,
|
|
3650
|
-
"type": "option"
|
|
3651
|
-
},
|
|
3652
|
-
"test-runner": {
|
|
3653
|
-
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3654
|
-
"name": "test-runner",
|
|
3655
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3656
|
-
"hasDynamicHelp": false,
|
|
3657
|
-
"multiple": false,
|
|
3658
|
-
"options": [
|
|
3659
|
-
"agentforce-studio",
|
|
3660
|
-
"testing-center"
|
|
2822
|
+
"concise": {
|
|
2823
|
+
"exclusive": [
|
|
2824
|
+
"verbose"
|
|
3661
2825
|
],
|
|
3662
|
-
"
|
|
3663
|
-
|
|
3664
|
-
"verbose": {
|
|
3665
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3666
|
-
"name": "verbose",
|
|
3667
|
-
"summary": "Show generated data in the test results output.",
|
|
2826
|
+
"name": "concise",
|
|
2827
|
+
"summary": "Display minimal output with only essential information about the publish operation.",
|
|
3668
2828
|
"allowNo": false,
|
|
3669
2829
|
"type": "boolean"
|
|
3670
2830
|
}
|
|
3671
2831
|
},
|
|
3672
2832
|
"hasDynamicHelp": true,
|
|
3673
2833
|
"hiddenAliases": [],
|
|
3674
|
-
"id": "agent:
|
|
2834
|
+
"id": "agent:publish:authoring-bundle",
|
|
3675
2835
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3676
2836
|
"pluginName": "@salesforce/plugin-agent",
|
|
3677
2837
|
"pluginType": "core",
|
|
3678
2838
|
"strict": true,
|
|
3679
|
-
"summary": "
|
|
2839
|
+
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
3680
2840
|
"enableJsonFlag": true,
|
|
3681
|
-
"
|
|
3682
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
3683
|
-
"body": [
|
|
3684
|
-
{
|
|
3685
|
-
"name": "SF_TARGET_ORG",
|
|
3686
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3687
|
-
}
|
|
3688
|
-
]
|
|
3689
|
-
},
|
|
2841
|
+
"requiresProject": true,
|
|
3690
2842
|
"errorCodes": {
|
|
3691
2843
|
"header": "ERROR CODES",
|
|
3692
2844
|
"body": [
|
|
3693
2845
|
{
|
|
3694
2846
|
"name": "Succeeded (0)",
|
|
3695
|
-
"description": "
|
|
2847
|
+
"description": "Agent published successfully without errors."
|
|
3696
2848
|
},
|
|
3697
2849
|
{
|
|
3698
2850
|
"name": "Failed (1)",
|
|
3699
|
-
"description": "
|
|
3700
|
-
},
|
|
3701
|
-
{
|
|
3702
|
-
"name": "NotFound (2)",
|
|
3703
|
-
"description": "Test definition not found or invalid test name."
|
|
3704
|
-
},
|
|
3705
|
-
{
|
|
3706
|
-
"name": "OperationFailed (4)",
|
|
3707
|
-
"description": "Failed to start or poll test due to API or network errors."
|
|
2851
|
+
"description": "Compilation errors found in the Agent Script file."
|
|
3708
2852
|
}
|
|
3709
2853
|
]
|
|
3710
2854
|
},
|
|
2855
|
+
"FLAGGABLE_PROMPTS": {
|
|
2856
|
+
"api-name": {
|
|
2857
|
+
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2858
|
+
"promptMessage": "API name of the authoring bundle to publish"
|
|
2859
|
+
}
|
|
2860
|
+
},
|
|
3711
2861
|
"isESM": true,
|
|
3712
2862
|
"relativePath": [
|
|
3713
2863
|
"lib",
|
|
3714
2864
|
"commands",
|
|
3715
2865
|
"agent",
|
|
3716
|
-
"
|
|
3717
|
-
"
|
|
2866
|
+
"publish",
|
|
2867
|
+
"authoring-bundle.js"
|
|
3718
2868
|
],
|
|
3719
2869
|
"aliasPermutations": [],
|
|
3720
2870
|
"permutations": [
|
|
3721
|
-
"agent:
|
|
3722
|
-
"
|
|
3723
|
-
"
|
|
3724
|
-
"agent:
|
|
3725
|
-
"
|
|
3726
|
-
"
|
|
2871
|
+
"agent:publish:authoring-bundle",
|
|
2872
|
+
"publish:agent:authoring-bundle",
|
|
2873
|
+
"publish:authoring-bundle:agent",
|
|
2874
|
+
"agent:authoring-bundle:publish",
|
|
2875
|
+
"authoring-bundle:agent:publish",
|
|
2876
|
+
"authoring-bundle:publish:agent"
|
|
3727
2877
|
]
|
|
3728
2878
|
},
|
|
3729
2879
|
"agent:trace:delete": {
|
|
@@ -4013,6 +3163,856 @@
|
|
|
4013
3163
|
"read:trace:agent"
|
|
4014
3164
|
]
|
|
4015
3165
|
},
|
|
3166
|
+
"agent:test:create": {
|
|
3167
|
+
"aliases": [],
|
|
3168
|
+
"args": {},
|
|
3169
|
+
"description": "To run this command, you must have an agent test spec file, which is a YAML file that lists the test cases for testing a specific agent. Use the \"agent generate test-spec\" CLI command to generate a test spec file. Then specify the file to this command with the --spec flag, or run this command with no flags to be prompted.\n\nWhen this command completes, your org contains the new agent test, which you can view and edit using the Testing Center UI (legacy) or Agentforce Studio (NGT). This command also retrieves the metadata component associated with the new test to your local Salesforce DX project and displays its filename. By default, the legacy AiEvaluationDefinition is created; use --test-runner agentforce-studio to author an AiTestingDefinition (NGT) instead.\n\nAfter you've created the test in the org, use the \"agent test run\" command to run it.",
|
|
3170
|
+
"examples": [
|
|
3171
|
+
"Create an agent test interactively and be prompted for the test spec and API name of the test in the org; use the default org:\n<%= config.bin %> <%= command.id %>",
|
|
3172
|
+
"Create an agent test and use flags to specify all required information; if a test with same API name already exists in the org, overwrite it without confirmation. Use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --force-overwrite --target-org my-org",
|
|
3173
|
+
"Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview",
|
|
3174
|
+
"Author an Agentforce Studio (NGT) test from an NGT-shaped YAML; writes an AiTestingDefinition metadata file:\n<%= config.bin %> <%= command.id %> --spec specs/ReturnsCheckout.ngt.yaml --api-name Returns_Checkout --test-runner agentforce-studio --target-org my-org"
|
|
3175
|
+
],
|
|
3176
|
+
"flags": {
|
|
3177
|
+
"json": {
|
|
3178
|
+
"description": "Format output as json.",
|
|
3179
|
+
"helpGroup": "GLOBAL",
|
|
3180
|
+
"name": "json",
|
|
3181
|
+
"allowNo": false,
|
|
3182
|
+
"type": "boolean"
|
|
3183
|
+
},
|
|
3184
|
+
"flags-dir": {
|
|
3185
|
+
"helpGroup": "GLOBAL",
|
|
3186
|
+
"name": "flags-dir",
|
|
3187
|
+
"summary": "Import flag values from a directory.",
|
|
3188
|
+
"hasDynamicHelp": false,
|
|
3189
|
+
"multiple": false,
|
|
3190
|
+
"type": "option"
|
|
3191
|
+
},
|
|
3192
|
+
"api-name": {
|
|
3193
|
+
"name": "api-name",
|
|
3194
|
+
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
3195
|
+
"hasDynamicHelp": false,
|
|
3196
|
+
"multiple": false,
|
|
3197
|
+
"type": "option"
|
|
3198
|
+
},
|
|
3199
|
+
"spec": {
|
|
3200
|
+
"name": "spec",
|
|
3201
|
+
"summary": "Path to the test spec YAML file.",
|
|
3202
|
+
"hasDynamicHelp": false,
|
|
3203
|
+
"multiple": false,
|
|
3204
|
+
"type": "option"
|
|
3205
|
+
},
|
|
3206
|
+
"target-org": {
|
|
3207
|
+
"char": "o",
|
|
3208
|
+
"name": "target-org",
|
|
3209
|
+
"noCacheDefault": true,
|
|
3210
|
+
"required": true,
|
|
3211
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3212
|
+
"hasDynamicHelp": true,
|
|
3213
|
+
"multiple": false,
|
|
3214
|
+
"type": "option"
|
|
3215
|
+
},
|
|
3216
|
+
"api-version": {
|
|
3217
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3218
|
+
"name": "api-version",
|
|
3219
|
+
"hasDynamicHelp": false,
|
|
3220
|
+
"multiple": false,
|
|
3221
|
+
"type": "option"
|
|
3222
|
+
},
|
|
3223
|
+
"preview": {
|
|
3224
|
+
"name": "preview",
|
|
3225
|
+
"summary": "Preview the test metadata file without deploying to your org.",
|
|
3226
|
+
"allowNo": false,
|
|
3227
|
+
"type": "boolean"
|
|
3228
|
+
},
|
|
3229
|
+
"force-overwrite": {
|
|
3230
|
+
"name": "force-overwrite",
|
|
3231
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test (based on API name) in your org.",
|
|
3232
|
+
"allowNo": false,
|
|
3233
|
+
"type": "boolean"
|
|
3234
|
+
},
|
|
3235
|
+
"test-runner": {
|
|
3236
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3237
|
+
"name": "test-runner",
|
|
3238
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3239
|
+
"hasDynamicHelp": false,
|
|
3240
|
+
"multiple": false,
|
|
3241
|
+
"options": [
|
|
3242
|
+
"agentforce-studio",
|
|
3243
|
+
"testing-center"
|
|
3244
|
+
],
|
|
3245
|
+
"type": "option"
|
|
3246
|
+
}
|
|
3247
|
+
},
|
|
3248
|
+
"hasDynamicHelp": true,
|
|
3249
|
+
"hiddenAliases": [],
|
|
3250
|
+
"id": "agent:test:create",
|
|
3251
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3252
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3253
|
+
"pluginType": "core",
|
|
3254
|
+
"strict": true,
|
|
3255
|
+
"summary": "Create an agent test in your org using a local test spec YAML file.",
|
|
3256
|
+
"enableJsonFlag": true,
|
|
3257
|
+
"envVariablesSection": {
|
|
3258
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3259
|
+
"body": [
|
|
3260
|
+
{
|
|
3261
|
+
"name": "SF_TARGET_ORG",
|
|
3262
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3263
|
+
}
|
|
3264
|
+
]
|
|
3265
|
+
},
|
|
3266
|
+
"errorCodes": {
|
|
3267
|
+
"header": "ERROR CODES",
|
|
3268
|
+
"body": [
|
|
3269
|
+
{
|
|
3270
|
+
"name": "Succeeded (0)",
|
|
3271
|
+
"description": "Test created and deployed successfully."
|
|
3272
|
+
},
|
|
3273
|
+
{
|
|
3274
|
+
"name": "Failed (1)",
|
|
3275
|
+
"description": "Test validation errors or metadata format issues."
|
|
3276
|
+
},
|
|
3277
|
+
{
|
|
3278
|
+
"name": "NotFound (2)",
|
|
3279
|
+
"description": "Test spec file not found or org connection failed."
|
|
3280
|
+
},
|
|
3281
|
+
{
|
|
3282
|
+
"name": "DeploymentFailed (4)",
|
|
3283
|
+
"description": "Deployment failed due to API or network errors."
|
|
3284
|
+
}
|
|
3285
|
+
]
|
|
3286
|
+
},
|
|
3287
|
+
"isESM": true,
|
|
3288
|
+
"relativePath": [
|
|
3289
|
+
"lib",
|
|
3290
|
+
"commands",
|
|
3291
|
+
"agent",
|
|
3292
|
+
"test",
|
|
3293
|
+
"create.js"
|
|
3294
|
+
],
|
|
3295
|
+
"aliasPermutations": [],
|
|
3296
|
+
"permutations": [
|
|
3297
|
+
"agent:test:create",
|
|
3298
|
+
"test:agent:create",
|
|
3299
|
+
"test:create:agent",
|
|
3300
|
+
"agent:create:test",
|
|
3301
|
+
"create:agent:test",
|
|
3302
|
+
"create:test:agent"
|
|
3303
|
+
]
|
|
3304
|
+
},
|
|
3305
|
+
"agent:test:list": {
|
|
3306
|
+
"aliases": [],
|
|
3307
|
+
"args": {},
|
|
3308
|
+
"description": "The command outputs a table with the name (API name) of each test along with its unique ID, type ('agentforce-studio' or 'testing-center'), and the date it was created in the org.",
|
|
3309
|
+
"examples": [
|
|
3310
|
+
"List the agent tests in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
3311
|
+
"List the agent tests in an org with alias \"my-org\"\"\n<%= config.bin %> <%= command.id %> --target-org my-org"
|
|
3312
|
+
],
|
|
3313
|
+
"flags": {
|
|
3314
|
+
"json": {
|
|
3315
|
+
"description": "Format output as json.",
|
|
3316
|
+
"helpGroup": "GLOBAL",
|
|
3317
|
+
"name": "json",
|
|
3318
|
+
"allowNo": false,
|
|
3319
|
+
"type": "boolean"
|
|
3320
|
+
},
|
|
3321
|
+
"flags-dir": {
|
|
3322
|
+
"helpGroup": "GLOBAL",
|
|
3323
|
+
"name": "flags-dir",
|
|
3324
|
+
"summary": "Import flag values from a directory.",
|
|
3325
|
+
"hasDynamicHelp": false,
|
|
3326
|
+
"multiple": false,
|
|
3327
|
+
"type": "option"
|
|
3328
|
+
},
|
|
3329
|
+
"target-org": {
|
|
3330
|
+
"char": "o",
|
|
3331
|
+
"name": "target-org",
|
|
3332
|
+
"noCacheDefault": true,
|
|
3333
|
+
"required": true,
|
|
3334
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3335
|
+
"hasDynamicHelp": true,
|
|
3336
|
+
"multiple": false,
|
|
3337
|
+
"type": "option"
|
|
3338
|
+
},
|
|
3339
|
+
"api-version": {
|
|
3340
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3341
|
+
"name": "api-version",
|
|
3342
|
+
"hasDynamicHelp": false,
|
|
3343
|
+
"multiple": false,
|
|
3344
|
+
"type": "option"
|
|
3345
|
+
}
|
|
3346
|
+
},
|
|
3347
|
+
"hasDynamicHelp": true,
|
|
3348
|
+
"hiddenAliases": [],
|
|
3349
|
+
"id": "agent:test:list",
|
|
3350
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3351
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3352
|
+
"pluginType": "core",
|
|
3353
|
+
"strict": true,
|
|
3354
|
+
"summary": "List the available agent tests in your org.",
|
|
3355
|
+
"enableJsonFlag": true,
|
|
3356
|
+
"envVariablesSection": {
|
|
3357
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3358
|
+
"body": [
|
|
3359
|
+
{
|
|
3360
|
+
"name": "SF_TARGET_ORG",
|
|
3361
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3362
|
+
}
|
|
3363
|
+
]
|
|
3364
|
+
},
|
|
3365
|
+
"errorCodes": {
|
|
3366
|
+
"header": "ERROR CODES",
|
|
3367
|
+
"body": [
|
|
3368
|
+
{
|
|
3369
|
+
"name": "Succeeded (0)",
|
|
3370
|
+
"description": "Agent tests listed successfully."
|
|
3371
|
+
},
|
|
3372
|
+
{
|
|
3373
|
+
"name": "Failed (4)",
|
|
3374
|
+
"description": "Failed to retrieve agent tests due to API or network errors."
|
|
3375
|
+
}
|
|
3376
|
+
]
|
|
3377
|
+
},
|
|
3378
|
+
"isESM": true,
|
|
3379
|
+
"relativePath": [
|
|
3380
|
+
"lib",
|
|
3381
|
+
"commands",
|
|
3382
|
+
"agent",
|
|
3383
|
+
"test",
|
|
3384
|
+
"list.js"
|
|
3385
|
+
],
|
|
3386
|
+
"aliasPermutations": [],
|
|
3387
|
+
"permutations": [
|
|
3388
|
+
"agent:test:list",
|
|
3389
|
+
"test:agent:list",
|
|
3390
|
+
"test:list:agent",
|
|
3391
|
+
"agent:list:test",
|
|
3392
|
+
"list:agent:test",
|
|
3393
|
+
"list:test:agent"
|
|
3394
|
+
]
|
|
3395
|
+
},
|
|
3396
|
+
"agent:test:results": {
|
|
3397
|
+
"aliases": [],
|
|
3398
|
+
"args": {},
|
|
3399
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
3400
|
+
"examples": [
|
|
3401
|
+
"Get the results of an agent test run in your default org using its job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
3402
|
+
"Get the results of the most recently run agent test in an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-org",
|
|
3403
|
+
"Get the results of the most recently run agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
3404
|
+
],
|
|
3405
|
+
"flags": {
|
|
3406
|
+
"json": {
|
|
3407
|
+
"description": "Format output as json.",
|
|
3408
|
+
"helpGroup": "GLOBAL",
|
|
3409
|
+
"name": "json",
|
|
3410
|
+
"allowNo": false,
|
|
3411
|
+
"type": "boolean"
|
|
3412
|
+
},
|
|
3413
|
+
"flags-dir": {
|
|
3414
|
+
"helpGroup": "GLOBAL",
|
|
3415
|
+
"name": "flags-dir",
|
|
3416
|
+
"summary": "Import flag values from a directory.",
|
|
3417
|
+
"hasDynamicHelp": false,
|
|
3418
|
+
"multiple": false,
|
|
3419
|
+
"type": "option"
|
|
3420
|
+
},
|
|
3421
|
+
"target-org": {
|
|
3422
|
+
"char": "o",
|
|
3423
|
+
"name": "target-org",
|
|
3424
|
+
"noCacheDefault": true,
|
|
3425
|
+
"required": true,
|
|
3426
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3427
|
+
"hasDynamicHelp": true,
|
|
3428
|
+
"multiple": false,
|
|
3429
|
+
"type": "option"
|
|
3430
|
+
},
|
|
3431
|
+
"api-version": {
|
|
3432
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3433
|
+
"name": "api-version",
|
|
3434
|
+
"hasDynamicHelp": false,
|
|
3435
|
+
"multiple": false,
|
|
3436
|
+
"type": "option"
|
|
3437
|
+
},
|
|
3438
|
+
"job-id": {
|
|
3439
|
+
"char": "i",
|
|
3440
|
+
"name": "job-id",
|
|
3441
|
+
"required": true,
|
|
3442
|
+
"summary": "Job ID of the completed agent test run.",
|
|
3443
|
+
"hasDynamicHelp": false,
|
|
3444
|
+
"multiple": false,
|
|
3445
|
+
"type": "option"
|
|
3446
|
+
},
|
|
3447
|
+
"result-format": {
|
|
3448
|
+
"name": "result-format",
|
|
3449
|
+
"summary": "Format of the agent test run results.",
|
|
3450
|
+
"default": "human",
|
|
3451
|
+
"hasDynamicHelp": false,
|
|
3452
|
+
"multiple": false,
|
|
3453
|
+
"options": [
|
|
3454
|
+
"json",
|
|
3455
|
+
"human",
|
|
3456
|
+
"junit",
|
|
3457
|
+
"tap"
|
|
3458
|
+
],
|
|
3459
|
+
"type": "option"
|
|
3460
|
+
},
|
|
3461
|
+
"output-dir": {
|
|
3462
|
+
"char": "d",
|
|
3463
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3464
|
+
"name": "output-dir",
|
|
3465
|
+
"summary": "Directory to write the agent test results into.",
|
|
3466
|
+
"hasDynamicHelp": false,
|
|
3467
|
+
"multiple": false,
|
|
3468
|
+
"type": "option"
|
|
3469
|
+
},
|
|
3470
|
+
"test-runner": {
|
|
3471
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3472
|
+
"name": "test-runner",
|
|
3473
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3474
|
+
"hasDynamicHelp": false,
|
|
3475
|
+
"multiple": false,
|
|
3476
|
+
"options": [
|
|
3477
|
+
"agentforce-studio",
|
|
3478
|
+
"testing-center"
|
|
3479
|
+
],
|
|
3480
|
+
"type": "option"
|
|
3481
|
+
},
|
|
3482
|
+
"verbose": {
|
|
3483
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3484
|
+
"name": "verbose",
|
|
3485
|
+
"summary": "Show generated data in the test results output.",
|
|
3486
|
+
"allowNo": false,
|
|
3487
|
+
"type": "boolean"
|
|
3488
|
+
}
|
|
3489
|
+
},
|
|
3490
|
+
"hasDynamicHelp": true,
|
|
3491
|
+
"hiddenAliases": [],
|
|
3492
|
+
"id": "agent:test:results",
|
|
3493
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3494
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3495
|
+
"pluginType": "core",
|
|
3496
|
+
"strict": true,
|
|
3497
|
+
"summary": "Get the results of a completed agent test run.",
|
|
3498
|
+
"enableJsonFlag": true,
|
|
3499
|
+
"envVariablesSection": {
|
|
3500
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3501
|
+
"body": [
|
|
3502
|
+
{
|
|
3503
|
+
"name": "SF_TARGET_ORG",
|
|
3504
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3505
|
+
}
|
|
3506
|
+
]
|
|
3507
|
+
},
|
|
3508
|
+
"errorCodes": {
|
|
3509
|
+
"header": "ERROR CODES",
|
|
3510
|
+
"body": [
|
|
3511
|
+
{
|
|
3512
|
+
"name": "Succeeded (0)",
|
|
3513
|
+
"description": "Results retrieved successfully. Test results (passed/failed) are in the output."
|
|
3514
|
+
},
|
|
3515
|
+
{
|
|
3516
|
+
"name": "NotFound (2)",
|
|
3517
|
+
"description": "Job ID not found or invalid."
|
|
3518
|
+
},
|
|
3519
|
+
{
|
|
3520
|
+
"name": "Failed (4)",
|
|
3521
|
+
"description": "Failed to retrieve results due to API or network errors."
|
|
3522
|
+
}
|
|
3523
|
+
]
|
|
3524
|
+
},
|
|
3525
|
+
"isESM": true,
|
|
3526
|
+
"relativePath": [
|
|
3527
|
+
"lib",
|
|
3528
|
+
"commands",
|
|
3529
|
+
"agent",
|
|
3530
|
+
"test",
|
|
3531
|
+
"results.js"
|
|
3532
|
+
],
|
|
3533
|
+
"aliasPermutations": [],
|
|
3534
|
+
"permutations": [
|
|
3535
|
+
"agent:test:results",
|
|
3536
|
+
"test:agent:results",
|
|
3537
|
+
"test:results:agent",
|
|
3538
|
+
"agent:results:test",
|
|
3539
|
+
"results:agent:test",
|
|
3540
|
+
"results:test:agent"
|
|
3541
|
+
]
|
|
3542
|
+
},
|
|
3543
|
+
"agent:test:resume": {
|
|
3544
|
+
"aliases": [],
|
|
3545
|
+
"args": {},
|
|
3546
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nUse the --wait flag to specify the number of minutes for this command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, the CLI returns control of the terminal to you, and you must run \"agent test resume\" again.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
3547
|
+
"examples": [
|
|
3548
|
+
"Resume an agent test in your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
3549
|
+
"Resume the most recently-run agent test in an org with alias \"my-org\" org; wait 10 minutes for the tests to finish:\n<%= config.bin %> <%= command.id %> --use-most-recent --wait 10 --target-org my-org",
|
|
3550
|
+
"Resume the most recent agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
3551
|
+
],
|
|
3552
|
+
"flags": {
|
|
3553
|
+
"json": {
|
|
3554
|
+
"description": "Format output as json.",
|
|
3555
|
+
"helpGroup": "GLOBAL",
|
|
3556
|
+
"name": "json",
|
|
3557
|
+
"allowNo": false,
|
|
3558
|
+
"type": "boolean"
|
|
3559
|
+
},
|
|
3560
|
+
"flags-dir": {
|
|
3561
|
+
"helpGroup": "GLOBAL",
|
|
3562
|
+
"name": "flags-dir",
|
|
3563
|
+
"summary": "Import flag values from a directory.",
|
|
3564
|
+
"hasDynamicHelp": false,
|
|
3565
|
+
"multiple": false,
|
|
3566
|
+
"type": "option"
|
|
3567
|
+
},
|
|
3568
|
+
"target-org": {
|
|
3569
|
+
"char": "o",
|
|
3570
|
+
"name": "target-org",
|
|
3571
|
+
"noCacheDefault": true,
|
|
3572
|
+
"required": true,
|
|
3573
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3574
|
+
"hasDynamicHelp": true,
|
|
3575
|
+
"multiple": false,
|
|
3576
|
+
"type": "option"
|
|
3577
|
+
},
|
|
3578
|
+
"api-version": {
|
|
3579
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3580
|
+
"name": "api-version",
|
|
3581
|
+
"hasDynamicHelp": false,
|
|
3582
|
+
"multiple": false,
|
|
3583
|
+
"type": "option"
|
|
3584
|
+
},
|
|
3585
|
+
"job-id": {
|
|
3586
|
+
"char": "i",
|
|
3587
|
+
"name": "job-id",
|
|
3588
|
+
"summary": "Job ID of the original agent test run.",
|
|
3589
|
+
"hasDynamicHelp": false,
|
|
3590
|
+
"multiple": false,
|
|
3591
|
+
"type": "option"
|
|
3592
|
+
},
|
|
3593
|
+
"use-most-recent": {
|
|
3594
|
+
"char": "r",
|
|
3595
|
+
"name": "use-most-recent",
|
|
3596
|
+
"summary": "Use the job ID of the most recent agent test run.",
|
|
3597
|
+
"allowNo": false,
|
|
3598
|
+
"type": "boolean"
|
|
3599
|
+
},
|
|
3600
|
+
"wait": {
|
|
3601
|
+
"char": "w",
|
|
3602
|
+
"name": "wait",
|
|
3603
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3604
|
+
"default": "5 minutes",
|
|
3605
|
+
"hasDynamicHelp": true,
|
|
3606
|
+
"multiple": false,
|
|
3607
|
+
"type": "option"
|
|
3608
|
+
},
|
|
3609
|
+
"result-format": {
|
|
3610
|
+
"name": "result-format",
|
|
3611
|
+
"summary": "Format of the agent test run results.",
|
|
3612
|
+
"default": "human",
|
|
3613
|
+
"hasDynamicHelp": false,
|
|
3614
|
+
"multiple": false,
|
|
3615
|
+
"options": [
|
|
3616
|
+
"json",
|
|
3617
|
+
"human",
|
|
3618
|
+
"junit",
|
|
3619
|
+
"tap"
|
|
3620
|
+
],
|
|
3621
|
+
"type": "option"
|
|
3622
|
+
},
|
|
3623
|
+
"output-dir": {
|
|
3624
|
+
"char": "d",
|
|
3625
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3626
|
+
"name": "output-dir",
|
|
3627
|
+
"summary": "Directory to write the agent test results into.",
|
|
3628
|
+
"hasDynamicHelp": false,
|
|
3629
|
+
"multiple": false,
|
|
3630
|
+
"type": "option"
|
|
3631
|
+
},
|
|
3632
|
+
"test-runner": {
|
|
3633
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3634
|
+
"name": "test-runner",
|
|
3635
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3636
|
+
"hasDynamicHelp": false,
|
|
3637
|
+
"multiple": false,
|
|
3638
|
+
"options": [
|
|
3639
|
+
"agentforce-studio",
|
|
3640
|
+
"testing-center"
|
|
3641
|
+
],
|
|
3642
|
+
"type": "option"
|
|
3643
|
+
},
|
|
3644
|
+
"verbose": {
|
|
3645
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3646
|
+
"name": "verbose",
|
|
3647
|
+
"summary": "Show generated data in the test results output.",
|
|
3648
|
+
"allowNo": false,
|
|
3649
|
+
"type": "boolean"
|
|
3650
|
+
}
|
|
3651
|
+
},
|
|
3652
|
+
"hasDynamicHelp": true,
|
|
3653
|
+
"hiddenAliases": [],
|
|
3654
|
+
"id": "agent:test:resume",
|
|
3655
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3656
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3657
|
+
"pluginType": "core",
|
|
3658
|
+
"strict": true,
|
|
3659
|
+
"summary": "Resume an agent test that you previously started in your org so you can view the test results.",
|
|
3660
|
+
"enableJsonFlag": true,
|
|
3661
|
+
"envVariablesSection": {
|
|
3662
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3663
|
+
"body": [
|
|
3664
|
+
{
|
|
3665
|
+
"name": "SF_TARGET_ORG",
|
|
3666
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3667
|
+
}
|
|
3668
|
+
]
|
|
3669
|
+
},
|
|
3670
|
+
"errorCodes": {
|
|
3671
|
+
"header": "ERROR CODES",
|
|
3672
|
+
"body": [
|
|
3673
|
+
{
|
|
3674
|
+
"name": "Succeeded (0)",
|
|
3675
|
+
"description": "Test completed successfully (with test results in the output)."
|
|
3676
|
+
},
|
|
3677
|
+
{
|
|
3678
|
+
"name": "Failed (1)",
|
|
3679
|
+
"description": "Tests encountered execution errors (test cases with ERROR status)."
|
|
3680
|
+
},
|
|
3681
|
+
{
|
|
3682
|
+
"name": "NotFound (2)",
|
|
3683
|
+
"description": "Job ID not found or invalid."
|
|
3684
|
+
},
|
|
3685
|
+
{
|
|
3686
|
+
"name": "OperationFailed (4)",
|
|
3687
|
+
"description": "Failed to poll test due to API or network errors."
|
|
3688
|
+
}
|
|
3689
|
+
]
|
|
3690
|
+
},
|
|
3691
|
+
"isESM": true,
|
|
3692
|
+
"relativePath": [
|
|
3693
|
+
"lib",
|
|
3694
|
+
"commands",
|
|
3695
|
+
"agent",
|
|
3696
|
+
"test",
|
|
3697
|
+
"resume.js"
|
|
3698
|
+
],
|
|
3699
|
+
"aliasPermutations": [],
|
|
3700
|
+
"permutations": [
|
|
3701
|
+
"agent:test:resume",
|
|
3702
|
+
"test:agent:resume",
|
|
3703
|
+
"test:resume:agent",
|
|
3704
|
+
"agent:resume:test",
|
|
3705
|
+
"resume:agent:test",
|
|
3706
|
+
"resume:test:agent"
|
|
3707
|
+
]
|
|
3708
|
+
},
|
|
3709
|
+
"agent:test:run-eval": {
|
|
3710
|
+
"aliases": [],
|
|
3711
|
+
"args": {},
|
|
3712
|
+
"description": "Specify the tests you want to run with one of these inputs to the --spec flag:\n\n- YAML test spec generated by the `agent generate test-spec` CLI command\n- JSON payload\n\nWhen you provide a YAML test spec, this command automatically translates test cases into internal state-based evaluation framework calls and infers the agent name from the test spec's `subjectName` field. As a result, you can use the same test spec with both the `agent test run` and `agent test run-eval` commands. YAML test specs also support context variables, which allow you to inject contextual data (such as CaseId or RoutableId) into agent sessions for testing with different contexts.\n\nWhen you provide a JSON payload, it's sent directly to the evaluation framework with optional normalization. The normalizer auto-corrects common field name mistakes, converts shorthand references to JSONPath, and injects defaults. Use `--no-normalize` to disable this auto-normalization. JSON payloads can also include context_variables on agent.create_session steps for the same contextual testing capabilities as when you use a YAML test spec.\n\nThis command supports more than 8 evaluator types, including subagent routing assertions, action invocation checks, string/numeric assertions, semantic similarity scoring, and LLM-based quality ratings.",
|
|
3713
|
+
"examples": [
|
|
3714
|
+
"Run tests using a YAML test spec on the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --target-org my-org",
|
|
3715
|
+
"Run tests using a YAML spec with explicit agent name override; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --api-name My_Agent",
|
|
3716
|
+
"Run tests using a JSON payload:\n<%= config.bin %> <%= command.id %> --spec specs/eval-payload.json --target-org my-org",
|
|
3717
|
+
"Run tests and output results in JUnit format; useful for continuous integration and deployment (CI/CD):\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --target-org my-org --result-format junit",
|
|
3718
|
+
"Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in your YAML spec):\n<%= config.bin %> <%= command.id %> --spec specs/agent-with-context.yaml --target-org my-org",
|
|
3719
|
+
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
3720
|
+
],
|
|
3721
|
+
"flags": {
|
|
3722
|
+
"json": {
|
|
3723
|
+
"description": "Format output as json.",
|
|
3724
|
+
"helpGroup": "GLOBAL",
|
|
3725
|
+
"name": "json",
|
|
3726
|
+
"allowNo": false,
|
|
3727
|
+
"type": "boolean"
|
|
3728
|
+
},
|
|
3729
|
+
"flags-dir": {
|
|
3730
|
+
"helpGroup": "GLOBAL",
|
|
3731
|
+
"name": "flags-dir",
|
|
3732
|
+
"summary": "Import flag values from a directory.",
|
|
3733
|
+
"hasDynamicHelp": false,
|
|
3734
|
+
"multiple": false,
|
|
3735
|
+
"type": "option"
|
|
3736
|
+
},
|
|
3737
|
+
"target-org": {
|
|
3738
|
+
"char": "o",
|
|
3739
|
+
"name": "target-org",
|
|
3740
|
+
"noCacheDefault": true,
|
|
3741
|
+
"required": true,
|
|
3742
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3743
|
+
"hasDynamicHelp": true,
|
|
3744
|
+
"multiple": false,
|
|
3745
|
+
"type": "option"
|
|
3746
|
+
},
|
|
3747
|
+
"api-version": {
|
|
3748
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3749
|
+
"name": "api-version",
|
|
3750
|
+
"hasDynamicHelp": false,
|
|
3751
|
+
"multiple": false,
|
|
3752
|
+
"type": "option"
|
|
3753
|
+
},
|
|
3754
|
+
"spec": {
|
|
3755
|
+
"char": "s",
|
|
3756
|
+
"name": "spec",
|
|
3757
|
+
"required": true,
|
|
3758
|
+
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
3759
|
+
"hasDynamicHelp": false,
|
|
3760
|
+
"multiple": false,
|
|
3761
|
+
"type": "option"
|
|
3762
|
+
},
|
|
3763
|
+
"api-name": {
|
|
3764
|
+
"char": "n",
|
|
3765
|
+
"name": "api-name",
|
|
3766
|
+
"summary": "Agent API name (also called DeveloperName) used to resolve agent_id and agent_version_id. Auto-inferred from the YAML spec's subjectName.",
|
|
3767
|
+
"hasDynamicHelp": false,
|
|
3768
|
+
"multiple": false,
|
|
3769
|
+
"type": "option"
|
|
3770
|
+
},
|
|
3771
|
+
"result-format": {
|
|
3772
|
+
"name": "result-format",
|
|
3773
|
+
"summary": "Format of the agent test run results.",
|
|
3774
|
+
"default": "human",
|
|
3775
|
+
"hasDynamicHelp": false,
|
|
3776
|
+
"multiple": false,
|
|
3777
|
+
"options": [
|
|
3778
|
+
"json",
|
|
3779
|
+
"human",
|
|
3780
|
+
"junit",
|
|
3781
|
+
"tap"
|
|
3782
|
+
],
|
|
3783
|
+
"type": "option"
|
|
3784
|
+
},
|
|
3785
|
+
"batch-size": {
|
|
3786
|
+
"name": "batch-size",
|
|
3787
|
+
"summary": "Number of tests per API request (max 5).",
|
|
3788
|
+
"default": 5,
|
|
3789
|
+
"hasDynamicHelp": false,
|
|
3790
|
+
"multiple": false,
|
|
3791
|
+
"type": "option"
|
|
3792
|
+
},
|
|
3793
|
+
"no-normalize": {
|
|
3794
|
+
"name": "no-normalize",
|
|
3795
|
+
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
3796
|
+
"allowNo": false,
|
|
3797
|
+
"type": "boolean"
|
|
3798
|
+
}
|
|
3799
|
+
},
|
|
3800
|
+
"hasDynamicHelp": true,
|
|
3801
|
+
"hiddenAliases": [],
|
|
3802
|
+
"id": "agent:test:run-eval",
|
|
3803
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3804
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3805
|
+
"pluginType": "core",
|
|
3806
|
+
"state": "beta",
|
|
3807
|
+
"strict": true,
|
|
3808
|
+
"summary": "Run rich evaluation tests against an Agentforce agent.",
|
|
3809
|
+
"enableJsonFlag": true,
|
|
3810
|
+
"envVariablesSection": {
|
|
3811
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3812
|
+
"body": [
|
|
3813
|
+
{
|
|
3814
|
+
"name": "SF_TARGET_ORG",
|
|
3815
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3816
|
+
}
|
|
3817
|
+
]
|
|
3818
|
+
},
|
|
3819
|
+
"errorCodes": {
|
|
3820
|
+
"header": "ERROR CODES",
|
|
3821
|
+
"body": [
|
|
3822
|
+
{
|
|
3823
|
+
"name": "Succeeded (0)",
|
|
3824
|
+
"description": "Tests completed successfully. Test results (passed/failed) are in the JSON output."
|
|
3825
|
+
},
|
|
3826
|
+
{
|
|
3827
|
+
"name": "Failed (1)",
|
|
3828
|
+
"description": "Tests encountered execution errors (tests couldn't run properly)."
|
|
3829
|
+
},
|
|
3830
|
+
{
|
|
3831
|
+
"name": "NotFound (2)",
|
|
3832
|
+
"description": "Agent not found, spec file not found, or invalid agent name."
|
|
3833
|
+
},
|
|
3834
|
+
{
|
|
3835
|
+
"name": "OperationFailed (4)",
|
|
3836
|
+
"description": "Failed to execute tests due to API or network errors."
|
|
3837
|
+
}
|
|
3838
|
+
]
|
|
3839
|
+
},
|
|
3840
|
+
"isESM": true,
|
|
3841
|
+
"relativePath": [
|
|
3842
|
+
"lib",
|
|
3843
|
+
"commands",
|
|
3844
|
+
"agent",
|
|
3845
|
+
"test",
|
|
3846
|
+
"run-eval.js"
|
|
3847
|
+
],
|
|
3848
|
+
"aliasPermutations": [],
|
|
3849
|
+
"permutations": [
|
|
3850
|
+
"agent:test:run-eval",
|
|
3851
|
+
"test:agent:run-eval",
|
|
3852
|
+
"test:run-eval:agent",
|
|
3853
|
+
"agent:run-eval:test",
|
|
3854
|
+
"run-eval:agent:test",
|
|
3855
|
+
"run-eval:test:agent"
|
|
3856
|
+
]
|
|
3857
|
+
},
|
|
3858
|
+
"agent:test:run": {
|
|
3859
|
+
"aliases": [],
|
|
3860
|
+
"args": {},
|
|
3861
|
+
"description": "Use the --api-name flag to specify the name of the agent test you want to run. Use the output of the \"agent test list\" command to get the names of all the available agent tests in your org.\n\nBy default, this command starts the agent test in your org, but it doesn't wait for the test to finish. Instead, it displays the \"agent test resume\" command, with a job ID, that you execute to see the results of the test run, and then returns control of the terminal window to you. Use the --wait flag to specify the number of minutes for the command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, run \"agent test resume\".\n\nBy default, this command outputs test results in human-readable tables for each test case, if the test completes in time. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
3862
|
+
"examples": [
|
|
3863
|
+
"Start an agent test called Resort_Manager_Test for an agent in your default org, don't wait for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test",
|
|
3864
|
+
"Start an agent test for an agent in an org with alias \"my-org\" and wait for 10 minutes for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --target-org my-org",
|
|
3865
|
+
"Start an agent test and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --output-dir ./test-results --result-format json"
|
|
3866
|
+
],
|
|
3867
|
+
"flags": {
|
|
3868
|
+
"json": {
|
|
3869
|
+
"description": "Format output as json.",
|
|
3870
|
+
"helpGroup": "GLOBAL",
|
|
3871
|
+
"name": "json",
|
|
3872
|
+
"allowNo": false,
|
|
3873
|
+
"type": "boolean"
|
|
3874
|
+
},
|
|
3875
|
+
"flags-dir": {
|
|
3876
|
+
"helpGroup": "GLOBAL",
|
|
3877
|
+
"name": "flags-dir",
|
|
3878
|
+
"summary": "Import flag values from a directory.",
|
|
3879
|
+
"hasDynamicHelp": false,
|
|
3880
|
+
"multiple": false,
|
|
3881
|
+
"type": "option"
|
|
3882
|
+
},
|
|
3883
|
+
"target-org": {
|
|
3884
|
+
"char": "o",
|
|
3885
|
+
"name": "target-org",
|
|
3886
|
+
"noCacheDefault": true,
|
|
3887
|
+
"required": true,
|
|
3888
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3889
|
+
"hasDynamicHelp": true,
|
|
3890
|
+
"multiple": false,
|
|
3891
|
+
"type": "option"
|
|
3892
|
+
},
|
|
3893
|
+
"api-version": {
|
|
3894
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3895
|
+
"name": "api-version",
|
|
3896
|
+
"hasDynamicHelp": false,
|
|
3897
|
+
"multiple": false,
|
|
3898
|
+
"type": "option"
|
|
3899
|
+
},
|
|
3900
|
+
"api-name": {
|
|
3901
|
+
"char": "n",
|
|
3902
|
+
"name": "api-name",
|
|
3903
|
+
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
3904
|
+
"hasDynamicHelp": false,
|
|
3905
|
+
"multiple": false,
|
|
3906
|
+
"type": "option"
|
|
3907
|
+
},
|
|
3908
|
+
"wait": {
|
|
3909
|
+
"char": "w",
|
|
3910
|
+
"name": "wait",
|
|
3911
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3912
|
+
"hasDynamicHelp": true,
|
|
3913
|
+
"multiple": false,
|
|
3914
|
+
"type": "option"
|
|
3915
|
+
},
|
|
3916
|
+
"result-format": {
|
|
3917
|
+
"name": "result-format",
|
|
3918
|
+
"summary": "Format of the agent test run results.",
|
|
3919
|
+
"default": "human",
|
|
3920
|
+
"hasDynamicHelp": false,
|
|
3921
|
+
"multiple": false,
|
|
3922
|
+
"options": [
|
|
3923
|
+
"json",
|
|
3924
|
+
"human",
|
|
3925
|
+
"junit",
|
|
3926
|
+
"tap"
|
|
3927
|
+
],
|
|
3928
|
+
"type": "option"
|
|
3929
|
+
},
|
|
3930
|
+
"output-dir": {
|
|
3931
|
+
"char": "d",
|
|
3932
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3933
|
+
"name": "output-dir",
|
|
3934
|
+
"summary": "Directory to write the agent test results into.",
|
|
3935
|
+
"hasDynamicHelp": false,
|
|
3936
|
+
"multiple": false,
|
|
3937
|
+
"type": "option"
|
|
3938
|
+
},
|
|
3939
|
+
"test-runner": {
|
|
3940
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3941
|
+
"name": "test-runner",
|
|
3942
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3943
|
+
"hasDynamicHelp": false,
|
|
3944
|
+
"multiple": false,
|
|
3945
|
+
"options": [
|
|
3946
|
+
"agentforce-studio",
|
|
3947
|
+
"testing-center"
|
|
3948
|
+
],
|
|
3949
|
+
"type": "option"
|
|
3950
|
+
},
|
|
3951
|
+
"verbose": {
|
|
3952
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3953
|
+
"name": "verbose",
|
|
3954
|
+
"summary": "Show generated data in the test results output.",
|
|
3955
|
+
"allowNo": false,
|
|
3956
|
+
"type": "boolean"
|
|
3957
|
+
}
|
|
3958
|
+
},
|
|
3959
|
+
"hasDynamicHelp": true,
|
|
3960
|
+
"hiddenAliases": [],
|
|
3961
|
+
"id": "agent:test:run",
|
|
3962
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3963
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3964
|
+
"pluginType": "core",
|
|
3965
|
+
"strict": true,
|
|
3966
|
+
"summary": "Start an agent test in your org.",
|
|
3967
|
+
"enableJsonFlag": true,
|
|
3968
|
+
"envVariablesSection": {
|
|
3969
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3970
|
+
"body": [
|
|
3971
|
+
{
|
|
3972
|
+
"name": "SF_TARGET_ORG",
|
|
3973
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3974
|
+
}
|
|
3975
|
+
]
|
|
3976
|
+
},
|
|
3977
|
+
"errorCodes": {
|
|
3978
|
+
"header": "ERROR CODES",
|
|
3979
|
+
"body": [
|
|
3980
|
+
{
|
|
3981
|
+
"name": "Succeeded (0)",
|
|
3982
|
+
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
3983
|
+
},
|
|
3984
|
+
{
|
|
3985
|
+
"name": "Failed (1)",
|
|
3986
|
+
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
3987
|
+
},
|
|
3988
|
+
{
|
|
3989
|
+
"name": "NotFound (2)",
|
|
3990
|
+
"description": "Test definition not found or invalid test name."
|
|
3991
|
+
},
|
|
3992
|
+
{
|
|
3993
|
+
"name": "OperationFailed (4)",
|
|
3994
|
+
"description": "Failed to start or poll test due to API or network errors."
|
|
3995
|
+
}
|
|
3996
|
+
]
|
|
3997
|
+
},
|
|
3998
|
+
"isESM": true,
|
|
3999
|
+
"relativePath": [
|
|
4000
|
+
"lib",
|
|
4001
|
+
"commands",
|
|
4002
|
+
"agent",
|
|
4003
|
+
"test",
|
|
4004
|
+
"run.js"
|
|
4005
|
+
],
|
|
4006
|
+
"aliasPermutations": [],
|
|
4007
|
+
"permutations": [
|
|
4008
|
+
"agent:test:run",
|
|
4009
|
+
"test:agent:run",
|
|
4010
|
+
"test:run:agent",
|
|
4011
|
+
"agent:run:test",
|
|
4012
|
+
"run:agent:test",
|
|
4013
|
+
"run:test:agent"
|
|
4014
|
+
]
|
|
4015
|
+
},
|
|
4016
4016
|
"agent:validate:authoring-bundle": {
|
|
4017
4017
|
"aliases": [],
|
|
4018
4018
|
"args": {},
|
|
@@ -4683,5 +4683,5 @@
|
|
|
4683
4683
|
]
|
|
4684
4684
|
}
|
|
4685
4685
|
},
|
|
4686
|
-
"version": "2.2.
|
|
4686
|
+
"version": "2.2.4"
|
|
4687
4687
|
}
|