@salesforce/plugin-agent 1.11.0 → 1.12.0

package/README.md

@@ -62,9 +62,7 @@ sf plugins
 <!-- commands -->
 
 - [`sf agent create`](#sf-agent-create)
-- [`sf agent create-v2`](#sf-agent-create-v2)
 - [`sf agent generate spec`](#sf-agent-generate-spec)
-- [`sf agent generate spec-v2`](#sf-agent-generate-spec-v2)
 - [`sf agent generate test-spec`](#sf-agent-generate-test-spec)
 - [`sf agent preview`](#sf-agent-preview)
 - [`sf agent test cancel`](#sf-agent-test-cancel)
@@ -76,72 +74,22 @@ sf plugins
 
 ## `sf agent create`
 
-Create an agent in your org from a local agent spec file.
-
-```
-USAGE
-  $ sf agent create -o <value> -f <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>]
-
-FLAGS
-  -f, --spec=<value>         (required) Path to an agent spec file.
-  -n, --name=<value>         (required) API name of the new agent.
-  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
-                             configuration variable is already set.
-      --api-version=<value>  Override the api version used for api requests made by this command
-
-GLOBAL FLAGS
-  --flags-dir=<value>  Import flag values from a directory.
-  --json               Format output as json.
-
-DESCRIPTION
-  Create an agent in your org from a local agent spec file.
-
-  To generate an agent spec file, run the "agent generate spec" CLI command, which outputs a JSON file with the list of
-  jobs and descriptions that the new agent can perform. Then specify this generated spec file to the --spec flag of this
-  command, along with the name of the new agent.
-
-  When this command finishes, your org contains the new agent, which you can then edit in the Agent Builder UI. The new
-  agent already has a list of topics and actions that were automatically created from the list of jobs in the provided
-  agent spec file. This command also retrieves all the metadata files associated with the new agent to your local DX
-  project.
-
-  To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --name
-  <api-name-of-your-agent>".
-
-EXAMPLES
-  Create an agent called "CustomerSupportAgent" in an org with alias "my-org" using the specified agent spec file:
-
-    $ sf agent create --name CustomerSupportAgent --spec ./config/agentSpec.json --target-org my-org
-```
-
-_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/create.ts)_
-
-## `sf agent create-v2`
-
 Create an agent in your org using a local agent spec file.
 
 ```
 USAGE
-  $ sf agent create-v2 -o <value> --spec <value> [--json] [--flags-dir <value>] [--api-version <value>] [--agent-name
-    <value>] [--user-id <value>] [--enrich-logs true|false] [--tone formal|casual|neutral] [--preview] [--planner-id
-    <value>]
+  $ sf agent create -o <value> --spec <value> [--json] [--flags-dir <value>] [--api-version <value>] [--agent-name
+    <value>] [--preview] [--agent-api-name <value>]
 
 FLAGS
-  -o, --target-org=<value>    (required) Username or alias of the target org. Not required if the `target-org`
-                              configuration variable is already set.
-      --agent-name=<value>    Name (label) of the new agent.
-      --api-version=<value>   Override the api version used for api requests made by this command
-      --enrich-logs=<option>  Adds agent conversation data to event logs so you can view all agent session activity in
-                              one place.
-                              <options: true|false>
-      --planner-id=<value>    The GenAiPlanner ID to associate with the agent.
-      --preview               Preview the agent without saving it in your org.
-      --spec=<value>          (required) Path to an agent spec file.
-      --tone=<option>         Conversational style of the agent, such as how it expresses your brand personality in its
-                              messages through word choice, punctuation, and sentence structure.
-                              <options: formal|casual|neutral>
-      --user-id=<value>       ID of a user in your org that is assigned to your agent; determines what your agent can
-                              access and do.
+  -o, --target-org=<value>      (required) Username or alias of the target org. Not required if the `target-org`
+                                configuration variable is already set.
+      --agent-api-name=<value>  API name of the new agent; if not specified, the API name is derived from the agent name
+                                (label); the API name must not exist in the org.
+      --agent-name=<value>      Name (label) of the new agent.
+      --api-version=<value>     Override the api version used for api requests made by this command
+      --preview                 Preview the agent without saving it in your org.
+      --spec=<value>            (required) Path to an agent spec file.
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -169,104 +117,54 @@ DESCRIPTION
 EXAMPLES
   Create an agent called "ResortManager" in an org with alias "my-org" using the specified agent spec file:
 
-    $ sf agent create-v2 --agent-name ResortManager --spec specs/resortManagerAgent.yaml --target-org my-org
+    $ sf agent create --agent-name ResortManager --spec specs/resortManagerAgent.yaml --target-org my-org
 
   Preview the creation of an agent called "ResortManager" and use your default org:
 
-    $ sf agent create-v2 --agent-name ResortManager --spec specs/resortManagerAgent.yaml --preview
+    $ sf agent create --agent-name ResortManager --spec specs/resortManagerAgent.yaml --preview
 ```
 
-_See code: [src/commands/agent/create-v2.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/create-v2.ts)_
+_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.12.0/src/commands/agent/create.ts)_
 
 ## `sf agent generate spec`
 
-Generate an agent spec, which is the list of jobs that the agent performs.
-
-```
-USAGE
-  $ sf agent generate spec -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t customer|internal]
-    [--role <value>] [--company-name <value>] [--company-description <value>] [--company-website <value>] [-d <value>]
-    [-f <value>]
-
-FLAGS
-  -d, --output-dir=<value>           [default: config] Directory where the agent spec file is written; can be an
-                                     absolute or relative path.
-  -f, --file-name=<value>            [default: agentSpec.json] Name of the generated agent spec file.
-  -o, --target-org=<value>           (required) Username or alias of the target org. Not required if the `target-org`
-                                     configuration variable is already set.
-  -t, --type=<option>                Type of agent to create.
-                                     <options: customer|internal>
-      --api-version=<value>          Override the api version used for api requests made by this command
-      --company-description=<value>  Description of your company.
-      --company-name=<value>         Name of your company.
-      --company-website=<value>      Website URL of your company.
-      --role=<value>                 Role of the agent.
-
-GLOBAL FLAGS
-  --flags-dir=<value>  Import flag values from a directory.
-  --json               Format output as json.
-
-DESCRIPTION
-  Generate an agent spec, which is the list of jobs that the agent performs.
-
-  When using Salesforce CLI to create an agent in your org, the first step is to generate the local JSON-formatted agent
-  spec file with this command.
-
-  An agent spec is a list of jobs and descriptions that capture what the agent can do. Use flags such as --role and
-  --company-description to provide details about your company and the role that the agent plays in your company; you can
-  also enter the information interactively if you prefer. When you then execute this command, the large language model
-  (LLM) associated with your org uses the information to generate the list of jobs that the agent most likely performs.
-  We recommend that you provide good details for --role, --company-description, etc, so that the LLM can generate the
-  best and most relevant list of jobs and descriptions. Once generated, you can edit the spec file; for example, you can
-  remove jobs that don't apply to your agent.
-
-  When your agent spec is ready, you then create the agent in your org by specifying the agent spec file to the
-  --job-spec flag of the "agent create" CLI command.
-
-EXAMPLES
-  Create an agent spec for your default org in the default location and use flags to specify the agent's role and your
-  company details:
-
-    $ sf agent generate spec --type customer --role "Assist users in navigating and managing bookings" \
-      --company-name "Coral Cloud" --company-description "Resort that manages guests and their reservations and \
-      experiences"
-
-  Create an agent spec by being prompted for role and company details interactively; write the generated file to the
-  "specs" directory and use the org with alias "my-org":
-
-    $ sf agent generate spec --output-dir specs --target-org my-org
-```
-
-_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/generate/spec.ts)_
-
-## `sf agent generate spec-v2`
-
 Generate an agent spec, which is a YAML file that captures what an agent can do.
 
 ```
 USAGE
-  $ sf agent generate spec-v2 -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t customer|internal]
-    [--role <value>] [--company-name <value>] [--company-description <value>] [--company-website <value>] [--spec
-    <value>] [--output-file <value>] [--max-topics <value>] [--grounding-context <value> --prompt-template <value>]
+  $ sf agent generate spec -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t customer|internal]
+    [--role <value>] [--company-name <value>] [--company-description <value>] [--company-website <value>] [--max-topics
+    <value>] [--agent-user <value>] [--enrich-logs true|false] [--tone formal|casual|neutral] [--spec <value>]
+    [--output-file <value>] [--full-interview] [--grounding-context <value> --prompt-template <value>] [--no-prompt]
 
 FLAGS
   -o, --target-org=<value>           (required) Username or alias of the target org. Not required if the `target-org`
                                      configuration variable is already set.
   -t, --type=<option>                Type of agent to create.
                                      <options: customer|internal>
+      --agent-user=<value>           Username of a user in your org to assign to your agent; determines what your agent
+                                     can access and do.
       --api-version=<value>          Override the api version used for api requests made by this command
       --company-description=<value>  Description of your company.
       --company-name=<value>         Name of your company.
       --company-website=<value>      Website URL of your company.
+      --enrich-logs=<option>         Adds agent conversation data to event logs so you can view all agent session
+                                     activity in one place.
+                                     <options: true|false>
+      --full-interview               Prompt for both required and optional flags.
       --grounding-context=<value>    Context information and personalization that's added to your prompts when using a
                                      custom prompt template.
       --max-topics=<value>           Maximum number of topics to generate in the agent spec; default is 10.
+      --no-prompt                    Don't prompt the user to confirm spec file overwrite.
       --output-file=<value>          [default: config/agentSpec.yaml] Path for the generated YAML agent spec file; can
                                      be an absolute or relative path.
       --prompt-template=<value>      API name of a customized prompt template to use instead of the default prompt
                                      template.
       --role=<value>                 Role of the agent.
       --spec=<value>                 Agent spec file, in YAML format, to use as input to the command.
+      --tone=<option>                Conversational style of the agent, such as how it expresses your brand personality
+                                     in its messages through word choice, punctuation, and sentence structure.
+                                     <options: formal|casual|neutral>
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -302,24 +200,24 @@ EXAMPLES
   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:
 
-    $ sf agent generate spec-v2 --type customer --role "Field customer complaints and manage employee schedules." \
+    $ sf agent generate spec --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."
 
   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":
 
-    $ sf agent generate spec-v2 --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org
+    $ sf agent generate spec --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org
 
   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:
 
-    $ sf agent generate spec-v2 --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml \
-      --role "Field customer complaints, manage employee schedules, and ensure all resort operations are running \
-      smoothly" --target-org my-org
+    $ sf agent generate spec --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \
+      "Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly" \
+      --target-org my-org
 ```
 
-_See code: [src/commands/agent/generate/spec-v2.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/generate/spec-v2.ts)_
+_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.12.0/src/commands/agent/generate/spec.ts)_
 
 ## `sf agent generate test-spec`
 
@@ -342,7 +240,7 @@ EXAMPLES
   $ sf agent generate test-spec
 ```
 
-_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.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.12.0/src/commands/agent/generate/test-spec.ts)_
 
 ## `sf agent preview`
 
@@ -377,7 +275,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.11.0/src/commands/agent/preview.ts)_
+_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.12.0/src/commands/agent/preview.ts)_
 
 ## `sf agent test cancel`
 
@@ -414,7 +312,7 @@ EXAMPLES
     $ sf agent test cancel --job-id 4KBfake0000003F4AQ --target-org my-org
 ```
 
-_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/test/cancel.ts)_
+_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.12.0/src/commands/agent/test/cancel.ts)_
 
 ## `sf agent test create`
 
@@ -450,7 +348,7 @@ FLAG DESCRIPTIONS
     More information about a flag. Don't repeat the summary.
 ```
 
-_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/test/create.ts)_
+_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.12.0/src/commands/agent/test/create.ts)_
 
 ## `sf agent test list`
 
@@ -479,7 +377,7 @@ EXAMPLES
   $ sf agent test list
 ```
 
-_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/test/list.ts)_
+_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.12.0/src/commands/agent/test/list.ts)_
 
 ## `sf agent test results`
 
