@salesforce/plugin-agent 1.26.5 → 1.26.7

package/messages/agent.preview.md

@@ -4,20 +4,20 @@ Interact with an agent to preview how it responds to your statements, questions,
 
 # description
 
-Use this command to have a natural language conversation with an agent while you code its Agent Script file. Previewing an agent works like an initial test to make sure it responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce Builder UI.
+Use this command to have a natural language conversation with an agent, either while you code its local Agent Script file or when it's published to an org. Previewing an agent acts like an initial test to make sure it responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce Builder UI.
 
-This command uses the agent's local authoring bundle, which contains its Agent Script file. You can let the command provide a list of authoring bundles (labeled "(Agent Script)") to choose from or use the --authoring-bundle flag to specify a bundle's API name.
+Run without flags, this command provides a list of agents to preview, divided into two categories: "Agent Script", which are agents that have a local authoring bundle in your DX project, or "Published", which are agents that are published and activated in your org. Authoring bundles contain an agent's Agent Script file. You then choose the agent you want to preview from the list. Or you can use the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent.
 
-You can use these two modes when previewing an agent from its Agent Script file:
+When previewing an agent from its Agent Script file, you can use these two modes:
 
-- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use this mode if none of the Apex classes, flows, and prompt templates that implement your actions are available yet. The LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.
-- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview. If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to your development org if you want to use them in your live preview. You can use the Apex Replay Debugger to debug your Apex classes when using live mode.
+- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use this mode if none of the Apex classes, flows, or prompt templates that implement your actions are available yet. The LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.
+- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview. If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to your development org if you want to use them in your live preview.
 
-The interface is simple: in the "Start typing..." prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.
+You can use the Apex Replay Debugger to debug your Apex classes when using live mode for Agent Script files and for activated published agents; specify the --apex-debug flag.
 
-When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the "./temp/agent-preview" directory. Specify a new default directory with the --output-dir flag.
+Once connected to your agent, the preview interface is simple: in the "Start typing..." prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.
 
-NOTE: You can also use this command to connect to a published and active agent, which are labeled "(Published)" if you let this command provide the list of agents to preview. That use case, however, requires additional security and configuration in both your org and your DX project. The examples in this help are for previewing an agent from its Agent Script file in your DX project and require only simple authorization of your org, such as with the "org login web" command. The --client-app and --api-name flags are used only for previewing published and active agents, they don't apply to Agent Script agents. See "Connect to a Published Agent" in the "Agentforce Developer Guide" for complete documentation: https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.
+When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the "./temp/agent-preview" directory. Specify a new default directory with the --output-dir flag.
 
 # flags.api-name.summary
 
@@ -27,10 +27,6 @@ API name of the published and active agent you want to interact with.
 
 API name of the authoring bundle metadata component that contains the agent's Agent Script file.
 
-# flags.client-app.summary
-
-Name of the linked client app to use for the connection to the published and active agent.
-
 # flags.output-dir.summary
 
 Directory where conversation transcripts are saved.
@@ -45,7 +41,7 @@ Enable Apex debug logging during the agent preview conversation.
 
 # examples
 
-- Preview an agent in simulated mode by choosing from a list of authoring bundles provided by the command; use the org with alias "my-dev-org":
+- Preview an agent by choosing from the list of available local Agent Script or published agents. If previewing a local Agent Script agent, use simulated mode. Use the org with alias "my-dev-org".
 
   <%= config.bin %> <%= command.id %> --target-org my-dev-org
 

package/oclif.manifest.json

