@salesforce/plugin-agent 1.18.0 → 1.18.1

package/README.md

@@ -132,7 +132,7 @@ EXAMPLES
     $ sf agent create --agent-name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
 ```
 
-_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/create.ts)_
+_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/create.ts)_
 
 ## `sf agent generate agent-spec`
 
@@ -237,11 +237,11 @@ EXAMPLES
     $ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
 ```
 
-_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/generate/agent-spec.ts)_
+_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/generate/agent-spec.ts)_
 
 ## `sf agent generate template`
 
-Generate an agent template for packaging.
+Generate an agent template from an existing agent in your DX project so you can then package the template in a managed package.
 
 ```
 USAGE
@@ -249,10 +249,10 @@ USAGE
     <value>]
 
 FLAGS
-  -f, --agent-file=<value>     (required) The path to an Agent (Bot) file.
+  -f, --agent-file=<value>     (required) Path to an agent (Bot) metadata file.
   -o, --target-org=<value>     (required) Username or alias of the target org. Not required if the `target-org`
                                configuration variable is already set.
-      --agent-version=<value>  (required) Version of the Agent (botVersion).
+      --agent-version=<value>  (required) Version of the agent (BotVersion).
       --api-version=<value>    Override the api version used for api requests made by this command
 
 GLOBAL FLAGS
@@ -260,18 +260,35 @@ GLOBAL FLAGS
   --json               Format output as json.
 
 DESCRIPTION
-  Generate an agent template for packaging.
-
-  Generate agent template metadata to for packaging your agent.
+  Generate an agent template from an existing agent in your DX project so you can then package the template in a managed
+  package.
+
+  At a high-level, agents are defined by the Bot, BotVersion, and GenAiPlanner metadata types. The GenAiPlanner 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 file for a specific agent (Bot). You then use the BotTemplate file,
+  along with the GenAiPlanner file that references the BotTemplate, to package the template in a managed package that
+  you can share between orgs or on AppExchange.
+
+  Use 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 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.
+
+  The new BotTemplate file is generated in the "botTemplates" directory in your local package directory, and has the
+  name <Agent_API_name>\_v<Version>\_Template.botTemplate-meta.xml, such as
+  force-app/main/default/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full
+  pathname of the generated files when it completes.
 
 EXAMPLES
-  Generate an agent template from a Bot metadata file in your project:
+  Generate an agent template from a Bot metadata file in your DX project that corresponds to the My_Awesome_Agent
+  agent; use version 1 of the agent.
 
     $ sf agent generate template --agent-file \
       force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
 ```
 
-_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/generate/template.ts)_
+_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/generate/template.ts)_
 
 ## `sf agent generate test-spec`
 
@@ -299,7 +316,7 @@ EXAMPLES
   $ sf agent generate test-spec
 ```
 
-_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/generate/test-spec.ts)_
+_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/generate/test-spec.ts)_
 
 ## `sf agent preview`
 
@@ -334,7 +351,7 @@ FLAG DESCRIPTIONS
     the API name of the agent? (TBD based on agents library)
 ```
 
-_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/preview.ts)_
+_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/preview.ts)_
 
 ## `sf agent test create`
 
@@ -370,7 +387,7 @@ EXAMPLES
   $ sf agent test create
 ```
 
-_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/test/create.ts)_
+_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/test/create.ts)_
 
 ## `sf agent test list`
 
@@ -399,7 +416,7 @@ EXAMPLES
   $ sf agent test list
 ```
 
-_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/test/list.ts)_
+_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/test/list.ts)_
 
 ## `sf agent test results`
 
@@ -455,7 +472,7 @@ FLAG DESCRIPTIONS
     test results aren't written.
 ```
 
-_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/test/results.ts)_
+_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/test/results.ts)_
 
 ## `sf agent test resume`
 
@@ -518,7 +535,7 @@ FLAG DESCRIPTIONS
     test results aren't written.
 ```
 
-_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/test/resume.ts)_
+_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/test/resume.ts)_
 
 ## `sf agent test run`
 
@@ -581,6 +598,6 @@ FLAG DESCRIPTIONS
     test results aren't written.
 ```
 
-_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.0/src/commands/agent/test/run.ts)_
+_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.18.1/src/commands/agent/test/run.ts)_
 
 <!-- commandsstop -->

package/messages/agent.generate.template.md

@@ -1,21 +1,25 @@
 # summary
 
-Generate an agent template for packaging.
+Generate an agent template from an existing agent in your DX project so you can then package the template in a managed package.
 
 # description
 
-Generate agent template metadata to for packaging your agent.
+At a high-level, agents are defined by the Bot, BotVersion, and GenAiPlanner metadata types. The GenAiPlanner 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 file for a specific agent (Bot). You then use the BotTemplate file, along with the GenAiPlanner file that references the BotTemplate, to package the template in a managed package that you can share between orgs or on AppExchange.
+
+Use 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 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.
+
+The new BotTemplate file is generated in the "botTemplates" directory in your local package directory, and has the name <Agent_API_name>\_v<Version>\_Template.botTemplate-meta.xml, such as force-app/main/default/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.
 
 # examples
 
-- Generate an agent template from a Bot metadata file in your project:
+- Generate an agent template from a Bot metadata file in your DX project that corresponds to the My_Awesome_Agent agent; use version 1 of the agent.
 
   <%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
 
 # flags.agent-version.summary
 
-Version of the Agent (botVersion).
+Version of the agent (BotVersion).
 
 # flags.agent-file.summary
 
-The path to an Agent (Bot) file.
+Path to an agent (Bot) metadata file.

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@salesforce/plugin-agent",
-  "version": "1.18.0",
+  "version": "1.18.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@salesforce/plugin-agent",
-      "version": "1.18.0",
+      "version": "1.18.1",
       "license": "BSD-3-Clause",
       "dependencies": {
         "@inquirer/core": "^10.1.6",

package/oclif.manifest.json

@@ -367,9 +367,9 @@
     "agent:generate:template": {
       "aliases": [],
       "args": {},
-      "description": "Generate agent template metadata to for packaging your agent.",
+      "description": "At a high-level, agents are defined by the Bot, BotVersion, and GenAiPlanner metadata types. The GenAiPlanner 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 file for a specific agent (Bot). You then use the BotTemplate file, along with the GenAiPlanner 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 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 file is generated in the \"botTemplates\" directory in your local package directory, and has the name <Agent_API_name>\\_v<Version>\\_Template.botTemplate-meta.xml, such as force-app/main/default/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.",
       "examples": [
-        "Generate an agent template from a Bot metadata file in your project:\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1"
+        "Generate an agent template from a Bot metadata file in your DX project that corresponds to the My_Awesome_Agent agent; use version 1 of the agent.\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1"
       ],
       "flags": {
         "json": {
@@ -407,7 +407,7 @@
         "agent-version": {
           "name": "agent-version",
           "required": true,
-          "summary": "Version of the Agent (botVersion).",
+          "summary": "Version of the agent (BotVersion).",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -416,7 +416,7 @@
           "char": "f",
           "name": "agent-file",
           "required": true,
-          "summary": "The path to an Agent (Bot) file.",
+          "summary": "Path to an agent (Bot) metadata file.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -430,7 +430,7 @@
       "pluginType": "core",
       "state": "beta",
       "strict": true,
-      "summary": "Generate an agent template for packaging.",
+      "summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a managed package.",
       "enableJsonFlag": true,
       "requiresProject": true,
       "isESM": true,
@@ -1100,5 +1100,5 @@
       ]
     }
   },
-  "version": "1.18.0"
+  "version": "1.18.1"
 }

package/package.json

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