Skip to content

W-21785024: edit help #385

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

Merged
WillieRuemmele merged 5 commits into from
Mar 30, 2026
Merged

W-21785024: edit help #385

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ca5364b
fix: edit help
jshackell-sfdc Mar 30, 2026
d7061b9
Fix formatting in agent.preview.start.md
jshackell-sfdc Mar 30, 2026
378fd56
chore: flag exclusivity at work
WillieRuemmele Mar 30, 2026
20b405c
chore: use oclif flag defs
WillieRuemmele Mar 30, 2026
c941d5e
fix: tweak help after Willie changed functionality a bit
jshackell-sfdc Mar 30, 2026
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
15 changes: 9 additions & 6 deletions messages/agent.preview.start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ This command outputs a session ID that you then use with the "agent preview send

Identify 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.

You must explicitly specify the preview execution mode using one of these flags: --use-live-actions: Executes real Apex classes, flows, and other actions in the org. --simulate-actions: Uses AI to simulate action execution without calling real implementations.
You must explicitly specify the preview execution mode using one of these flags:

Published agents always use live actions regardless of which flag is specified.
--use-live-actions: Executes real Apex classes, flows, and other actions in the org.
--simulate-actions: Uses AI to simulate action execution without calling real implementations.

Published agents always use live actions regardless of which flag you specify.

# flags.api-name.summary

Expand All @@ -22,19 +25,19 @@ API name of the authoring bundle metadata component that contains the agent's Ag

# flags.use-live-actions.summary

Execute real actions in the org (Apex classes, flows, etc.).
Execute real actions in the org, such as Apex classes and flows. You must specify either this flag or --simulate-actions.

# flags.simulate-actions.summary

Use AI to simulate action execution instead of calling real actions.
Use AI to simulate action execution instead of calling real actions. You must specify either this flag or --use-live-actions.

# output.sessionId

Session ID: %s

# examples

- Start a programmatic agent preview session by specifying an authoring bundle. Use the org with alias "my-dev-org":
- Start a programmatic agent preview session by specifying an authoring bundle; use simulated actions. Use the org with alias "my-dev-org":

<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org --simulate-actions

Expand All @@ -44,4 +47,4 @@ Session ID: %s

- Start a preview session with an activated published agent:

<%= config.bin %> <%= command.id %> --api-name My_Published_Agent
<%= config.bin %> <%= command.id %> --api-name My_Published_Agent --use-live-actions
Loading