@@ -248,9 +248,9 @@
     "agent:preview": {
       "aliases": [],
       "args": {},
-      "description": "Use this command to have a natural language conversation with an agent while you code its Agent Script file. Previewing an agent works like an initial test to make sure it responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce Builder UI.\n\nThis command uses the agent's local authoring bundle, which contains its Agent Script file. You can let the command provide a list of authoring bundles (labeled \"(Agent Script)\") to choose from or use the --authoring-bundle flag to specify a bundle's API name.\n\nYou can use these two modes when previewing an agent from its Agent Script file:\n\n- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use this mode if none of the Apex classes, flows, and prompt templates that implement your actions are available yet. The LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.\n- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview. If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to your development org if you want to use them in your live preview. You can use the Apex Replay Debugger to debug your Apex classes when using live mode.\n\nThe interface is simple: in the \"Start typing...\" prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.\n\nWhen the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the \"./temp/agent-preview\" directory. Specify a new default directory with the --output-dir flag.\n\nNOTE: You can also use this command to connect to a published and active agent, which are labeled \"(Published)\" if you let this command provide the list of agents to preview. That use case, however, requires additional security and configuration in both your org and your DX project. The examples in this help are for previewing an agent from its Agent Script file in your DX project and require only simple authorization of your org, such as with the \"org login web\" command. The --client-app and --api-name flags are used only for previewing published and active agents, they don't apply to Agent Script agents. See \"Connect to a Published Agent\" in the \"Agentforce Developer Guide\" for complete documentation: https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.",
+      "description": "Use this command to have a natural language conversation with an agent, either while you code its local Agent Script file or when it's published to an org. Previewing an agent acts like an initial test to make sure it responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce Builder UI.\n\nRun without flags, this command provides a list of agents to preview, divided into two categories: \"Agent Script\", which are agents that have a local authoring bundle in your DX project, or \"Published\", which are agents that are published and activated in your org. Authoring bundles contain an agent's Agent Script file. You then choose the agent you want to preview from the list. Or you can use the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent.\n\nWhen previewing an agent from its Agent Script file, you can use these two modes:\n\n- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use this mode if none of the Apex classes, flows, or prompt templates that implement your actions are available yet. The LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.\n- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview. If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to your development org if you want to use them in your live preview.\n\nYou can use the Apex Replay Debugger to debug your Apex classes when using live mode for Agent Script files and for activated published agents; specify the --apex-debug flag.\n\nOnce connected to your agent, the preview interface is simple: in the \"Start typing...\" prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.\n\nWhen the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the \"./temp/agent-preview\" directory. Specify a new default directory with the --output-dir flag.",
       "examples": [
-        "Preview an agent in simulated mode by choosing from a list of authoring bundles provided by the command; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --target-org my-dev-org",
+        "Preview an agent by choosing from the list of available local Agent Script or published agents. If previewing a local Agent Script agent, use simulated mode. Use the org with alias \"my-dev-org\".\n<%= config.bin %> <%= command.id %> --target-org my-dev-org",
         "Preview an agent in live mode by choosing from a list of authoring bundles. Save the conversation transcripts to the \"./transcripts/my-preview\" directory, enable the Apex debug logs, and use your default org:\n<%= config.bin %> <%= command.id %> --use-live-actions --apex-debug --output-dir transcripts/my-preview"
       ],
       "flags": {
@@ -279,17 +279,6 @@
           "multiple": false,
           "type": "option"
         },
-        "client-app": {
-          "char": "c",
-          "dependsOn": [
-            "target-org"
-          ],
-          "name": "client-app",
-          "summary": "Name of the linked client app to use for the connection to the published and active agent.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "api-name": {
           "char": "n",
           "name": "api-name",
@@ -892,6 +881,91 @@
         "authoring-bundle:publish:agent"
       ]
     },
