@salesforce/plugin-deploy-retrieve 3.7.9 → 3.7.10

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.
Files changed (40) hide show
  1. package/README.md +20 -20
  2. package/lib/commands/project/deploy/cancel.js +1 -1
  3. package/lib/commands/project/deploy/cancel.js.map +1 -1
  4. package/lib/commands/project/deploy/quick.js +1 -1
  5. package/lib/commands/project/deploy/quick.js.map +1 -1
  6. package/lib/commands/project/deploy/resume.js +1 -1
  7. package/lib/commands/project/deploy/resume.js.map +1 -1
  8. package/lib/commands/project/deploy/start.js +4 -4
  9. package/lib/commands/project/deploy/start.js.map +1 -1
  10. package/lib/commands/project/deploy/validate.js +3 -3
  11. package/lib/commands/project/deploy/validate.js.map +1 -1
  12. package/lib/commands/project/retrieve/start.js +1 -1
  13. package/lib/commands/project/retrieve/start.js.map +1 -1
  14. package/lib/formatters/asyncDeployCancelResultFormatter.d.ts +1 -2
  15. package/lib/formatters/asyncDeployCancelResultFormatter.js +3 -5
  16. package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
  17. package/lib/formatters/asyncDeployResultFormatter.d.ts +1 -2
  18. package/lib/formatters/asyncDeployResultFormatter.js +4 -6
  19. package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
  20. package/lib/utils/deploy.d.ts +1 -1
  21. package/lib/utils/deploy.js +2 -2
  22. package/lib/utils/deploy.js.map +1 -1
  23. package/messages/convert.mdapi.md +3 -3
  24. package/messages/convert.source.md +4 -4
  25. package/messages/delete.source.md +6 -6
  26. package/messages/delete.tracking.md +4 -4
  27. package/messages/deploy.async.md +3 -3
  28. package/messages/deploy.metadata.cancel.md +8 -8
  29. package/messages/deploy.metadata.md +18 -18
  30. package/messages/deploy.metadata.preview.md +8 -8
  31. package/messages/deploy.metadata.quick.md +6 -6
  32. package/messages/deploy.metadata.report.md +7 -7
  33. package/messages/deploy.metadata.resume.md +7 -7
  34. package/messages/deploy.metadata.validate.md +10 -10
  35. package/messages/list.ignored.md +3 -3
  36. package/messages/manifest.generate.md +4 -4
  37. package/messages/retrieve.metadata.preview.md +4 -4
  38. package/messages/retrieve.start.md +17 -17
  39. package/oclif.manifest.json +511 -511
  40. package/package.json +5 -5
@@ -6,10 +6,10 @@
6
6
  ],
7
7
  "args": {},
8
8
  "deprecateAliases": true,
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 \"<%= config.bin %> 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.",
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$ <%= 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"
11
+ "Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:\n$ sf <%= command.id %> --root-dir path/to/metadata",
12
+ "Similar to previous example, but writes converted files to the specified output directory:\n$ sf <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir"
13
13
  ],
