@salesforce/plugin-agent 1.32.14 → 1.32.15

package/oclif.manifest.json

@@ -66,6 +66,32 @@
       "strict": true,
       "summary": "Activate an agent in an org.",
       "enableJsonFlag": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Agent activated successfully."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Agent not found in the org."
+          },
+          {
+            "name": "ActivationFailed (4)",
+            "description": "Failed to activate the agent due to API or network errors."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -239,6 +265,32 @@
       "strict": true,
       "summary": "Deactivate an agent in an org.",
       "enableJsonFlag": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Agent deactivated successfully."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Agent not found in the org."
+          },
+          {
+            "name": "DeactivationFailed (4)",
+            "description": "Failed to deactivate the agent due to API or network errors."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -819,7 +871,7 @@
     "agent:preview:end": {
       "aliases": [],
       "args": {},
-      "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, 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.",
+      "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, 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.",
       "examples": [
         "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",
         "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",
@@ -892,6 +944,36 @@
       "summary": "End an existing programmatic agent preview session and get trace location.",
       "enableJsonFlag": true,
       "requiresProject": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Preview session ended successfully and traces saved."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Agent not found, or no preview session exists for this agent."
+          },
+          {
+            "name": "PreviewEndFailed (4)",
+            "description": "Failed to end the preview session."
+          },
+          {
+            "name": "SessionAmbiguous (5)",
+            "description": "Multiple preview sessions found; specify --session-id to choose one."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -913,7 +995,7 @@
     "agent:preview:send": {
       "aliases": [],
       "args": {},
-      "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.",
+      "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.",
       "examples": [
         "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>",
         "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",
@@ -995,6 +1077,36 @@
       "summary": "Send a message to an existing agent preview session.",
       "enableJsonFlag": true,
       "requiresProject": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Message sent successfully and agent response received."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Agent not found, or no preview session exists for this agent."
+          },
+          {
+            "name": "PreviewSendFailed (4)",
+            "description": "Failed to send message or receive response from the preview session."
+          },
+          {
+            "name": "SessionAmbiguous (5)",
+            "description": "Multiple preview sessions found; specify --session-id to choose one."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -1047,6 +1159,15 @@
       "summary": "List all known programmatic agent preview sessions.",
       "enableJsonFlag": true,
       "requiresProject": true,
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Sessions listed successfully (or empty list if no active sessions)."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -1068,7 +1189,7 @@
     "agent:preview:start": {
       "aliases": [],
       "args": {},
-      "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 using the authoring bundle, which contains the agent's Agent Script file, the preview uses mocked actions by default.  Specify --use-live-actions for live mode, which uses the real Apex classes, flows, etc, in the org for the actions.",
+      "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 using the authoring bundle, which contains the agent's Agent Script file, the preview uses mocked actions by default. Specify --use-live-actions for live mode, which uses the real Apex classes, flows, etc, in the org for the actions.",
       "examples": [
         "Start a programmatic agent preview session by specifying an authoring bundle; uses mocked actions by default. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org",
         "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",
@@ -1139,6 +1260,40 @@
       "summary": "Start a programmatic agent preview session.",
       "enableJsonFlag": true,
       "requiresProject": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Preview session started successfully."
+          },
+          {
+            "name": "Failed (1)",
+            "description": "Agent Script compilation failed (syntax errors in the script)."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
+          },
+          {
+            "name": "ServerError (3)",
+            "description": "Compilation API returned HTTP 500 (server error during compilation)."
+          },
+          {
+            "name": "PreviewStartFailed (4)",
+            "description": "Preview session failed to start due to API or network errors."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -1325,6 +1480,36 @@
       "strict": true,
       "summary": "Create an agent test in your org using a local test spec YAML file.",
       "enableJsonFlag": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Test created and deployed successfully."
+          },
+          {
+            "name": "Failed (1)",
+            "description": "Test validation errors or metadata format issues."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Test spec file not found or org connection failed."
+          },
+          {
+            "name": "DeploymentFailed (4)",
+            "description": "Deployment failed due to API or network errors."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -1394,6 +1579,28 @@
       "strict": true,
       "summary": "List the available agent tests in your org.",
       "enableJsonFlag": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Agent tests listed successfully."
+          },
+          {
+            "name": "Failed (4)",
+            "description": "Failed to retrieve agent tests due to API or network errors."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -1503,6 +1710,32 @@
       "strict": true,
       "summary": "Get the results of a completed agent test run.",
       "enableJsonFlag": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Results retrieved successfully. Test results (passed/failed) are in the output."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Job ID not found or invalid."
+          },
+          {
+            "name": "Failed (4)",
+            "description": "Failed to retrieve results due to API or network errors."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -1627,6 +1860,36 @@
       "strict": true,
       "summary": "Resume an agent test that you previously started in your org so you can view the test results.",
       "enableJsonFlag": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Test completed successfully (with test results in the output)."
+          },
+          {
+            "name": "Failed (1)",
+            "description": "Tests encountered execution errors (test cases with ERROR status)."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Job ID not found or invalid."
+          },
+          {
+            "name": "OperationFailed (4)",
+            "description": "Failed to poll test due to API or network errors."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -1756,6 +2019,36 @@
       "strict": true,
       "summary": "Run evaluation tests against an Agentforce agent.",
       "enableJsonFlag": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Tests completed successfully. Test results (passed/failed) are in the JSON output."
+          },
+          {
+            "name": "Failed (1)",
+            "description": "Tests encountered execution errors (tests couldn't run properly)."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Agent not found, spec file not found, or invalid agent name."
+          },
+          {
+            "name": "OperationFailed (4)",
+            "description": "Failed to execute tests due to API or network errors."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -1872,6 +2165,36 @@
       "strict": true,
       "summary": "Start an agent test in your org.",
       "enableJsonFlag": true,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
+          },
+          {
+            "name": "Failed (1)",
+            "description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Test definition not found or invalid test name."
+          },
+          {
+            "name": "OperationFailed (4)",
+            "description": "Failed to start or poll test due to API or network errors."
+          }
+        ]
+      },
       "isESM": true,
       "relativePath": [
         "lib",
@@ -1950,6 +2273,36 @@
       "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,
+      "envVariablesSection": {
+        "header": "ENVIRONMENT VARIABLES",
+        "body": [
+          {
+            "name": "SF_TARGET_ORG",
+            "description": "Username or alias of your default org. Overrides the target-org configuration variable."
+          }
+        ]
+      },
+      "errorCodes": {
+        "header": "ERROR CODES",
+        "body": [
+          {
+            "name": "Succeeded (0)",
+            "description": "Agent Script file compiled successfully without errors."
+          },
+          {
+            "name": "Failed (1)",
+            "description": "Compilation errors found in the Agent Script file."
+          },
+          {
+            "name": "NotFound (2)",
+            "description": "Validation/compilation API returned HTTP 404. The API endpoint may not be available in your org or region."
+          },
+          {
+            "name": "ServerError (3)",
+            "description": "Validation/compilation API returned HTTP 500. A server error occurred during compilation."
+          }
+        ]
+      },
       "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.",
@@ -1975,5 +2328,5 @@
       ]
     }
   },
-  "version": "1.32.14"
+  "version": "1.32.15"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-agent",
     "description": "Commands to interact with Salesforce agents",
-    "version": "1.32.14",
+    "version": "1.32.15",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "enableO11y": true,
@@ -240,7 +240,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.32.14.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.32.14.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.32.15.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.32.15.sig"
     }
 }