Skip to content

Commit 5a819b3

Browse files
fix: change --name to --api-name for org open agent
1 parent 41fbfae commit 5a819b3

3 files changed

Lines changed: 12 additions & 11 deletions

File tree

command-snapshot.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
"command": "org:open:agent",
143143
"flagAliases": ["urlonly"],
144144
"flagChars": ["b", "n", "o", "r"],
145-
"flags": ["api-version", "browser", "flags-dir", "json", "name", "private", "target-org", "url-only"],
145+
"flags": ["api-name", "api-version", "browser", "flags-dir", "json", "private", "target-org", "url-only"],
146146
"plugin": "@salesforce/plugin-org"
147147
},
148148
{

messages/open.agent.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,29 @@ Open an agent in your org's Agent Builder UI in a browser.
44

55
# description
66

7-
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.
7+
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
8+
name, go to Setup in your org and navigate to the agent's details page.
89

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

11-
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.
12+
To open Agent Builder in a specific browser, use the --browser flag. Supported browsers are "chrome", "edge", and "
13+
firefox". If you don't specify --browser, the org opens in your default browser.
1214

1315
# examples
1416

1517
- Open the agent with API name Coral_Cloud_Agent in your default org using your default browser:
1618

17-
$ <%= config.bin %> <%= command.id %> --name Coral_Cloud_Agent
19+
$ <%= config.bin %> <%= command.id %> api-name Coral_Cloud_Agent
1820

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

21-
$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:
23+
$ <%= config.bin %> <%= command.id %> --private api-name Coral_Cloud_Agent:
2224

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

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

27-
# flags.name.summary
29+
# flags.api-name.summary
2830

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

src/commands/org/open/agent.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,14 @@ export class OrgOpenAgent extends OrgOpenCommandBase<OrgOpenOutput> {
1818
public static readonly summary = messages.getMessage('summary');
1919
public static readonly description = messages.getMessage('description');
2020
public static readonly examples = messages.getMessages('examples');
21-
public static readonly state = 'beta';
2221

2322
public static readonly flags = {
2423
...OrgOpenCommandBase.flags,
2524
'target-org': Flags.requiredOrg(),
2625
'api-version': Flags.orgApiVersion(),
27-
name: Flags.string({
26+
'api-name': Flags.string({
2827
char: 'n',
29-
summary: messages.getMessage('flags.name.summary'),
28+
summary: messages.getMessage('flags.api-name.summary'),
3029
required: true,
3130
}),
3231
private: Flags.boolean({
@@ -54,7 +53,7 @@ export class OrgOpenAgent extends OrgOpenCommandBase<OrgOpenOutput> {
5453

5554
const [frontDoorUrl, retUrl] = await Promise.all([
5655
buildFrontdoorUrl(this.org, this.connection, true),
57-
buildRetUrl(this.connection, flags.name),
56+
buildRetUrl(this.connection, flags['api-name']),
5857
]);
5958

6059
return this.openOrgUI(flags, frontDoorUrl, encodeURIComponent(retUrl));

0 commit comments

Comments
 (0)