14
14
  "flags": {
15
15
  "json": {
@@ -155,10 +155,10 @@
155
155
  ],
156
156
  "args": {},
157
157
  "deprecateAliases": true,
158
- "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.",
158
+ "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 \"sf project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"sf 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.",
159
159
  "examples": [
160
- "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",
161
- "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'"
160
+ "Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ sf <%= command.id %> --root-dir path/to/source",
161
+ "Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ sf <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
162
162
  ],
163
163
  "flags": {
164
164
  "json": {
@@ -218,7 +218,7 @@
218
218
  "deprecateAliases": true,
219
219
  "name": "output-dir",
220
220
  "summary": "Output directory to store the Metadata API–formatted files in.",
221
- "default": "metadataPackage_1716626862131",
221
+ "default": "metadataPackage_1716916525319",
222
222
  "hasDynamicHelp": false,
223
223
  "multiple": false,
224
224
  "type": "option"
@@ -311,18 +311,16 @@
311
311
  "source:convert:project"
312
312
  ]
313
313
  },
314
- "project:delete:source": {
314
+ "project:deploy:cancel": {
315
315
  "aliases": [
316
- "force:source:delete"
316
+ "deploy:metadata:cancel"
317
317
  ],
318
318
  "args": {},
319
319
  "deprecateAliases": true,
320
- "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.",
320
+ "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.",
321
321
  "examples": [
322
- "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",
323
- "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",
324
- "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",
325
- "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"
322
+ "Cancel a deploy operation using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
323
+ "Cancel the most recent deploy operation:\nsf <%= command.id %> --use-most-recent"
326
324
  ],
327
325
  "flags": {
328
326
  "json": {
@@ -340,206 +338,104 @@
340
338
  "multiple": false,
341
339
  "type": "option"
342
340
  },
343
- "api-version": {
344
- "aliases": [
345
- "apiversion"
346
- ],
347
- "deprecateAliases": true,
348
- "description": "Override the api version used for api requests made by this command",
349
- "name": "api-version",
350
- "hasDynamicHelp": false,
351
- "multiple": false,
352
- "type": "option"
353
- },
354
- "loglevel": {
355
- "deprecated": {
356
- "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."
357
- },
358
- "hidden": true,
359
- "name": "loglevel",
360
- "hasDynamicHelp": false,
361
- "multiple": false,
362
- "type": "option"
363
- },
364
341
  "target-org": {
365
- "aliases": [
366
- "targetusername",
367
- "u"
368
- ],
369
342
  "char": "o",
370
- "deprecateAliases": true,
343
+ "description": "Overrides your default org.",
371
344
  "name": "target-org",
372
345
  "noCacheDefault": true,
373
- "required": true,
374
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
346
+ "summary": "Login username or alias for the target org.",
375
347
  "hasDynamicHelp": true,
376
348
  "multiple": false,
377
349
  "type": "option"
378
350
  },
379
- "check-only": {
380
- "aliases": [
381
- "checkonly"
351
+ "async": {
352
+ "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\".",
353
+ "exclusive": [
354
+ "wait"
382
355
  ],
383
- "char": "c",
384
- "deprecateAliases": true,
385
- "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 --chec-konly 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.",
386
- "name": "check-only",
387
- "summary": "Validate delete command but don't delete anything from the org or the local project.",
356
+ "name": "async",
357
+ "summary": "Run the command asynchronously.",
388
358
  "allowNo": false,
389
359
  "type": "boolean"
390
360
  },
391
- "wait": {
392
- "char": "w",
393
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
394
- "name": "wait",
395
- "summary": "Number of minutes to wait for the command to finish.",
396
- "hasDynamicHelp": true,
397
- "multiple": false,
398
- "type": "option"
399
- },
400
- "tests": {
401
- "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\"",
402
- "helpGroup": "Test",
403
- "name": "tests",
404
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
405
- "hasDynamicHelp": false,
406
- "multiple": true,
407
- "type": "option"
408
- },
409
- "test-level": {
410
- "aliases": [
411
- "testlevel"
412
- ],
413
- "char": "l",
414
- "deprecateAliases": true,
415
- "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.",
416
- "helpGroup": "Test",
417
- "name": "test-level",
418
- "summary": "Deployment Apex testing level.",
361
+ "job-id": {
362
+ "char": "i",
363
+ "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.",
364
+ "name": "job-id",
365
+ "summary": "Job ID of the deploy operation you want to cancel.",
419
366
  "hasDynamicHelp": false,
420
367
  "multiple": false,
421
- "options": [
422
- "NoTestRun",
423
- "RunSpecifiedTests",
424
- "RunLocalTests",
425
- "RunAllTestsInOrg"
426
- ],
427
368
  "type": "option"
428
369
  },
429
- "no-prompt": {
430
- "aliases": [
431
- "noprompt"
432
- ],
370
+ "use-most-recent": {
433
371
  "char": "r",
434
- "deprecateAliases": true,
435
- "name": "no-prompt",
436
- "summary": "Don't prompt for delete confirmation.",
372
+ "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.",
373
+ "name": "use-most-recent",
374
+ "summary": "Use the job ID of the most recent deploy operation.",
437
375
  "allowNo": false,
438
376
  "type": "boolean"
439
377
  },
440
- "metadata": {
441
- "char": "m",
442
- "description": "If you specify this parameter, don’t specify --source-dir.",
443
- "name": "metadata",
444
- "summary": "Metadata components to delete.",
445
- "delimiter": ",",
446
- "hasDynamicHelp": false,
447
- "multiple": true,
448
- "type": "option"
449
- },
450
- "source-dir": {
451
- "aliases": [
452
- "sourcepath"
453
- ],
454
- "char": "p",
455
- "deprecateAliases": true,
456
- "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.",
457
- "name": "source-dir",
458
- "summary": "Source file paths to delete.",
459
- "delimiter": ",",
460
- "hasDynamicHelp": false,
461
- "multiple": true,
462
- "type": "option"
463
- },
464
- "track-source": {
465
- "aliases": [
466
- "tracksource"
467
- ],
468
- "char": "t",
469
- "deprecateAliases": true,
378
+ "wait": {
379
+ "char": "w",
380
+ "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\".",
470
381
  "exclusive": [
471
- "check-only"
472
- ],
473
- "name": "track-source",
474
- "summary": "If the delete succeeds, update the source tracking information.",
475
- "allowNo": false,
476
- "type": "boolean"
477
- },
478
- "force-overwrite": {
479
- "aliases": [
480
- "forceoverwrite"
481
- ],
482
- "char": "f",
483
- "dependsOn": [
484
- "track-source"
382
+ "async"
485
383
  ],
486
- "deprecateAliases": true,
487
- "name": "force-overwrite",
488
- "summary": "Ignore conflict warnings and overwrite changes to the org.",
489
- "allowNo": false,
490
- "type": "boolean"
491
- },
492
- "verbose": {
493
- "name": "verbose",
494
- "summary": "Verbose output of the delete result.",
495
- "allowNo": false,
496
- "type": "boolean"
384
+ "name": "wait",
385
+ "summary": "Number of minutes to wait for the command to complete and display results.",
386
+ "hasDynamicHelp": true,
387
+ "helpValue": "<minutes>",
388
+ "multiple": false,
389
+ "type": "option"
497
390
  }
498
391
  },
499
392
  "hasDynamicHelp": true,
500
393
  "hiddenAliases": [],
501
- "id": "project:delete:source",
394
+ "id": "project:deploy:cancel",
502
395
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
503
396
  "pluginName": "@salesforce/plugin-deploy-retrieve",
504
397
  "pluginType": "core",
505
398
  "strict": true,
506
- "summary": "Delete source from your project and from a non-source-tracked org.",
399
+ "summary": "Cancel a deploy operation.",
507
400
  "enableJsonFlag": true,
508
- "requiresProject": true,
509
401
  "isESM": true,
510
402
  "relativePath": [
511
403
  "lib",
512
404
  "commands",
513
405
  "project",
514
- "delete",
515
- "source.js"
406
+ "deploy",
407
+ "cancel.js"
516
408
  ],
517
409
  "aliasPermutations": [
518
- "force:source:delete",
519
- "source:force:delete",
520
- "source:delete:force",
521
- "force:delete:source",
522
- "delete:force:source",
523
- "delete:source:force"
410
+ "deploy:metadata:cancel",
411
+ "metadata:deploy:cancel",
412
+ "metadata:cancel:deploy",
413
+ "deploy:cancel:metadata",
414
+ "cancel:deploy:metadata",
415
+ "cancel:metadata:deploy"
524
416
  ],
525
417
  "permutations": [
526
- "project:delete:source",
527
- "delete:project:source",
528
- "delete:source:project",
529
- "project:source:delete",
530
- "source:project:delete",
531
- "source:delete:project"
418
+ "project:deploy:cancel",
419
+ "deploy:project:cancel",
420
+ "deploy:cancel:project",
421
+ "project:cancel:deploy",
422
+ "cancel:project:deploy",
423
+ "cancel:deploy:project"
532
424
  ]
533
425
  },
534
- "project:delete:tracking": {
426
+ "project:deploy:preview": {
535
427
  "aliases": [
536
- "force:source:tracking:clear"
428
+ "deploy:metadata:preview"
537
429
  ],
538
430
  "args": {},
539
431
  "deprecateAliases": true,
540
- "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.",
432
+ "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.",
541
433
  "examples": [
542
- "Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
434
+ "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.",
435
+ "Preview the deployment of source files in a directory, such as force-app, to your default org:\nsf <%= command.id %> --source-dir force-app",
436
+ "Preview the deployment of all Apex classes to an org with alias \"my-scratch\":\nsf <%= command.id %> --metadata ApexClass --target-org my-scratch",
437
+ "Preview deployment of a specific Apex class:\nsf <%= command.id %> --metadata ApexClass:MyApexClass",
438
+ "Preview deployment of all components listed in a manifest:\nsf <%= command.id %> --manifest path/to/package.xml"
543
439
  ],
544
440
  "flags": {
545
441
  "json": {
@@ -557,298 +453,55 @@
557
453
  "multiple": false,
558
454
  "type": "option"
559
455
  },
560
- "api-version": {
561
- "aliases": [
562
- "apiversion"
456
+ "ignore-conflicts": {
457
+ "char": "c",
458
+ "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.",
459
+ "name": "ignore-conflicts",
460
+ "summary": "Don't display conflicts in preview of the deployment.",
461
+ "allowNo": false,
462
+ "type": "boolean"
463
+ },
464
+ "manifest": {
465
+ "char": "x",
466
+ "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
467
+ "exclusive": [
468
+ "source-dir",
469
+ "metadata"
563
470
  ],
564
- "deprecateAliases": true,
565
- "description": "Override the api version used for api requests made by this command",
566
- "name": "api-version",
471
+ "name": "manifest",
472
+ "summary": "Full file path for manifest (package.xml) of components to preview.",
567
473
  "hasDynamicHelp": false,
568
474
  "multiple": false,
569
475
  "type": "option"
570
476
  },
571
- "loglevel": {
572
- "deprecated": {
573
- "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."
574
- },
575
- "hidden": true,
576
- "name": "loglevel",
477
+ "metadata": {
478
+ "char": "m",
479
+ "exclusive": [
480
+ "manifest",
481
+ "source-dir"
482
+ ],
483
+ "name": "metadata",
484
+ "summary": "Metadata component names to preview.",
577
485
  "hasDynamicHelp": false,
578
- "multiple": false,
486
+ "multiple": true,
579
487
  "type": "option"
580
488
  },
581
- "target-org": {
582
- "aliases": [
583
- "targetusername",
584
- "u"
489
+ "source-dir": {
490
+ "char": "d",
491
+ "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.",
492
+ "exclusive": [
493
+ "manifest",
494
+ "metadata"
585
495
  ],
496
+ "name": "source-dir",
497
+ "summary": "Path to the local source files to preview.",
498
+ "hasDynamicHelp": false,
499
+ "multiple": true,
500
+ "type": "option"
501
+ },
502
+ "target-org": {
586
503
  "char": "o",
587
- "deprecateAliases": true,
588
- "name": "target-org",
589
- "noCacheDefault": true,
590
- "required": true,
591
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
592
- "hasDynamicHelp": true,
593
- "multiple": false,
594
- "type": "option"
595
- },
596
- "no-prompt": {
597
- "aliases": [
598
- "noprompt"
599
- ],
600
- "char": "p",
601
- "deprecateAliases": true,
602
- "name": "no-prompt",
603
- "summary": "Don't prompt for source tracking override confirmation.",
604
- "allowNo": false,
605
- "type": "boolean"
606
- }
607
- },
608
- "hasDynamicHelp": true,
609
- "hiddenAliases": [],
610
- "id": "project:delete:tracking",
611
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
612
- "pluginName": "@salesforce/plugin-deploy-retrieve",
613
- "pluginType": "core",
614
- "strict": true,
615
- "summary": "Delete all local source tracking information.",
616
- "enableJsonFlag": true,
617
- "requiresProject": true,
618
- "isESM": true,
619
- "relativePath": [
620
- "lib",
621
- "commands",
622
- "project",
623
- "delete",
624
- "tracking.js"
625
- ],
626
- "aliasPermutations": [
627
- "force:source:tracking:clear",
628
- "source:force:tracking:clear",
629
- "source:tracking:force:clear",
630
- "source:tracking:clear:force",
631
- "force:tracking:source:clear",
632
- "tracking:force:source:clear",
633
- "tracking:source:force:clear",
634
- "tracking:source:clear:force",
635
- "force:tracking:clear:source",
636
- "tracking:force:clear:source",
637
- "tracking:clear:force:source",
638
- "tracking:clear:source:force",
639
- "force:source:clear:tracking",
640
- "source:force:clear:tracking",
641
- "source:clear:force:tracking",
642
- "source:clear:tracking:force",
643
- "force:clear:source:tracking",
644
- "clear:force:source:tracking",
645
- "clear:source:force:tracking",
646
- "clear:source:tracking:force",
647
- "force:clear:tracking:source",
648
- "clear:force:tracking:source",
649
- "clear:tracking:force:source",
650
- "clear:tracking:source:force"
651
- ],
652
- "permutations": [
653
- "project:delete:tracking",
654
- "delete:project:tracking",
655
- "delete:tracking:project",
656
- "project:tracking:delete",
657
- "tracking:project:delete",
658
- "tracking:delete:project"
659
- ]
660
- },
661
- "project:deploy:cancel": {
662
- "aliases": [
663
- "deploy:metadata:cancel"
664
- ],
665
- "args": {},
666
- "deprecateAliases": true,
667
- "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.",
668
- "examples": [
669
- "Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
670
- "Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
671
- ],
672
- "flags": {
673
- "json": {
674
- "description": "Format output as json.",
675
- "helpGroup": "GLOBAL",
676
- "name": "json",
677
- "allowNo": false,
678
- "type": "boolean"
679
- },
680
- "flags-dir": {
681
- "helpGroup": "GLOBAL",
682
- "name": "flags-dir",
683
- "summary": "Import flag values from a directory.",
684
- "hasDynamicHelp": false,
685
- "multiple": false,
686
- "type": "option"
687
- },
688
- "target-org": {
689
- "char": "o",
690
- "description": "Overrides your default org.",
691
- "name": "target-org",
692
- "noCacheDefault": true,
693
- "summary": "Login username or alias for the target org.",
694
- "hasDynamicHelp": true,
695
- "multiple": false,
696
- "type": "option"
697
- },
698
- "async": {
699
- "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\".",
700
- "exclusive": [
701
- "wait"
702
- ],
703
- "name": "async",
704
- "summary": "Run the command asynchronously.",
705
- "allowNo": false,
706
- "type": "boolean"
707
- },
708
- "job-id": {
709
- "char": "i",
710
- "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.",
711
- "name": "job-id",
712
- "summary": "Job ID of the deploy operation you want to cancel.",
713
- "hasDynamicHelp": false,
714
- "multiple": false,
715
- "type": "option"
716
- },
717
- "use-most-recent": {
718
- "char": "r",
719
- "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.",
720
- "name": "use-most-recent",
721
- "summary": "Use the job ID of the most recent deploy operation.",
722
- "allowNo": false,
723
- "type": "boolean"
724
- },
725
- "wait": {
726
- "char": "w",
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 cancellation, run \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
728
- "exclusive": [
729
- "async"
730
- ],
731
- "name": "wait",
732
- "summary": "Number of minutes to wait for the command to complete and display results.",
733
- "hasDynamicHelp": true,
734
- "helpValue": "<minutes>",
735
- "multiple": false,
736
- "type": "option"
737
- }
738
- },
739
- "hasDynamicHelp": true,
740
- "hiddenAliases": [],
741
- "id": "project:deploy:cancel",
742
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
743
- "pluginName": "@salesforce/plugin-deploy-retrieve",
744
- "pluginType": "core",
745
- "strict": true,
746
- "summary": "Cancel a deploy operation.",
747
- "enableJsonFlag": true,
748
- "isESM": true,
749
- "relativePath": [
750
- "lib",
751
- "commands",
752
- "project",
753
- "deploy",
754
- "cancel.js"
755
- ],
756
- "aliasPermutations": [
757
- "deploy:metadata:cancel",
758
- "metadata:deploy:cancel",
759
- "metadata:cancel:deploy",
760
- "deploy:cancel:metadata",
761
- "cancel:deploy:metadata",
762
- "cancel:metadata:deploy"
763
- ],
764
- "permutations": [
765
- "project:deploy:cancel",
766
- "deploy:project:cancel",
767
- "deploy:cancel:project",
768
- "project:cancel:deploy",
769
- "cancel:project:deploy",
770
- "cancel:deploy:project"
771
- ]
772
- },
773
- "project:deploy:preview": {
774
- "aliases": [
775
- "deploy:metadata:preview"
776
- ],
777
- "args": {},
778
- "deprecateAliases": true,
779
- "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.",
780
- "examples": [
781
- "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.",
782
- "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",
783
- "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",
784
- "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
785
- "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
786
- ],
787
- "flags": {
788
- "json": {
789
- "description": "Format output as json.",
790
- "helpGroup": "GLOBAL",
791
- "name": "json",
792
- "allowNo": false,
793
- "type": "boolean"
794
- },
795
- "flags-dir": {
796
- "helpGroup": "GLOBAL",
797
- "name": "flags-dir",
798
- "summary": "Import flag values from a directory.",
799
- "hasDynamicHelp": false,
800
- "multiple": false,
801
- "type": "option"
802
- },
803
- "ignore-conflicts": {
804
- "char": "c",
805
- "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.",
806
- "name": "ignore-conflicts",
807
- "summary": "Don't display conflicts in preview of the deployment.",
808
- "allowNo": false,
809
- "type": "boolean"
810
- },
811
- "manifest": {
812
- "char": "x",
813
- "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
814
- "exclusive": [
815
- "source-dir",
816
- "metadata"
817
- ],
818
- "name": "manifest",
819
- "summary": "Full file path for manifest (package.xml) of components to preview.",
820
- "hasDynamicHelp": false,
821
- "multiple": false,
822
- "type": "option"
823
- },
824
- "metadata": {
825
- "char": "m",
826
- "exclusive": [
827
- "manifest",
828
- "source-dir"
829
- ],
830
- "name": "metadata",
831
- "summary": "Metadata component names to preview.",
832
- "hasDynamicHelp": false,
833
- "multiple": true,
834
- "type": "option"
835
- },
836
- "source-dir": {
837
- "char": "d",
838
- "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.",
839
- "exclusive": [
840
- "manifest",
841
- "metadata"
842
- ],
843
- "name": "source-dir",
844
- "summary": "Path to the local source files to preview.",
845
- "hasDynamicHelp": false,
846
- "multiple": true,
847
- "type": "option"
848
- },
849
- "target-org": {
850
- "char": "o",
851
- "description": "Overrides your default org.",
504
+ "description": "Overrides your default org.",
852
505
  "name": "target-org",
853
506
  "noCacheDefault": true,
854
507
  "required": true,
@@ -905,10 +558,10 @@
905
558
  ],
906
559
  "args": {},
907
560
  "deprecateAliases": true,
908
- "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 `sf project deploy start` instead.",
561
+ "description": "Before you run this command, first create a validated deployment with the \"sf 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 `sf project deploy start` instead.",
909
562
  "examples": [
910
- "Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
911
- "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"
563
+ "Run a quick deploy to your default org using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
564
+ "Asynchronously run a quick deploy of the most recently validated deployment to an org with alias \"my-prod-org\":\nsf <%= command.id %> --async --use-most-recent --target-org my-prod-org"
912
565
  ],
913
566
  "flags": {
914
567
  "json": {
@@ -927,7 +580,7 @@
927
580
  "type": "option"
928
581
  },
929
582
  "async": {
930
- "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\".",
583
+ "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 \"sf project deploy resume\". To check the status of the deploy, run \"sf project deploy report\".",
931
584
  "exclusive": [
932
585
  "wait"
933
586
  ],
@@ -983,7 +636,7 @@
983
636
  },
984
637
  "wait": {
985
638
  "char": "w",
986
- "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\".",
639
+ "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 \"sf project deploy resume\". To check the status of the deploy, run \"sf project deploy report\".",
987
640
  "exclusive": [
988
641
  "async"
989
642
  ],
@@ -1080,9 +733,9 @@
1080
733
  "deprecateAliases": true,
1081
734
  "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.",
1082
735
  "examples": [
1083
- "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1084
- "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
1085
- "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"
736
+ "Check the status using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
737
+ "Check the status of the most recent deploy operation:\nsf <%= command.id %> --use-most-recent",
738
+ "Poll for the status using a job ID and target org:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30"
1086
739
  ],
1087
740
  "flags": {
1088
741
  "json": {
@@ -1112,7 +765,7 @@
1112
765
  },
1113
766
  "job-id": {
1114
767
  "char": "i",
1115
- "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.",
768
+ "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.",
1116
769
  "name": "job-id",
1117
770
  "summary": "Job ID of the deploy operation you want to check the status of.",
1118
771
  "hasDynamicHelp": false,
@@ -1175,7 +828,7 @@
1175
828
  },
1176
829
  "wait": {
1177
830
  "char": "w",
1178
- "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\".",
831
+ "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 \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1179
832
  "name": "wait",
1180
833
  "summary": "Number of minutes to wait for command to complete and display results.",
1181
834
  "hasDynamicHelp": true,
@@ -1226,8 +879,8 @@
1226
879
  "deprecateAliases": true,
1227
880
  "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.",
1228
881
  "examples": [
1229
- "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1230
- "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
882
+ "Resume watching a deploy operation using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
883
+ "Resume watching the most recent deploy operation:\nsf <%= command.id %> --use-most-recent"
1231
884
  ],
1232
885
  "flags": {
1233
886
  "json": {
@@ -1256,7 +909,7 @@
1256
909
  },
1257
910
  "job-id": {
1258
911
  "char": "i",
1259
- "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.",
912
+ "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.",
1260
913
  "name": "job-id",
1261
914
  "summary": "Job ID of the deploy operation you want to resume.",
1262
915
  "hasDynamicHelp": false,
@@ -1282,7 +935,7 @@
1282
935
  },
1283
936
  "wait": {
1284
937
  "char": "w",
1285
- "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\".",
938
+ "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 \"sf project deploy report\".",
1286
939
  "name": "wait",
1287
940
  "summary": "Number of minutes to wait for the command to complete and display results.",
1288
941
  "hasDynamicHelp": true,
@@ -1419,18 +1072,18 @@
1419
1072
  ],
1420
1073
  "args": {},
1421
1074
  "deprecateAliases": true,
1422
- "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.",
1075
+ "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 \"sf 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.",
1423
1076
  "examples": [
1424
- "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1425
- "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",
1426
- "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",
1427
- "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1428
- "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",
1429
- "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",
1430
- "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",
1431
- "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\"",
1432
- "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
1433
- "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"
1077
+ "Deploy local changes not in the org; uses your default org:\nsf <%= command.id %>",
1078
+ "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:\nsf <%= command.id %> --source-dir force-app --target-org my-scratch --concise",
1079
+ "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:\nsf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\nsf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
1080
+ "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\nsf <%= command.id %> --metadata ApexClass",
1081
+ "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!):\nsf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
1082
+ "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):\nsf <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
1083
+ "Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\nsf <%= command.id %> --metadata CustomObject ApexClass\nsf <%= command.id %> --metadata CustomObject --metadata ApexClass",
1084
+ "Deploy all Apex classes and a profile that has a space in its name:\nsf <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
1085
+ "Deploy all components listed in a manifest:\nsf <%= command.id %> --manifest path/to/package.xml",
1086
+ "Run the tests that aren’t in any managed packages as part of a deployment:\nsf <%= command.id %> --metadata ApexClass --test-level RunLocalTests"
1434
1087
  ],
1435
1088
  "flags": {
1436
1089
  "json": {
@@ -1458,7 +1111,7 @@
1458
1111
  "type": "option"
1459
1112
  },
1460
1113
  "async": {
1461
- "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\".",
1114
+ "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 \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1462
1115
  "exclusive": [
1463
1116
  "wait"
1464
1117
  ],
@@ -1621,7 +1274,7 @@
1621
1274
  },
1622
1275
  "wait": {
1623
1276
  "char": "w",
1624
- "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\".",
1277
+ "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 \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1625
1278
  "exclusive": [
1626
1279
  "async"
1627
1280
  ],
@@ -1815,13 +1468,13 @@
1815
1468
  ],
1816
1469
  "args": {},
1817
1470
  "deprecateAliases": true,
1818
- "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 \"sf project deploy start --dry-run --test-level RunLocalTests\" instead.",
1471
+ "description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"sf 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 \"sf 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 \"sf project deploy start --dry-run --test-level RunLocalTests\" instead.",
1819
1472
  "examples": [
1820
- "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.",
1821
- "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",
1822
- "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",
1823
- "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",
1824
- "Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
1473
+ "NOTE: These examples focus on validating large deployments. See the help for \"sf project deploy start\" for examples of deploying smaller sets of metadata which you can also use to validate.",
1474
+ "Validate the deployment of all source files in the \"force-app\" directory to the default org:\nsf <%= command.id %> --source-dir force-app",
1475
+ "Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\nsf <%= command.id %> --source-dir force-app --source-dir force-app-utils",
1476
+ "Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\nsf <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
1477
+ "Validate the deployment of all components listed in a manifest:\nsf <%= command.id %> --manifest path/to/package.xml"
1825
1478
  ],
1826
1479
  "flags": {
1827
1480
  "json": {
@@ -1849,7 +1502,7 @@
1849
1502
  "type": "option"
1850
1503
  },
1851
1504
  "async": {
1852
- "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\".",
1505
+ "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 \"sf project deploy resume\". To check the status of the validation, run \"sf project deploy report\".",
1853
1506
  "name": "async",
1854
1507
  "summary": "Run the command asynchronously.",
1855
1508
  "allowNo": false,
@@ -1959,7 +1612,7 @@
1959
1612
  },
1960
1613
  "wait": {
1961
1614
  "char": "w",
1962
- "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\".",
1615
+ "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 \"sf project deploy resume\". To check the status of the validation, run \"sf project deploy report\".",
1963
1616
  "name": "wait",
1964
1617
  "summary": "Number of minutes to wait for the command to complete and display results.",
1965
1618
  "hasDynamicHelp": true,
@@ -2156,6 +1809,353 @@
2156
1809
  "validate:deploy:project"
2157
1810
  ]
2158
1811
  },
1812
+ "project:delete:source": {
1813
+ "aliases": [
1814
+ "force:source:delete"
1815
+ ],
1816
+ "args": {},
1817
+ "deprecateAliases": true,
1818
+ "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, \"sf 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.",
1819
+ "examples": [
1820
+ "Delete all local Apex source files and all Apex classes from the org with alias \"my-scratch\":\nsf <%= command.id %> --metadata ApexClass --target-org my-scratch",
1821
+ "Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:\nsf <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata \"Profile: My Profile\" --no-prompt",
1822
+ "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",
1823
+ "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"
1824
+ ],
1825
+ "flags": {
1826
+ "json": {
1827
+ "description": "Format output as json.",
1828
+ "helpGroup": "GLOBAL",
1829
+ "name": "json",
1830
+ "allowNo": false,
1831
+ "type": "boolean"
1832
+ },
1833
+ "flags-dir": {
1834
+ "helpGroup": "GLOBAL",
1835
+ "name": "flags-dir",
1836
+ "summary": "Import flag values from a directory.",
1837
+ "hasDynamicHelp": false,
1838
+ "multiple": false,
1839
+ "type": "option"
1840
+ },
1841
+ "api-version": {
1842
+ "aliases": [
1843
+ "apiversion"
1844
+ ],
1845
+ "deprecateAliases": true,
1846
+ "description": "Override the api version used for api requests made by this command",
1847
+ "name": "api-version",
1848
+ "hasDynamicHelp": false,
1849
+ "multiple": false,
1850
+ "type": "option"
1851
+ },
1852
+ "loglevel": {
1853
+ "deprecated": {
1854
+ "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."
1855
+ },
1856
+ "hidden": true,
1857
+ "name": "loglevel",
1858
+ "hasDynamicHelp": false,
1859
+ "multiple": false,
1860
+ "type": "option"
1861
+ },
1862
+ "target-org": {
1863
+ "aliases": [
1864
+ "targetusername",
1865
+ "u"
1866
+ ],
1867
+ "char": "o",
1868
+ "deprecateAliases": true,
1869
+ "name": "target-org",
1870
+ "noCacheDefault": true,
1871
+ "required": true,
1872
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1873
+ "hasDynamicHelp": true,
1874
+ "multiple": false,
1875
+ "type": "option"
1876
+ },
1877
+ "check-only": {
1878
+ "aliases": [
1879
+ "checkonly"
1880
+ ],
1881
+ "char": "c",
1882
+ "deprecateAliases": true,
1883
+ "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.",
1884
+ "name": "check-only",
1885
+ "summary": "Validate delete command but don't delete anything from the org or the local project.",
1886
+ "allowNo": false,
1887
+ "type": "boolean"
1888
+ },
1889
+ "wait": {
1890
+ "char": "w",
1891
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
1892
+ "name": "wait",
1893
+ "summary": "Number of minutes to wait for the command to finish.",
1894
+ "hasDynamicHelp": true,
1895
+ "multiple": false,
1896
+ "type": "option"
1897
+ },
1898
+ "tests": {
1899
+ "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\"",
1900
+ "helpGroup": "Test",
1901
+ "name": "tests",
1902
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1903
+ "hasDynamicHelp": false,
1904
+ "multiple": true,
1905
+ "type": "option"
1906
+ },
1907
+ "test-level": {
1908
+ "aliases": [
1909
+ "testlevel"
1910
+ ],
1911
+ "char": "l",
1912
+ "deprecateAliases": true,
1913
+ "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.",
1914
+ "helpGroup": "Test",
1915
+ "name": "test-level",
1916
+ "summary": "Deployment Apex testing level.",
1917
+ "hasDynamicHelp": false,
1918
+ "multiple": false,
1919
+ "options": [
1920
+ "NoTestRun",
1921
+ "RunSpecifiedTests",
1922
+ "RunLocalTests",
1923
+ "RunAllTestsInOrg"
1924
+ ],
1925
+ "type": "option"
1926
+ },
1927
+ "no-prompt": {
1928
+ "aliases": [
1929
+ "noprompt"
1930
+ ],
1931
+ "char": "r",
1932
+ "deprecateAliases": true,
1933
+ "name": "no-prompt",
1934
+ "summary": "Don't prompt for delete confirmation.",
1935
+ "allowNo": false,
1936
+ "type": "boolean"
1937
+ },
1938
+ "metadata": {
1939
+ "char": "m",
1940
+ "description": "If you specify this parameter, don’t specify --source-dir.",
1941
+ "name": "metadata",
1942
+ "summary": "Metadata components to delete.",
1943
+ "delimiter": ",",
1944
+ "hasDynamicHelp": false,
1945
+ "multiple": true,
1946
+ "type": "option"
1947
+ },
1948
+ "source-dir": {
1949
+ "aliases": [
1950
+ "sourcepath"
1951
+ ],
1952
+ "char": "p",
1953
+ "deprecateAliases": true,
1954
+ "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.",
1955
+ "name": "source-dir",
1956
+ "summary": "Source file paths to delete.",
1957
+ "delimiter": ",",
1958
+ "hasDynamicHelp": false,
1959
+ "multiple": true,
1960
+ "type": "option"
1961
+ },
1962
+ "track-source": {
1963
+ "aliases": [
1964
+ "tracksource"
1965
+ ],
1966
+ "char": "t",
1967
+ "deprecateAliases": true,
1968
+ "exclusive": [
1969
+ "check-only"
1970
+ ],
1971
+ "name": "track-source",
1972
+ "summary": "If the delete succeeds, update the source tracking information.",
1973
+ "allowNo": false,
1974
+ "type": "boolean"
1975
+ },
1976
+ "force-overwrite": {
1977
+ "aliases": [
1978
+ "forceoverwrite"
1979
+ ],
1980
+ "char": "f",
1981
+ "dependsOn": [
1982
+ "track-source"
1983
+ ],
1984
+ "deprecateAliases": true,
1985
+ "name": "force-overwrite",
1986
+ "summary": "Ignore conflict warnings and overwrite changes to the org.",
1987
+ "allowNo": false,
1988
+ "type": "boolean"
1989
+ },
1990
+ "verbose": {
1991
+ "name": "verbose",
1992
+ "summary": "Verbose output of the delete result.",
1993
+ "allowNo": false,
1994
+ "type": "boolean"
1995
+ }
1996
+ },
1997
+ "hasDynamicHelp": true,
1998
+ "hiddenAliases": [],
1999
+ "id": "project:delete:source",
2000
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2001
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2002
+ "pluginType": "core",
2003
+ "strict": true,
2004
+ "summary": "Delete source from your project and from a non-source-tracked org.",
2005
+ "enableJsonFlag": true,
2006
+ "requiresProject": true,
2007
+ "isESM": true,
2008
+ "relativePath": [
2009
+ "lib",
2010
+ "commands",
2011
+ "project",
2012
+ "delete",
2013
+ "source.js"
2014
+ ],
2015
+ "aliasPermutations": [
2016
+ "force:source:delete",
2017
+ "source:force:delete",
2018
+ "source:delete:force",
2019
+ "force:delete:source",
2020
+ "delete:force:source",
2021
+ "delete:source:force"
2022
+ ],
2023
+ "permutations": [
2024
+ "project:delete:source",
2025
+ "delete:project:source",
2026
+ "delete:source:project",
2027
+ "project:source:delete",
2028
+ "source:project:delete",
2029
+ "source:delete:project"
2030
+ ]
2031
+ },
2032
+ "project:delete:tracking": {
2033
+ "aliases": [
2034
+ "force:source:tracking:clear"
2035
+ ],
2036
+ "args": {},
2037
+ "deprecateAliases": true,
2038
+ "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.",
2039
+ "examples": [
2040
+ "Delete local source tracking for the org with alias \"my-scratch\":\n$ sf <%= command.id %> --target-org my-scratch"
2041
+ ],
2042
+ "flags": {
2043
+ "json": {
2044
+ "description": "Format output as json.",
2045
+ "helpGroup": "GLOBAL",
2046
+ "name": "json",
2047
+ "allowNo": false,
2048
+ "type": "boolean"
2049
+ },
2050
+ "flags-dir": {
2051
+ "helpGroup": "GLOBAL",
2052
+ "name": "flags-dir",
2053
+ "summary": "Import flag values from a directory.",
2054
+ "hasDynamicHelp": false,
2055
+ "multiple": false,
2056
+ "type": "option"
2057
+ },
2058
+ "api-version": {
2059
+ "aliases": [
2060
+ "apiversion"
2061
+ ],
2062
+ "deprecateAliases": true,
2063
+ "description": "Override the api version used for api requests made by this command",
2064
+ "name": "api-version",
2065
+ "hasDynamicHelp": false,
2066
+ "multiple": false,
2067
+ "type": "option"
2068
+ },
2069
+ "loglevel": {
2070
+ "deprecated": {
2071
+ "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."
2072
+ },
2073
+ "hidden": true,
2074
+ "name": "loglevel",
2075
+ "hasDynamicHelp": false,
2076
+ "multiple": false,
2077
+ "type": "option"
2078
+ },
2079
+ "target-org": {
2080
+ "aliases": [
2081
+ "targetusername",
2082
+ "u"
2083
+ ],
2084
+ "char": "o",
2085
+ "deprecateAliases": true,
2086
+ "name": "target-org",
2087
+ "noCacheDefault": true,
2088
+ "required": true,
2089
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2090
+ "hasDynamicHelp": true,
2091
+ "multiple": false,
2092
+ "type": "option"
2093
+ },
2094
+ "no-prompt": {
2095
+ "aliases": [
2096
+ "noprompt"
2097
+ ],
2098
+ "char": "p",
2099
+ "deprecateAliases": true,
2100
+ "name": "no-prompt",
2101
+ "summary": "Don't prompt for source tracking override confirmation.",
2102
+ "allowNo": false,
2103
+ "type": "boolean"
2104
+ }
2105
+ },
2106
+ "hasDynamicHelp": true,
2107
+ "hiddenAliases": [],
2108
+ "id": "project:delete:tracking",
2109
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2110
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2111
+ "pluginType": "core",
2112
+ "strict": true,
2113
+ "summary": "Delete all local source tracking information.",
2114
+ "enableJsonFlag": true,
2115
+ "requiresProject": true,
2116
+ "isESM": true,
2117
+ "relativePath": [
2118
+ "lib",
2119
+ "commands",
2120
+ "project",
2121
+ "delete",
2122
+ "tracking.js"
2123
+ ],
2124
+ "aliasPermutations": [
2125
+ "force:source:tracking:clear",
2126
+ "source:force:tracking:clear",
2127
+ "source:tracking:force:clear",
2128
+ "source:tracking:clear:force",
2129
+ "force:tracking:source:clear",
2130
+ "tracking:force:source:clear",
2131
+ "tracking:source:force:clear",
2132
+ "tracking:source:clear:force",
2133
+ "force:tracking:clear:source",
2134
+ "tracking:force:clear:source",
2135
+ "tracking:clear:force:source",
2136
+ "tracking:clear:source:force",
2137
+ "force:source:clear:tracking",
2138
+ "source:force:clear:tracking",
2139
+ "source:clear:force:tracking",
2140
+ "source:clear:tracking:force",
2141
+ "force:clear:source:tracking",
2142
+ "clear:force:source:tracking",
2143
+ "clear:source:force:tracking",
2144
+ "clear:source:tracking:force",
2145
+ "force:clear:tracking:source",
2146
+ "clear:force:tracking:source",
2147
+ "clear:tracking:force:source",
2148
+ "clear:tracking:source:force"
2149
+ ],
2150
+ "permutations": [
2151
+ "project:delete:tracking",
2152
+ "delete:project:tracking",
2153
+ "delete:tracking:project",
2154
+ "project:tracking:delete",
2155
+ "tracking:project:delete",
2156
+ "tracking:delete:project"
2157
+ ]
2158
+ },
2159
2159
  "project:generate:manifest": {
2160
2160
  "aliases": [
2161
2161
  "force:source:manifest:create"
@@ -2164,10 +2164,10 @@
2164
2164
  "deprecateAliases": true,
2165
2165
  "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.",
2166
2166
  "examples": [
2167
- "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
2168
- "Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
2169
- "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",
2170
- "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"
2167
+ "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ sf <%= command.id %> --metadata ApexClass --metadata CustomObject",
2168
+ "Create a manifest for deleting the specified Apex class:\n$ sf <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
2169
+ "Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:\n$ sf <%= command.id %> --source-dir force-app --name myNewManifest",
2170
+ "Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:\n$ sf <%= command.id %> --from-org test@myorg.com --include-packages unlocked"
2171
2171
  ],
2172
2172
  "flags": {
2173
2173
  "json": {
@@ -2370,9 +2370,9 @@
2370
2370
  "deprecateAliases": true,
2371
2371
  "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.",
2372
2372
  "examples": [
2373
- "List all the files in all package directories that are ignored:\n<%= config.bin %> <%= command.id %>",
2374
- "List all the files in a specific directory that are ignored:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
2375
- "Check if a particular file is ignored:\n<%= config.bin %> <%= command.id %> --source-dir package.xml"
2373
+ "List all the files in all package directories that are ignored:\nsf <%= command.id %>",
2374
+ "List all the files in a specific directory that are ignored:\nsf <%= command.id %> --source-dir force-app",
2375
+ "Check if a particular file is ignored:\nsf <%= command.id %> --source-dir package.xml"
2376
2376
  ],
2377
2377
  "flags": {
2378
2378
  "json": {
@@ -2462,10 +2462,10 @@
2462
2462
  ],
2463
2463
  "args": {},
2464
2464
  "deprecateAliases": true,
2465
- "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",
2465
+ "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 sf data query --query \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" --use-tooling-api --target-org my-scratch",
2466
2466
  "examples": [
2467
- "Reset source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch",
2468
- "Reset source tracking to revision number 30 for your default org:\n$ <%= config.bin %> <%= command.id %> --revision 30"
2467
+ "Reset source tracking for the org with alias \"my-scratch\":\n$ sf <%= command.id %> --target-org my-scratch",
2468
+ "Reset source tracking to revision number 30 for your default org:\n$ sf <%= command.id %> --revision 30"
2469
2469
  ],
2470
2470
  "flags": {
2471
2471
  "json": {
@@ -2598,10 +2598,10 @@
2598
2598
  ],
2599
2599
  "args": {},
2600
2600
  "deprecateAliases": true,
2601
- "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.",
2601
+ "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 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 \"sf org create scratch|sandbox\" commands.",
2602
2602
  "examples": [
2603
- "Preview the retrieve of all changes from your default org:\n<%= config.bin %> <%= command.id %>",
2604
- "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"
2603
+ "Preview the retrieve of all changes from your default org:\nsf <%= command.id %>",
2604
+ "Preview the retrieve when ignoring any conflicts from an org with alias \"my-scratch\":\nsf <%= command.id %> --ignore-conflicts --target-org my-scratch"
2605
2605
  ],
2606
2606
  "flags": {
2607
2607
  "json": {
@@ -2686,20 +2686,20 @@
2686
2686
  ],
2687
2687
  "args": {},
2688
2688
  "deprecateAliases": true,
2689
- "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.",
2689
+ "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 \"sf 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.",
2690
2690
  "examples": [
2691
- "Retrieve all remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
2692
- "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",
2693
- "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",
2694
- "Retrieve all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
2695
- "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",
2696
- "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*'",
2697
- "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",
2698
- "Retrieve all metadata components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
2699
- "Retrieve metadata from a package:\n<%= config.bin %> <%= command.id %> --package-name MyPackageName",
2700
- "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",
2701
- "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",
2702
- "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"
2691
+ "Retrieve all remote changes from your default org:\nsf <%= command.id %>",
2692
+ "Retrieve the source files in the \"force-app\" directory from an org with alias \"my-scratch\":\nsf <%= command.id %> --source-dir force-app --target-org my-scratch",
2693
+ "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:\nsf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\nsf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
2694
+ "Retrieve all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\nsf <%= command.id %> --metadata ApexClass",
2695
+ "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!):\nsf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
2696
+ "Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string \"MyApex\":\nsf <%= command.id %> --metadata 'ApexClass:MyApex*'",
2697
+ "Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\nsf <%= command.id %> --metadata CustomObject ApexClass\nsf <%= command.id %> --metadata CustomObject --metadata ApexClass",
2698
+ "Retrieve all metadata components listed in a manifest:\nsf <%= command.id %> --manifest path/to/package.xml",
2699
+ "Retrieve metadata from a package:\nsf <%= command.id %> --package-name MyPackageName",
2700
+ "Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):\nsf <%= command.id %> --package-name Package1 \"PackageName With Spaces\" Package3\nsf <%= command.id %> --package-name Package1 --package-name \"PackageName With Spaces\" --package-name Package3",
2701
+ "Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the \"output\" directory:\nsf <%= command.id %> --source-dir force-app --target-metadata-dir output",
2702
+ "Retrieve in metadata format and automatically extract the contents into the \"output\" directory:\nsf <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip"
2703
2703
  ],
2704
2704
  "flags": {
2705
2705
  "json": {
@@ -2936,5 +2936,5 @@
2936
2936
  ]
2937
2937
  }
2938
2938
  },
2939
- "version": "3.7.9"
2939
+ "version": "3.7.10"
2940
2940
  }