@salesforce/cli 2.138.4 → 2.138.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 +504 -95
- package/npm-shrinkwrap.json +51 -42
- package/oclif.lock +51 -46
- package/oclif.manifest.json +1 -1
- package/package.json +7 -7
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.138.
|
|
28
|
+
@salesforce/cli/2.138.6 linux-x64 node-v22.22.3
|
|
29
29
|
$ sf --help [COMMAND]
|
|
30
30
|
USAGE
|
|
31
31
|
$ sf COMMAND
|
|
@@ -43,6 +43,16 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
43
43
|
<!-- commands -->
|
|
44
44
|
|
|
45
45
|
- [`sf agent activate`](#sf-agent-activate)
|
|
46
|
+
- [`sf agent adl create`](#sf-agent-adl-create)
|
|
47
|
+
- [`sf agent adl delete`](#sf-agent-adl-delete)
|
|
48
|
+
- [`sf agent adl file add`](#sf-agent-adl-file-add)
|
|
49
|
+
- [`sf agent adl file delete`](#sf-agent-adl-file-delete)
|
|
50
|
+
- [`sf agent adl file list`](#sf-agent-adl-file-list)
|
|
51
|
+
- [`sf agent adl get`](#sf-agent-adl-get)
|
|
52
|
+
- [`sf agent adl list`](#sf-agent-adl-list)
|
|
53
|
+
- [`sf agent adl status`](#sf-agent-adl-status)
|
|
54
|
+
- [`sf agent adl update`](#sf-agent-adl-update)
|
|
55
|
+
- [`sf agent adl upload`](#sf-agent-adl-upload)
|
|
46
56
|
- [`sf agent create`](#sf-agent-create)
|
|
47
57
|
- [`sf agent deactivate`](#sf-agent-deactivate)
|
|
48
58
|
- [`sf agent generate agent-spec`](#sf-agent-generate-agent-spec)
|
|
@@ -284,7 +294,389 @@ ERROR CODES
|
|
|
284
294
|
ActivationFailed (4) Failed to activate the agent due to API or network errors.
|
|
285
295
|
```
|
|
286
296
|
|
|
287
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
297
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/activate.ts)_
|
|
298
|
+
|
|
299
|
+
## `sf agent adl create`
|
|
300
|
+
|
|
301
|
+
Create an Agentforce Data Library.
|
|
302
|
+
|
|
303
|
+
```
|
|
304
|
+
USAGE
|
|
305
|
+
$ sf agent adl create -o <value> -n <value> --developer-name <value> --source-type sfdrive|knowledge|retriever
|
|
306
|
+
[--json] [--flags-dir <value>] [--api-version <value>] [--description <value>] [--index-mode basic|enhanced]
|
|
307
|
+
[--retriever-id <value>] [--primary-index-field1 <value>] [--primary-index-field2 <value>]
|
|
308
|
+
|
|
309
|
+
FLAGS
|
|
310
|
+
-n, --name=<value> (required) Display name for the data library (max 80 characters).
|
|
311
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
312
|
+
configuration variable is already set.
|
|
313
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
314
|
+
--description=<value> Description of the data library (max 255 characters).
|
|
315
|
+
--developer-name=<value> (required) API name for the data library (max 80 characters, alphanumeric and
|
|
316
|
+
underscores only, must start with a letter).
|
|
317
|
+
--index-mode=<option> Index mode for SFDRIVE libraries: basic or enhanced.
|
|
318
|
+
<options: basic|enhanced>
|
|
319
|
+
--primary-index-field1=<value> Primary index field 1 for KNOWLEDGE libraries (required, immutable after
|
|
320
|
+
creation).
|
|
321
|
+
--primary-index-field2=<value> Primary index field 2 for KNOWLEDGE libraries (required, immutable after
|
|
322
|
+
creation).
|
|
323
|
+
--retriever-id=<value> ID of an active Custom Retriever (required for RETRIEVER source type; retriever
|
|
324
|
+
must be active).
|
|
325
|
+
--source-type=<option> (required) Type of grounding source: sfdrive (file upload), knowledge (Salesforce
|
|
326
|
+
Knowledge articles), or retriever (existing active Custom Retriever).
|
|
327
|
+
<options: sfdrive|knowledge|retriever>
|
|
328
|
+
|
|
329
|
+
GLOBAL FLAGS
|
|
330
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
331
|
+
--json Format output as json.
|
|
332
|
+
|
|
333
|
+
DESCRIPTION
|
|
334
|
+
Create an Agentforce Data Library.
|
|
335
|
+
|
|
336
|
+
Creates a new data library in the target org. The --source-type flag determines the type of library: SFDRIVE (file
|
|
337
|
+
upload), KNOWLEDGE (Salesforce Knowledge articles), or RETRIEVER (existing active Custom Retriever).
|
|
338
|
+
|
|
339
|
+
EXAMPLES
|
|
340
|
+
Create an SFDRIVE library:
|
|
341
|
+
|
|
342
|
+
$ sf agent adl create --target-org myOrg --name "My Docs" --developer-name My_Docs --source-type sfdrive
|
|
343
|
+
|
|
344
|
+
Create a KNOWLEDGE library with index fields:
|
|
345
|
+
|
|
346
|
+
$ sf agent adl create --target-org myOrg --name "KB Library" --developer-name KB_Library --source-type knowledge \
|
|
347
|
+
--primary-index-field1 Title --primary-index-field2 Summary
|
|
348
|
+
|
|
349
|
+
Create a RETRIEVER library:
|
|
350
|
+
|
|
351
|
+
$ sf agent adl create --target-org myOrg --name "Existing Retriever" --developer-name Existing_Retriever \
|
|
352
|
+
--source-type retriever --retriever-id 0ppXX0000000001
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/create.ts)_
|
|
356
|
+
|
|
357
|
+
## `sf agent adl delete`
|
|
358
|
+
|
|
359
|
+
Delete an Agentforce Data Library.
|
|
360
|
+
|
|
361
|
+
```
|
|
362
|
+
USAGE
|
|
363
|
+
$ sf agent adl delete -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
364
|
+
|
|
365
|
+
FLAGS
|
|
366
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
367
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
368
|
+
configuration variable is already set.
|
|
369
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
370
|
+
|
|
371
|
+
GLOBAL FLAGS
|
|
372
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
373
|
+
--json Format output as json.
|
|
374
|
+
|
|
375
|
+
DESCRIPTION
|
|
376
|
+
Delete an Agentforce Data Library.
|
|
377
|
+
|
|
378
|
+
Permanently deletes a data library and all associated files and indexing data.
|
|
379
|
+
|
|
380
|
+
EXAMPLES
|
|
381
|
+
Delete a data library:
|
|
382
|
+
|
|
383
|
+
$ sf agent adl delete --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/delete.ts)_
|
|
387
|
+
|
|
388
|
+
## `sf agent adl file add`
|
|
389
|
+
|
|
390
|
+
Add files to an existing Agentforce Data Library.
|
|
391
|
+
|
|
392
|
+
```
|
|
393
|
+
USAGE
|
|
394
|
+
$ sf agent adl file add -o <value> -i <value> -f <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
395
|
+
|
|
396
|
+
FLAGS
|
|
397
|
+
-f, --file=<value> (required) Path to the file to add to the library.
|
|
398
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
399
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
400
|
+
configuration variable is already set.
|
|
401
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
402
|
+
|
|
403
|
+
GLOBAL FLAGS
|
|
404
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
405
|
+
--json Format output as json.
|
|
406
|
+
|
|
407
|
+
DESCRIPTION
|
|
408
|
+
Add files to an existing Agentforce Data Library.
|
|
409
|
+
|
|
410
|
+
Adds one or more files to an existing SFDRIVE data library and triggers SearchIndex re-hydration. This is the day-2
|
|
411
|
+
operation for adding files to an already-provisioned library.
|
|
412
|
+
|
|
413
|
+
Constraints: at least 1 file required, no duplicate file names in a batch, maximum 1000 files per library.
|
|
414
|
+
|
|
415
|
+
EXAMPLES
|
|
416
|
+
Add a file to an existing library:
|
|
417
|
+
|
|
418
|
+
$ sf agent adl file add --library-id 1JDSG000007IbWX4A0 --file ./docs/new-guide.pdf --target-org myOrg
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/file/add.ts)_
|
|
422
|
+
|
|
423
|
+
## `sf agent adl file delete`
|
|
424
|
+
|
|
425
|
+
Delete a file from an Agentforce Data Library.
|
|
426
|
+
|
|
427
|
+
```
|
|
428
|
+
USAGE
|
|
429
|
+
$ sf agent adl file delete -o <value> -i <value> --file-id <value> [--json] [--flags-dir <value>] [--api-version
|
|
430
|
+
<value>]
|
|
431
|
+
|
|
432
|
+
FLAGS
|
|
433
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
434
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
435
|
+
configuration variable is already set.
|
|
436
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
437
|
+
--file-id=<value> (required) ID of the file to delete (AiGroundingFileRef record ID).
|
|
438
|
+
|
|
439
|
+
GLOBAL FLAGS
|
|
440
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
441
|
+
--json Format output as json.
|
|
442
|
+
|
|
443
|
+
DESCRIPTION
|
|
444
|
+
Delete a file from an Agentforce Data Library.
|
|
445
|
+
|
|
446
|
+
Permanently removes a file from an SFDRIVE data library and triggers re-indexing of the search index.
|
|
447
|
+
|
|
448
|
+
EXAMPLES
|
|
449
|
+
Delete a file from a data library:
|
|
450
|
+
|
|
451
|
+
$ sf agent adl file delete --library-id 1JDSG000007IbWX4A0 --file-id a1B2C3D4E5F6G7H8I9 --target-org myOrg
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/file/delete.ts)_
|
|
455
|
+
|
|
456
|
+
## `sf agent adl file list`
|
|
457
|
+
|
|
458
|
+
List files in an Agentforce Data Library.
|
|
459
|
+
|
|
460
|
+
```
|
|
461
|
+
USAGE
|
|
462
|
+
$ sf agent adl file list -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
463
|
+
|
|
464
|
+
FLAGS
|
|
465
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
466
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
467
|
+
configuration variable is already set.
|
|
468
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
469
|
+
|
|
470
|
+
GLOBAL FLAGS
|
|
471
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
472
|
+
--json Format output as json.
|
|
473
|
+
|
|
474
|
+
DESCRIPTION
|
|
475
|
+
List files in an Agentforce Data Library.
|
|
476
|
+
|
|
477
|
+
Returns the list of files in an SFDRIVE library including file name, size, and creation date.
|
|
478
|
+
|
|
479
|
+
EXAMPLES
|
|
480
|
+
List files in a data library:
|
|
481
|
+
|
|
482
|
+
$ sf agent adl file list --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
483
|
+
|
|
484
|
+
List files and output as JSON:
|
|
485
|
+
|
|
486
|
+
$ sf agent adl file list --library-id 1JDSG000007IbWX4A0 --target-org myOrg --json
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/file/list.ts)_
|
|
490
|
+
|
|
491
|
+
## `sf agent adl get`
|
|
492
|
+
|
|
493
|
+
Get details of an Agentforce Data Library.
|
|
494
|
+
|
|
495
|
+
```
|
|
496
|
+
USAGE
|
|
497
|
+
$ sf agent adl get -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
498
|
+
|
|
499
|
+
FLAGS
|
|
500
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
501
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
502
|
+
configuration variable is already set.
|
|
503
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
504
|
+
|
|
505
|
+
GLOBAL FLAGS
|
|
506
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
507
|
+
--json Format output as json.
|
|
508
|
+
|
|
509
|
+
DESCRIPTION
|
|
510
|
+
Get details of an Agentforce Data Library.
|
|
511
|
+
|
|
512
|
+
Returns the full detail of a data library including its grounding source configuration, status, and retriever ID.
|
|
513
|
+
|
|
514
|
+
EXAMPLES
|
|
515
|
+
Get details of a data library:
|
|
516
|
+
|
|
517
|
+
$ sf agent adl get --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
518
|
+
```
|
|
519
|
+
|
|
520
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/get.ts)_
|
|
521
|
+
|
|
522
|
+
## `sf agent adl list`
|
|
523
|
+
|
|
524
|
+
List Agentforce Data Libraries in an org.
|
|
525
|
+
|
|
526
|
+
```
|
|
527
|
+
USAGE
|
|
528
|
+
$ sf agent adl list -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
529
|
+
|
|
530
|
+
FLAGS
|
|
531
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
532
|
+
configuration variable is already set.
|
|
533
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
534
|
+
|
|
535
|
+
GLOBAL FLAGS
|
|
536
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
537
|
+
--json Format output as json.
|
|
538
|
+
|
|
539
|
+
DESCRIPTION
|
|
540
|
+
List Agentforce Data Libraries in an org.
|
|
541
|
+
|
|
542
|
+
Returns all data libraries in the target org, including their source type, status, and library ID.
|
|
543
|
+
|
|
544
|
+
EXAMPLES
|
|
545
|
+
List all data libraries in the default target org:
|
|
546
|
+
|
|
547
|
+
$ sf agent adl list --target-org myOrg
|
|
548
|
+
|
|
549
|
+
List data libraries and output as JSON:
|
|
550
|
+
|
|
551
|
+
$ sf agent adl list --target-org myOrg --json
|
|
552
|
+
```
|
|
553
|
+
|
|
554
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/list.ts)_
|
|
555
|
+
|
|
556
|
+
## `sf agent adl status`
|
|
557
|
+
|
|
558
|
+
Get indexing status of an Agentforce Data Library.
|
|
559
|
+
|
|
560
|
+
```
|
|
561
|
+
USAGE
|
|
562
|
+
$ sf agent adl status -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
563
|
+
|
|
564
|
+
FLAGS
|
|
565
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
566
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
567
|
+
configuration variable is already set.
|
|
568
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
569
|
+
|
|
570
|
+
GLOBAL FLAGS
|
|
571
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
572
|
+
--json Format output as json.
|
|
573
|
+
|
|
574
|
+
DESCRIPTION
|
|
575
|
+
Get indexing status of an Agentforce Data Library.
|
|
576
|
+
|
|
577
|
+
Returns the current indexing status including stage details (DATA_LAKE_OBJECT, SEARCH_INDEX, RETRIEVER) and any
|
|
578
|
+
errors.
|
|
579
|
+
|
|
580
|
+
EXAMPLES
|
|
581
|
+
Get status of a data library:
|
|
582
|
+
|
|
583
|
+
$ sf agent adl status --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
584
|
+
```
|
|
585
|
+
|
|
586
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/status.ts)_
|
|
587
|
+
|
|
588
|
+
## `sf agent adl update`
|
|
589
|
+
|
|
590
|
+
Update an Agentforce Data Library.
|
|
591
|
+
|
|
592
|
+
```
|
|
593
|
+
USAGE
|
|
594
|
+
$ sf agent adl update -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
|
|
595
|
+
[--description <value>] [--content-fields <value>] [--restrict-to-public-articles]
|
|
596
|
+
|
|
597
|
+
FLAGS
|
|
598
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
599
|
+
-n, --name=<value> New display name for the data library (max 80 characters).
|
|
600
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the
|
|
601
|
+
`target-org` configuration variable is already set.
|
|
602
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
603
|
+
--content-fields=<value> Comma-separated list of content fields for KNOWLEDGE libraries (triggers
|
|
604
|
+
re-indexing).
|
|
605
|
+
--description=<value> New description for the data library (max 255 characters).
|
|
606
|
+
--[no-]restrict-to-public-articles Restrict to public Knowledge articles only (KNOWLEDGE libraries, triggers
|
|
607
|
+
re-indexing).
|
|
608
|
+
|
|
609
|
+
GLOBAL FLAGS
|
|
610
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
611
|
+
--json Format output as json.
|
|
612
|
+
|
|
613
|
+
DESCRIPTION
|
|
614
|
+
Update an Agentforce Data Library.
|
|
615
|
+
|
|
616
|
+
Updates the label, description, or other mutable properties of an existing data library.
|
|
617
|
+
|
|
618
|
+
EXAMPLES
|
|
619
|
+
Update the label of a data library:
|
|
620
|
+
|
|
621
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --name "New Name" --target-org myOrg
|
|
622
|
+
|
|
623
|
+
Update the description:
|
|
624
|
+
|
|
625
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --description "Updated description" --target-org myOrg
|
|
626
|
+
|
|
627
|
+
Update Knowledge library content fields (triggers re-indexing):
|
|
628
|
+
|
|
629
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --content-fields "Answer**c,Summary**c" --target-org myOrg
|
|
630
|
+
|
|
631
|
+
Restrict Knowledge library to public articles:
|
|
632
|
+
|
|
633
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/update.ts)_
|
|
637
|
+
|
|
638
|
+
## `sf agent adl upload`
|
|
639
|
+
|
|
640
|
+
Upload a file to an SFDRIVE Agentforce Data Library.
|
|
641
|
+
|
|
642
|
+
```
|
|
643
|
+
USAGE
|
|
644
|
+
$ sf agent adl upload -o <value> -i <value> -f <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w
|
|
645
|
+
<value>]
|
|
646
|
+
|
|
647
|
+
FLAGS
|
|
648
|
+
-f, --file=<value> (required) Path to the file to upload.
|
|
649
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
650
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
651
|
+
configuration variable is already set.
|
|
652
|
+
-w, --wait=<value> Number of minutes to wait for indexing to complete. If not specified, returns after
|
|
653
|
+
triggering indexing.
|
|
654
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
655
|
+
|
|
656
|
+
GLOBAL FLAGS
|
|
657
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
658
|
+
--json Format output as json.
|
|
659
|
+
|
|
660
|
+
DESCRIPTION
|
|
661
|
+
Upload a file to an SFDRIVE Agentforce Data Library.
|
|
662
|
+
|
|
663
|
+
Performs the multi-step upload workflow: checks upload readiness, obtains a pre-signed S3 URL, uploads the file,
|
|
664
|
+
triggers indexing, and optionally polls until the library is ready (retrieverId is populated).
|
|
665
|
+
|
|
666
|
+
This command only works with SFDRIVE libraries. KNOWLEDGE libraries index automatically after creation, and RETRIEVER
|
|
667
|
+
libraries require no file upload.
|
|
668
|
+
|
|
669
|
+
EXAMPLES
|
|
670
|
+
Upload a file and wait for indexing to complete:
|
|
671
|
+
|
|
672
|
+
$ sf agent adl upload --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg --wait 10
|
|
673
|
+
|
|
674
|
+
Upload a file without waiting:
|
|
675
|
+
|
|
676
|
+
$ sf agent adl upload --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg
|
|
677
|
+
```
|
|
678
|
+
|
|
679
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/upload.ts)_
|
|
288
680
|
|
|
289
681
|
## `sf agent create`
|
|
290
682
|
|
|
@@ -351,7 +743,7 @@ EXAMPLES
|
|
|
351
743
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
352
744
|
```
|
|
353
745
|
|
|
354
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
746
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/create.ts)_
|
|
355
747
|
|
|
356
748
|
## `sf agent deactivate`
|
|
357
749
|
|
|
@@ -400,7 +792,7 @@ ERROR CODES
|
|
|
400
792
|
DeactivationFailed (4) Failed to deactivate the agent due to API or network errors.
|
|
401
793
|
```
|
|
402
794
|
|
|
403
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
795
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/deactivate.ts)_
|
|
404
796
|
|
|
405
797
|
## `sf agent generate agent-spec`
|
|
406
798
|
|
|
@@ -507,7 +899,7 @@ EXAMPLES
|
|
|
507
899
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
508
900
|
```
|
|
509
901
|
|
|
510
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
902
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/generate/agent-spec.ts)_
|
|
511
903
|
|
|
512
904
|
## `sf agent generate authoring-bundle`
|
|
513
905
|
|
|
@@ -584,7 +976,7 @@ EXAMPLES
|
|
|
584
976
|
other-package-dir/main/default --target-org my-dev-org
|
|
585
977
|
```
|
|
586
978
|
|
|
587
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
979
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/generate/authoring-bundle.ts)_
|
|
588
980
|
|
|
589
981
|
## `sf agent generate template`
|
|
590
982
|
|
|
@@ -646,7 +1038,7 @@ EXAMPLES
|
|
|
646
1038
|
my-package --source-org my-scratch-org
|
|
647
1039
|
```
|
|
648
1040
|
|
|
649
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1041
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/generate/template.ts)_
|
|
650
1042
|
|
|
651
1043
|
## `sf agent generate test-spec`
|
|
652
1044
|
|
|
@@ -711,7 +1103,7 @@ EXAMPLES
|
|
|
711
1103
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
712
1104
|
```
|
|
713
1105
|
|
|
714
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1106
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/generate/test-spec.ts)_
|
|
715
1107
|
|
|
716
1108
|
## `sf agent preview`
|
|
717
1109
|
|
|
@@ -784,7 +1176,7 @@ EXAMPLES
|
|
|
784
1176
|
$ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
|
|
785
1177
|
```
|
|
786
1178
|
|
|
787
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1179
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview.ts)_
|
|
788
1180
|
|
|
789
1181
|
## `sf agent preview end`
|
|
790
1182
|
|
|
@@ -868,7 +1260,7 @@ ERROR CODES
|
|
|
868
1260
|
SessionAmbiguous (5) Multiple preview sessions found; specify --session-id to choose one.
|
|
869
1261
|
```
|
|
870
1262
|
|
|
871
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1263
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview/end.ts)_
|
|
872
1264
|
|
|
873
1265
|
## `sf agent preview send`
|
|
874
1266
|
|
|
@@ -935,7 +1327,7 @@ ERROR CODES
|
|
|
935
1327
|
SessionAmbiguous (5) Multiple preview sessions found; specify --session-id to choose one.
|
|
936
1328
|
```
|
|
937
1329
|
|
|
938
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1330
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview/send.ts)_
|
|
939
1331
|
|
|
940
1332
|
## `sf agent preview sessions`
|
|
941
1333
|
|
|
@@ -971,7 +1363,7 @@ ERROR CODES
|
|
|
971
1363
|
Succeeded (0) Sessions listed successfully (or empty list if no active sessions).
|
|
972
1364
|
```
|
|
973
1365
|
|
|
974
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1366
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview/sessions.ts)_
|
|
975
1367
|
|
|
976
1368
|
## `sf agent preview start`
|
|
977
1369
|
|
|
@@ -1047,7 +1439,7 @@ ERROR CODES
|
|
|
1047
1439
|
PreviewStartFailed (4) Preview session failed to start due to API or network errors.
|
|
1048
1440
|
```
|
|
1049
1441
|
|
|
1050
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1442
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview/start.ts)_
|
|
1051
1443
|
|
|
1052
1444
|
## `sf agent publish authoring-bundle`
|
|
1053
1445
|
|
|
@@ -1111,7 +1503,7 @@ ERROR CODES
|
|
|
1111
1503
|
Failed (1) Compilation errors found in the Agent Script file.
|
|
1112
1504
|
```
|
|
1113
1505
|
|
|
1114
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1506
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/publish/authoring-bundle.ts)_
|
|
1115
1507
|
|
|
1116
1508
|
## `sf agent test create`
|
|
1117
1509
|
|
|
@@ -1120,17 +1512,19 @@ Create an agent test in your org using a local test spec YAML file.
|
|
|
1120
1512
|
```
|
|
1121
1513
|
USAGE
|
|
1122
1514
|
$ sf agent test create -o <value> [--json] [--flags-dir <value>] [--api-name <value>] [--spec <value>] [--api-version
|
|
1123
|
-
<value>] [--preview] [--force-overwrite]
|
|
1515
|
+
<value>] [--preview] [--force-overwrite] [--test-runner agentforce-studio|testing-center]
|
|
1124
1516
|
|
|
1125
1517
|
FLAGS
|
|
1126
|
-
-o, --target-org=<value>
|
|
1127
|
-
|
|
1128
|
-
--api-name=<value>
|
|
1129
|
-
--api-version=<value>
|
|
1130
|
-
--force-overwrite
|
|
1131
|
-
|
|
1132
|
-
--preview
|
|
1133
|
-
--spec=<value>
|
|
1518
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1519
|
+
configuration variable is already set.
|
|
1520
|
+
--api-name=<value> API name of the new test; the API name must not exist in the org.
|
|
1521
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1522
|
+
--force-overwrite Don't prompt for confirmation when overwriting an existing test (based on API name) in
|
|
1523
|
+
your org.
|
|
1524
|
+
--preview Preview the test metadata file without deploying to your org.
|
|
1525
|
+
--spec=<value> Path to the test spec YAML file.
|
|
1526
|
+
--test-runner=<option> Explicitly specify which test runner to use (agentforce-studio or testing-center).
|
|
1527
|
+
<options: agentforce-studio|testing-center>
|
|
1134
1528
|
|
|
1135
1529
|
GLOBAL FLAGS
|
|
1136
1530
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -1144,8 +1538,9 @@ DESCRIPTION
|
|
|
1144
1538
|
to this command with the --spec flag, or run this command with no flags to be prompted.
|
|
1145
1539
|
|
|
1146
1540
|
When this command completes, your org contains the new agent test, which you can view and edit using the Testing
|
|
1147
|
-
Center UI. This command also retrieves the metadata component
|
|
1148
|
-
your local Salesforce DX project and displays its filename.
|
|
1541
|
+
Center UI (legacy) or Agentforce Studio (NGT). This command also retrieves the metadata component associated with the
|
|
1542
|
+
new test to your local Salesforce DX project and displays its filename. By default, the legacy AiEvaluationDefinition
|
|
1543
|
+
is created; use --test-runner agentforce-studio to author an AiTestingDefinition (NGT) instead.
|
|
1149
1544
|
|
|
1150
1545
|
After you've created the test in the org, use the "agent test run" command to run it.
|
|
1151
1546
|
|
|
@@ -1165,6 +1560,20 @@ EXAMPLES
|
|
|
1165
1560
|
|
|
1166
1561
|
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
|
|
1167
1562
|
|
|
1563
|
+
Author an Agentforce Studio (NGT) test from an NGT-shaped YAML; writes an AiTestingDefinition metadata file:
|
|
1564
|
+
|
|
1565
|
+
$ sf agent test create --spec specs/ReturnsCheckout.ngt.yaml --api-name Returns_Checkout --test-runner \
|
|
1566
|
+
agentforce-studio --target-org my-org
|
|
1567
|
+
|
|
1568
|
+
FLAG DESCRIPTIONS
|
|
1569
|
+
--test-runner=agentforce-studio|testing-center
|
|
1570
|
+
|
|
1571
|
+
Explicitly specify which test runner to use (agentforce-studio or testing-center).
|
|
1572
|
+
|
|
1573
|
+
By default, the command automatically detects which test runner to use based on the test definition metadata type in
|
|
1574
|
+
your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition
|
|
1575
|
+
metadata. 'testing-center' uses AiEvaluationDefinition metadata.
|
|
1576
|
+
|
|
1168
1577
|
ENVIRONMENT VARIABLES
|
|
1169
1578
|
SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
|
|
1170
1579
|
|
|
@@ -1175,7 +1584,7 @@ ERROR CODES
|
|
|
1175
1584
|
DeploymentFailed (4) Deployment failed due to API or network errors.
|
|
1176
1585
|
```
|
|
1177
1586
|
|
|
1178
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1587
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/create.ts)_
|
|
1179
1588
|
|
|
1180
1589
|
## `sf agent test list`
|
|
1181
1590
|
|
|
@@ -1217,7 +1626,7 @@ ERROR CODES
|
|
|
1217
1626
|
Failed (4) Failed to retrieve agent tests due to API or network errors.
|
|
1218
1627
|
```
|
|
1219
1628
|
|
|
1220
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1629
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/list.ts)_
|
|
1221
1630
|
|
|
1222
1631
|
## `sf agent test results`
|
|
1223
1632
|
|
|
@@ -1301,7 +1710,7 @@ ERROR CODES
|
|
|
1301
1710
|
Failed (4) Failed to retrieve results due to API or network errors.
|
|
1302
1711
|
```
|
|
1303
1712
|
|
|
1304
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1713
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/results.ts)_
|
|
1305
1714
|
|
|
1306
1715
|
## `sf agent test resume`
|
|
1307
1716
|
|
|
@@ -1394,7 +1803,7 @@ ERROR CODES
|
|
|
1394
1803
|
OperationFailed (4) Failed to poll test due to API or network errors.
|
|
1395
1804
|
```
|
|
1396
1805
|
|
|
1397
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1806
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/resume.ts)_
|
|
1398
1807
|
|
|
1399
1808
|
## `sf agent test run`
|
|
1400
1809
|
|
|
@@ -1487,7 +1896,7 @@ ERROR CODES
|
|
|
1487
1896
|
OperationFailed (4) Failed to start or poll test due to API or network errors.
|
|
1488
1897
|
```
|
|
1489
1898
|
|
|
1490
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1899
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/run.ts)_
|
|
1491
1900
|
|
|
1492
1901
|
## `sf agent test run-eval`
|
|
1493
1902
|
|
|
@@ -1572,7 +1981,7 @@ ERROR CODES
|
|
|
1572
1981
|
OperationFailed (4) Failed to execute tests due to API or network errors.
|
|
1573
1982
|
```
|
|
1574
1983
|
|
|
1575
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1984
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/run-eval.ts)_
|
|
1576
1985
|
|
|
1577
1986
|
## `sf agent trace delete`
|
|
1578
1987
|
|
|
@@ -1639,7 +2048,7 @@ ERROR CODES
|
|
|
1639
2048
|
Succeeded (0) Traces deleted successfully (or no traces matched).
|
|
1640
2049
|
```
|
|
1641
2050
|
|
|
1642
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
2051
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/trace/delete.ts)_
|
|
1643
2052
|
|
|
1644
2053
|
## `sf agent trace list`
|
|
1645
2054
|
|
|
@@ -1712,7 +2121,7 @@ ERROR CODES
|
|
|
1712
2121
|
Succeeded (0) Trace files listed successfully (or empty list if none found).
|
|
1713
2122
|
```
|
|
1714
2123
|
|
|
1715
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
2124
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/trace/list.ts)_
|
|
1716
2125
|
|
|
1717
2126
|
## `sf agent trace read`
|
|
1718
2127
|
|
|
@@ -1800,7 +2209,7 @@ EXAMPLES
|
|
|
1800
2209
|
$ sf agent trace read --session-id <SESSION_ID> --json
|
|
1801
2210
|
```
|
|
1802
2211
|
|
|
1803
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
2212
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/trace/read.ts)_
|
|
1804
2213
|
|
|
1805
2214
|
## `sf agent validate authoring-bundle`
|
|
1806
2215
|
|
|
@@ -1857,7 +2266,7 @@ ERROR CODES
|
|
|
1857
2266
|
ServerError (3) Validation/compilation API returned HTTP 500. A server error occurred during compilation.
|
|
1858
2267
|
```
|
|
1859
2268
|
|
|
1860
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
2269
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/validate/authoring-bundle.ts)_
|
|
1861
2270
|
|
|
1862
2271
|
## `sf alias list`
|
|
1863
2272
|
|
|
@@ -2842,7 +3251,7 @@ EXAMPLES
|
|
|
2842
3251
|
$ sf data bulk results --job-id 7507i000fake341G --target-org my-scratch
|
|
2843
3252
|
```
|
|
2844
3253
|
|
|
2845
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3254
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/bulk/results.ts)_
|
|
2846
3255
|
|
|
2847
3256
|
## `sf data create file`
|
|
2848
3257
|
|
|
@@ -2891,7 +3300,7 @@ EXAMPLES
|
|
|
2891
3300
|
$ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
|
|
2892
3301
|
```
|
|
2893
3302
|
|
|
2894
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3303
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/create/file.ts)_
|
|
2895
3304
|
|
|
2896
3305
|
## `sf data create record`
|
|
2897
3306
|
|
|
@@ -2947,7 +3356,7 @@ EXAMPLES
|
|
|
2947
3356
|
TracedEntityId=01p17000000R6bLAAS"
|
|
2948
3357
|
```
|
|
2949
3358
|
|
|
2950
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3359
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/create/record.ts)_
|
|
2951
3360
|
|
|
2952
3361
|
## `sf data delete bulk`
|
|
2953
3362
|
|
|
@@ -3006,7 +3415,7 @@ FLAG DESCRIPTIONS
|
|
|
3006
3415
|
and can be enabled only by a system administrator.
|
|
3007
3416
|
```
|
|
3008
3417
|
|
|
3009
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3418
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/delete/bulk.ts)_
|
|
3010
3419
|
|
|
3011
3420
|
## `sf data delete record`
|
|
3012
3421
|
|
|
@@ -3067,7 +3476,7 @@ EXAMPLES
|
|
|
3067
3476
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
3068
3477
|
```
|
|
3069
3478
|
|
|
3070
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3479
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/delete/record.ts)_
|
|
3071
3480
|
|
|
3072
3481
|
## `sf data delete resume`
|
|
3073
3482
|
|
|
@@ -3106,7 +3515,7 @@ EXAMPLES
|
|
|
3106
3515
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
3107
3516
|
```
|
|
3108
3517
|
|
|
3109
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3518
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/delete/resume.ts)_
|
|
3110
3519
|
|
|
3111
3520
|
## `sf data export bulk`
|
|
3112
3521
|
|
|
@@ -3173,7 +3582,7 @@ EXAMPLES
|
|
|
3173
3582
|
--result-format json --wait 10 --all-rows
|
|
3174
3583
|
```
|
|
3175
3584
|
|
|
3176
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3585
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/export/bulk.ts)_
|
|
3177
3586
|
|
|
3178
3587
|
## `sf data export resume`
|
|
3179
3588
|
|
|
@@ -3212,7 +3621,7 @@ EXAMPLES
|
|
|
3212
3621
|
$ sf data export resume --use-most-recent
|
|
3213
3622
|
```
|
|
3214
3623
|
|
|
3215
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3624
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/export/resume.ts)_
|
|
3216
3625
|
|
|
3217
3626
|
## `sf data export tree`
|
|
3218
3627
|
|
|
@@ -3272,7 +3681,7 @@ EXAMPLES
|
|
|
3272
3681
|
my-scratch
|
|
3273
3682
|
```
|
|
3274
3683
|
|
|
3275
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3684
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/export/tree.ts)_
|
|
3276
3685
|
|
|
3277
3686
|
## `sf data get record`
|
|
3278
3687
|
|
|
@@ -3336,7 +3745,7 @@ EXAMPLES
|
|
|
3336
3745
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
3337
3746
|
```
|
|
3338
3747
|
|
|
3339
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3748
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/get/record.ts)_
|
|
3340
3749
|
|
|
3341
3750
|
## `sf data import bulk`
|
|
3342
3751
|
|
|
@@ -3388,7 +3797,7 @@ EXAMPLES
|
|
|
3388
3797
|
$ sf data import bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
|
|
3389
3798
|
```
|
|
3390
3799
|
|
|
3391
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3800
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/import/bulk.ts)_
|
|
3392
3801
|
|
|
3393
3802
|
## `sf data import resume`
|
|
3394
3803
|
|
|
@@ -3424,7 +3833,7 @@ EXAMPLES
|
|
|
3424
3833
|
$ sf data import resume --use-most-recent --target-org my-scratch
|
|
3425
3834
|
```
|
|
3426
3835
|
|
|
3427
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3836
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/import/resume.ts)_
|
|
3428
3837
|
|
|
3429
3838
|
## `sf data import tree`
|
|
3430
3839
|
|
|
@@ -3488,7 +3897,7 @@ FLAG DESCRIPTIONS
|
|
|
3488
3897
|
- files(array) - Files: An array of files paths to load
|
|
3489
3898
|
```
|
|
3490
3899
|
|
|
3491
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3900
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/import/tree.ts)_
|
|
3492
3901
|
|
|
3493
3902
|
## `sf data query`
|
|
3494
3903
|
|
|
@@ -3541,7 +3950,7 @@ EXAMPLES
|
|
|
3541
3950
|
$ sf data query --query "SELECT Name FROM ApexTrigger" --use-tooling-api
|
|
3542
3951
|
```
|
|
3543
3952
|
|
|
3544
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3953
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/query.ts)_
|
|
3545
3954
|
|
|
3546
3955
|
## `sf data resume`
|
|
3547
3956
|
|
|
@@ -3578,7 +3987,7 @@ EXAMPLES
|
|
|
3578
3987
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
3579
3988
|
```
|
|
3580
3989
|
|
|
3581
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3990
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/resume.ts)_
|
|
3582
3991
|
|
|
3583
3992
|
## `sf data search`
|
|
3584
3993
|
|
|
@@ -3628,7 +4037,7 @@ EXAMPLES
|
|
|
3628
4037
|
$ sf data search --file query.txt --target-org my-scratch --result-format csv
|
|
3629
4038
|
```
|
|
3630
4039
|
|
|
3631
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
4040
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/search.ts)_
|
|
3632
4041
|
|
|
3633
4042
|
## `sf data update bulk`
|
|
3634
4043
|
|
|
@@ -3683,7 +4092,7 @@ EXAMPLES
|
|
|
3683
4092
|
$ sf data update bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
|
|
3684
4093
|
```
|
|
3685
4094
|
|
|
3686
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
4095
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/update/bulk.ts)_
|
|
3687
4096
|
|
|
3688
4097
|
## `sf data update record`
|
|
3689
4098
|
|
|
@@ -3745,7 +4154,7 @@ EXAMPLES
|
|
|
3745
4154
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
3746
4155
|
```
|
|
3747
4156
|
|
|
3748
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
4157
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/update/record.ts)_
|
|
3749
4158
|
|
|
3750
4159
|
## `sf data update resume`
|
|
3751
4160
|
|
|
@@ -3784,7 +4193,7 @@ EXAMPLES
|
|
|
3784
4193
|
$ sf data update resume --use-most-recent
|
|
3785
4194
|
```
|
|
3786
4195
|
|
|
3787
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
4196
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/update/resume.ts)_
|
|
3788
4197
|
|
|
3789
4198
|
## `sf data upsert bulk`
|
|
3790
4199
|
|
|
@@ -3840,7 +4249,7 @@ EXAMPLES
|
|
|
3840
4249
|
my-scratch
|
|
3841
4250
|
```
|
|
3842
4251
|
|
|
3843
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
4252
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/upsert/bulk.ts)_
|
|
3844
4253
|
|
|
3845
4254
|
## `sf data upsert resume`
|
|
3846
4255
|
|
|
@@ -3879,7 +4288,7 @@ EXAMPLES
|
|
|
3879
4288
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
3880
4289
|
```
|
|
3881
4290
|
|
|
3882
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
4291
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/data/upsert/resume.ts)_
|
|
3883
4292
|
|
|
3884
4293
|
## `sf doctor`
|
|
3885
4294
|
|
|
@@ -3974,7 +4383,7 @@ EXAMPLES
|
|
|
3974
4383
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
3975
4384
|
```
|
|
3976
4385
|
|
|
3977
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
4386
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/force/data/bulk/delete.ts)_
|
|
3978
4387
|
|
|
3979
4388
|
## `sf force data bulk status`
|
|
3980
4389
|
|
|
@@ -4011,7 +4420,7 @@ EXAMPLES
|
|
|
4011
4420
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
4012
4421
|
```
|
|
4013
4422
|
|
|
4014
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
4423
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/force/data/bulk/status.ts)_
|
|
4015
4424
|
|
|
4016
4425
|
## `sf force data bulk upsert`
|
|
4017
4426
|
|
|
@@ -4069,7 +4478,7 @@ EXAMPLES
|
|
|
4069
4478
|
--target-org my-scratch
|
|
4070
4479
|
```
|
|
4071
4480
|
|
|
4072
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
4481
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.106/src/commands/force/data/bulk/upsert.ts)_
|
|
4073
4482
|
|
|
4074
4483
|
## `sf help [COMMAND]`
|
|
4075
4484
|
|
|
@@ -4435,7 +4844,7 @@ EXAMPLES
|
|
|
4435
4844
|
$ sf org auth show-access-token --target-org my-org --json
|
|
4436
4845
|
```
|
|
4437
4846
|
|
|
4438
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
4847
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/auth/show-access-token.ts)_
|
|
4439
4848
|
|
|
4440
4849
|
## `sf org auth show-sfdx-auth-url`
|
|
4441
4850
|
|
|
@@ -4479,7 +4888,7 @@ EXAMPLES
|
|
|
4479
4888
|
$ sf org auth show-sfdx-auth-url --target-org my-org --json
|
|
4480
4889
|
```
|
|
4481
4890
|
|
|
4482
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
4891
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/auth/show-sfdx-auth-url.ts)_
|
|
4483
4892
|
|
|
4484
4893
|
## `sf org auth show-user-password`
|
|
4485
4894
|
|
|
@@ -4526,7 +4935,7 @@ EXAMPLES
|
|
|
4526
4935
|
$ sf org auth show-user-password --target-org my-org --json
|
|
4527
4936
|
```
|
|
4528
4937
|
|
|
4529
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
4938
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/auth/show-user-password.ts)_
|
|
4530
4939
|
|
|
4531
4940
|
## `sf org create agent-user`
|
|
4532
4941
|
|
|
@@ -4604,7 +5013,7 @@ FLAG DESCRIPTIONS
|
|
|
4604
5013
|
"agent.user.<GUID>@your-org-domain.com".
|
|
4605
5014
|
```
|
|
4606
5015
|
|
|
4607
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5016
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/create/agent-user.ts)_
|
|
4608
5017
|
|
|
4609
5018
|
## `sf org create sandbox`
|
|
4610
5019
|
|
|
@@ -4738,7 +5147,7 @@ FLAG DESCRIPTIONS
|
|
|
4738
5147
|
You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
|
|
4739
5148
|
```
|
|
4740
5149
|
|
|
4741
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5150
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/create/sandbox.ts)_
|
|
4742
5151
|
|
|
4743
5152
|
## `sf org create scratch`
|
|
4744
5153
|
|
|
@@ -4920,7 +5329,7 @@ FLAG DESCRIPTIONS
|
|
|
4920
5329
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
4921
5330
|
```
|
|
4922
5331
|
|
|
4923
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5332
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/create/scratch.ts)_
|
|
4924
5333
|
|
|
4925
5334
|
## `sf org create user`
|
|
4926
5335
|
|
|
@@ -5074,7 +5483,7 @@ EXAMPLES
|
|
|
5074
5483
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
5075
5484
|
```
|
|
5076
5485
|
|
|
5077
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5486
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/delete/sandbox.ts)_
|
|
5078
5487
|
|
|
5079
5488
|
## `sf org delete scratch`
|
|
5080
5489
|
|
|
@@ -5118,7 +5527,7 @@ EXAMPLES
|
|
|
5118
5527
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
5119
5528
|
```
|
|
5120
5529
|
|
|
5121
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5530
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/delete/scratch.ts)_
|
|
5122
5531
|
|
|
5123
5532
|
## `sf org disable tracking`
|
|
5124
5533
|
|
|
@@ -5157,7 +5566,7 @@ EXAMPLES
|
|
|
5157
5566
|
$ sf org disable tracking
|
|
5158
5567
|
```
|
|
5159
5568
|
|
|
5160
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5569
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/disable/tracking.ts)_
|
|
5161
5570
|
|
|
5162
5571
|
## `sf org display`
|
|
5163
5572
|
|
|
@@ -5202,7 +5611,7 @@ EXAMPLES
|
|
|
5202
5611
|
$ sf org display --target-org TestOrg1 --verbose
|
|
5203
5612
|
```
|
|
5204
5613
|
|
|
5205
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5614
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/display.ts)_
|
|
5206
5615
|
|
|
5207
5616
|
## `sf org display user`
|
|
5208
5617
|
|
|
@@ -5282,7 +5691,7 @@ EXAMPLES
|
|
|
5282
5691
|
$ sf org enable tracking
|
|
5283
5692
|
```
|
|
5284
5693
|
|
|
5285
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5694
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/enable/tracking.ts)_
|
|
5286
5695
|
|
|
5287
5696
|
## `sf org generate password`
|
|
5288
5697
|
|
|
@@ -5388,7 +5797,7 @@ EXAMPLES
|
|
|
5388
5797
|
$ sf org list --clean
|
|
5389
5798
|
```
|
|
5390
5799
|
|
|
5391
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5800
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/list.ts)_
|
|
5392
5801
|
|
|
5393
5802
|
## `sf org list auth`
|
|
5394
5803
|
|
|
@@ -5527,7 +5936,7 @@ FLAG DESCRIPTIONS
|
|
|
5527
5936
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
5528
5937
|
```
|
|
5529
5938
|
|
|
5530
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5939
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/list/metadata.ts)_
|
|
5531
5940
|
|
|
5532
5941
|
## `sf org list metadata-types`
|
|
5533
5942
|
|
|
@@ -5582,7 +5991,7 @@ FLAG DESCRIPTIONS
|
|
|
5582
5991
|
Override the api version used for api requests made by this command
|
|
5583
5992
|
```
|
|
5584
5993
|
|
|
5585
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
5994
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/list/metadata-types.ts)_
|
|
5586
5995
|
|
|
5587
5996
|
## `sf org list sobject record-counts`
|
|
5588
5997
|
|
|
@@ -6128,7 +6537,7 @@ EXAMPLES
|
|
|
6128
6537
|
$ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
|
|
6129
6538
|
```
|
|
6130
6539
|
|
|
6131
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
6540
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/open.ts)_
|
|
6132
6541
|
|
|
6133
6542
|
## `sf org open agent`
|
|
6134
6543
|
|
|
@@ -6192,7 +6601,7 @@ EXAMPLES
|
|
|
6192
6601
|
$ sf org open agent --authoring-bundle Coral_Cloud_Agent --version 1
|
|
6193
6602
|
```
|
|
6194
6603
|
|
|
6195
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
6604
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/open/agent.ts)_
|
|
6196
6605
|
|
|
6197
6606
|
## `sf org open authoring-bundle`
|
|
6198
6607
|
|
|
@@ -6238,7 +6647,7 @@ EXAMPLES
|
|
|
6238
6647
|
$ sf org open authoring-bundle --target-org MyTestOrg1 --browser firefox
|
|
6239
6648
|
```
|
|
6240
6649
|
|
|
6241
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
6650
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/open/authoring-bundle.ts)_
|
|
6242
6651
|
|
|
6243
6652
|
## `sf org refresh sandbox`
|
|
6244
6653
|
|
|
@@ -6341,7 +6750,7 @@ FLAG DESCRIPTIONS
|
|
|
6341
6750
|
You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
|
|
6342
6751
|
```
|
|
6343
6752
|
|
|
6344
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
6753
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/refresh/sandbox.ts)_
|
|
6345
6754
|
|
|
6346
6755
|
## `sf org resume sandbox`
|
|
6347
6756
|
|
|
@@ -6404,7 +6813,7 @@ FLAG DESCRIPTIONS
|
|
|
6404
6813
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
6405
6814
|
```
|
|
6406
6815
|
|
|
6407
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
6816
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/resume/sandbox.ts)_
|
|
6408
6817
|
|
|
6409
6818
|
## `sf org resume scratch`
|
|
6410
6819
|
|
|
@@ -6457,7 +6866,7 @@ FLAG DESCRIPTIONS
|
|
|
6457
6866
|
returns the job ID. To resume checking the scratch creation, rerun this command.
|
|
6458
6867
|
```
|
|
6459
6868
|
|
|
6460
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
6869
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.11.6/src/commands/org/resume/scratch.ts)_
|
|
6461
6870
|
|
|
6462
6871
|
## `sf package convert`
|
|
6463
6872
|
|
|
@@ -10518,7 +10927,7 @@ FLAG DESCRIPTIONS
|
|
|
10518
10927
|
directory.
|
|
10519
10928
|
```
|
|
10520
10929
|
|
|
10521
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10930
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/analytics/template.ts)_
|
|
10522
10931
|
|
|
10523
10932
|
## `sf template generate apex class`
|
|
10524
10933
|
|
|
@@ -10578,7 +10987,7 @@ FLAG DESCRIPTIONS
|
|
|
10578
10987
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
10579
10988
|
```
|
|
10580
10989
|
|
|
10581
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
10990
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/apex/class.ts)_
|
|
10582
10991
|
|
|
10583
10992
|
## `sf template generate apex trigger`
|
|
10584
10993
|
|
|
@@ -10648,7 +11057,7 @@ FLAG DESCRIPTIONS
|
|
|
10648
11057
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
10649
11058
|
```
|
|
10650
11059
|
|
|
10651
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11060
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/apex/trigger.ts)_
|
|
10652
11061
|
|
|
10653
11062
|
## `sf template generate digital-experience site`
|
|
10654
11063
|
|
|
@@ -10702,7 +11111,7 @@ FLAG DESCRIPTIONS
|
|
|
10702
11111
|
project, defaults to the current directory.
|
|
10703
11112
|
```
|
|
10704
11113
|
|
|
10705
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11114
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/digital-experience/site.ts)_
|
|
10706
11115
|
|
|
10707
11116
|
## `sf template generate flexipage`
|
|
10708
11117
|
|
|
@@ -10784,7 +11193,7 @@ FLAG DESCRIPTIONS
|
|
|
10784
11193
|
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
|
|
10785
11194
|
```
|
|
10786
11195
|
|
|
10787
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11196
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/flexipage/index.ts)_
|
|
10788
11197
|
|
|
10789
11198
|
## `sf template generate lightning app`
|
|
10790
11199
|
|
|
@@ -10842,7 +11251,7 @@ FLAG DESCRIPTIONS
|
|
|
10842
11251
|
field in the DX project's "sfdx-project.json" file.
|
|
10843
11252
|
```
|
|
10844
11253
|
|
|
10845
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11254
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/app.ts)_
|
|
10846
11255
|
|
|
10847
11256
|
## `sf template generate lightning component`
|
|
10848
11257
|
|
|
@@ -10919,7 +11328,7 @@ FLAG DESCRIPTIONS
|
|
|
10919
11328
|
field in the DX project's "sfdx-project.json" file.
|
|
10920
11329
|
```
|
|
10921
11330
|
|
|
10922
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11331
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/component.ts)_
|
|
10923
11332
|
|
|
10924
11333
|
## `sf template generate lightning event`
|
|
10925
11334
|
|
|
@@ -10977,7 +11386,7 @@ FLAG DESCRIPTIONS
|
|
|
10977
11386
|
field in the DX project's "sfdx-project.json" file.
|
|
10978
11387
|
```
|
|
10979
11388
|
|
|
10980
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11389
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/event.ts)_
|
|
10981
11390
|
|
|
10982
11391
|
## `sf template generate lightning interface`
|
|
10983
11392
|
|
|
@@ -11035,7 +11444,7 @@ FLAG DESCRIPTIONS
|
|
|
11035
11444
|
field in the DX project's "sfdx-project.json" file.
|
|
11036
11445
|
```
|
|
11037
11446
|
|
|
11038
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11447
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/interface.ts)_
|
|
11039
11448
|
|
|
11040
11449
|
## `sf template generate lightning test`
|
|
11041
11450
|
|
|
@@ -11093,7 +11502,7 @@ FLAG DESCRIPTIONS
|
|
|
11093
11502
|
field in the DX project's "sfdx-project.json" file.
|
|
11094
11503
|
```
|
|
11095
11504
|
|
|
11096
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11505
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/lightning/test.ts)_
|
|
11097
11506
|
|
|
11098
11507
|
## `sf template generate project`
|
|
11099
11508
|
|
|
@@ -11219,7 +11628,7 @@ FLAG DESCRIPTIONS
|
|
|
11219
11628
|
server-side type stripping.
|
|
11220
11629
|
```
|
|
11221
11630
|
|
|
11222
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11631
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/project/index.ts)_
|
|
11223
11632
|
|
|
11224
11633
|
## `sf template generate static-resource`
|
|
11225
11634
|
|
|
@@ -11282,7 +11691,7 @@ FLAG DESCRIPTIONS
|
|
|
11282
11691
|
etc.
|
|
11283
11692
|
```
|
|
11284
11693
|
|
|
11285
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11694
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/static-resource/index.ts)_
|
|
11286
11695
|
|
|
11287
11696
|
## `sf template generate ui-bundle`
|
|
11288
11697
|
|
|
@@ -11366,7 +11775,7 @@ FLAG DESCRIPTIONS
|
|
|
11366
11775
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
11367
11776
|
```
|
|
11368
11777
|
|
|
11369
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11778
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/ui-bundle/index.ts)_
|
|
11370
11779
|
|
|
11371
11780
|
## `sf template generate visualforce component`
|
|
11372
11781
|
|
|
@@ -11423,7 +11832,7 @@ FLAG DESCRIPTIONS
|
|
|
11423
11832
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
11424
11833
|
```
|
|
11425
11834
|
|
|
11426
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11835
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/visualforce/component.ts)_
|
|
11427
11836
|
|
|
11428
11837
|
## `sf template generate visualforce page`
|
|
11429
11838
|
|
|
@@ -11474,7 +11883,7 @@ FLAG DESCRIPTIONS
|
|
|
11474
11883
|
The name can be up to 40 characters and must start with a letter.
|
|
11475
11884
|
```
|
|
11476
11885
|
|
|
11477
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
11886
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.18.0/src/commands/template/generate/visualforce/page.ts)_
|
|
11478
11887
|
|
|
11479
11888
|
## `sf update [CHANNEL]`
|
|
11480
11889
|
|
|
@@ -11512,7 +11921,7 @@ EXAMPLES
|
|
|
11512
11921
|
$ sf update --available
|
|
11513
11922
|
```
|
|
11514
11923
|
|
|
11515
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.7.
|
|
11924
|
+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.7.46/src/commands/update.ts)_
|
|
11516
11925
|
|
|
11517
11926
|
## `sf version`
|
|
11518
11927
|
|