@@ -535,7 +433,7 @@ FLAG DESCRIPTIONS
     test results aren't written.
 ```
 
-_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/test/results.ts)_
+_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.12.0/src/commands/agent/test/results.ts)_
 
 ## `sf agent test resume`
 
@@ -598,7 +496,7 @@ FLAG DESCRIPTIONS
     test results aren't written.
 ```
 
-_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/test/resume.ts)_
+_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.12.0/src/commands/agent/test/resume.ts)_
 
 ## `sf agent test run`
 
@@ -661,6 +559,6 @@ FLAG DESCRIPTIONS
     test results aren't written.
 ```
 
-_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.11.0/src/commands/agent/test/run.ts)_
+_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.12.0/src/commands/agent/test/run.ts)_
 
 <!-- commandsstop -->

package/lib/commands/agent/create.d.ts

@@ -1,7 +1,7 @@
 import { SfCommand } from '@salesforce/sf-plugins-core';
-export type AgentCreateResult = {
-    isSuccess: boolean;
-    errorMessage?: string;
+import { AgentCreateResponseV2 } from '@salesforce/agents';
+export type AgentCreateResult = AgentCreateResponseV2 & {
+    previewFilePath?: string;
 };
 export default class AgentCreate extends SfCommand<AgentCreateResult> {
     static readonly summary: string;
@@ -10,10 +10,13 @@ export default class AgentCreate extends SfCommand<AgentCreateResult> {
     static readonly requiresProject = true;
     static state: string;
     static readonly flags: {
+        spec: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        preview: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'agent-api-name': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'planner-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "agent-name": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
         'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        spec: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<AgentCreateResult>;
 }

package/lib/commands/agent/create.js

@@ -4,14 +4,30 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import * as fs from 'node:fs';
+import { resolve } from 'node:path';
+import { readFileSync, writeFileSync } from 'node:fs';
+import YAML from 'yaml';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Lifecycle, Messages } from '@salesforce/core';
 import { MultiStageOutput } from '@oclif/multi-stage-output';
 import { colorize } from '@oclif/core/ux';
-import { Agent, AgentCreateLifecycleStages } from '@salesforce/agents';
+import { Agent, AgentCreateLifecycleStagesV2, generateAgentApiName, } from '@salesforce/agents';
+import { makeFlags, promptForFlag, validateAgentType } from '../../flags.js';
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.create');
+const MSO_STAGES = {
+    parse: 'Parsing Agent spec',
+    preview: 'Creating Agent for preview',
+    create: 'Creating Agent in org',
+    retrieve: 'Retrieving Agent metadata',
+};
+const FLAGGABLE_PROMPTS = {
+    'agent-name': {
+        message: messages.getMessage('flags.agent-name.summary'),
+        validate: (d) => d.length > 0 || 'Agent Name cannot be empty',
+        required: true,
+    },
+};
 export default class AgentCreate extends SfCommand {
     static summary = messages.getMessage('summary');
     static description = messages.getMessage('description');
@@ -21,54 +37,128 @@ export default class AgentCreate extends SfCommand {
     static flags = {
         'target-org': Flags.requiredOrg(),
         'api-version': Flags.orgApiVersion(),
+        ...makeFlags(FLAGGABLE_PROMPTS),
         spec: Flags.file({
-            char: 'f',
-            required: true,
+            // char: 'f',
             summary: messages.getMessage('flags.spec.summary'),
-        }),
-        name: Flags.string({
-            char: 'n',
+            exists: true,
             required: true,
-            summary: messages.getMessage('flags.name.summary'),
+        }),
+        preview: Flags.boolean({
+            summary: messages.getMessage('flags.preview.summary'),
+        }),
+        'agent-api-name': Flags.string({
+            summary: messages.getMessage('flags.agent-api-name.summary'),
+        }),
+        // This would be used as more of an agent update than create.
+        // Could possibly move to an `agent update` command.
+        'planner-id': Flags.string({
+            summary: messages.getMessage('flags.planner-id.summary'),
+            hidden: true,
         }),
     };
+    // eslint-disable-next-line complexity
     async run() {
         const { flags } = await this.parse(AgentCreate);
-        const jsonParsingStage = `Parsing ${flags.spec}`;
-        const mso = new MultiStageOutput({
-            jsonEnabled: this.jsonEnabled(),
-            title: `Creating ${flags.name} Agent`,
-            stages: [
-                jsonParsingStage,
-                'Generating local metadata',
-                'Deploying metadata to org',
-                'Creating Agent in org',
-                'Retrieving Agent metadata',
-            ],
-        });
-        mso.goto(jsonParsingStage);
-        const agentConfig = {
-            ...JSON.parse(fs.readFileSync(flags.spec, 'utf8')),
-            name: flags.name,
-        };
-        // @ts-expect-error not using async method in callback
-        Lifecycle.getInstance().on(AgentCreateLifecycleStages.CreatingLocally, () => mso.goto('Generating local metadata'));
-        Lifecycle.getInstance().on(AgentCreateLifecycleStages.DeployingMetadata, () => 
+        // throw error if --json is used and not all required flags are provided
+        if (this.jsonEnabled() && !flags['agent-name']) {
+            throw messages.createError('error.missingRequiredFlags', ['agent-name']);
+        }
+        // Read the agent spec and validate
+        const inputSpec = YAML.parse(readFileSync(resolve(flags.spec), 'utf8'));
+        validateSpec(inputSpec);
+        // If we don't have an agent name yet, prompt.
+        const agentName = flags['agent-name'] ?? (await promptForFlag(FLAGGABLE_PROMPTS['agent-name']));
+        const agentApiName = flags['agent-api-name'] ?? generateAgentApiName(agentName);
+        let title;
+        const stages = [MSO_STAGES.parse];
+        if (flags.preview) {
+            title = `Previewing ${agentName} Creation`;
+            stages.push(MSO_STAGES.preview);
+        }
+        else {
+            title = `Creating ${agentName} Agent`;
+            stages.push(MSO_STAGES.create);
+            stages.push(MSO_STAGES.retrieve);
+        }
+        const mso = new MultiStageOutput({ jsonEnabled: this.jsonEnabled(), title, stages });
+        mso.goto(MSO_STAGES.parse);
         // @ts-expect-error not using async method in callback
-        mso.goto('Deploying metadata to org'));
+        Lifecycle.getInstance().on(AgentCreateLifecycleStagesV2.Previewing, () => mso.goto(MSO_STAGES.preview));
         // @ts-expect-error not using async method in callback
-        Lifecycle.getInstance().on(AgentCreateLifecycleStages.CreatingRemotely, () => mso.goto('Creating Agent in org'));
-        Lifecycle.getInstance().on(AgentCreateLifecycleStages.RetrievingMetadata, () => 
+        Lifecycle.getInstance().on(AgentCreateLifecycleStagesV2.Creating, () => mso.goto(MSO_STAGES.create));
         // @ts-expect-error not using async method in callback
-        mso.goto('Retrieving Agent metadata'));
-        const agent = new Agent(flags['target-org'].getConnection(flags['api-version']), this.project);
-        const created = await agent.create(agentConfig);
+        Lifecycle.getInstance().on(AgentCreateLifecycleStagesV2.Retrieving, () => mso.goto(MSO_STAGES.retrieve));
+        const connection = flags['target-org'].getConnection(flags['api-version']);
+        const agent = new Agent(connection, this.project);
+        const agentConfig = {
+            agentType: inputSpec.agentType,
+            generationInfo: {
+                defaultInfo: {
+                    role: inputSpec.role,
+                    companyName: inputSpec.companyName,
+                    companyDescription: inputSpec.companyDescription,
+                    preDefinedTopics: inputSpec.topics,
+                },
+            },
+            generationSettings: {},
+        };
+        if (inputSpec?.companyWebsite) {
+            agentConfig.generationInfo.defaultInfo.companyWebsite = inputSpec?.companyWebsite;
+        }
+        if (!flags.preview) {
+            agentConfig.saveAgent = true;
+            agentConfig.agentSettings = { agentName, agentApiName };
+            if (flags['planner-id']) {
+                agentConfig.agentSettings.plannerId = flags['planner-id'];
+            }
+            if (inputSpec?.agentUser) {
+                // TODO: query for the user ID from the username
+                agentConfig.agentSettings.userId = inputSpec.agentUser;
+            }
+            if (inputSpec?.enrichLogs) {
+                agentConfig.agentSettings.enrichLogs = inputSpec.enrichLogs;
+            }
+            if (inputSpec?.tone) {
+                agentConfig.agentSettings.tone = inputSpec.tone;
+            }
+        }
+        const response = await agent.createV2(agentConfig);
+        const result = response;
         mso.stop();
-        this.log(created.isSuccess
-            ? colorize('green', `Successfully created ${flags.name} in ${flags['target-org'].getUsername() ?? 'the target org'}.`)
-            : colorize('red', `failed to create agent ${flags.name}: ${created.errorMessage ?? ''}`));
-        this.log(`Use ${colorize('dim', `sf org open agent --name ${flags.name}`)} to view the agent in the browser.`);
-        return { isSuccess: created.isSuccess };
+        if (response.isSuccess) {
+            if (!flags.preview) {
+                const orgUsername = flags['target-org'].getUsername();
+                this.log(`Successfully created ${agentName} in ${orgUsername}.\n`);
+                this.log(`Use ${colorize('dim', `sf org open agent --name ${agentApiName} -o ${orgUsername}`)} to view the agent in the browser.`);
+            }
+            else {
+                const previewFileName = `${agentApiName}_Preview_${new Date().toISOString()}.json`;
+                writeFileSync(previewFileName, JSON.stringify(response, null, 2));
+                result.previewFilePath = resolve(previewFileName);
+                this.log(`Successfully created agent for preview. See ${previewFileName}\n`);
+            }
+        }
+        else {
+            this.log(colorize('red', `Failed to create agent: ${response.errorMessage ?? ''}`));
+        }
+        return result;
     }
 }
+// The spec must define: agentType, role, companyName, companyDescription, and topics.
+// Agent type must be 'customer' or 'internal'.
+const validateSpec = (spec) => {
+    const requiredSpecValues = [
+        'agentType',
+        'role',
+        'companyName',
+        'companyDescription',
+        'topics',
+    ];
+    const missingFlags = requiredSpecValues.filter((f) => !spec[f]);
+    if (missingFlags.length) {
+        throw messages.createError('error.missingRequiredSpecProperties', [missingFlags.join(', ')]);
+    }
+    validateAgentType(spec.agentType, true);
+};
 //# sourceMappingURL=create.js.map

package/lib/commands/agent/create.js.map

@@ -1 +1 @@
-{"version":3,"file":"create.js","sourceRoot":"","sources":["../../../src/commands/agent/create.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAqB,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAE1F,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,cAAc,CAAC,CAAC;AAOnF,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,SAA4B;IAC5D,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,eAAe,GAAG,IAAI,CAAC;IACvC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;IAEtB,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;SACnD,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;SACnD,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,gBAAgB,GAAG,WAAW,KAAK,CAAC,IAAI,EAAE,CAAC;QACjD,MAAM,GAAG,GAAG,IAAI,gBAAgB,CAAC;YAC/B,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;YAC/B,KAAK,EAAE,YAAY,KAAK,CAAC,IAAI,QAAQ;YACrC,MAAM,EAAE;gBACN,gBAAgB;gBAChB,2BAA2B;gBAC3B,2BAA2B;gBAC3B,uBAAuB;gBACvB,2BAA2B;aAC5B;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3B,MAAM,WAAW,GAAG;YAClB,GAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAuB;YACzE,IAAI,EAAE,KAAK,CAAC,IAAI;SACjB,CAAC;QAEF,sDAAsD;QACtD,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,eAAe,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACpH,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC5E,sDAAsD;QACtD,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CACtC,CAAC;QACF,sDAAsD;QACtD,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,gBAAgB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACjH,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC7E,sDAAsD;QACtD,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CACtC,CAAC;QAEF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,OAAQ,CAAC,CAAC;QAChG,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEhD,GAAG,CAAC,IAAI,EAAE,CAAC;QAEX,IAAI,CAAC,GAAG,CACN,OAAO,CAAC,SAAS;YACf,CAAC,CAAC,QAAQ,CACN,OAAO,EACP,wBAAwB,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,IAAI,gBAAgB,GAAG,CAClG;YACH,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC,CAC3F,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,OAAO,QAAQ,CAAC,KAAK,EAAE,4BAA4B,KAAK,CAAC,IAAI,EAAE,CAAC,oCAAoC,CAAC,CAAC;QAE/G,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;IAC1C,CAAC"}
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../../src/commands/agent/create.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EACL,KAAK,EAGL,4BAA4B,EAE5B,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAmB,SAAS,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAG9F,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,cAAc,CAAC,CAAC;AAOnF,MAAM,UAAU,GAAG;IACjB,KAAK,EAAE,oBAAoB;IAC3B,OAAO,EAAE,4BAA4B;IACrC,MAAM,EAAE,uBAAuB;IAC/B,QAAQ,EAAE,2BAA2B;CACtC,CAAC;AAEF,MAAM,iBAAiB,GAAG;IACxB,YAAY,EAAE;QACZ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;QACxD,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,4BAA4B;QACvF,QAAQ,EAAE,IAAI;KACf;CACwC,CAAC;AAE5C,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,SAA4B;IAC5D,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,eAAe,GAAG,IAAI,CAAC;IACvC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;IAEtB,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,GAAG,SAAS,CAAC,iBAAiB,CAAC;QAC/B,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;YACf,aAAa;YACb,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,MAAM,EAAE,IAAI;YACZ,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;YACrB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;SACtD,CAAC;QACF,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC;YAC7B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,8BAA8B,CAAC;SAC7D,CAAC;QACF,6DAA6D;QAC7D,oDAAoD;QACpD,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;YACxD,MAAM,EAAE,IAAI;SACb,CAAC;KACH,CAAC;IAEF,sCAAsC;IAC/B,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAEhD,wEAAwE;QACxE,IAAI,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/C,MAAM,QAAQ,CAAC,WAAW,CAAC,4BAA4B,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;QAC3E,CAAC;QAED,mCAAmC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAA0B,CAAC;QACjG,YAAY,CAAC,SAAS,CAAC,CAAC;QAExB,8CAA8C;QAC9C,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAChG,MAAM,YAAY,GAAG,KAAK,CAAC,gBAAgB,CAAC,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAEhF,IAAI,KAAa,CAAC;QAClB,MAAM,MAAM,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,KAAK,GAAG,cAAc,SAAS,WAAW,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,YAAY,SAAS,QAAQ,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,gBAAgB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QACrF,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAE3B,sDAAsD;QACtD,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,4BAA4B,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QACxG,sDAAsD;QACtD,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,4BAA4B,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QACrG,sDAAsD;QACtD,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,4BAA4B,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEzG,MAAM,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAC3E,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,OAAQ,CAAC,CAAC;QAEnD,MAAM,WAAW,GAAwB;YACvC,SAAS,EAAE,SAAS,CAAC,SAAS;YAC9B,cAAc,EAAE;gBACd,WAAW,EAAE;oBACX,IAAI,EAAE,SAAS,CAAC,IAAI;oBACpB,WAAW,EAAE,SAAS,CAAC,WAAW;oBAClC,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;oBAChD,gBAAgB,EAAE,SAAS,CAAC,MAAM;iBACnC;aACF;YACD,kBAAkB,EAAE,EAAE;SACvB,CAAC;QACF,IAAI,SAAS,EAAE,cAAc,EAAE,CAAC;YAC9B,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,cAAc,GAAG,SAAS,EAAE,cAAc,CAAC;QACpF,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACnB,WAAW,CAAC,SAAS,GAAG,IAAI,CAAC;YAC7B,WAAW,CAAC,aAAa,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;YACxD,IAAI,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;gBACxB,WAAW,CAAC,aAAa,CAAC,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,SAAS,EAAE,SAAS,EAAE,CAAC;gBACzB,gDAAgD;gBAChD,WAAW,CAAC,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC;YACzD,CAAC;YACD,IAAI,SAAS,EAAE,UAAU,EAAE,CAAC;gBAC1B,WAAW,CAAC,aAAa,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC;YAC9D,CAAC;YACD,IAAI,SAAS,EAAE,IAAI,EAAE,CAAC;gBACpB,WAAW,CAAC,aAAa,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;YAClD,CAAC;QACH,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACnD,MAAM,MAAM,GAAsB,QAAQ,CAAC;QAE3C,GAAG,CAAC,IAAI,EAAE,CAAC;QAEX,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAY,CAAC;gBAChE,IAAI,CAAC,GAAG,CAAC,wBAAwB,SAAS,OAAO,WAAW,KAAK,CAAC,CAAC;gBACnE,IAAI,CAAC,GAAG,CACN,OAAO,QAAQ,CACb,KAAK,EACL,4BAA4B,YAAY,OAAO,WAAW,EAAE,CAC7D,oCAAoC,CACtC,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,eAAe,GAAG,GAAG,YAAY,YAAY,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC;gBACnF,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBAClE,MAAM,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;gBAClD,IAAI,CAAC,GAAG,CAAC,+CAA+C,eAAe,IAAI,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,2BAA2B,QAAQ,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QACtF,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;;AAGH,sFAAsF;AACtF,+CAA+C;AAC/C,MAAM,YAAY,GAAG,CAAC,IAA6B,EAAQ,EAAE;IAC3D,MAAM,kBAAkB,GAAkF;QACxG,WAAW;QACX,MAAM;QACN,aAAa;QACb,oBAAoB;QACpB,QAAQ;KACT,CAAC;IACF,MAAM,YAAY,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;QACxB,MAAM,QAAQ,CAAC,WAAW,CAAC,qCAAqC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED,iBAAiB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC1C,CAAC,CAAC"}