Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 12 additions & 24 deletions messages/open.agent.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# summary

Open an agent in your org's Agent Builder UI in a browser.
Open an agent in your org's Agentforce Builder UI in a browser.

# description

Use the --api-name flag to open an agent using its API name in the Agent Builder UI of your org. To find the agent's API name, go to Setup in your org and navigate to the agent's details page.

Alternatively, use the --authoring-bundle flag to open an agent in Agentforce Builder. Optionally include --version to open a specific version of the agent. You'll specify the api name of the authoring bundle.
Use the --api-name flag to open an agent using its API name in the Agentforce Builder UI of your org. Alternatively, use the --authoring-bundle flag to open an agent using the API name of its authoring bundle. The two API names are typically the same for the same agent. Optionally specify the --version flag to open a specific version of the agent.

To generate the URL but not launch it in your browser, specify --url-only.

To open Agent Builder in a specific browser, use the --browser flag. Supported browsers are "chrome", "edge", and "firefox". If you don't specify --browser, the org opens in your default browser.
To open Agentforce Builder in a specific browser, use the --browser flag. Supported browsers are "chrome", "edge", and "firefox". If you don't specify --browser, the org opens in your default browser.

# examples

- Open the agent with API name Coral_Cloud_Agent in your default org using your default browser:
- Open the agent with API name Coral_Cloud_Agent in your default org using your default browser; opens the highest version:

$ <%= config.bin %> <%= command.id %> --api-name Coral_Cloud_Agent

Expand All @@ -26,21 +24,21 @@ To open Agent Builder in a specific browser, use the --browser flag. Supported b

$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent

- Open an agent in Agentforce Builder using its authoring bundle name:
- Open an agent in Agentforce Builder using its authoring bundle API name:

$ <%= config.bin %> <%= command.id %> --authoring-bundle MyAgent
$ <%= config.bin %> <%= command.id %> --authoring-bundle Coral_Cloud_Agent

- Open a specific version of an agent in Agentforce Builder:
- Open a version 1 of an agent in Agentforce Builder:

$ <%= config.bin %> <%= command.id %> --authoring-bundle MyAgent --version 1
$ <%= config.bin %> <%= command.id %> --authoring-bundle Coral_Cloud_Agent --version 1

# flags.api-name.summary

API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.
API name, also known as developer name, of the agent you want to open in the org's Agentforce Builder UI.

# flags.private.summary

Open the org in the default browser using private (incognito) mode.
Open the agent in the default browser using private (incognito) mode.

# flags.browser.summary

Expand All @@ -52,18 +50,8 @@ Display navigation URL, but don’t launch browser.

# flags.authoring-bundle.summary

API name of the agent to open in Agentforce Builder.

# flags.authoring-bundle.description

The API name of the agent to open directly in Agentforce Builder. Optionally specify --version to open a specific
version.
API name of the agent's authoring bundle to open in Agentforce Builder.

# flags.version.summary

Version number of the agent to open in Agentforce Builder.

# flags.version.description

The version number of the agent to open directly in Agentforce Builder. Can only be used with the --authoring-bundle
flag.
Version number of the agent to open in Agentforce Builder. If not specified, the highest version is opened by default.
2 changes: 0 additions & 2 deletions src/commands/org/open/agent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,10 @@ export class OrgOpenAgent extends OrgOpenCommandBase<OrgOpenOutput> {
}),
'authoring-bundle': Flags.string({
summary: messages.getMessage('flags.authoring-bundle.summary'),
description: messages.getMessage('flags.authoring-bundle.description'),
exactlyOne: ['api-name', 'authoring-bundle'],
}),
version: Flags.string({
summary: messages.getMessage('flags.version.summary'),
description: messages.getMessage('flags.version.description'),
}),
};

Expand Down
Loading