@salesforce/cli 2.92.5 → 2.92.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +761 -23
- package/npm-shrinkwrap.json +733 -226
- package/oclif.lock +152 -31
- package/oclif.manifest.json +1 -1111
- package/package.json +6 -4
package/README.md
CHANGED
|
@@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli
|
|
|
25
25
|
$ sf COMMAND
|
|
26
26
|
running command...
|
|
27
27
|
$ sf (--version|-v)
|
|
28
|
-
@salesforce/cli/2.92.
|
|
28
|
+
@salesforce/cli/2.92.6 linux-x64 node-v22.16.0
|
|
29
29
|
$ sf --help [COMMAND]
|
|
30
30
|
USAGE
|
|
31
31
|
$ sf COMMAND
|
|
@@ -42,6 +42,16 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
42
42
|
|
|
43
43
|
<!-- commands -->
|
|
44
44
|
|
|
45
|
+
- [`sf agent create`](#sf-agent-create)
|
|
46
|
+
- [`sf agent generate agent-spec`](#sf-agent-generate-agent-spec)
|
|
47
|
+
- [`sf agent generate template`](#sf-agent-generate-template)
|
|
48
|
+
- [`sf agent generate test-spec`](#sf-agent-generate-test-spec)
|
|
49
|
+
- [`sf agent preview`](#sf-agent-preview)
|
|
50
|
+
- [`sf agent test create`](#sf-agent-test-create)
|
|
51
|
+
- [`sf agent test list`](#sf-agent-test-list)
|
|
52
|
+
- [`sf agent test results`](#sf-agent-test-results)
|
|
53
|
+
- [`sf agent test resume`](#sf-agent-test-resume)
|
|
54
|
+
- [`sf agent test run`](#sf-agent-test-run)
|
|
45
55
|
- [`sf alias list`](#sf-alias-list)
|
|
46
56
|
- [`sf alias set`](#sf-alias-set)
|
|
47
57
|
- [`sf alias unset`](#sf-alias-unset)
|
|
@@ -124,6 +134,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
124
134
|
- [`sf org refresh sandbox`](#sf-org-refresh-sandbox)
|
|
125
135
|
- [`sf org resume sandbox`](#sf-org-resume-sandbox)
|
|
126
136
|
- [`sf org resume scratch`](#sf-org-resume-scratch)
|
|
137
|
+
- [`sf package convert`](#sf-package-convert)
|
|
127
138
|
- [`sf package create`](#sf-package-create)
|
|
128
139
|
- [`sf package delete`](#sf-package-delete)
|
|
129
140
|
- [`sf package install`](#sf-package-install)
|
|
@@ -187,6 +198,646 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
187
198
|
- [`sf visualforce generate page`](#sf-visualforce-generate-page)
|
|
188
199
|
- [`sf which`](#sf-which)
|
|
189
200
|
|
|
201
|
+
## `sf agent create`
|
|
202
|
+
|
|
203
|
+
Create an agent in your org using a local agent spec file.
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
USAGE
|
|
207
|
+
$ sf agent create -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--name <value>] [--api-name
|
|
208
|
+
<value>] [--spec <value>] [--preview]
|
|
209
|
+
|
|
210
|
+
FLAGS
|
|
211
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
212
|
+
configuration variable is already set.
|
|
213
|
+
--api-name=<value> API name of the new agent; if not specified, the API name is derived from the agent name
|
|
214
|
+
(label); the API name must not exist in the org.
|
|
215
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
216
|
+
--name=<value> Name (label) of the new agent.
|
|
217
|
+
--preview Preview the agent without saving it in your org.
|
|
218
|
+
--spec=<value> Path to an agent spec file.
|
|
219
|
+
|
|
220
|
+
GLOBAL FLAGS
|
|
221
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
222
|
+
--json Format output as json.
|
|
223
|
+
|
|
224
|
+
DESCRIPTION
|
|
225
|
+
Create an agent in your org using a local agent spec file.
|
|
226
|
+
|
|
227
|
+
To run this command, you must have an agent spec file, which is a YAML file that define the agent properties and
|
|
228
|
+
contains a list of AI-generated topics. Topics define the range of jobs the agent can handle. Use the "agent generate
|
|
229
|
+
agent-spec" CLI command to generate an agent spec file. Then specify the file to this command using the --spec flag,
|
|
230
|
+
along with the name (label) of the new agent with the --name flag. If you don't specify any of the required flags, the
|
|
231
|
+
command prompts you.
|
|
232
|
+
|
|
233
|
+
When this command completes, your org contains the new agent, which you can then edit and customize in the Agent
|
|
234
|
+
Builder UI. The new agent's topics are the same as the ones listed in the agent spec file. The agent might also have
|
|
235
|
+
some AI-generated actions, or you can add them. This command also retrieves all the metadata files associated with the
|
|
236
|
+
new agent to your local Salesforce DX project.
|
|
237
|
+
|
|
238
|
+
Use the --preview flag to review what the agent looks like without actually saving it in your org. When previewing,
|
|
239
|
+
the command creates a JSON file in the current directory with all the agent details. The name of the JSON file is the
|
|
240
|
+
agent's API name and a timestamp.
|
|
241
|
+
|
|
242
|
+
To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --api-name <api-name>".
|
|
243
|
+
|
|
244
|
+
EXAMPLES
|
|
245
|
+
Create an agent by being prompted for the required information, such as the agent spec file and agent name, and then
|
|
246
|
+
create it in your default org:
|
|
247
|
+
|
|
248
|
+
$ sf agent create
|
|
249
|
+
|
|
250
|
+
Create an agent by specifying the agent name, API name, and spec file with flags; use the org with alias "my-org";
|
|
251
|
+
the command fails if the API name is already being used in your org:
|
|
252
|
+
|
|
253
|
+
$ sf agent create --name "Resort Manager" --api-name Resort_Manager --spec specs/resortManagerAgent.yaml \
|
|
254
|
+
--target-org my-org
|
|
255
|
+
|
|
256
|
+
Preview the creation of an agent named "Resort Manager" and use your default org:
|
|
257
|
+
|
|
258
|
+
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/create.ts)_
|
|
262
|
+
|
|
263
|
+
## `sf agent generate agent-spec`
|
|
264
|
+
|
|
265
|
+
Generate an agent spec, which is a YAML file that captures what an agent can do.
|
|
266
|
+
|
|
267
|
+
```
|
|
268
|
+
USAGE
|
|
269
|
+
$ sf agent generate agent-spec -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--type customer|internal]
|
|
270
|
+
[--role <value>] [--company-name <value>] [--company-description <value>] [--company-website <value>] [--max-topics
|
|
271
|
+
<value>] [--agent-user <value>] [--enrich-logs true|false] [--tone formal|casual|neutral] [--spec <value>]
|
|
272
|
+
[--output-file <value>] [--full-interview] [--grounding-context <value> --prompt-template <value>]
|
|
273
|
+
[--force-overwrite]
|
|
274
|
+
|
|
275
|
+
FLAGS
|
|
276
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
277
|
+
configuration variable is already set.
|
|
278
|
+
--agent-user=<value> Username of a user in your org to assign to your agent; determines what your agent
|
|
279
|
+
can access and do.
|
|
280
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
281
|
+
--company-description=<value> Description of your company.
|
|
282
|
+
--company-name=<value> Name of your company.
|
|
283
|
+
--company-website=<value> Website URL of your company.
|
|
284
|
+
--enrich-logs=<option> Adds agent conversation data to event logs so you can view all agent session
|
|
285
|
+
activity in one place.
|
|
286
|
+
<options: true|false>
|
|
287
|
+
--force-overwrite Don't prompt the user to confirm that an existing spec file will be overwritten.
|
|
288
|
+
--full-interview Prompt for both required and optional flags.
|
|
289
|
+
--grounding-context=<value> Context information and personalization that's added to your prompts when using a
|
|
290
|
+
custom prompt template.
|
|
291
|
+
--max-topics=<value> Maximum number of topics to generate in the agent spec; default is 5.
|
|
292
|
+
--output-file=<value> [default: specs/agentSpec.yaml] Path for the generated YAML agent spec file; can be
|
|
293
|
+
an absolute or relative path.
|
|
294
|
+
--prompt-template=<value> API name of a customized prompt template to use instead of the default prompt
|
|
295
|
+
template.
|
|
296
|
+
--role=<value> Role of the agent.
|
|
297
|
+
--spec=<value> Agent spec file, in YAML format, to use as input to the command.
|
|
298
|
+
--tone=<option> Conversational style of the agent, such as how it expresses your brand personality
|
|
299
|
+
in its messages through word choice, punctuation, and sentence structure.
|
|
300
|
+
<options: formal|casual|neutral>
|
|
301
|
+
--type=<option> Type of agent to create. Internal types are copilots used internally by your
|
|
302
|
+
company and customer types are the agents you create for your customers.
|
|
303
|
+
<options: customer|internal>
|
|
304
|
+
|
|
305
|
+
GLOBAL FLAGS
|
|
306
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
307
|
+
--json Format output as json.
|
|
308
|
+
|
|
309
|
+
DESCRIPTION
|
|
310
|
+
Generate an agent spec, which is a YAML file that captures what an agent can do.
|
|
311
|
+
|
|
312
|
+
The first step in creating an agent in your org with Salesforce CLI is to generate an agent spec using this command.
|
|
313
|
+
An agent spec is a YAML-formatted file that contains information about the agent, such as its role and company
|
|
314
|
+
description, and then an AI-generated list of topics based on this information. Topics define the range of jobs your
|
|
315
|
+
agent can handle.
|
|
316
|
+
|
|
317
|
+
Use flags, such as --role and --company-description, to provide details about your company and the role that the agent
|
|
318
|
+
plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be
|
|
319
|
+
prompted for all required and optional properties. Upon command execution, the large language model (LLM) associated
|
|
320
|
+
with your org uses the provided information to generate a list of topics for the agent. Because the LLM uses the
|
|
321
|
+
company and role information to generate the topics, we recommend that you provide accurate, complete, and specific
|
|
322
|
+
details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for
|
|
323
|
+
example, you can remove topics that don't apply or change a topic's description.
|
|
324
|
+
|
|
325
|
+
You can also iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this
|
|
326
|
+
command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively
|
|
327
|
+
improving the description of your agent allows the LLM to generate progressively better topics.
|
|
328
|
+
|
|
329
|
+
You can also specify other agent properties, such as a custom prompt template, how to ground the prompt template to
|
|
330
|
+
add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the
|
|
331
|
+
agent.
|
|
332
|
+
|
|
333
|
+
When your agent spec is ready, you then create the agent in your org by running the "agent create" CLI command and
|
|
334
|
+
specifying the spec with the --spec flag.
|
|
335
|
+
|
|
336
|
+
EXAMPLES
|
|
337
|
+
Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and
|
|
338
|
+
your company details; use your default org:
|
|
339
|
+
|
|
340
|
+
$ sf agent generate agent-spec --type customer --role "Field customer complaints and manage employee schedules." \
|
|
341
|
+
--company-name "Coral Cloud Resorts" --company-description "Provide customers with exceptional destination \
|
|
342
|
+
activities, unforgettable experiences, and reservation services."
|
|
343
|
+
|
|
344
|
+
Generate an agent spec by being prompted for the required agent properties and generate a maxiumum of 5 topics;
|
|
345
|
+
write the generated file to the "specs/resortManagerSpec.yaml" file and use the org with alias "my-org":
|
|
346
|
+
|
|
347
|
+
$ sf agent generate agent-spec --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org
|
|
348
|
+
|
|
349
|
+
Be prompted for all required and optional agent properties; use your default org:
|
|
350
|
+
|
|
351
|
+
$ sf agent generate agent-spec --full-interview
|
|
352
|
+
|
|
353
|
+
Specify an existing agent spec file called "specs/resortManagerAgent.yaml", and then overwrite it with a new version
|
|
354
|
+
that contains newly AI-generated topics based on the updated role information passed in with the --role flag:
|
|
355
|
+
|
|
356
|
+
$ sf agent generate agent-spec --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml \
|
|
357
|
+
--role "Field customer complaints, manage employee schedules, and ensure all resort operations are running \
|
|
358
|
+
smoothly"
|
|
359
|
+
|
|
360
|
+
Specify that the conversational tone of the agent is formal and to attach the "resortmanager@myorg.com" username to
|
|
361
|
+
it; be prompted for the required properties and use your default org:
|
|
362
|
+
|
|
363
|
+
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/generate/agent-spec.ts)_
|
|
367
|
+
|
|
368
|
+
## `sf agent generate template`
|
|
369
|
+
|
|
370
|
+
Generate an agent template from an existing agent in your DX project so you can then package the template in a managed package.
|
|
371
|
+
|
|
372
|
+
```
|
|
373
|
+
USAGE
|
|
374
|
+
$ sf agent generate template --agent-version <value> -f <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
375
|
+
|
|
376
|
+
FLAGS
|
|
377
|
+
-f, --agent-file=<value> (required) Path to an agent (Bot) metadata file.
|
|
378
|
+
--agent-version=<value> (required) Version of the agent (BotVersion).
|
|
379
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
380
|
+
|
|
381
|
+
GLOBAL FLAGS
|
|
382
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
383
|
+
--json Format output as json.
|
|
384
|
+
|
|
385
|
+
DESCRIPTION
|
|
386
|
+
Generate an agent template from an existing agent in your DX project so you can then package the template in a managed
|
|
387
|
+
package.
|
|
388
|
+
|
|
389
|
+
At a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The
|
|
390
|
+
GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these
|
|
391
|
+
three types, located in your local DX project, to generate a BotTemplate file for a specific agent (Bot). You then use
|
|
392
|
+
the BotTemplate file, along with the GenAiPlannerBundle file that references the BotTemplate, to package the template
|
|
393
|
+
in a managed package that you can share between orgs or on AppExchange.
|
|
394
|
+
|
|
395
|
+
Use the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as
|
|
396
|
+
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple
|
|
397
|
+
BotVersions, so use the --agent-version flag to specify the version. The corresponding BotVersion file must exist
|
|
398
|
+
locally. For example, if you specify "--agent-version 4", then the file
|
|
399
|
+
force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.
|
|
400
|
+
|
|
401
|
+
The new BotTemplate file is generated in the "botTemplates" directory in your local package directory, and has the
|
|
402
|
+
name <Agent_API_name>_v<Version>_Template.botTemplate-meta.xml, such as
|
|
403
|
+
force-app/main/default/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full
|
|
404
|
+
pathname of the generated files when it completes.
|
|
405
|
+
|
|
406
|
+
EXAMPLES
|
|
407
|
+
Generate an agent template from a Bot metadata file in your DX project that corresponds to the My_Awesome_Agent
|
|
408
|
+
agent; use version 1 of the agent.
|
|
409
|
+
|
|
410
|
+
$ sf agent generate template --agent-file \
|
|
411
|
+
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/generate/template.ts)_
|
|
415
|
+
|
|
416
|
+
## `sf agent generate test-spec`
|
|
417
|
+
|
|
418
|
+
Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.
|
|
419
|
+
|
|
420
|
+
```
|
|
421
|
+
USAGE
|
|
422
|
+
$ sf agent generate test-spec [--flags-dir <value>] [-d <value>] [--force-overwrite] [-f <value>]
|
|
423
|
+
|
|
424
|
+
FLAGS
|
|
425
|
+
-d, --from-definition=<value> Filepath to the AIEvaluationDefinition metadata XML file in your DX project that you
|
|
426
|
+
want to convert to a test spec YAML file.
|
|
427
|
+
-f, --output-file=<value> Name of the generated test spec YAML file. Default value is
|
|
428
|
+
"specs/<AGENT_API_NAME>-testSpec.yaml".
|
|
429
|
+
--force-overwrite Don't prompt for confirmation when overwriting an existing test spec YAML file.
|
|
430
|
+
|
|
431
|
+
GLOBAL FLAGS
|
|
432
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
433
|
+
|
|
434
|
+
DESCRIPTION
|
|
435
|
+
Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.
|
|
436
|
+
|
|
437
|
+
The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to
|
|
438
|
+
generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being
|
|
439
|
+
tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX
|
|
440
|
+
project when prompting for information, such as the agent API name; it doesn't look in your org.
|
|
441
|
+
|
|
442
|
+
To generate a specific agent test case, this command prompts you for this information; when possible, the command
|
|
443
|
+
provides a list of options for you to choose from:
|
|
444
|
+
|
|
445
|
+
- Utterance: Natural language statement, question, or command used to test the agent.
|
|
446
|
+
- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.
|
|
447
|
+
- Expected actions: One or more API names of the expection actions the agent takes.
|
|
448
|
+
- Expected outcome: Natural language description of the outcome you expect.
|
|
449
|
+
|
|
450
|
+
When your test spec is ready, you then run the "agent test create" command to actually create the test in your org and
|
|
451
|
+
synchronize the metadata with your DX project. The metadata type for an agent test is AiEvaluationDefinition.
|
|
452
|
+
|
|
453
|
+
If you have an existing AiEvaluationDefinition metadata XML file in your DX project, you can generate its equivalent
|
|
454
|
+
YAML test spec file with the --from-definition flag.
|
|
455
|
+
|
|
456
|
+
EXAMPLES
|
|
457
|
+
Generate an agent test spec YAML file interactively:
|
|
458
|
+
|
|
459
|
+
$ sf agent generate test-spec
|
|
460
|
+
|
|
461
|
+
Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without
|
|
462
|
+
confirmation:
|
|
463
|
+
|
|
464
|
+
$ sf agent generate test-spec --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite
|
|
465
|
+
|
|
466
|
+
Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:
|
|
467
|
+
|
|
468
|
+
$ sf agent generate test-spec --from-definition \
|
|
469
|
+
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/generate/test-spec.ts)_
|
|
473
|
+
|
|
474
|
+
## `sf agent preview`
|
|
475
|
+
|
|
476
|
+
Interact with an active agent to preview how the agent responds to your statements, questions, and commands (utterances).
|
|
477
|
+
|
|
478
|
+
```
|
|
479
|
+
USAGE
|
|
480
|
+
$ sf agent preview -o <value> -a <value> [--flags-dir <value>] [--api-version <value>] [-n <value>] [-d <value>]
|
|
481
|
+
[-x]
|
|
482
|
+
|
|
483
|
+
FLAGS
|
|
484
|
+
-a, --connected-app-user=<value> (required) Username or alias of the connected app user that's configured with
|
|
485
|
+
web-based access tokens to the agent.
|
|
486
|
+
-d, --output-dir=<value> Directory where conversation transcripts are saved.
|
|
487
|
+
-n, --api-name=<value> API name of the agent you want to interact with.
|
|
488
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
489
|
+
configuration variable is already set.
|
|
490
|
+
-x, --apex-debug Enable Apex debug logging during the agent preview conversation.
|
|
491
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
492
|
+
|
|
493
|
+
GLOBAL FLAGS
|
|
494
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
495
|
+
|
|
496
|
+
DESCRIPTION
|
|
497
|
+
Interact with an active agent to preview how the agent responds to your statements, questions, and commands
|
|
498
|
+
(utterances).
|
|
499
|
+
|
|
500
|
+
Use this command to have a natural language conversation with an active agent in your org, as if you were an actual
|
|
501
|
+
user. The interface is simple: in the "Start typing..." prompt, enter a statement, question, or command; when you're
|
|
502
|
+
done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left.
|
|
503
|
+
To exit the conversation, hit ESC or Control+C.
|
|
504
|
+
|
|
505
|
+
This command is useful to test if the agent responds to your utterances as you expect. For example, you can test that
|
|
506
|
+
the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated
|
|
507
|
+
with that topic. This command is the CLI-equivalent of the Conversation Preview panel in your org's Agent Builder UI.
|
|
508
|
+
|
|
509
|
+
When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default,
|
|
510
|
+
the files are saved to the "./temp/agent-preview" directory. Specify a new default directory by setting the
|
|
511
|
+
environment variable "SF_AGENT_PREVIEW_OUTPUT_DIR" to the directory. Or you can pass the directory to the --output-dir
|
|
512
|
+
flag.
|
|
513
|
+
|
|
514
|
+
Find the agent's API name in its main details page in your org's Agent page in Setup.
|
|
515
|
+
|
|
516
|
+
Before you use this command, you must complete these steps:
|
|
517
|
+
|
|
518
|
+
1. Create a connected app in your org as described in the "Create a Connected App" section here:
|
|
519
|
+
https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#create-a-connected-app. Do these
|
|
520
|
+
four additional steps:
|
|
521
|
+
|
|
522
|
+
a. When specifying the connected app's Callback URL, add this second callback URL on a new line:
|
|
523
|
+
"http://localhost:1717/OauthRedirect".
|
|
524
|
+
|
|
525
|
+
b. When adding the scopes to the connected app, add "Manage user data via Web browsers (web)".
|
|
526
|
+
|
|
527
|
+
c. Ensure that the "Require Secret for Web Server Flow" option is not selected.
|
|
528
|
+
|
|
529
|
+
d. Make note of the user that you specified as the "Run As" user when updating the Client Credentials Flow section.
|
|
530
|
+
|
|
531
|
+
2. Add the connected app to your agent as described in the "Add Connected App to Agent" section here:
|
|
532
|
+
https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#add-connected-app-to-agent.
|
|
533
|
+
|
|
534
|
+
3. Copy the consumer key from your connected app as described in the "Obtain Credentials" section here:
|
|
535
|
+
https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#obtain-credentials.
|
|
536
|
+
|
|
537
|
+
4. Set the "SFDX_AUTH_SCOPES" environment variable to "refresh_token sfap_api chatbot_api web api". This step ensures
|
|
538
|
+
that you get the specific OAuth scopes required by this command.
|
|
539
|
+
|
|
540
|
+
5. Using the username of the user you specified as the "Run As" user above, authorize your org using the web server
|
|
541
|
+
flow, as described in this document:
|
|
542
|
+
https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_web_flow.htm.
|
|
543
|
+
|
|
544
|
+
IMPORTANT: You must use the "--client-id <CONNECTED-APP-CONSUMER-KEY>" flag of "org login web", where
|
|
545
|
+
CONNECTED-APP-CONSUMER-KEY is the consumer key you previously copied. This step ensures that the "org login web"
|
|
546
|
+
command uses your custom connected app, and not the default CLI connected app.
|
|
547
|
+
|
|
548
|
+
Press Enter to skip sharing the client secret.
|
|
549
|
+
|
|
550
|
+
6. When you run this command to interact with an agent, specify the username you authorized in the preceding step with
|
|
551
|
+
the --connected-app-user (-a) flag.
|
|
552
|
+
|
|
553
|
+
EXAMPLES
|
|
554
|
+
Interact with an agent with API name "Resort_Manager" in the org with alias "my-org". Connect to your agent using
|
|
555
|
+
the alias "my-agent-user"; this alias must point to the username who is authorized using the Web server flow:
|
|
556
|
+
|
|
557
|
+
$ sf agent preview --api-name "Resort_Manager" --target-org my-org --connected-app-user my-agent-user
|
|
558
|
+
|
|
559
|
+
Same as the preceding example, but this time save the conversation transcripts to the "./transcripts/my-preview"
|
|
560
|
+
directory rather than the default "./temp/agent-preview":
|
|
561
|
+
|
|
562
|
+
$ sf agent preview --api-name "Resort_Manager" --target-org my-org --connected-app-user my-agent-user \
|
|
563
|
+
--output-dir "transcripts/my-preview"
|
|
564
|
+
```
|
|
565
|
+
|
|
566
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/preview.ts)_
|
|
567
|
+
|
|
568
|
+
## `sf agent test create`
|
|
569
|
+
|
|
570
|
+
Create an agent test in your org using a local test spec YAML file.
|
|
571
|
+
|
|
572
|
+
```
|
|
573
|
+
USAGE
|
|
574
|
+
$ sf agent test create -o <value> [--json] [--flags-dir <value>] [--api-name <value>] [--spec <value>] [--api-version
|
|
575
|
+
<value>] [--preview] [--force-overwrite]
|
|
576
|
+
|
|
577
|
+
FLAGS
|
|
578
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
579
|
+
configuration variable is already set.
|
|
580
|
+
--api-name=<value> API name of the new test; the API name must not exist in the org.
|
|
581
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
582
|
+
--force-overwrite Don't prompt for confirmation when overwriting an existing test (based on API name) in your
|
|
583
|
+
org.
|
|
584
|
+
--preview Preview the test metadata file (AiEvaluationDefinition) without deploying to your org.
|
|
585
|
+
--spec=<value> Path to the test spec YAML file.
|
|
586
|
+
|
|
587
|
+
GLOBAL FLAGS
|
|
588
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
589
|
+
--json Format output as json.
|
|
590
|
+
|
|
591
|
+
DESCRIPTION
|
|
592
|
+
Create an agent test in your org using a local test spec YAML file.
|
|
593
|
+
|
|
594
|
+
To run this command, you must have an agent test spec file, which is a YAML file that lists the test cases for testing
|
|
595
|
+
a specific agent. Use the "agent generate test-spec" CLI command to generate a test spec file. Then specify the file
|
|
596
|
+
to this command with the --spec flag, or run this command with no flags to be prompted.
|
|
597
|
+
|
|
598
|
+
When this command completes, your org contains the new agent test, which you can view and edit using the Testing
|
|
599
|
+
Center UI. This command also retrieves the metadata component (AiEvaluationDefinition) associated with the new test to
|
|
600
|
+
your local Salesforce DX project and displays its filename.
|
|
601
|
+
|
|
602
|
+
After you've created the test in the org, use the "agent test run" command to run it.
|
|
603
|
+
|
|
604
|
+
EXAMPLES
|
|
605
|
+
Create an agent test interactively and be prompted for the test spec and API name of the test in the org; use the
|
|
606
|
+
default org:
|
|
607
|
+
|
|
608
|
+
$ sf agent test create
|
|
609
|
+
|
|
610
|
+
Create an agent test and use flags to specify all required information; if a test with same API name already exists
|
|
611
|
+
in the org, overwrite it without confirmation. Use the org with alias "my-org":
|
|
612
|
+
|
|
613
|
+
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test \
|
|
614
|
+
--force-overwrite --target-org my-org
|
|
615
|
+
|
|
616
|
+
Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:
|
|
617
|
+
|
|
618
|
+
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
|
|
619
|
+
```
|
|
620
|
+
|
|
621
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/create.ts)_
|
|
622
|
+
|
|
623
|
+
## `sf agent test list`
|
|
624
|
+
|
|
625
|
+
List the available agent tests in your org.
|
|
626
|
+
|
|
627
|
+
```
|
|
628
|
+
USAGE
|
|
629
|
+
$ sf agent test list -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
630
|
+
|
|
631
|
+
FLAGS
|
|
632
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
633
|
+
configuration variable is already set.
|
|
634
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
635
|
+
|
|
636
|
+
GLOBAL FLAGS
|
|
637
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
638
|
+
--json Format output as json.
|
|
639
|
+
|
|
640
|
+
DESCRIPTION
|
|
641
|
+
List the available agent tests in your org.
|
|
642
|
+
|
|
643
|
+
The command outputs a table with the name (API name) of each test along with its unique ID and the date it was created
|
|
644
|
+
in the org.
|
|
645
|
+
|
|
646
|
+
EXAMPLES
|
|
647
|
+
List the agent tests in your default org:
|
|
648
|
+
|
|
649
|
+
$ sf agent test list
|
|
650
|
+
|
|
651
|
+
List the agent tests in an org with alias "my-org""
|
|
652
|
+
|
|
653
|
+
$ sf agent test list --target-org my-org
|
|
654
|
+
```
|
|
655
|
+
|
|
656
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/list.ts)_
|
|
657
|
+
|
|
658
|
+
## `sf agent test results`
|
|
659
|
+
|
|
660
|
+
Get the results of a completed agent test run.
|
|
661
|
+
|
|
662
|
+
```
|
|
663
|
+
USAGE
|
|
664
|
+
$ sf agent test results -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [--result-format
|
|
665
|
+
json|human|junit|tap] [-d <value>]
|
|
666
|
+
|
|
667
|
+
FLAGS
|
|
668
|
+
-d, --output-dir=<value> Directory to write the agent test results into.
|
|
669
|
+
-i, --job-id=<value> (required) Job ID of the completed agent test run.
|
|
670
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
671
|
+
configuration variable is already set.
|
|
672
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
673
|
+
--result-format=<option> [default: human] Format of the agent test run results.
|
|
674
|
+
<options: json|human|junit|tap>
|
|
675
|
+
|
|
676
|
+
GLOBAL FLAGS
|
|
677
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
678
|
+
--json Format output as json.
|
|
679
|
+
|
|
680
|
+
DESCRIPTION
|
|
681
|
+
Get the results of a completed agent test run.
|
|
682
|
+
|
|
683
|
+
This command requires a job ID, which the original "agent test run" command displays when it completes. You can also
|
|
684
|
+
use the --use-most-recent flag to see results for the most recently run agent test.
|
|
685
|
+
|
|
686
|
+
By default, this command outputs test results in human-readable tables for each test case. The tables show whether the
|
|
687
|
+
test case passed, the expected and actual values, the test score, how long the test took, and more. Use the
|
|
688
|
+
--result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to
|
|
689
|
+
a file rather than to the terminal.
|
|
690
|
+
|
|
691
|
+
EXAMPLES
|
|
692
|
+
Get the results of an agent test run in your default org using its job ID:
|
|
693
|
+
|
|
694
|
+
$ sf agent test results --job-id 4KBfake0000003F4AQ
|
|
695
|
+
|
|
696
|
+
Get the results of the most recently run agent test in an org with alias "my-org":
|
|
697
|
+
|
|
698
|
+
$ sf agent test results --use-most-recent --target-org my-org
|
|
699
|
+
|
|
700
|
+
Get the results of the most recently run agent test in your default org, and write the JSON-formatted results into a
|
|
701
|
+
directory called "test-results":
|
|
702
|
+
|
|
703
|
+
$ sf agent test results --use-most-recent --output-dir ./test-results --result-format json
|
|
704
|
+
|
|
705
|
+
FLAG DESCRIPTIONS
|
|
706
|
+
-d, --output-dir=<value> Directory to write the agent test results into.
|
|
707
|
+
|
|
708
|
+
If the agent test run completes, write the results to the specified directory. If the test is still running, the
|
|
709
|
+
test results aren't written.
|
|
710
|
+
```
|
|
711
|
+
|
|
712
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/results.ts)_
|
|
713
|
+
|
|
714
|
+
## `sf agent test resume`
|
|
715
|
+
|
|
716
|
+
Resume an agent test that you previously started in your org so you can view the test results.
|
|
717
|
+
|
|
718
|
+
```
|
|
719
|
+
USAGE
|
|
720
|
+
$ sf agent test resume -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-r] [-w
|
|
721
|
+
<value>] [--result-format json|human|junit|tap] [-d <value>]
|
|
722
|
+
|
|
723
|
+
FLAGS
|
|
724
|
+
-d, --output-dir=<value> Directory to write the agent test results into.
|
|
725
|
+
-i, --job-id=<value> Job ID of the original agent test run.
|
|
726
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
727
|
+
configuration variable is already set.
|
|
728
|
+
-r, --use-most-recent Use the job ID of the most recent agent test run.
|
|
729
|
+
-w, --wait=<value> [default: 5 minutes] Number of minutes to wait for the command to complete and display
|
|
730
|
+
results to the terminal window.
|
|
731
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
732
|
+
--result-format=<option> [default: human] Format of the agent test run results.
|
|
733
|
+
<options: json|human|junit|tap>
|
|
734
|
+
|
|
735
|
+
GLOBAL FLAGS
|
|
736
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
737
|
+
--json Format output as json.
|
|
738
|
+
|
|
739
|
+
DESCRIPTION
|
|
740
|
+
Resume an agent test that you previously started in your org so you can view the test results.
|
|
741
|
+
|
|
742
|
+
This command requires a job ID, which the original "agent test run" command displays when it completes. You can also
|
|
743
|
+
use the --use-most-recent flag to see results for the most recently run agent test.
|
|
744
|
+
|
|
745
|
+
Use the --wait flag to specify the number of minutes for this command to wait for the agent test to complete; if the
|
|
746
|
+
test completes by the end of the wait time, the command displays the test results. If not, the CLI returns control of
|
|
747
|
+
the terminal to you, and you must run "agent test resume" again.
|
|
748
|
+
|
|
749
|
+
By default, this command outputs test results in human-readable tables for each test case. The tables show whether the
|
|
750
|
+
test case passed, the expected and actual values, the test score, how long the test took, and more. Use the
|
|
751
|
+
--result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to
|
|
752
|
+
a file rather than to the terminal.
|
|
753
|
+
|
|
754
|
+
EXAMPLES
|
|
755
|
+
Resume an agent test in your default org using a job ID:
|
|
756
|
+
|
|
757
|
+
$ sf agent test resume --job-id 4KBfake0000003F4AQ
|
|
758
|
+
|
|
759
|
+
Resume the most recently-run agent test in an org with alias "my-org" org; wait 10 minutes for the tests to finish:
|
|
760
|
+
|
|
761
|
+
$ sf agent test resume --use-most-recent --wait 10 --target-org my-org
|
|
762
|
+
|
|
763
|
+
Resume the most recent agent test in your default org, and write the JSON-formatted results into a directory called
|
|
764
|
+
"test-results":
|
|
765
|
+
|
|
766
|
+
$ sf agent test resume --use-most-recent --output-dir ./test-results --result-format json
|
|
767
|
+
|
|
768
|
+
FLAG DESCRIPTIONS
|
|
769
|
+
-d, --output-dir=<value> Directory to write the agent test results into.
|
|
770
|
+
|
|
771
|
+
If the agent test run completes, write the results to the specified directory. If the test is still running, the
|
|
772
|
+
test results aren't written.
|
|
773
|
+
```
|
|
774
|
+
|
|
775
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/resume.ts)_
|
|
776
|
+
|
|
777
|
+
## `sf agent test run`
|
|
778
|
+
|
|
779
|
+
Start an agent test in your org.
|
|
780
|
+
|
|
781
|
+
```
|
|
782
|
+
USAGE
|
|
783
|
+
$ sf agent test run -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>] [-w <value>]
|
|
784
|
+
[--result-format json|human|junit|tap] [-d <value>]
|
|
785
|
+
|
|
786
|
+
FLAGS
|
|
787
|
+
-d, --output-dir=<value> Directory to write the agent test results into.
|
|
788
|
+
-n, --api-name=<value> API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition
|
|
789
|
+
metadata component that implements the agent test.
|
|
790
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
791
|
+
configuration variable is already set.
|
|
792
|
+
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the
|
|
793
|
+
terminal window.
|
|
794
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
795
|
+
--result-format=<option> [default: human] Format of the agent test run results.
|
|
796
|
+
<options: json|human|junit|tap>
|
|
797
|
+
|
|
798
|
+
GLOBAL FLAGS
|
|
799
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
800
|
+
--json Format output as json.
|
|
801
|
+
|
|
802
|
+
DESCRIPTION
|
|
803
|
+
Start an agent test in your org.
|
|
804
|
+
|
|
805
|
+
Use the --api-name flag to specify the name of the agent test you want to run. Use the output of the "agent test list"
|
|
806
|
+
command to get the names of all the available agent tests in your org.
|
|
807
|
+
|
|
808
|
+
By default, this command starts the agent test in your org, but it doesn't wait for the test to finish. Instead, it
|
|
809
|
+
displays the "agent test resume" command, with a job ID, that you execute to see the results of the test run, and then
|
|
810
|
+
returns control of the terminal window to you. Use the --wait flag to specify the number of minutes for the command to
|
|
811
|
+
wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test
|
|
812
|
+
results. If not, run "agent test resume".
|
|
813
|
+
|
|
814
|
+
By default, this command outputs test results in human-readable tables for each test case, if the test completes in
|
|
815
|
+
time. The tables show whether the test case passed, the expected and actual values, the test score, how long the test
|
|
816
|
+
took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag
|
|
817
|
+
to write the results to a file rather than to the terminal.
|
|
818
|
+
|
|
819
|
+
EXAMPLES
|
|
820
|
+
Start an agent test called Resort_Manager_Test for an agent in your default org, don't wait for the test to finish:
|
|
821
|
+
|
|
822
|
+
$ sf agent test run --api-name Resort_Manager_Test
|
|
823
|
+
|
|
824
|
+
Start an agent test for an agent in an org with alias "my-org" and wait for 10 minutes for the test to finish:
|
|
825
|
+
|
|
826
|
+
$ sf agent test run --api-name Resort_Manager_Test --wait 10 --target-org my-org
|
|
827
|
+
|
|
828
|
+
Start an agent test and write the JSON-formatted results into a directory called "test-results":
|
|
829
|
+
|
|
830
|
+
$ sf agent test run --api-name Resort_Manager_Test --wait 10 --output-dir ./test-results --result-format json
|
|
831
|
+
|
|
832
|
+
FLAG DESCRIPTIONS
|
|
833
|
+
-d, --output-dir=<value> Directory to write the agent test results into.
|
|
834
|
+
|
|
835
|
+
If the agent test run completes, write the results to the specified directory. If the test is still running, the
|
|
836
|
+
test results aren't written.
|
|
837
|
+
```
|
|
838
|
+
|
|
839
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/run.ts)_
|
|
840
|
+
|
|
190
841
|
## `sf alias list`
|
|
191
842
|
|
|
192
843
|
List all aliases currently set on your local computer.
|
|
@@ -4849,6 +5500,93 @@ FLAG DESCRIPTIONS
|
|
|
4849
5500
|
|
|
4850
5501
|
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.7.13/src/commands/org/resume/scratch.ts)_
|
|
4851
5502
|
|
|
5503
|
+
## `sf package convert`
|
|
5504
|
+
|
|
5505
|
+
Create a second-generation package version from a first-generation package.
|
|
5506
|
+
|
|
5507
|
+
```
|
|
5508
|
+
USAGE
|
|
5509
|
+
$ sf package convert -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-k <value>] [-f
|
|
5510
|
+
<value>] [-x] [-w <value>] [-m <value>] [--verbose] [-a <value>]
|
|
5511
|
+
|
|
5512
|
+
FLAGS
|
|
5513
|
+
-a, --patch-version=<value> Specific released patch version to convert
|
|
5514
|
+
-f, --definition-file=<value> Path to a definition file that contains features and org preferences that the metadata
|
|
5515
|
+
of the package version depends on.
|
|
5516
|
+
-k, --installation-key=<value> Installation key for key-protected package.
|
|
5517
|
+
-m, --seed-metadata=<value> Directory containing metadata to be deployed prior to conversion.
|
|
5518
|
+
-p, --package=<value> (required) ID (starts with 033) of the first-generation package to convert.
|
|
5519
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
5520
|
+
configuration variable is already set.
|
|
5521
|
+
-w, --wait=<value> Minutes to wait for the package version to be created.
|
|
5522
|
+
-x, --installation-key-bypass Bypass the installation key requirement.
|
|
5523
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
5524
|
+
--verbose Display verbose command output.
|
|
5525
|
+
|
|
5526
|
+
GLOBAL FLAGS
|
|
5527
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
5528
|
+
--json Format output as json.
|
|
5529
|
+
|
|
5530
|
+
DESCRIPTION
|
|
5531
|
+
Create a second-generation package version from a first-generation package.
|
|
5532
|
+
|
|
5533
|
+
The package convert creates a new package in the Dev Hub if one does not already exist for the specified
|
|
5534
|
+
first-generation package.
|
|
5535
|
+
|
|
5536
|
+
It then creates a new package version in the Dev Hub with contents based on the specified first-generation package.
|
|
5537
|
+
|
|
5538
|
+
By default, the latest released non-patch version from the specified first-generation package will be converted. Use
|
|
5539
|
+
--patch-version to override the default. Read more about --patch-version option in help
|
|
5540
|
+
|
|
5541
|
+
To retrieve details about a package version create request, including status and package version ID (04t), run "sf
|
|
5542
|
+
package version create report -i 08c...".
|
|
5543
|
+
|
|
5544
|
+
We recommend specifying the --installation-key to protect the contents of your package and to prevent unauthorized
|
|
5545
|
+
installation of your package.
|
|
5546
|
+
|
|
5547
|
+
To list package version creation requests in the org, run "sf package version create list".
|
|
5548
|
+
|
|
5549
|
+
ALIASES
|
|
5550
|
+
$ sf force package convert
|
|
5551
|
+
|
|
5552
|
+
EXAMPLES
|
|
5553
|
+
Create a second-generation package version from the first-generation package with the specified ID and give it the
|
|
5554
|
+
installation key "password123"; uses your default Dev Hub org:
|
|
5555
|
+
|
|
5556
|
+
$ sf package convert --package 033... --installation-key password123
|
|
5557
|
+
|
|
5558
|
+
Similar to previous example, but uses the specified Dev Hub org:
|
|
5559
|
+
|
|
5560
|
+
$ sf package convert --package 033... --installation-key password123 --target-dev-hub devhuborg@example.com
|
|
5561
|
+
|
|
5562
|
+
FLAG DESCRIPTIONS
|
|
5563
|
+
-a, --patch-version=<value> Specific released patch version to convert
|
|
5564
|
+
|
|
5565
|
+
Specify a released patch version as major.minor.patch.build to convert to second generation package version
|
|
5566
|
+
|
|
5567
|
+
-f, --definition-file=<value>
|
|
5568
|
+
|
|
5569
|
+
Path to a definition file that contains features and org preferences that the metadata of the package version
|
|
5570
|
+
depends on.
|
|
5571
|
+
|
|
5572
|
+
This definition file is similar to the scratch org definition file.
|
|
5573
|
+
|
|
5574
|
+
-k, --installation-key=<value> Installation key for key-protected package.
|
|
5575
|
+
|
|
5576
|
+
Either an --installation-key value or the --installation-key-bypass flag is required.
|
|
5577
|
+
|
|
5578
|
+
-m, --seed-metadata=<value> Directory containing metadata to be deployed prior to conversion.
|
|
5579
|
+
|
|
5580
|
+
The directory containing metadata that will be deployed on the build org prior to attempting conversion.
|
|
5581
|
+
|
|
5582
|
+
-x, --installation-key-bypass Bypass the installation key requirement.
|
|
5583
|
+
|
|
5584
|
+
If you bypass this requirement, anyone can install your package. Either an --installation-key value or the
|
|
5585
|
+
--installation-key-bypass flag is required.
|
|
5586
|
+
```
|
|
5587
|
+
|
|
5588
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/convert.ts)_
|
|
5589
|
+
|
|
4852
5590
|
## `sf package create`
|
|
4853
5591
|
|
|
4854
5592
|
Create a package.
|
|
@@ -4926,7 +5664,7 @@ FLAG DESCRIPTIONS
|
|
|
4926
5664
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
4927
5665
|
```
|
|
4928
5666
|
|
|
4929
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5667
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/create.ts)_
|
|
4930
5668
|
|
|
4931
5669
|
## `sf package delete`
|
|
4932
5670
|
|
|
@@ -4968,7 +5706,7 @@ EXAMPLES
|
|
|
4968
5706
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
4969
5707
|
```
|
|
4970
5708
|
|
|
4971
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5709
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/delete.ts)_
|
|
4972
5710
|
|
|
4973
5711
|
## `sf package install`
|
|
4974
5712
|
|
|
@@ -5067,7 +5805,7 @@ FLAG DESCRIPTIONS
|
|
|
5067
5805
|
- Delete: Delete all removed components that can be safely deleted, and deprecate the other components.
|
|
5068
5806
|
```
|
|
5069
5807
|
|
|
5070
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5808
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/install.ts)_
|
|
5071
5809
|
|
|
5072
5810
|
## `sf package install report`
|
|
5073
5811
|
|
|
@@ -5100,7 +5838,7 @@ EXAMPLES
|
|
|
5100
5838
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
5101
5839
|
```
|
|
5102
5840
|
|
|
5103
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5841
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/install/report.ts)_
|
|
5104
5842
|
|
|
5105
5843
|
## `sf package installed list`
|
|
5106
5844
|
|
|
@@ -5132,7 +5870,7 @@ EXAMPLES
|
|
|
5132
5870
|
$ sf package installed list --target-org me@example.com
|
|
5133
5871
|
```
|
|
5134
5872
|
|
|
5135
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5873
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/installed/list.ts)_
|
|
5136
5874
|
|
|
5137
5875
|
## `sf package list`
|
|
5138
5876
|
|
|
@@ -5170,7 +5908,7 @@ EXAMPLES
|
|
|
5170
5908
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
5171
5909
|
```
|
|
5172
5910
|
|
|
5173
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5911
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/list.ts)_
|
|
5174
5912
|
|
|
5175
5913
|
## `sf package uninstall`
|
|
5176
5914
|
|
|
@@ -5218,7 +5956,7 @@ EXAMPLES
|
|
|
5218
5956
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
5219
5957
|
```
|
|
5220
5958
|
|
|
5221
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5959
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/uninstall.ts)_
|
|
5222
5960
|
|
|
5223
5961
|
## `sf package uninstall report`
|
|
5224
5962
|
|
|
@@ -5251,7 +5989,7 @@ EXAMPLES
|
|
|
5251
5989
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
5252
5990
|
```
|
|
5253
5991
|
|
|
5254
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5992
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/uninstall/report.ts)_
|
|
5255
5993
|
|
|
5256
5994
|
## `sf package update`
|
|
5257
5995
|
|
|
@@ -5306,7 +6044,7 @@ FLAG DESCRIPTIONS
|
|
|
5306
6044
|
associated with your package.
|
|
5307
6045
|
```
|
|
5308
6046
|
|
|
5309
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6047
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/update.ts)_
|
|
5310
6048
|
|
|
5311
6049
|
## `sf package version create`
|
|
5312
6050
|
|
|
@@ -5481,7 +6219,7 @@ FLAG DESCRIPTIONS
|
|
|
5481
6219
|
periods of no output from commands.
|
|
5482
6220
|
```
|
|
5483
6221
|
|
|
5484
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6222
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/create.ts)_
|
|
5485
6223
|
|
|
5486
6224
|
## `sf package version create list`
|
|
5487
6225
|
|
|
@@ -5542,7 +6280,7 @@ EXAMPLES
|
|
|
5542
6280
|
$ sf package version create list --created-last-days 0 --status Success
|
|
5543
6281
|
```
|
|
5544
6282
|
|
|
5545
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6283
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/create/list.ts)_
|
|
5546
6284
|
|
|
5547
6285
|
## `sf package version create report`
|
|
5548
6286
|
|
|
@@ -5585,7 +6323,7 @@ EXAMPLES
|
|
|
5585
6323
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
5586
6324
|
```
|
|
5587
6325
|
|
|
5588
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6326
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/create/report.ts)_
|
|
5589
6327
|
|
|
5590
6328
|
## `sf package version delete`
|
|
5591
6329
|
|
|
@@ -5626,7 +6364,7 @@ EXAMPLES
|
|
|
5626
6364
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
5627
6365
|
```
|
|
5628
6366
|
|
|
5629
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6367
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/delete.ts)_
|
|
5630
6368
|
|
|
5631
6369
|
## `sf package version displayancestry`
|
|
5632
6370
|
|
|
@@ -5686,7 +6424,7 @@ FLAG DESCRIPTIONS
|
|
|
5686
6424
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
5687
6425
|
```
|
|
5688
6426
|
|
|
5689
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6427
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/displayancestry.ts)_
|
|
5690
6428
|
|
|
5691
6429
|
## `sf package version list`
|
|
5692
6430
|
|
|
@@ -5762,7 +6500,7 @@ EXAMPLES
|
|
|
5762
6500
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
5763
6501
|
```
|
|
5764
6502
|
|
|
5765
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6503
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/list.ts)_
|
|
5766
6504
|
|
|
5767
6505
|
## `sf package version promote`
|
|
5768
6506
|
|
|
@@ -5806,7 +6544,7 @@ EXAMPLES
|
|
|
5806
6544
|
$ sf package version promote --package "Awesome Package Alias"
|
|
5807
6545
|
```
|
|
5808
6546
|
|
|
5809
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6547
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/promote.ts)_
|
|
5810
6548
|
|
|
5811
6549
|
## `sf package version report`
|
|
5812
6550
|
|
|
@@ -5846,7 +6584,7 @@ EXAMPLES
|
|
|
5846
6584
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
5847
6585
|
```
|
|
5848
6586
|
|
|
5849
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6587
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/report.ts)_
|
|
5850
6588
|
|
|
5851
6589
|
## `sf package version update`
|
|
5852
6590
|
|
|
@@ -5899,7 +6637,7 @@ EXAMPLES
|
|
|
5899
6637
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
5900
6638
|
```
|
|
5901
6639
|
|
|
5902
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6640
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/version/update.ts)_
|
|
5903
6641
|
|
|
5904
6642
|
## `sf package1 version create`
|
|
5905
6643
|
|
|
@@ -5966,7 +6704,7 @@ FLAG DESCRIPTIONS
|
|
|
5966
6704
|
subscribers.
|
|
5967
6705
|
```
|
|
5968
6706
|
|
|
5969
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6707
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package1/version/create.ts)_
|
|
5970
6708
|
|
|
5971
6709
|
## `sf package1 version create get`
|
|
5972
6710
|
|
|
@@ -5999,7 +6737,7 @@ EXAMPLES
|
|
|
5999
6737
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
6000
6738
|
```
|
|
6001
6739
|
|
|
6002
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6740
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package1/version/create/get.ts)_
|
|
6003
6741
|
|
|
6004
6742
|
## `sf package1 version display`
|
|
6005
6743
|
|
|
@@ -6033,7 +6771,7 @@ EXAMPLES
|
|
|
6033
6771
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
6034
6772
|
```
|
|
6035
6773
|
|
|
6036
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6774
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package1/version/display.ts)_
|
|
6037
6775
|
|
|
6038
6776
|
## `sf package1 version list`
|
|
6039
6777
|
|
|
@@ -6071,7 +6809,7 @@ FLAG DESCRIPTIONS
|
|
|
6071
6809
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
6072
6810
|
```
|
|
6073
6811
|
|
|
6074
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6812
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package1/version/list.ts)_
|
|
6075
6813
|
|
|
6076
6814
|
## `sf plugins`
|
|
6077
6815
|
|