+    "agent:validate:authoring-bundle": {
+      "aliases": [],
+      "args": {},
+      "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\nThis command validates that the Agent Script file in the authoring bundle compiles without errors so that you can later publish the bundle to your org. Use this command while you code the Agent Script file to ensure that it's valid. If the validation fails, the command outputs the list of syntax errors, a brief description of the error, and the location in the Agent Script file where the error occurred.\n\nThis command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.",
+      "examples": [
+        "Validate an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
+        "Validate an authoring bundle with API name MyAuthoringBundle; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle --target-org my-dev-org"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-name": {
+          "char": "n",
+          "name": "api-name",
+          "summary": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "agent:validate:authoring-bundle",
+      "pluginAlias": "@salesforce/plugin-agent",
+      "pluginName": "@salesforce/plugin-agent",
+      "pluginType": "core",
+      "state": "beta",
+      "strict": true,
+      "summary": "Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an agent.",
+      "enableJsonFlag": true,
+      "requiresProject": true,
+      "FLAGGABLE_PROMPTS": {
+        "api-name": {
+          "message": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
+          "promptMessage": "API name of the authoring bundle to validate"
+        }
+      },
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "agent",
+        "validate",
+        "authoring-bundle.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "agent:validate:authoring-bundle",
+        "validate:agent:authoring-bundle",
+        "validate:authoring-bundle:agent",
+        "agent:authoring-bundle:validate",
+        "authoring-bundle:agent:validate",
+        "authoring-bundle:validate:agent"
+      ]
+    },
     "agent:test:create": {
       "aliases": [],
       "args": {},
@@ -1405,92 +1479,7 @@
         "run:agent:test",
         "run:test:agent"
       ]
-    },
-    "agent:validate:authoring-bundle": {
-      "aliases": [],
-      "args": {},
-      "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\nThis command validates that the Agent Script file in the authoring bundle compiles without errors so that you can later publish the bundle to your org. Use this command while you code the Agent Script file to ensure that it's valid. If the validation fails, the command outputs the list of syntax errors, a brief description of the error, and the location in the Agent Script file where the error occurred.\n\nThis command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.",
-      "examples": [
-        "Validate an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
-        "Validate an authoring bundle with API name MyAuthoringBundle; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle --target-org my-dev-org"
-      ],
-      "flags": {
-        "json": {
-          "description": "Format output as json.",
-          "helpGroup": "GLOBAL",
-          "name": "json",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "flags-dir": {
-          "helpGroup": "GLOBAL",
-          "name": "flags-dir",
-          "summary": "Import flag values from a directory.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "target-org": {
-          "char": "o",
-          "name": "target-org",
-          "noCacheDefault": true,
-          "required": true,
-          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
-          "hasDynamicHelp": true,
-          "multiple": false,
-          "type": "option"
-        },
-        "api-version": {
-          "description": "Override the api version used for api requests made by this command",
-          "name": "api-version",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "api-name": {
-          "char": "n",
-          "name": "api-name",
-          "summary": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": true,
-      "hiddenAliases": [],
-      "id": "agent:validate:authoring-bundle",
-      "pluginAlias": "@salesforce/plugin-agent",
-      "pluginName": "@salesforce/plugin-agent",
-      "pluginType": "core",
-      "state": "beta",
-      "strict": true,
-      "summary": "Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an agent.",
-      "enableJsonFlag": true,
-      "requiresProject": true,
-      "FLAGGABLE_PROMPTS": {
-        "api-name": {
-          "message": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
-          "promptMessage": "API name of the authoring bundle to validate"
-        }
-      },
-      "isESM": true,
-      "relativePath": [
-        "lib",
-        "commands",
-        "agent",
-        "validate",
-        "authoring-bundle.js"
-      ],
-      "aliasPermutations": [],
-      "permutations": [
-        "agent:validate:authoring-bundle",
-        "validate:agent:authoring-bundle",
-        "validate:authoring-bundle:agent",
-        "agent:authoring-bundle:validate",
-        "authoring-bundle:agent:validate",
-        "authoring-bundle:validate:agent"
-      ]
     }
   },
-  "version": "1.26.5"
+  "version": "1.26.7"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-agent",
     "description": "Commands to interact with Salesforce agents",
-    "version": "1.26.5",
+    "version": "1.26.7",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
@@ -9,7 +9,7 @@
         "@inquirer/prompts": "^7.10.1",
         "@oclif/core": "^4",
         "@oclif/multi-stage-output": "^0.8.29",
-        "@salesforce/agents": "^0.20.0",
+        "@salesforce/agents": "^0.21.1",
         "@salesforce/core": "^8.24.3",
         "@salesforce/kit": "^3.2.3",
         "@salesforce/sf-plugins-core": "^12.2.6",
@@ -237,7 +237,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.5.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.5.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.7.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.7.sig"
     }
 }