@salesforce/plugin-deploy-retrieve 3.8.4 → 3.9.1
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 +47 -45
- package/lib/commands/project/convert/source-behavior.d.ts +4 -4
- package/lib/commands/project/convert/source.d.ts +5 -5
- package/lib/commands/project/delete/tracking.d.ts +4 -4
- package/lib/commands/project/deploy/cancel.d.ts +5 -5
- package/lib/commands/project/deploy/preview.d.ts +6 -6
- package/lib/commands/project/deploy/quick.d.ts +8 -8
- package/lib/commands/project/deploy/report.d.ts +7 -7
- package/lib/commands/project/deploy/resume.d.ts +8 -8
- package/lib/commands/project/deploy/start.d.ts +23 -23
- package/lib/commands/project/deploy/validate.d.ts +20 -20
- package/lib/commands/project/generate/manifest.d.ts +9 -9
- package/lib/commands/project/list/ignored.d.ts +1 -1
- package/lib/commands/project/reset/tracking.d.ts +5 -5
- package/lib/commands/project/retrieve/preview.d.ts +3 -3
- package/lib/formatters/asyncDeployCancelResultFormatter.js +2 -1
- package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
- package/lib/formatters/asyncDeployResultFormatter.js +2 -1
- package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
- package/lib/formatters/deleteResultFormatter.js +6 -7
- package/lib/formatters/deleteResultFormatter.js.map +1 -1
- package/lib/formatters/deployCancelResultFormatter.js +4 -2
- package/lib/formatters/deployCancelResultFormatter.js.map +1 -1
- package/lib/formatters/deployReportResultFormatter.js +2 -1
- package/lib/formatters/deployReportResultFormatter.js.map +1 -1
- package/lib/formatters/deployResultFormatter.js +4 -3
- package/lib/formatters/deployResultFormatter.js.map +1 -1
- package/lib/formatters/metadataConvertResultFormatter.js +3 -2
- package/lib/formatters/metadataConvertResultFormatter.js.map +1 -1
- package/lib/formatters/metadataRetrieveResultFormatter.js +2 -1
- package/lib/formatters/metadataRetrieveResultFormatter.js.map +1 -1
- package/lib/formatters/retrieveResultFormatter.js +1 -1
- package/lib/formatters/retrieveResultFormatter.js.map +1 -1
- package/lib/formatters/sourceConvertResultFormatter.js +2 -1
- package/lib/formatters/sourceConvertResultFormatter.js.map +1 -1
- package/lib/formatters/testResultsFormatter.js +3 -2
- package/lib/formatters/testResultsFormatter.js.map +1 -1
- package/lib/utils/conflicts.js +2 -1
- package/lib/utils/conflicts.js.map +1 -1
- package/lib/utils/flags.d.ts +6 -6
- package/lib/utils/previewOutput.js +2 -1
- package/lib/utils/previewOutput.js.map +1 -1
- package/lib/utils/progressBar.js +3 -3
- package/lib/utils/progressBar.js.map +1 -1
- package/messages/convert.mdapi.md +2 -2
- package/messages/convert.source.md +4 -4
- package/messages/delete.source.md +5 -5
- package/messages/delete.tracking.md +4 -4
- package/messages/deploy.metadata.cancel.md +8 -8
- package/messages/deploy.metadata.md +15 -15
- package/messages/deploy.metadata.preview.md +7 -7
- package/messages/deploy.metadata.quick.md +6 -6
- package/messages/deploy.metadata.report.md +7 -7
- package/messages/deploy.metadata.resume.md +7 -7
- package/messages/deploy.metadata.validate.md +9 -9
- package/messages/list.ignored.md +3 -3
- package/messages/manifest.generate.md +4 -4
- package/messages/retrieve.metadata.preview.md +4 -4
- package/messages/retrieve.start.md +16 -16
- package/oclif.manifest.json +508 -508
- package/package.json +8 -8
package/oclif.manifest.json
CHANGED
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
"deprecateAliases": true,
|
|
9
9
|
"description": "To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using this command.\n\nTo convert files from the source format back to the metadata format, run \"sf project convert source\".\n\nTo convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
10
10
|
"examples": [
|
|
11
|
-
"Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:\n$
|
|
12
|
-
"Similar to previous example, but writes converted files to the specified output directory:\n$
|
|
11
|
+
"Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata",
|
|
12
|
+
"Similar to previous example, but writes converted files to the specified output directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir"
|
|
13
13
|
],
|
|
14
14
|
"flags": {
|
|
15
15
|
"json": {
|
|
@@ -246,10 +246,10 @@
|
|
|
246
246
|
],
|
|
247
247
|
"args": {},
|
|
248
248
|
"deprecateAliases": true,
|
|
249
|
-
"description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"
|
|
249
|
+
"description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.\n\nTo convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
250
250
|
"examples": [
|
|
251
|
-
"Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$
|
|
252
|
-
"Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$
|
|
251
|
+
"Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source",
|
|
252
|
+
"Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
|
|
253
253
|
],
|
|
254
254
|
"flags": {
|
|
255
255
|
"json": {
|
|
@@ -309,7 +309,7 @@
|
|
|
309
309
|
"deprecateAliases": true,
|
|
310
310
|
"name": "output-dir",
|
|
311
311
|
"summary": "Output directory to store the Metadata API–formatted files in.",
|
|
312
|
-
"default": "
|
|
312
|
+
"default": "metadataPackage_1717814994951",
|
|
313
313
|
"hasDynamicHelp": false,
|
|
314
314
|
"multiple": false,
|
|
315
315
|
"type": "option"
|
|
@@ -402,18 +402,16 @@
|
|
|
402
402
|
"source:convert:project"
|
|
403
403
|
]
|
|
404
404
|
},
|
|
405
|
-
"project:
|
|
405
|
+
"project:deploy:cancel": {
|
|
406
406
|
"aliases": [
|
|
407
|
-
"
|
|
407
|
+
"deploy:metadata:cancel"
|
|
408
408
|
],
|
|
409
409
|
"args": {},
|
|
410
410
|
"deprecateAliases": true,
|
|
411
|
-
"description": "Use this command to
|
|
411
|
+
"description": "Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
412
412
|
"examples": [
|
|
413
|
-
"
|
|
414
|
-
"
|
|
415
|
-
"Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:\nsf <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
|
|
416
|
-
"Delete the Apex source files in a directory and the corresponding components from your default org:\nsf <%= command.id %> --source-dir force-app/main/default/classes"
|
|
413
|
+
"Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
414
|
+
"Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
417
415
|
],
|
|
418
416
|
"flags": {
|
|
419
417
|
"json": {
|
|
@@ -431,206 +429,103 @@
|
|
|
431
429
|
"multiple": false,
|
|
432
430
|
"type": "option"
|
|
433
431
|
},
|
|
434
|
-
"api-version": {
|
|
435
|
-
"aliases": [
|
|
436
|
-
"apiversion"
|
|
437
|
-
],
|
|
438
|
-
"deprecateAliases": true,
|
|
439
|
-
"description": "Override the api version used for api requests made by this command",
|
|
440
|
-
"name": "api-version",
|
|
441
|
-
"hasDynamicHelp": false,
|
|
442
|
-
"multiple": false,
|
|
443
|
-
"type": "option"
|
|
444
|
-
},
|
|
445
|
-
"loglevel": {
|
|
446
|
-
"deprecated": {
|
|
447
|
-
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
448
|
-
},
|
|
449
|
-
"hidden": true,
|
|
450
|
-
"name": "loglevel",
|
|
451
|
-
"hasDynamicHelp": false,
|
|
452
|
-
"multiple": false,
|
|
453
|
-
"type": "option"
|
|
454
|
-
},
|
|
455
432
|
"target-org": {
|
|
456
|
-
"aliases": [
|
|
457
|
-
"targetusername",
|
|
458
|
-
"u"
|
|
459
|
-
],
|
|
460
433
|
"char": "o",
|
|
461
|
-
"deprecateAliases": true,
|
|
462
434
|
"name": "target-org",
|
|
463
435
|
"noCacheDefault": true,
|
|
464
|
-
"
|
|
465
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
436
|
+
"summary": "Username or alias of the target org.",
|
|
466
437
|
"hasDynamicHelp": true,
|
|
467
438
|
"multiple": false,
|
|
468
439
|
"type": "option"
|
|
469
440
|
},
|
|
470
|
-
"
|
|
471
|
-
"
|
|
472
|
-
|
|
441
|
+
"async": {
|
|
442
|
+
"description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
|
|
443
|
+
"exclusive": [
|
|
444
|
+
"wait"
|
|
473
445
|
],
|
|
474
|
-
"
|
|
475
|
-
"
|
|
476
|
-
"description": "IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.\n\nIf your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.\n\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n\n 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.\n\n 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.",
|
|
477
|
-
"name": "check-only",
|
|
478
|
-
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
446
|
+
"name": "async",
|
|
447
|
+
"summary": "Run the command asynchronously.",
|
|
479
448
|
"allowNo": false,
|
|
480
449
|
"type": "boolean"
|
|
481
450
|
},
|
|
482
|
-
"
|
|
483
|
-
"char": "
|
|
484
|
-
"description": "
|
|
485
|
-
"name": "
|
|
486
|
-
"summary": "
|
|
487
|
-
"hasDynamicHelp": true,
|
|
488
|
-
"multiple": false,
|
|
489
|
-
"type": "option"
|
|
490
|
-
},
|
|
491
|
-
"tests": {
|
|
492
|
-
"description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
|
|
493
|
-
"helpGroup": "Test",
|
|
494
|
-
"name": "tests",
|
|
495
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
496
|
-
"hasDynamicHelp": false,
|
|
497
|
-
"multiple": true,
|
|
498
|
-
"type": "option"
|
|
499
|
-
},
|
|
500
|
-
"test-level": {
|
|
501
|
-
"aliases": [
|
|
502
|
-
"testlevel"
|
|
503
|
-
],
|
|
504
|
-
"char": "l",
|
|
505
|
-
"deprecateAliases": true,
|
|
506
|
-
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
|
|
507
|
-
"helpGroup": "Test",
|
|
508
|
-
"name": "test-level",
|
|
509
|
-
"summary": "Deployment Apex testing level.",
|
|
451
|
+
"job-id": {
|
|
452
|
+
"char": "i",
|
|
453
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
454
|
+
"name": "job-id",
|
|
455
|
+
"summary": "Job ID of the deploy operation you want to cancel.",
|
|
510
456
|
"hasDynamicHelp": false,
|
|
511
457
|
"multiple": false,
|
|
512
|
-
"options": [
|
|
513
|
-
"NoTestRun",
|
|
514
|
-
"RunSpecifiedTests",
|
|
515
|
-
"RunLocalTests",
|
|
516
|
-
"RunAllTestsInOrg"
|
|
517
|
-
],
|
|
518
458
|
"type": "option"
|
|
519
459
|
},
|
|
520
|
-
"
|
|
521
|
-
"aliases": [
|
|
522
|
-
"noprompt"
|
|
523
|
-
],
|
|
460
|
+
"use-most-recent": {
|
|
524
461
|
"char": "r",
|
|
525
|
-
"
|
|
526
|
-
"name": "
|
|
527
|
-
"summary": "
|
|
462
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.",
|
|
463
|
+
"name": "use-most-recent",
|
|
464
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
528
465
|
"allowNo": false,
|
|
529
466
|
"type": "boolean"
|
|
530
467
|
},
|
|
531
|
-
"
|
|
532
|
-
"char": "
|
|
533
|
-
"description": "If you
|
|
534
|
-
"name": "metadata",
|
|
535
|
-
"summary": "Metadata components to delete.",
|
|
536
|
-
"delimiter": ",",
|
|
537
|
-
"hasDynamicHelp": false,
|
|
538
|
-
"multiple": true,
|
|
539
|
-
"type": "option"
|
|
540
|
-
},
|
|
541
|
-
"source-dir": {
|
|
542
|
-
"aliases": [
|
|
543
|
-
"sourcepath"
|
|
544
|
-
],
|
|
545
|
-
"char": "p",
|
|
546
|
-
"deprecateAliases": true,
|
|
547
|
-
"description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this parameter, don’t specify --metadata.",
|
|
548
|
-
"name": "source-dir",
|
|
549
|
-
"summary": "Source file paths to delete.",
|
|
550
|
-
"delimiter": ",",
|
|
551
|
-
"hasDynamicHelp": false,
|
|
552
|
-
"multiple": true,
|
|
553
|
-
"type": "option"
|
|
554
|
-
},
|
|
555
|
-
"track-source": {
|
|
556
|
-
"aliases": [
|
|
557
|
-
"tracksource"
|
|
558
|
-
],
|
|
559
|
-
"char": "t",
|
|
560
|
-
"deprecateAliases": true,
|
|
468
|
+
"wait": {
|
|
469
|
+
"char": "w",
|
|
470
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
|
|
561
471
|
"exclusive": [
|
|
562
|
-
"
|
|
563
|
-
],
|
|
564
|
-
"name": "track-source",
|
|
565
|
-
"summary": "If the delete succeeds, update the source tracking information.",
|
|
566
|
-
"allowNo": false,
|
|
567
|
-
"type": "boolean"
|
|
568
|
-
},
|
|
569
|
-
"force-overwrite": {
|
|
570
|
-
"aliases": [
|
|
571
|
-
"forceoverwrite"
|
|
572
|
-
],
|
|
573
|
-
"char": "f",
|
|
574
|
-
"dependsOn": [
|
|
575
|
-
"track-source"
|
|
472
|
+
"async"
|
|
576
473
|
],
|
|
577
|
-
"
|
|
578
|
-
"
|
|
579
|
-
"
|
|
580
|
-
"
|
|
581
|
-
"
|
|
582
|
-
|
|
583
|
-
"verbose": {
|
|
584
|
-
"name": "verbose",
|
|
585
|
-
"summary": "Verbose output of the delete result.",
|
|
586
|
-
"allowNo": false,
|
|
587
|
-
"type": "boolean"
|
|
474
|
+
"name": "wait",
|
|
475
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
476
|
+
"hasDynamicHelp": true,
|
|
477
|
+
"helpValue": "<minutes>",
|
|
478
|
+
"multiple": false,
|
|
479
|
+
"type": "option"
|
|
588
480
|
}
|
|
589
481
|
},
|
|
590
482
|
"hasDynamicHelp": true,
|
|
591
483
|
"hiddenAliases": [],
|
|
592
|
-
"id": "project:
|
|
484
|
+
"id": "project:deploy:cancel",
|
|
593
485
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
594
486
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
595
487
|
"pluginType": "core",
|
|
596
488
|
"strict": true,
|
|
597
|
-
"summary": "
|
|
489
|
+
"summary": "Cancel a deploy operation.",
|
|
598
490
|
"enableJsonFlag": true,
|
|
599
|
-
"requiresProject": true,
|
|
600
491
|
"isESM": true,
|
|
601
492
|
"relativePath": [
|
|
602
493
|
"lib",
|
|
603
494
|
"commands",
|
|
604
495
|
"project",
|
|
605
|
-
"
|
|
606
|
-
"
|
|
496
|
+
"deploy",
|
|
497
|
+
"cancel.js"
|
|
607
498
|
],
|
|
608
499
|
"aliasPermutations": [
|
|
609
|
-
"
|
|
610
|
-
"
|
|
611
|
-
"
|
|
612
|
-
"
|
|
613
|
-
"
|
|
614
|
-
"
|
|
500
|
+
"deploy:metadata:cancel",
|
|
501
|
+
"metadata:deploy:cancel",
|
|
502
|
+
"metadata:cancel:deploy",
|
|
503
|
+
"deploy:cancel:metadata",
|
|
504
|
+
"cancel:deploy:metadata",
|
|
505
|
+
"cancel:metadata:deploy"
|
|
615
506
|
],
|
|
616
507
|
"permutations": [
|
|
617
|
-
"project:
|
|
618
|
-
"
|
|
619
|
-
"
|
|
620
|
-
"project:
|
|
621
|
-
"
|
|
622
|
-
"
|
|
508
|
+
"project:deploy:cancel",
|
|
509
|
+
"deploy:project:cancel",
|
|
510
|
+
"deploy:cancel:project",
|
|
511
|
+
"project:cancel:deploy",
|
|
512
|
+
"cancel:project:deploy",
|
|
513
|
+
"cancel:deploy:project"
|
|
623
514
|
]
|
|
624
515
|
},
|
|
625
|
-
"project:
|
|
516
|
+
"project:deploy:preview": {
|
|
626
517
|
"aliases": [
|
|
627
|
-
"
|
|
518
|
+
"deploy:metadata:preview"
|
|
628
519
|
],
|
|
629
520
|
"args": {},
|
|
630
521
|
"deprecateAliases": true,
|
|
631
|
-
"description": "
|
|
522
|
+
"description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"<%= config.bin %> project deploy start\" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
632
523
|
"examples": [
|
|
633
|
-
"
|
|
524
|
+
"NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for \"<%= config.bin %> project deploy start\" for more examples that you can adapt for previewing.",
|
|
525
|
+
"Preview the deployment of source files in a directory, such as force-app, to your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
526
|
+
"Preview the deployment of all Apex classes to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
|
|
527
|
+
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
528
|
+
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
634
529
|
],
|
|
635
530
|
"flags": {
|
|
636
531
|
"json": {
|
|
@@ -648,295 +543,53 @@
|
|
|
648
543
|
"multiple": false,
|
|
649
544
|
"type": "option"
|
|
650
545
|
},
|
|
651
|
-
"
|
|
652
|
-
"
|
|
653
|
-
|
|
546
|
+
"ignore-conflicts": {
|
|
547
|
+
"char": "c",
|
|
548
|
+
"description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
|
|
549
|
+
"name": "ignore-conflicts",
|
|
550
|
+
"summary": "Don't display conflicts in preview of the deployment.",
|
|
551
|
+
"allowNo": false,
|
|
552
|
+
"type": "boolean"
|
|
553
|
+
},
|
|
554
|
+
"manifest": {
|
|
555
|
+
"char": "x",
|
|
556
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
557
|
+
"exclusive": [
|
|
558
|
+
"source-dir",
|
|
559
|
+
"metadata"
|
|
654
560
|
],
|
|
655
|
-
"
|
|
656
|
-
"
|
|
657
|
-
"name": "api-version",
|
|
561
|
+
"name": "manifest",
|
|
562
|
+
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
658
563
|
"hasDynamicHelp": false,
|
|
659
564
|
"multiple": false,
|
|
660
565
|
"type": "option"
|
|
661
566
|
},
|
|
662
|
-
"
|
|
663
|
-
"
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
567
|
+
"metadata": {
|
|
568
|
+
"char": "m",
|
|
569
|
+
"exclusive": [
|
|
570
|
+
"manifest",
|
|
571
|
+
"source-dir"
|
|
572
|
+
],
|
|
573
|
+
"name": "metadata",
|
|
574
|
+
"summary": "Metadata component names to preview.",
|
|
668
575
|
"hasDynamicHelp": false,
|
|
669
|
-
"multiple":
|
|
576
|
+
"multiple": true,
|
|
670
577
|
"type": "option"
|
|
671
578
|
},
|
|
672
|
-
"
|
|
673
|
-
"
|
|
674
|
-
|
|
675
|
-
|
|
579
|
+
"source-dir": {
|
|
580
|
+
"char": "d",
|
|
581
|
+
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
582
|
+
"exclusive": [
|
|
583
|
+
"manifest",
|
|
584
|
+
"metadata"
|
|
676
585
|
],
|
|
677
|
-
"
|
|
678
|
-
"
|
|
679
|
-
"
|
|
680
|
-
"
|
|
681
|
-
"
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
"multiple": false,
|
|
685
|
-
"type": "option"
|
|
686
|
-
},
|
|
687
|
-
"no-prompt": {
|
|
688
|
-
"aliases": [
|
|
689
|
-
"noprompt"
|
|
690
|
-
],
|
|
691
|
-
"char": "p",
|
|
692
|
-
"deprecateAliases": true,
|
|
693
|
-
"name": "no-prompt",
|
|
694
|
-
"summary": "Don't prompt for source tracking override confirmation.",
|
|
695
|
-
"allowNo": false,
|
|
696
|
-
"type": "boolean"
|
|
697
|
-
}
|
|
698
|
-
},
|
|
699
|
-
"hasDynamicHelp": true,
|
|
700
|
-
"hiddenAliases": [],
|
|
701
|
-
"id": "project:delete:tracking",
|
|
702
|
-
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
703
|
-
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
704
|
-
"pluginType": "core",
|
|
705
|
-
"strict": true,
|
|
706
|
-
"summary": "Delete all local source tracking information.",
|
|
707
|
-
"enableJsonFlag": true,
|
|
708
|
-
"requiresProject": true,
|
|
709
|
-
"isESM": true,
|
|
710
|
-
"relativePath": [
|
|
711
|
-
"lib",
|
|
712
|
-
"commands",
|
|
713
|
-
"project",
|
|
714
|
-
"delete",
|
|
715
|
-
"tracking.js"
|
|
716
|
-
],
|
|
717
|
-
"aliasPermutations": [
|
|
718
|
-
"force:source:tracking:clear",
|
|
719
|
-
"source:force:tracking:clear",
|
|
720
|
-
"source:tracking:force:clear",
|
|
721
|
-
"source:tracking:clear:force",
|
|
722
|
-
"force:tracking:source:clear",
|
|
723
|
-
"tracking:force:source:clear",
|
|
724
|
-
"tracking:source:force:clear",
|
|
725
|
-
"tracking:source:clear:force",
|
|
726
|
-
"force:tracking:clear:source",
|
|
727
|
-
"tracking:force:clear:source",
|
|
728
|
-
"tracking:clear:force:source",
|
|
729
|
-
"tracking:clear:source:force",
|
|
730
|
-
"force:source:clear:tracking",
|
|
731
|
-
"source:force:clear:tracking",
|
|
732
|
-
"source:clear:force:tracking",
|
|
733
|
-
"source:clear:tracking:force",
|
|
734
|
-
"force:clear:source:tracking",
|
|
735
|
-
"clear:force:source:tracking",
|
|
736
|
-
"clear:source:force:tracking",
|
|
737
|
-
"clear:source:tracking:force",
|
|
738
|
-
"force:clear:tracking:source",
|
|
739
|
-
"clear:force:tracking:source",
|
|
740
|
-
"clear:tracking:force:source",
|
|
741
|
-
"clear:tracking:source:force"
|
|
742
|
-
],
|
|
743
|
-
"permutations": [
|
|
744
|
-
"project:delete:tracking",
|
|
745
|
-
"delete:project:tracking",
|
|
746
|
-
"delete:tracking:project",
|
|
747
|
-
"project:tracking:delete",
|
|
748
|
-
"tracking:project:delete",
|
|
749
|
-
"tracking:delete:project"
|
|
750
|
-
]
|
|
751
|
-
},
|
|
752
|
-
"project:deploy:cancel": {
|
|
753
|
-
"aliases": [
|
|
754
|
-
"deploy:metadata:cancel"
|
|
755
|
-
],
|
|
756
|
-
"args": {},
|
|
757
|
-
"deprecateAliases": true,
|
|
758
|
-
"description": "Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
759
|
-
"examples": [
|
|
760
|
-
"Cancel a deploy operation using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
761
|
-
"Cancel the most recent deploy operation:\nsf <%= command.id %> --use-most-recent"
|
|
762
|
-
],
|
|
763
|
-
"flags": {
|
|
764
|
-
"json": {
|
|
765
|
-
"description": "Format output as json.",
|
|
766
|
-
"helpGroup": "GLOBAL",
|
|
767
|
-
"name": "json",
|
|
768
|
-
"allowNo": false,
|
|
769
|
-
"type": "boolean"
|
|
770
|
-
},
|
|
771
|
-
"flags-dir": {
|
|
772
|
-
"helpGroup": "GLOBAL",
|
|
773
|
-
"name": "flags-dir",
|
|
774
|
-
"summary": "Import flag values from a directory.",
|
|
775
|
-
"hasDynamicHelp": false,
|
|
776
|
-
"multiple": false,
|
|
777
|
-
"type": "option"
|
|
778
|
-
},
|
|
779
|
-
"target-org": {
|
|
780
|
-
"char": "o",
|
|
781
|
-
"name": "target-org",
|
|
782
|
-
"noCacheDefault": true,
|
|
783
|
-
"summary": "Username or alias of the target org.",
|
|
784
|
-
"hasDynamicHelp": true,
|
|
785
|
-
"multiple": false,
|
|
786
|
-
"type": "option"
|
|
787
|
-
},
|
|
788
|
-
"async": {
|
|
789
|
-
"description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run \"sf project deploy resume\". To check the status of the cancellation, run \"sf project deploy report\".",
|
|
790
|
-
"exclusive": [
|
|
791
|
-
"wait"
|
|
792
|
-
],
|
|
793
|
-
"name": "async",
|
|
794
|
-
"summary": "Run the command asynchronously.",
|
|
795
|
-
"allowNo": false,
|
|
796
|
-
"type": "boolean"
|
|
797
|
-
},
|
|
798
|
-
"job-id": {
|
|
799
|
-
"char": "i",
|
|
800
|
-
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy start\n- sf project deploy validate\n- sf project deploy quick\n- sf project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
801
|
-
"name": "job-id",
|
|
802
|
-
"summary": "Job ID of the deploy operation you want to cancel.",
|
|
803
|
-
"hasDynamicHelp": false,
|
|
804
|
-
"multiple": false,
|
|
805
|
-
"type": "option"
|
|
806
|
-
},
|
|
807
|
-
"use-most-recent": {
|
|
808
|
-
"char": "r",
|
|
809
|
-
"description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.",
|
|
810
|
-
"name": "use-most-recent",
|
|
811
|
-
"summary": "Use the job ID of the most recent deploy operation.",
|
|
812
|
-
"allowNo": false,
|
|
813
|
-
"type": "boolean"
|
|
814
|
-
},
|
|
815
|
-
"wait": {
|
|
816
|
-
"char": "w",
|
|
817
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run \"sf project deploy resume\". To check the status of the cancellation, run \"sf project deploy report\".",
|
|
818
|
-
"exclusive": [
|
|
819
|
-
"async"
|
|
820
|
-
],
|
|
821
|
-
"name": "wait",
|
|
822
|
-
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
823
|
-
"hasDynamicHelp": true,
|
|
824
|
-
"helpValue": "<minutes>",
|
|
825
|
-
"multiple": false,
|
|
826
|
-
"type": "option"
|
|
827
|
-
}
|
|
828
|
-
},
|
|
829
|
-
"hasDynamicHelp": true,
|
|
830
|
-
"hiddenAliases": [],
|
|
831
|
-
"id": "project:deploy:cancel",
|
|
832
|
-
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
833
|
-
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
834
|
-
"pluginType": "core",
|
|
835
|
-
"strict": true,
|
|
836
|
-
"summary": "Cancel a deploy operation.",
|
|
837
|
-
"enableJsonFlag": true,
|
|
838
|
-
"isESM": true,
|
|
839
|
-
"relativePath": [
|
|
840
|
-
"lib",
|
|
841
|
-
"commands",
|
|
842
|
-
"project",
|
|
843
|
-
"deploy",
|
|
844
|
-
"cancel.js"
|
|
845
|
-
],
|
|
846
|
-
"aliasPermutations": [
|
|
847
|
-
"deploy:metadata:cancel",
|
|
848
|
-
"metadata:deploy:cancel",
|
|
849
|
-
"metadata:cancel:deploy",
|
|
850
|
-
"deploy:cancel:metadata",
|
|
851
|
-
"cancel:deploy:metadata",
|
|
852
|
-
"cancel:metadata:deploy"
|
|
853
|
-
],
|
|
854
|
-
"permutations": [
|
|
855
|
-
"project:deploy:cancel",
|
|
856
|
-
"deploy:project:cancel",
|
|
857
|
-
"deploy:cancel:project",
|
|
858
|
-
"project:cancel:deploy",
|
|
859
|
-
"cancel:project:deploy",
|
|
860
|
-
"cancel:deploy:project"
|
|
861
|
-
]
|
|
862
|
-
},
|
|
863
|
-
"project:deploy:preview": {
|
|
864
|
-
"aliases": [
|
|
865
|
-
"deploy:metadata:preview"
|
|
866
|
-
],
|
|
867
|
-
"args": {},
|
|
868
|
-
"deprecateAliases": true,
|
|
869
|
-
"description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"sf project deploy start\" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"sf org create scratch|sandbox\" commands.\n\nTo preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
870
|
-
"examples": [
|
|
871
|
-
"NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for \"sf project deploy start\" for more examples that you can adapt for previewing.",
|
|
872
|
-
"Preview the deployment of source files in a directory, such as force-app, to your default org:\nsf <%= command.id %> --source-dir force-app",
|
|
873
|
-
"Preview the deployment of all Apex classes to an org with alias \"my-scratch\":\nsf <%= command.id %> --metadata ApexClass --target-org my-scratch",
|
|
874
|
-
"Preview deployment of a specific Apex class:\nsf <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
875
|
-
"Preview deployment of all components listed in a manifest:\nsf <%= command.id %> --manifest path/to/package.xml"
|
|
876
|
-
],
|
|
877
|
-
"flags": {
|
|
878
|
-
"json": {
|
|
879
|
-
"description": "Format output as json.",
|
|
880
|
-
"helpGroup": "GLOBAL",
|
|
881
|
-
"name": "json",
|
|
882
|
-
"allowNo": false,
|
|
883
|
-
"type": "boolean"
|
|
884
|
-
},
|
|
885
|
-
"flags-dir": {
|
|
886
|
-
"helpGroup": "GLOBAL",
|
|
887
|
-
"name": "flags-dir",
|
|
888
|
-
"summary": "Import flag values from a directory.",
|
|
889
|
-
"hasDynamicHelp": false,
|
|
890
|
-
"multiple": false,
|
|
891
|
-
"type": "option"
|
|
892
|
-
},
|
|
893
|
-
"ignore-conflicts": {
|
|
894
|
-
"char": "c",
|
|
895
|
-
"description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
|
|
896
|
-
"name": "ignore-conflicts",
|
|
897
|
-
"summary": "Don't display conflicts in preview of the deployment.",
|
|
898
|
-
"allowNo": false,
|
|
899
|
-
"type": "boolean"
|
|
900
|
-
},
|
|
901
|
-
"manifest": {
|
|
902
|
-
"char": "x",
|
|
903
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
904
|
-
"exclusive": [
|
|
905
|
-
"source-dir",
|
|
906
|
-
"metadata"
|
|
907
|
-
],
|
|
908
|
-
"name": "manifest",
|
|
909
|
-
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
910
|
-
"hasDynamicHelp": false,
|
|
911
|
-
"multiple": false,
|
|
912
|
-
"type": "option"
|
|
913
|
-
},
|
|
914
|
-
"metadata": {
|
|
915
|
-
"char": "m",
|
|
916
|
-
"exclusive": [
|
|
917
|
-
"manifest",
|
|
918
|
-
"source-dir"
|
|
919
|
-
],
|
|
920
|
-
"name": "metadata",
|
|
921
|
-
"summary": "Metadata component names to preview.",
|
|
922
|
-
"hasDynamicHelp": false,
|
|
923
|
-
"multiple": true,
|
|
924
|
-
"type": "option"
|
|
925
|
-
},
|
|
926
|
-
"source-dir": {
|
|
927
|
-
"char": "d",
|
|
928
|
-
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
929
|
-
"exclusive": [
|
|
930
|
-
"manifest",
|
|
931
|
-
"metadata"
|
|
932
|
-
],
|
|
933
|
-
"name": "source-dir",
|
|
934
|
-
"summary": "Path to the local source files to preview.",
|
|
935
|
-
"hasDynamicHelp": false,
|
|
936
|
-
"multiple": true,
|
|
937
|
-
"type": "option"
|
|
938
|
-
},
|
|
939
|
-
"target-org": {
|
|
586
|
+
"name": "source-dir",
|
|
587
|
+
"summary": "Path to the local source files to preview.",
|
|
588
|
+
"hasDynamicHelp": false,
|
|
589
|
+
"multiple": true,
|
|
590
|
+
"type": "option"
|
|
591
|
+
},
|
|
592
|
+
"target-org": {
|
|
940
593
|
"char": "o",
|
|
941
594
|
"name": "target-org",
|
|
942
595
|
"noCacheDefault": true,
|
|
@@ -994,10 +647,10 @@
|
|
|
994
647
|
],
|
|
995
648
|
"args": {},
|
|
996
649
|
"deprecateAliases": true,
|
|
997
|
-
"description": "Before you run this command, first create a validated deployment with the \"
|
|
650
|
+
"description": "Before you run this command, first create a validated deployment with the \"<%= config.bin %> project deploy validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. Use \"<%= config.bin %> project deploy start\" instead.",
|
|
998
651
|
"examples": [
|
|
999
|
-
"Run a quick deploy to your default org using a job ID:\
|
|
1000
|
-
"Asynchronously run a quick deploy of the most recently validated deployment to an org with alias \"my-prod-org\":\
|
|
652
|
+
"Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
653
|
+
"Asynchronously run a quick deploy of the most recently validated deployment to an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --target-org my-prod-org"
|
|
1001
654
|
],
|
|
1002
655
|
"flags": {
|
|
1003
656
|
"json": {
|
|
@@ -1016,7 +669,7 @@
|
|
|
1016
669
|
"type": "option"
|
|
1017
670
|
},
|
|
1018
671
|
"async": {
|
|
1019
|
-
"description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run \"
|
|
672
|
+
"description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
|
|
1020
673
|
"exclusive": [
|
|
1021
674
|
"wait"
|
|
1022
675
|
],
|
|
@@ -1071,7 +724,7 @@
|
|
|
1071
724
|
},
|
|
1072
725
|
"wait": {
|
|
1073
726
|
"char": "w",
|
|
1074
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run \"
|
|
727
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
|
|
1075
728
|
"exclusive": [
|
|
1076
729
|
"async"
|
|
1077
730
|
],
|
|
@@ -1168,9 +821,9 @@
|
|
|
1168
821
|
"deprecateAliases": true,
|
|
1169
822
|
"description": "Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation. If you specify the --wait flag, the command polls for the status every second until the timeout of --wait minutes. If you don't specify the --wait flag, the command simply checks and displays the status of the deploy; the command doesn't poll for the status.\n\nYou typically don't specify the --target-org flag because the cached job already references the org to which you deployed. But if you run this command on a computer different than the one from which you deployed, then you must specify the --target-org and it must point to the same org.\n\nThis command doesn't update source tracking information.",
|
|
1170
823
|
"examples": [
|
|
1171
|
-
"Check the status using a job ID:\
|
|
1172
|
-
"Check the status of the most recent deploy operation:\
|
|
1173
|
-
"Poll for the status using a job ID and target org:\
|
|
824
|
+
"Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
825
|
+
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
|
|
826
|
+
"Poll for the status using a job ID and target org:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30"
|
|
1174
827
|
],
|
|
1175
828
|
"flags": {
|
|
1176
829
|
"json": {
|
|
@@ -1199,7 +852,7 @@
|
|
|
1199
852
|
},
|
|
1200
853
|
"job-id": {
|
|
1201
854
|
"char": "i",
|
|
1202
|
-
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n-
|
|
855
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
1203
856
|
"name": "job-id",
|
|
1204
857
|
"summary": "Job ID of the deploy operation you want to check the status of.",
|
|
1205
858
|
"hasDynamicHelp": false,
|
|
@@ -1262,7 +915,7 @@
|
|
|
1262
915
|
},
|
|
1263
916
|
"wait": {
|
|
1264
917
|
"char": "w",
|
|
1265
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"
|
|
918
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1266
919
|
"name": "wait",
|
|
1267
920
|
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1268
921
|
"hasDynamicHelp": true,
|
|
@@ -1313,8 +966,8 @@
|
|
|
1313
966
|
"deprecateAliases": true,
|
|
1314
967
|
"description": "Use this command to resume watching a deploy operation if the original command times out or you specified the --async flag. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations. This command doesn't resume the original operation itself, because the operation always continues after you've started it, regardless of whether you're watching it or not. When the deploy completes, source tracking information is updated as needed.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
1315
968
|
"examples": [
|
|
1316
|
-
"Resume watching a deploy operation using a job ID:\
|
|
1317
|
-
"Resume watching the most recent deploy operation:\
|
|
969
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
970
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1318
971
|
],
|
|
1319
972
|
"flags": {
|
|
1320
973
|
"json": {
|
|
@@ -1343,7 +996,7 @@
|
|
|
1343
996
|
},
|
|
1344
997
|
"job-id": {
|
|
1345
998
|
"char": "i",
|
|
1346
|
-
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n-
|
|
999
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
1347
1000
|
"name": "job-id",
|
|
1348
1001
|
"summary": "Job ID of the deploy operation you want to resume.",
|
|
1349
1002
|
"hasDynamicHelp": false,
|
|
@@ -1369,7 +1022,7 @@
|
|
|
1369
1022
|
},
|
|
1370
1023
|
"wait": {
|
|
1371
1024
|
"char": "w",
|
|
1372
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy operation, run this command again. To check the status of the deploy operation, run \"
|
|
1025
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy operation, run this command again. To check the status of the deploy operation, run \"<%= config.bin %> project deploy report\".",
|
|
1373
1026
|
"name": "wait",
|
|
1374
1027
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1375
1028
|
"hasDynamicHelp": true,
|
|
@@ -1506,20 +1159,20 @@
|
|
|
1506
1159
|
],
|
|
1507
1160
|
"args": {},
|
|
1508
1161
|
"deprecateAliases": true,
|
|
1509
|
-
"description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"
|
|
1162
|
+
"description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
1510
1163
|
"examples": [
|
|
1511
|
-
"Deploy local changes not in the org; uses your default org:\
|
|
1512
|
-
"Deploy all source files in the \"force-app\" directory to an org with alias \"my-scratch\"; show only concise output, in other words don't print a list of all the source that was deployed:\
|
|
1513
|
-
"Deploy all the Apex classes and custom objects that are in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:\
|
|
1514
|
-
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\
|
|
1515
|
-
"Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\
|
|
1516
|
-
"Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\
|
|
1164
|
+
"Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1165
|
+
"Deploy all source files in the \"force-app\" directory to an org with alias \"my-scratch\"; show only concise output, in other words don't print a list of all the source that was deployed:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise",
|
|
1166
|
+
"Deploy all the Apex classes and custom objects that are in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
|
|
1167
|
+
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1168
|
+
"Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
|
|
1169
|
+
"Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
|
|
1517
1170
|
"Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
1518
1171
|
"Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
1519
|
-
"Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\
|
|
1520
|
-
"Deploy all Apex classes and a profile that has a space in its name:\
|
|
1521
|
-
"Deploy all components listed in a manifest:\
|
|
1522
|
-
"Run the tests that aren’t in any managed packages as part of a deployment:\
|
|
1172
|
+
"Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
|
|
1173
|
+
"Deploy all Apex classes and a profile that has a space in its name:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
|
|
1174
|
+
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1175
|
+
"Run the tests that aren’t in any managed packages as part of a deployment:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests"
|
|
1523
1176
|
],
|
|
1524
1177
|
"flags": {
|
|
1525
1178
|
"json": {
|
|
@@ -1547,7 +1200,7 @@
|
|
|
1547
1200
|
"type": "option"
|
|
1548
1201
|
},
|
|
1549
1202
|
"async": {
|
|
1550
|
-
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"
|
|
1203
|
+
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1551
1204
|
"exclusive": [
|
|
1552
1205
|
"wait"
|
|
1553
1206
|
],
|
|
@@ -1709,7 +1362,7 @@
|
|
|
1709
1362
|
},
|
|
1710
1363
|
"wait": {
|
|
1711
1364
|
"char": "w",
|
|
1712
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"
|
|
1365
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1713
1366
|
"exclusive": [
|
|
1714
1367
|
"async"
|
|
1715
1368
|
],
|
|
@@ -1903,13 +1556,13 @@
|
|
|
1903
1556
|
],
|
|
1904
1557
|
"args": {},
|
|
1905
1558
|
"deprecateAliases": true,
|
|
1906
|
-
"description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"
|
|
1559
|
+
"description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"<%= config.bin %> project deploy start\", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the \"<%= config.bin %> project deploy quick\" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nYou must run this command from within a project.\n\nThis command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.\n\nTo validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use \"<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests\" instead.",
|
|
1907
1560
|
"examples": [
|
|
1908
|
-
"NOTE: These examples focus on validating large deployments. See the help for \"
|
|
1909
|
-
"Validate the deployment of all source files in the \"force-app\" directory to the default org:\
|
|
1910
|
-
"Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\
|
|
1911
|
-
"Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\
|
|
1912
|
-
"Validate the deployment of all components listed in a manifest:\
|
|
1561
|
+
"NOTE: These examples focus on validating large deployments. See the help for \"<%= config.bin %> project deploy start\" for examples of deploying smaller sets of metadata which you can also use to validate.",
|
|
1562
|
+
"Validate the deployment of all source files in the \"force-app\" directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
1563
|
+
"Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils",
|
|
1564
|
+
"Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\n<%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
|
|
1565
|
+
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
1913
1566
|
],
|
|
1914
1567
|
"flags": {
|
|
1915
1568
|
"json": {
|
|
@@ -1937,7 +1590,7 @@
|
|
|
1937
1590
|
"type": "option"
|
|
1938
1591
|
},
|
|
1939
1592
|
"async": {
|
|
1940
|
-
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume watching the validation, run \"
|
|
1593
|
+
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
|
|
1941
1594
|
"name": "async",
|
|
1942
1595
|
"summary": "Run the command asynchronously.",
|
|
1943
1596
|
"allowNo": false,
|
|
@@ -2046,7 +1699,7 @@
|
|
|
2046
1699
|
},
|
|
2047
1700
|
"wait": {
|
|
2048
1701
|
"char": "w",
|
|
2049
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume watching the validation, run \"
|
|
1702
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
|
|
2050
1703
|
"name": "wait",
|
|
2051
1704
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
2052
1705
|
"hasDynamicHelp": true,
|
|
@@ -2243,6 +1896,353 @@
|
|
|
2243
1896
|
"validate:deploy:project"
|
|
2244
1897
|
]
|
|
2245
1898
|
},
|
|
1899
|
+
"project:delete:source": {
|
|
1900
|
+
"aliases": [
|
|
1901
|
+
"force:source:delete"
|
|
1902
|
+
],
|
|
1903
|
+
"args": {},
|
|
1904
|
+
"deprecateAliases": true,
|
|
1905
|
+
"description": "Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, \"<%= config.bin %> project deploy start\".\n\nWhen you run this command, both the local source file and the metadata component in the org are deleted.\n\nTo delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
1906
|
+
"examples": [
|
|
1907
|
+
"Delete all local Apex source files and all Apex classes from the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
|
|
1908
|
+
"Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata \"Profile: My Profile\" --no-prompt",
|
|
1909
|
+
"Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
|
|
1910
|
+
"Delete the Apex source files in a directory and the corresponding components from your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes"
|
|
1911
|
+
],
|
|
1912
|
+
"flags": {
|
|
1913
|
+
"json": {
|
|
1914
|
+
"description": "Format output as json.",
|
|
1915
|
+
"helpGroup": "GLOBAL",
|
|
1916
|
+
"name": "json",
|
|
1917
|
+
"allowNo": false,
|
|
1918
|
+
"type": "boolean"
|
|
1919
|
+
},
|
|
1920
|
+
"flags-dir": {
|
|
1921
|
+
"helpGroup": "GLOBAL",
|
|
1922
|
+
"name": "flags-dir",
|
|
1923
|
+
"summary": "Import flag values from a directory.",
|
|
1924
|
+
"hasDynamicHelp": false,
|
|
1925
|
+
"multiple": false,
|
|
1926
|
+
"type": "option"
|
|
1927
|
+
},
|
|
1928
|
+
"api-version": {
|
|
1929
|
+
"aliases": [
|
|
1930
|
+
"apiversion"
|
|
1931
|
+
],
|
|
1932
|
+
"deprecateAliases": true,
|
|
1933
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1934
|
+
"name": "api-version",
|
|
1935
|
+
"hasDynamicHelp": false,
|
|
1936
|
+
"multiple": false,
|
|
1937
|
+
"type": "option"
|
|
1938
|
+
},
|
|
1939
|
+
"loglevel": {
|
|
1940
|
+
"deprecated": {
|
|
1941
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
1942
|
+
},
|
|
1943
|
+
"hidden": true,
|
|
1944
|
+
"name": "loglevel",
|
|
1945
|
+
"hasDynamicHelp": false,
|
|
1946
|
+
"multiple": false,
|
|
1947
|
+
"type": "option"
|
|
1948
|
+
},
|
|
1949
|
+
"target-org": {
|
|
1950
|
+
"aliases": [
|
|
1951
|
+
"targetusername",
|
|
1952
|
+
"u"
|
|
1953
|
+
],
|
|
1954
|
+
"char": "o",
|
|
1955
|
+
"deprecateAliases": true,
|
|
1956
|
+
"name": "target-org",
|
|
1957
|
+
"noCacheDefault": true,
|
|
1958
|
+
"required": true,
|
|
1959
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1960
|
+
"hasDynamicHelp": true,
|
|
1961
|
+
"multiple": false,
|
|
1962
|
+
"type": "option"
|
|
1963
|
+
},
|
|
1964
|
+
"check-only": {
|
|
1965
|
+
"aliases": [
|
|
1966
|
+
"checkonly"
|
|
1967
|
+
],
|
|
1968
|
+
"char": "c",
|
|
1969
|
+
"deprecateAliases": true,
|
|
1970
|
+
"description": "IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.\n\nIf your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.\n\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n\n 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.\n\n 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.",
|
|
1971
|
+
"name": "check-only",
|
|
1972
|
+
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
1973
|
+
"allowNo": false,
|
|
1974
|
+
"type": "boolean"
|
|
1975
|
+
},
|
|
1976
|
+
"wait": {
|
|
1977
|
+
"char": "w",
|
|
1978
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
|
|
1979
|
+
"name": "wait",
|
|
1980
|
+
"summary": "Number of minutes to wait for the command to finish.",
|
|
1981
|
+
"hasDynamicHelp": true,
|
|
1982
|
+
"multiple": false,
|
|
1983
|
+
"type": "option"
|
|
1984
|
+
},
|
|
1985
|
+
"tests": {
|
|
1986
|
+
"description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
|
|
1987
|
+
"helpGroup": "Test",
|
|
1988
|
+
"name": "tests",
|
|
1989
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1990
|
+
"hasDynamicHelp": false,
|
|
1991
|
+
"multiple": true,
|
|
1992
|
+
"type": "option"
|
|
1993
|
+
},
|
|
1994
|
+
"test-level": {
|
|
1995
|
+
"aliases": [
|
|
1996
|
+
"testlevel"
|
|
1997
|
+
],
|
|
1998
|
+
"char": "l",
|
|
1999
|
+
"deprecateAliases": true,
|
|
2000
|
+
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
|
|
2001
|
+
"helpGroup": "Test",
|
|
2002
|
+
"name": "test-level",
|
|
2003
|
+
"summary": "Deployment Apex testing level.",
|
|
2004
|
+
"hasDynamicHelp": false,
|
|
2005
|
+
"multiple": false,
|
|
2006
|
+
"options": [
|
|
2007
|
+
"NoTestRun",
|
|
2008
|
+
"RunSpecifiedTests",
|
|
2009
|
+
"RunLocalTests",
|
|
2010
|
+
"RunAllTestsInOrg"
|
|
2011
|
+
],
|
|
2012
|
+
"type": "option"
|
|
2013
|
+
},
|
|
2014
|
+
"no-prompt": {
|
|
2015
|
+
"aliases": [
|
|
2016
|
+
"noprompt"
|
|
2017
|
+
],
|
|
2018
|
+
"char": "r",
|
|
2019
|
+
"deprecateAliases": true,
|
|
2020
|
+
"name": "no-prompt",
|
|
2021
|
+
"summary": "Don't prompt for delete confirmation.",
|
|
2022
|
+
"allowNo": false,
|
|
2023
|
+
"type": "boolean"
|
|
2024
|
+
},
|
|
2025
|
+
"metadata": {
|
|
2026
|
+
"char": "m",
|
|
2027
|
+
"description": "If you specify this parameter, don’t specify --source-dir.",
|
|
2028
|
+
"name": "metadata",
|
|
2029
|
+
"summary": "Metadata components to delete.",
|
|
2030
|
+
"delimiter": ",",
|
|
2031
|
+
"hasDynamicHelp": false,
|
|
2032
|
+
"multiple": true,
|
|
2033
|
+
"type": "option"
|
|
2034
|
+
},
|
|
2035
|
+
"source-dir": {
|
|
2036
|
+
"aliases": [
|
|
2037
|
+
"sourcepath"
|
|
2038
|
+
],
|
|
2039
|
+
"char": "p",
|
|
2040
|
+
"deprecateAliases": true,
|
|
2041
|
+
"description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this parameter, don’t specify --metadata.",
|
|
2042
|
+
"name": "source-dir",
|
|
2043
|
+
"summary": "Source file paths to delete.",
|
|
2044
|
+
"delimiter": ",",
|
|
2045
|
+
"hasDynamicHelp": false,
|
|
2046
|
+
"multiple": true,
|
|
2047
|
+
"type": "option"
|
|
2048
|
+
},
|
|
2049
|
+
"track-source": {
|
|
2050
|
+
"aliases": [
|
|
2051
|
+
"tracksource"
|
|
2052
|
+
],
|
|
2053
|
+
"char": "t",
|
|
2054
|
+
"deprecateAliases": true,
|
|
2055
|
+
"exclusive": [
|
|
2056
|
+
"check-only"
|
|
2057
|
+
],
|
|
2058
|
+
"name": "track-source",
|
|
2059
|
+
"summary": "If the delete succeeds, update the source tracking information.",
|
|
2060
|
+
"allowNo": false,
|
|
2061
|
+
"type": "boolean"
|
|
2062
|
+
},
|
|
2063
|
+
"force-overwrite": {
|
|
2064
|
+
"aliases": [
|
|
2065
|
+
"forceoverwrite"
|
|
2066
|
+
],
|
|
2067
|
+
"char": "f",
|
|
2068
|
+
"dependsOn": [
|
|
2069
|
+
"track-source"
|
|
2070
|
+
],
|
|
2071
|
+
"deprecateAliases": true,
|
|
2072
|
+
"name": "force-overwrite",
|
|
2073
|
+
"summary": "Ignore conflict warnings and overwrite changes to the org.",
|
|
2074
|
+
"allowNo": false,
|
|
2075
|
+
"type": "boolean"
|
|
2076
|
+
},
|
|
2077
|
+
"verbose": {
|
|
2078
|
+
"name": "verbose",
|
|
2079
|
+
"summary": "Verbose output of the delete result.",
|
|
2080
|
+
"allowNo": false,
|
|
2081
|
+
"type": "boolean"
|
|
2082
|
+
}
|
|
2083
|
+
},
|
|
2084
|
+
"hasDynamicHelp": true,
|
|
2085
|
+
"hiddenAliases": [],
|
|
2086
|
+
"id": "project:delete:source",
|
|
2087
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2088
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2089
|
+
"pluginType": "core",
|
|
2090
|
+
"strict": true,
|
|
2091
|
+
"summary": "Delete source from your project and from a non-source-tracked org.",
|
|
2092
|
+
"enableJsonFlag": true,
|
|
2093
|
+
"requiresProject": true,
|
|
2094
|
+
"isESM": true,
|
|
2095
|
+
"relativePath": [
|
|
2096
|
+
"lib",
|
|
2097
|
+
"commands",
|
|
2098
|
+
"project",
|
|
2099
|
+
"delete",
|
|
2100
|
+
"source.js"
|
|
2101
|
+
],
|
|
2102
|
+
"aliasPermutations": [
|
|
2103
|
+
"force:source:delete",
|
|
2104
|
+
"source:force:delete",
|
|
2105
|
+
"source:delete:force",
|
|
2106
|
+
"force:delete:source",
|
|
2107
|
+
"delete:force:source",
|
|
2108
|
+
"delete:source:force"
|
|
2109
|
+
],
|
|
2110
|
+
"permutations": [
|
|
2111
|
+
"project:delete:source",
|
|
2112
|
+
"delete:project:source",
|
|
2113
|
+
"delete:source:project",
|
|
2114
|
+
"project:source:delete",
|
|
2115
|
+
"source:project:delete",
|
|
2116
|
+
"source:delete:project"
|
|
2117
|
+
]
|
|
2118
|
+
},
|
|
2119
|
+
"project:delete:tracking": {
|
|
2120
|
+
"aliases": [
|
|
2121
|
+
"force:source:tracking:clear"
|
|
2122
|
+
],
|
|
2123
|
+
"args": {},
|
|
2124
|
+
"deprecateAliases": true,
|
|
2125
|
+
"description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nDeletes all local source tracking information. When you next run 'project deploy preview', Salesforce CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.",
|
|
2126
|
+
"examples": [
|
|
2127
|
+
"Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
|
|
2128
|
+
],
|
|
2129
|
+
"flags": {
|
|
2130
|
+
"json": {
|
|
2131
|
+
"description": "Format output as json.",
|
|
2132
|
+
"helpGroup": "GLOBAL",
|
|
2133
|
+
"name": "json",
|
|
2134
|
+
"allowNo": false,
|
|
2135
|
+
"type": "boolean"
|
|
2136
|
+
},
|
|
2137
|
+
"flags-dir": {
|
|
2138
|
+
"helpGroup": "GLOBAL",
|
|
2139
|
+
"name": "flags-dir",
|
|
2140
|
+
"summary": "Import flag values from a directory.",
|
|
2141
|
+
"hasDynamicHelp": false,
|
|
2142
|
+
"multiple": false,
|
|
2143
|
+
"type": "option"
|
|
2144
|
+
},
|
|
2145
|
+
"api-version": {
|
|
2146
|
+
"aliases": [
|
|
2147
|
+
"apiversion"
|
|
2148
|
+
],
|
|
2149
|
+
"deprecateAliases": true,
|
|
2150
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2151
|
+
"name": "api-version",
|
|
2152
|
+
"hasDynamicHelp": false,
|
|
2153
|
+
"multiple": false,
|
|
2154
|
+
"type": "option"
|
|
2155
|
+
},
|
|
2156
|
+
"loglevel": {
|
|
2157
|
+
"deprecated": {
|
|
2158
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
2159
|
+
},
|
|
2160
|
+
"hidden": true,
|
|
2161
|
+
"name": "loglevel",
|
|
2162
|
+
"hasDynamicHelp": false,
|
|
2163
|
+
"multiple": false,
|
|
2164
|
+
"type": "option"
|
|
2165
|
+
},
|
|
2166
|
+
"target-org": {
|
|
2167
|
+
"aliases": [
|
|
2168
|
+
"targetusername",
|
|
2169
|
+
"u"
|
|
2170
|
+
],
|
|
2171
|
+
"char": "o",
|
|
2172
|
+
"deprecateAliases": true,
|
|
2173
|
+
"name": "target-org",
|
|
2174
|
+
"noCacheDefault": true,
|
|
2175
|
+
"required": true,
|
|
2176
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2177
|
+
"hasDynamicHelp": true,
|
|
2178
|
+
"multiple": false,
|
|
2179
|
+
"type": "option"
|
|
2180
|
+
},
|
|
2181
|
+
"no-prompt": {
|
|
2182
|
+
"aliases": [
|
|
2183
|
+
"noprompt"
|
|
2184
|
+
],
|
|
2185
|
+
"char": "p",
|
|
2186
|
+
"deprecateAliases": true,
|
|
2187
|
+
"name": "no-prompt",
|
|
2188
|
+
"summary": "Don't prompt for source tracking override confirmation.",
|
|
2189
|
+
"allowNo": false,
|
|
2190
|
+
"type": "boolean"
|
|
2191
|
+
}
|
|
2192
|
+
},
|
|
2193
|
+
"hasDynamicHelp": true,
|
|
2194
|
+
"hiddenAliases": [],
|
|
2195
|
+
"id": "project:delete:tracking",
|
|
2196
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2197
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2198
|
+
"pluginType": "core",
|
|
2199
|
+
"strict": true,
|
|
2200
|
+
"summary": "Delete all local source tracking information.",
|
|
2201
|
+
"enableJsonFlag": true,
|
|
2202
|
+
"requiresProject": true,
|
|
2203
|
+
"isESM": true,
|
|
2204
|
+
"relativePath": [
|
|
2205
|
+
"lib",
|
|
2206
|
+
"commands",
|
|
2207
|
+
"project",
|
|
2208
|
+
"delete",
|
|
2209
|
+
"tracking.js"
|
|
2210
|
+
],
|
|
2211
|
+
"aliasPermutations": [
|
|
2212
|
+
"force:source:tracking:clear",
|
|
2213
|
+
"source:force:tracking:clear",
|
|
2214
|
+
"source:tracking:force:clear",
|
|
2215
|
+
"source:tracking:clear:force",
|
|
2216
|
+
"force:tracking:source:clear",
|
|
2217
|
+
"tracking:force:source:clear",
|
|
2218
|
+
"tracking:source:force:clear",
|
|
2219
|
+
"tracking:source:clear:force",
|
|
2220
|
+
"force:tracking:clear:source",
|
|
2221
|
+
"tracking:force:clear:source",
|
|
2222
|
+
"tracking:clear:force:source",
|
|
2223
|
+
"tracking:clear:source:force",
|
|
2224
|
+
"force:source:clear:tracking",
|
|
2225
|
+
"source:force:clear:tracking",
|
|
2226
|
+
"source:clear:force:tracking",
|
|
2227
|
+
"source:clear:tracking:force",
|
|
2228
|
+
"force:clear:source:tracking",
|
|
2229
|
+
"clear:force:source:tracking",
|
|
2230
|
+
"clear:source:force:tracking",
|
|
2231
|
+
"clear:source:tracking:force",
|
|
2232
|
+
"force:clear:tracking:source",
|
|
2233
|
+
"clear:force:tracking:source",
|
|
2234
|
+
"clear:tracking:force:source",
|
|
2235
|
+
"clear:tracking:source:force"
|
|
2236
|
+
],
|
|
2237
|
+
"permutations": [
|
|
2238
|
+
"project:delete:tracking",
|
|
2239
|
+
"delete:project:tracking",
|
|
2240
|
+
"delete:tracking:project",
|
|
2241
|
+
"project:tracking:delete",
|
|
2242
|
+
"tracking:project:delete",
|
|
2243
|
+
"tracking:delete:project"
|
|
2244
|
+
]
|
|
2245
|
+
},
|
|
2246
2246
|
"project:generate:manifest": {
|
|
2247
2247
|
"aliases": [
|
|
2248
2248
|
"force:source:manifest:create"
|
|
@@ -2251,10 +2251,10 @@
|
|
|
2251
2251
|
"deprecateAliases": true,
|
|
2252
2252
|
"description": "Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these parameters, not both.\n\nUse --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are:\n\n * package : package.xml (default)\n * pre : destructiveChangesPre.xml\n * post : destructiveChangesPost.xml\n * destroy : destructiveChanges.xml\n\nSee https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files.\n\nUse --name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --type or --name, but not both.\n\nTo include multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --include-packages and --source-dir.",
|
|
2253
2253
|
"examples": [
|
|
2254
|
-
"Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$
|
|
2255
|
-
"Create a manifest for deleting the specified Apex class:\n$
|
|
2256
|
-
"Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:\n$
|
|
2257
|
-
"Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:\n$
|
|
2254
|
+
"Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
|
|
2255
|
+
"Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
|
|
2256
|
+
"Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:\n$ <%= config.bin %> <%= command.id %> --source-dir force-app --name myNewManifest",
|
|
2257
|
+
"Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked"
|
|
2258
2258
|
],
|
|
2259
2259
|
"flags": {
|
|
2260
2260
|
"json": {
|
|
@@ -2457,9 +2457,9 @@
|
|
|
2457
2457
|
"deprecateAliases": true,
|
|
2458
2458
|
"description": "When deploying or retrieving metadata between your local project and an org, you can specify the source files you want to exclude with a .forceignore file. The .forceignore file structure mimics the .gitignore structure. Each line in .forceignore specifies a pattern that corresponds to one or more files. The files typically represent metadata components, but can be any files you want to exclude, such as LWC configuration JSON files or tests.",
|
|
2459
2459
|
"examples": [
|
|
2460
|
-
"List all the files in all package directories that are ignored:\
|
|
2461
|
-
"List all the files in a specific directory that are ignored:\
|
|
2462
|
-
"Check if a particular file is ignored:\
|
|
2460
|
+
"List all the files in all package directories that are ignored:\n<%= config.bin %> <%= command.id %>",
|
|
2461
|
+
"List all the files in a specific directory that are ignored:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
2462
|
+
"Check if a particular file is ignored:\n<%= config.bin %> <%= command.id %> --source-dir package.xml"
|
|
2463
2463
|
],
|
|
2464
2464
|
"flags": {
|
|
2465
2465
|
"json": {
|
|
@@ -2549,10 +2549,10 @@
|
|
|
2549
2549
|
],
|
|
2550
2550
|
"args": {},
|
|
2551
2551
|
"deprecateAliases": true,
|
|
2552
|
-
"description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nResets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.\n\nUse the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:\n\n
|
|
2552
|
+
"description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nResets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.\n\nUse the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:\n\n <%= config.bin %> data query --query \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" --use-tooling-api --target-org my-scratch",
|
|
2553
2553
|
"examples": [
|
|
2554
|
-
"Reset source tracking for the org with alias \"my-scratch\":\n$
|
|
2555
|
-
"Reset source tracking to revision number 30 for your default org:\n$
|
|
2554
|
+
"Reset source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch",
|
|
2555
|
+
"Reset source tracking to revision number 30 for your default org:\n$ <%= config.bin %> <%= command.id %> --revision 30"
|
|
2556
2556
|
],
|
|
2557
2557
|
"flags": {
|
|
2558
2558
|
"json": {
|
|
@@ -2685,10 +2685,10 @@
|
|
|
2685
2685
|
],
|
|
2686
2686
|
"args": {},
|
|
2687
2687
|
"deprecateAliases": true,
|
|
2688
|
-
"description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"
|
|
2688
|
+
"description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"<%= config.bin %> project retrieve start\" command. The table lists the metadata components that will be retrieved and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be retrieved because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.",
|
|
2689
2689
|
"examples": [
|
|
2690
|
-
"Preview the retrieve of all changes from your default org:\
|
|
2691
|
-
"Preview the retrieve when ignoring any conflicts from an org with alias \"my-scratch\":\
|
|
2690
|
+
"Preview the retrieve of all changes from your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2691
|
+
"Preview the retrieve when ignoring any conflicts from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --ignore-conflicts --target-org my-scratch"
|
|
2692
2692
|
],
|
|
2693
2693
|
"flags": {
|
|
2694
2694
|
"json": {
|
|
@@ -2772,22 +2772,22 @@
|
|
|
2772
2772
|
],
|
|
2773
2773
|
"args": {},
|
|
2774
2774
|
"deprecateAliases": true,
|
|
2775
|
-
"description": "You must run this command from within a project.\n\nMetadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"
|
|
2775
|
+
"description": "You must run this command from within a project.\n\nMetadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
2776
2776
|
"examples": [
|
|
2777
|
-
"Retrieve all remote changes from your default org:\
|
|
2778
|
-
"Retrieve the source files in the \"force-app\" directory from an org with alias \"my-scratch\":\
|
|
2779
|
-
"Retrieve all the Apex classes and custom objects whose source is in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:\
|
|
2780
|
-
"Retrieve all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\
|
|
2781
|
-
"Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class source files in your local project if there are conflicts!):\
|
|
2782
|
-
"Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string \"MyApex\":\
|
|
2777
|
+
"Retrieve all remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2778
|
+
"Retrieve the source files in the \"force-app\" directory from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch",
|
|
2779
|
+
"Retrieve all the Apex classes and custom objects whose source is in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
|
|
2780
|
+
"Retrieve all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
2781
|
+
"Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class source files in your local project if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
|
|
2782
|
+
"Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string \"MyApex\":\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'",
|
|
2783
2783
|
"Retrieve a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
2784
2784
|
"Retrieve all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
2785
|
-
"Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\
|
|
2786
|
-
"Retrieve all metadata components listed in a manifest:\
|
|
2787
|
-
"Retrieve metadata from a package:\
|
|
2788
|
-
"Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):\
|
|
2789
|
-
"Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the \"output\" directory:\
|
|
2790
|
-
"Retrieve in metadata format and automatically extract the contents into the \"output\" directory:\
|
|
2785
|
+
"Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
|
|
2786
|
+
"Retrieve all metadata components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
2787
|
+
"Retrieve metadata from a package:\n<%= config.bin %> <%= command.id %> --package-name MyPackageName",
|
|
2788
|
+
"Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --package-name Package1 \"PackageName With Spaces\" Package3\n<%= config.bin %> <%= command.id %> --package-name Package1 --package-name \"PackageName With Spaces\" --package-name Package3",
|
|
2789
|
+
"Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the \"output\" directory:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output",
|
|
2790
|
+
"Retrieve in metadata format and automatically extract the contents into the \"output\" directory:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip"
|
|
2791
2791
|
],
|
|
2792
2792
|
"flags": {
|
|
2793
2793
|
"json": {
|
|
@@ -3023,5 +3023,5 @@
|
|
|
3023
3023
|
]
|
|
3024
3024
|
}
|
|
3025
3025
|
},
|
|
3026
|
-
"version": "3.
|
|
3026
|
+
"version": "3.9.1"
|
|
3027
3027
|
}
|