Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

W-17205614 edit messages #1265

Merged
merged 1 commit into from
Nov 13, 2024
Merged

W-17205614 edit messages #1265

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions messages/open.agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# summary

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

# description

Use the --name flag to open an agent using the developer name (aka API name) in the Agent Builder Org UI.
Use the --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; the API name is shown in the top-right.

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

To open 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 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.

# examples

- Open the agent with developer name "Coral_Cloud_Agent using the default browser:
- Open the agent with API name Coral_Cloud_Agent in your default org using your default browser:

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

- Open the agent in an incognito window of your default browser:

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

- Open the agent in the org with alias MyTestOrg1 using the Firefox browser:
- Open the agent in an org with alias MyTestOrg1 using the Firefox browser:

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

# flags.name.summary

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

# flags.private.summary

Expand Down