@salesforce/plugin-deploy-retrieve 3.2.23 → 3.2.25

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.
@@ -202,7 +202,7 @@
202
202
  "deprecateAliases": true,
203
203
  "name": "output-dir",
204
204
  "summary": "Output directory to store the Metadata API–formatted files in.",
205
- "default": "metadataPackage_1709380111509",
205
+ "default": "metadataPackage_1709594365139",
206
206
  "hasDynamicHelp": false,
207
207
  "multiple": false,
208
208
  "type": "option"
@@ -295,18 +295,16 @@
295
295
  "source:convert:project"
296
296
  ]
297
297
  },
298
- "project:delete:source": {
298
+ "project:deploy:cancel": {
299
299
  "aliases": [
300
- "force:source:delete"
300
+ "deploy:metadata:cancel"
301
301
  ],
302
302
  "args": {},
303
303
  "deprecateAliases": true,
304
- "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.",
304
+ "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.",
305
305
  "examples": [
306
- "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",
307
- "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",
308
- "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",
309
- "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"
306
+ "Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
307
+ "Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
310
308
  ],
311
309
  "flags": {
312
310
  "json": {
@@ -316,174 +314,175 @@
316
314
  "allowNo": false,
317
315
  "type": "boolean"
318
316
  },
319
- "api-version": {
320
- "aliases": [
321
- "apiversion"
317
+ "async": {
318
+ "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\".",
319
+ "exclusive": [
320
+ "wait"
322
321
  ],
323
- "deprecateAliases": true,
324
- "description": "Override the api version used for api requests made by this command",
325
- "name": "api-version",
326
- "hasDynamicHelp": false,
327
- "multiple": false,
328
- "type": "option"
322
+ "name": "async",
323
+ "summary": "Run the command asynchronously.",
324
+ "allowNo": false,
325
+ "type": "boolean"
329
326
  },
330
- "loglevel": {
331
- "deprecated": {
332
- "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."
333
- },
334
- "hidden": true,
335
- "name": "loglevel",
327
+ "job-id": {
328
+ "char": "i",
329
+ "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.",
330
+ "name": "job-id",
331
+ "summary": "Job ID of the deploy operation you want to cancel.",
336
332
  "hasDynamicHelp": false,
337
333
  "multiple": false,
338
334
  "type": "option"
339
335
  },
340
- "target-org": {
341
- "aliases": [
342
- "targetusername",
343
- "u"
344
- ],
345
- "char": "o",
346
- "deprecateAliases": true,
347
- "name": "target-org",
348
- "noCacheDefault": true,
349
- "required": true,
350
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
351
- "hasDynamicHelp": true,
352
- "multiple": false,
353
- "type": "option"
354
- },
355
- "check-only": {
356
- "aliases": [
357
- "checkonly"
358
- ],
359
- "char": "c",
360
- "deprecateAliases": true,
361
- "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.",
362
- "name": "check-only",
363
- "summary": "Validate delete command but don't delete anything from the org or the local project.",
336
+ "use-most-recent": {
337
+ "char": "r",
338
+ "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.",
339
+ "name": "use-most-recent",
340
+ "summary": "Use the job ID of the most recent deploy operation.",
364
341
  "allowNo": false,
365
342
  "type": "boolean"
366
343
  },
367
344
  "wait": {
368
345
  "char": "w",
369
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
346
+ "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\".",
347
+ "exclusive": [
348
+ "async"
349
+ ],
370
350
  "name": "wait",
371
- "summary": "Number of minutes to wait for the command to finish.",
372
- "default": {
373
- "quantity": 33,
374
- "unit": 0
375
- },
351
+ "summary": "Number of minutes to wait for the command to complete and display results.",
376
352
  "hasDynamicHelp": false,
353
+ "helpValue": "<minutes>",
377
354
  "multiple": false,
378
355
  "type": "option"
356
+ }
357
+ },
358
+ "hasDynamicHelp": false,
359
+ "hiddenAliases": [],
360
+ "id": "project:deploy:cancel",
361
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
362
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
363
+ "pluginType": "core",
364
+ "strict": true,
365
+ "summary": "Cancel a deploy operation.",
366
+ "enableJsonFlag": true,
367
+ "isESM": true,
368
+ "relativePath": [
369
+ "lib",
370
+ "commands",
371
+ "project",
372
+ "deploy",
373
+ "cancel.js"
374
+ ],
375
+ "aliasPermutations": [
376
+ "deploy:metadata:cancel",
377
+ "metadata:deploy:cancel",
378
+ "metadata:cancel:deploy",
379
+ "deploy:cancel:metadata",
380
+ "cancel:deploy:metadata",
381
+ "cancel:metadata:deploy"
382
+ ],
383
+ "permutations": [
384
+ "project:deploy:cancel",
385
+ "deploy:project:cancel",
386
+ "deploy:cancel:project",
387
+ "project:cancel:deploy",
388
+ "cancel:project:deploy",
389
+ "cancel:deploy:project"
390
+ ]
391
+ },
392
+ "project:deploy:preview": {
393
+ "aliases": [
394
+ "deploy:metadata:preview"
395
+ ],
396
+ "args": {},
397
+ "deprecateAliases": true,
398
+ "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.",
399
+ "examples": [
400
+ "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.",
401
+ "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",
402
+ "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",
403
+ "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
404
+ "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
405
+ ],
406
+ "flags": {
407
+ "json": {
408
+ "description": "Format output as json.",
409
+ "helpGroup": "GLOBAL",
410
+ "name": "json",
411
+ "allowNo": false,
412
+ "type": "boolean"
379
413
  },
380
- "tests": {
381
- "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\"",
382
- "helpGroup": "Test",
383
- "name": "tests",
384
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
385
- "hasDynamicHelp": false,
386
- "multiple": true,
387
- "type": "option"
414
+ "ignore-conflicts": {
415
+ "char": "c",
416
+ "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.",
417
+ "name": "ignore-conflicts",
418
+ "summary": "Don't display conflicts in preview of the deployment.",
419
+ "allowNo": false,
420
+ "type": "boolean"
388
421
  },
389
- "test-level": {
390
- "aliases": [
391
- "testlevel"
422
+ "manifest": {
423
+ "char": "x",
424
+ "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
425
+ "exclusive": [
426
+ "source-dir",
427
+ "metadata"
392
428
  ],
393
- "char": "l",
394
- "deprecateAliases": true,
395
- "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.",
396
- "helpGroup": "Test",
397
- "name": "test-level",
398
- "summary": "Deployment Apex testing level.",
429
+ "name": "manifest",
430
+ "summary": "Full file path for manifest (package.xml) of components to preview.",
399
431
  "hasDynamicHelp": false,
400
432
  "multiple": false,
401
- "options": [
402
- "NoTestRun",
403
- "RunSpecifiedTests",
404
- "RunLocalTests",
405
- "RunAllTestsInOrg"
406
- ],
407
433
  "type": "option"
408
434
  },
409
- "no-prompt": {
410
- "aliases": [
411
- "noprompt"
412
- ],
413
- "char": "r",
414
- "deprecateAliases": true,
415
- "name": "no-prompt",
416
- "summary": "Don't prompt for delete confirmation.",
417
- "allowNo": false,
418
- "type": "boolean"
419
- },
420
435
  "metadata": {
421
436
  "char": "m",
422
- "description": "If you specify this parameter, don’t specify --source-dir.",
437
+ "exclusive": [
438
+ "manifest",
439
+ "source-dir"
440
+ ],
423
441
  "name": "metadata",
424
- "summary": "Metadata components to delete.",
425
- "delimiter": ",",
442
+ "summary": "Metadata component names to preview.",
426
443
  "hasDynamicHelp": false,
427
444
  "multiple": true,
428
445
  "type": "option"
429
446
  },
430
447
  "source-dir": {
431
- "aliases": [
432
- "sourcepath"
448
+ "char": "d",
449
+ "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.",
450
+ "exclusive": [
451
+ "manifest",
452
+ "metadata"
433
453
  ],
434
- "char": "p",
435
- "deprecateAliases": true,
436
- "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.",
437
454
  "name": "source-dir",
438
- "summary": "Source file paths to delete.",
439
- "delimiter": ",",
455
+ "summary": "Path to the local source files to preview.",
440
456
  "hasDynamicHelp": false,
441
457
  "multiple": true,
442
458
  "type": "option"
443
459
  },
444
- "track-source": {
445
- "aliases": [
446
- "tracksource"
447
- ],
448
- "char": "t",
449
- "deprecateAliases": true,
450
- "exclusive": [
451
- "check-only"
452
- ],
453
- "name": "track-source",
454
- "summary": "If the delete succeeds, update the source tracking information.",
455
- "allowNo": false,
456
- "type": "boolean"
457
- },
458
- "force-overwrite": {
459
- "aliases": [
460
- "forceoverwrite"
461
- ],
462
- "char": "f",
463
- "dependsOn": [
464
- "track-source"
465
- ],
466
- "deprecateAliases": true,
467
- "name": "force-overwrite",
468
- "summary": "Ignore conflict warnings and overwrite changes to the org.",
469
- "allowNo": false,
470
- "type": "boolean"
460
+ "target-org": {
461
+ "char": "o",
462
+ "description": "Overrides your default org.",
463
+ "name": "target-org",
464
+ "noCacheDefault": true,
465
+ "required": true,
466
+ "summary": "Login username or alias for the target org.",
467
+ "hasDynamicHelp": true,
468
+ "multiple": false,
469
+ "type": "option"
471
470
  },
472
- "verbose": {
473
- "name": "verbose",
474
- "summary": "Verbose output of the delete result.",
471
+ "concise": {
472
+ "name": "concise",
473
+ "summary": "Show only the changes that will be deployed; omits files that are forceignored.",
475
474
  "allowNo": false,
476
475
  "type": "boolean"
477
476
  }
478
477
  },
479
478
  "hasDynamicHelp": true,
480
479
  "hiddenAliases": [],
481
- "id": "project:delete:source",
480
+ "id": "project:deploy:preview",
482
481
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
483
482
  "pluginName": "@salesforce/plugin-deploy-retrieve",
484
483
  "pluginType": "core",
485
484
  "strict": true,
486
- "summary": "Delete source from your project and from a non-source-tracked org.",
485
+ "summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
487
486
  "enableJsonFlag": true,
488
487
  "requiresProject": true,
489
488
  "isESM": true,
@@ -491,35 +490,36 @@
491
490
  "lib",
492
491
  "commands",
493
492
  "project",
494
- "delete",
495
- "source.js"
493
+ "deploy",
494
+ "preview.js"
496
495
  ],
497
496
  "aliasPermutations": [
498
- "force:source:delete",
499
- "source:force:delete",
500
- "source:delete:force",
501
- "force:delete:source",
502
- "delete:force:source",
503
- "delete:source:force"
497
+ "deploy:metadata:preview",
498
+ "metadata:deploy:preview",
499
+ "metadata:preview:deploy",
500
+ "deploy:preview:metadata",
501
+ "preview:deploy:metadata",
502
+ "preview:metadata:deploy"
504
503
  ],
505
504
  "permutations": [
506
- "project:delete:source",
507
- "delete:project:source",
508
- "delete:source:project",
509
- "project:source:delete",
510
- "source:project:delete",
511
- "source:delete:project"
505
+ "project:deploy:preview",
506
+ "deploy:project:preview",
507
+ "deploy:preview:project",
508
+ "project:preview:deploy",
509
+ "preview:project:deploy",
510
+ "preview:deploy:project"
512
511
  ]
513
512
  },
514
- "project:delete:tracking": {
513
+ "project:deploy:quick": {
515
514
  "aliases": [
516
- "force:source:tracking:clear"
515
+ "deploy:metadata:quick"
517
516
  ],
518
517
  "args": {},
519
518
  "deprecateAliases": true,
520
- "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.",
519
+ "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.",
521
520
  "examples": [
522
- "Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
521
+ "Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
522
+ "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"
523
523
  ],
524
524
  "flags": {
525
525
  "json": {
@@ -529,117 +529,166 @@
529
529
  "allowNo": false,
530
530
  "type": "boolean"
531
531
  },
532
- "api-version": {
533
- "aliases": [
534
- "apiversion"
532
+ "async": {
533
+ "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\".",
534
+ "exclusive": [
535
+ "wait"
535
536
  ],
536
- "deprecateAliases": true,
537
- "description": "Override the api version used for api requests made by this command",
538
- "name": "api-version",
539
- "hasDynamicHelp": false,
540
- "multiple": false,
541
- "type": "option"
537
+ "name": "async",
538
+ "summary": "Run the command asynchronously.",
539
+ "allowNo": false,
540
+ "type": "boolean"
542
541
  },
543
- "loglevel": {
544
- "deprecated": {
545
- "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."
546
- },
547
- "hidden": true,
548
- "name": "loglevel",
542
+ "concise": {
543
+ "exclusive": [
544
+ "verbose"
545
+ ],
546
+ "name": "concise",
547
+ "summary": "Show concise output of the deploy result.",
548
+ "allowNo": false,
549
+ "type": "boolean"
550
+ },
551
+ "job-id": {
552
+ "char": "i",
553
+ "description": "The job ID is valid for 10 days from when you started the validation.",
554
+ "name": "job-id",
555
+ "summary": "Job ID of the deployment you want to quick deploy.",
549
556
  "hasDynamicHelp": false,
550
557
  "multiple": false,
551
558
  "type": "option"
552
559
  },
553
560
  "target-org": {
554
- "aliases": [
555
- "targetusername",
556
- "u"
557
- ],
558
561
  "char": "o",
559
- "deprecateAliases": true,
562
+ "description": "Overrides your default org.",
560
563
  "name": "target-org",
561
564
  "noCacheDefault": true,
562
- "required": true,
563
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
565
+ "summary": "Login username or alias for the target org.",
564
566
  "hasDynamicHelp": true,
565
567
  "multiple": false,
566
568
  "type": "option"
567
569
  },
568
- "no-prompt": {
569
- "aliases": [
570
- "noprompt"
570
+ "use-most-recent": {
571
+ "char": "r",
572
+ "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find a job ID.",
573
+ "name": "use-most-recent",
574
+ "summary": "Use the job ID of the most recently validated deployment.",
575
+ "allowNo": false,
576
+ "type": "boolean"
577
+ },
578
+ "verbose": {
579
+ "exclusive": [
580
+ "concise"
571
581
  ],
572
- "char": "p",
573
- "deprecateAliases": true,
574
- "name": "no-prompt",
575
- "summary": "Don't prompt for source tracking override confirmation.",
582
+ "name": "verbose",
583
+ "summary": "Show verbose output of the deploy result.",
576
584
  "allowNo": false,
577
585
  "type": "boolean"
586
+ },
587
+ "wait": {
588
+ "char": "w",
589
+ "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\".",
590
+ "exclusive": [
591
+ "async"
592
+ ],
593
+ "name": "wait",
594
+ "summary": "Number of minutes to wait for the command to complete and display results.",
595
+ "default": {
596
+ "quantity": 33,
597
+ "unit": 0
598
+ },
599
+ "hasDynamicHelp": false,
600
+ "helpValue": "<minutes>",
601
+ "multiple": false,
602
+ "type": "option"
603
+ },
604
+ "api-version": {
605
+ "char": "a",
606
+ "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
607
+ "name": "api-version",
608
+ "summary": "Target API version for the deploy.",
609
+ "hasDynamicHelp": false,
610
+ "multiple": false,
611
+ "type": "option"
578
612
  }
579
613
  },
580
614
  "hasDynamicHelp": true,
581
615
  "hiddenAliases": [],
582
- "id": "project:delete:tracking",
616
+ "id": "project:deploy:quick",
583
617
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
584
618
  "pluginName": "@salesforce/plugin-deploy-retrieve",
585
619
  "pluginType": "core",
586
620
  "strict": true,
587
- "summary": "Delete all local source tracking information.",
621
+ "summary": "Quickly deploy a validated deployment to an org.",
588
622
  "enableJsonFlag": true,
589
- "requiresProject": true,
623
+ "errorCodes": {
624
+ "header": "ERROR CODES",
625
+ "body": [
626
+ {
627
+ "name": "Succeeded (0)",
628
+ "description": "The deploy succeeded."
629
+ },
630
+ {
631
+ "name": "Canceled (1)",
632
+ "description": "The deploy was canceled."
633
+ },
634
+ {
635
+ "name": "Failed (1)",
636
+ "description": "The deploy failed."
637
+ },
638
+ {
639
+ "name": "SucceededPartial (68)",
640
+ "description": "The deploy partially succeeded."
641
+ },
642
+ {
643
+ "name": "InProgress (69)",
644
+ "description": "The deploy is in progress."
645
+ },
646
+ {
647
+ "name": "Pending (69)",
648
+ "description": "The deploy is pending."
649
+ },
650
+ {
651
+ "name": "Canceling (69)",
652
+ "description": "The deploy is being canceled."
653
+ }
654
+ ]
655
+ },
590
656
  "isESM": true,
591
657
  "relativePath": [
592
658
  "lib",
593
659
  "commands",
594
660
  "project",
595
- "delete",
596
- "tracking.js"
661
+ "deploy",
662
+ "quick.js"
597
663
  ],
598
664
  "aliasPermutations": [
599
- "force:source:tracking:clear",
600
- "source:force:tracking:clear",
601
- "source:tracking:force:clear",
602
- "source:tracking:clear:force",
603
- "force:tracking:source:clear",
604
- "tracking:force:source:clear",
605
- "tracking:source:force:clear",
606
- "tracking:source:clear:force",
607
- "force:tracking:clear:source",
608
- "tracking:force:clear:source",
609
- "tracking:clear:force:source",
610
- "tracking:clear:source:force",
611
- "force:source:clear:tracking",
612
- "source:force:clear:tracking",
613
- "source:clear:force:tracking",
614
- "source:clear:tracking:force",
615
- "force:clear:source:tracking",
616
- "clear:force:source:tracking",
617
- "clear:source:force:tracking",
618
- "clear:source:tracking:force",
619
- "force:clear:tracking:source",
620
- "clear:force:tracking:source",
621
- "clear:tracking:force:source",
622
- "clear:tracking:source:force"
665
+ "deploy:metadata:quick",
666
+ "metadata:deploy:quick",
667
+ "metadata:quick:deploy",
668
+ "deploy:quick:metadata",
669
+ "quick:deploy:metadata",
670
+ "quick:metadata:deploy"
623
671
  ],
624
672
  "permutations": [
625
- "project:delete:tracking",
626
- "delete:project:tracking",
627
- "delete:tracking:project",
628
- "project:tracking:delete",
629
- "tracking:project:delete",
630
- "tracking:delete:project"
673
+ "project:deploy:quick",
674
+ "deploy:project:quick",
675
+ "deploy:quick:project",
676
+ "project:quick:deploy",
677
+ "quick:project:deploy",
678
+ "quick:deploy:project"
631
679
  ]
632
680
  },
633
- "project:deploy:cancel": {
681
+ "project:deploy:report": {
634
682
  "aliases": [
635
- "deploy:metadata:cancel"
683
+ "deploy:metadata:report"
636
684
  ],
637
685
  "args": {},
638
686
  "deprecateAliases": true,
639
- "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.",
687
+ "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.",
640
688
  "examples": [
641
- "Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
642
- "Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
689
+ "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
690
+ "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
691
+ "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"
643
692
  ],
644
693
  "flags": {
645
694
  "json": {
@@ -649,212 +698,134 @@
649
698
  "allowNo": false,
650
699
  "type": "boolean"
651
700
  },
652
- "async": {
653
- "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\".",
654
- "exclusive": [
655
- "wait"
656
- ],
657
- "name": "async",
658
- "summary": "Run the command asynchronously.",
659
- "allowNo": false,
660
- "type": "boolean"
701
+ "target-org": {
702
+ "char": "o",
703
+ "description": "Overrides your default org.",
704
+ "name": "target-org",
705
+ "noCacheDefault": true,
706
+ "summary": "Login username or alias for the target org.",
707
+ "hasDynamicHelp": true,
708
+ "multiple": false,
709
+ "type": "option"
661
710
  },
662
711
  "job-id": {
663
712
  "char": "i",
664
713
  "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.",
665
714
  "name": "job-id",
666
- "summary": "Job ID of the deploy operation you want to cancel.",
715
+ "summary": "Job ID of the deploy operation you want to check the status of.",
667
716
  "hasDynamicHelp": false,
668
717
  "multiple": false,
669
718
  "type": "option"
670
719
  },
671
720
  "use-most-recent": {
672
721
  "char": "r",
673
- "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.",
722
+ "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 operation was more than 3 days ago, this flag won't find a job ID.",
674
723
  "name": "use-most-recent",
675
724
  "summary": "Use the job ID of the most recent deploy operation.",
676
725
  "allowNo": false,
677
726
  "type": "boolean"
678
727
  },
679
- "wait": {
680
- "char": "w",
681
- "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\".",
682
- "exclusive": [
683
- "async"
684
- ],
685
- "name": "wait",
686
- "summary": "Number of minutes to wait for the command to complete and display results.",
687
- "hasDynamicHelp": false,
688
- "helpValue": "<minutes>",
689
- "multiple": false,
690
- "type": "option"
691
- }
692
- },
693
- "hasDynamicHelp": false,
694
- "hiddenAliases": [],
695
- "id": "project:deploy:cancel",
696
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
697
- "pluginName": "@salesforce/plugin-deploy-retrieve",
698
- "pluginType": "core",
699
- "strict": true,
700
- "summary": "Cancel a deploy operation.",
701
- "enableJsonFlag": true,
702
- "isESM": true,
703
- "relativePath": [
704
- "lib",
705
- "commands",
706
- "project",
707
- "deploy",
708
- "cancel.js"
709
- ],
710
- "aliasPermutations": [
711
- "deploy:metadata:cancel",
712
- "metadata:deploy:cancel",
713
- "metadata:cancel:deploy",
714
- "deploy:cancel:metadata",
715
- "cancel:deploy:metadata",
716
- "cancel:metadata:deploy"
717
- ],
718
- "permutations": [
719
- "project:deploy:cancel",
720
- "deploy:project:cancel",
721
- "deploy:cancel:project",
722
- "project:cancel:deploy",
723
- "cancel:project:deploy",
724
- "cancel:deploy:project"
725
- ]
726
- },
727
- "project:deploy:preview": {
728
- "aliases": [
729
- "deploy:metadata:preview"
730
- ],
731
- "args": {},
732
- "deprecateAliases": true,
733
- "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.",
734
- "examples": [
735
- "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.",
736
- "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",
737
- "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",
738
- "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
739
- "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
740
- ],
741
- "flags": {
742
- "json": {
743
- "description": "Format output as json.",
744
- "helpGroup": "GLOBAL",
745
- "name": "json",
746
- "allowNo": false,
747
- "type": "boolean"
728
+ "coverage-formatters": {
729
+ "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
730
+ "helpGroup": "Test",
731
+ "name": "coverage-formatters",
732
+ "summary": "Format of the code coverage results.",
733
+ "hasDynamicHelp": false,
734
+ "multiple": true,
735
+ "options": [
736
+ "clover",
737
+ "cobertura",
738
+ "html-spa",
739
+ "html",
740
+ "json",
741
+ "json-summary",
742
+ "lcovonly",
743
+ "none",
744
+ "teamcity",
745
+ "text",
746
+ "text-summary"
747
+ ],
748
+ "type": "option"
748
749
  },
749
- "ignore-conflicts": {
750
- "char": "c",
751
- "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.",
752
- "name": "ignore-conflicts",
753
- "summary": "Don't display conflicts in preview of the deployment.",
750
+ "junit": {
751
+ "helpGroup": "Test",
752
+ "name": "junit",
753
+ "summary": "Output JUnit test results.",
754
754
  "allowNo": false,
755
755
  "type": "boolean"
756
756
  },
757
- "manifest": {
758
- "char": "x",
759
- "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
760
- "exclusive": [
761
- "source-dir",
762
- "metadata"
757
+ "results-dir": {
758
+ "helpGroup": "Test",
759
+ "name": "results-dir",
760
+ "relationships": [
761
+ {
762
+ "type": "some",
763
+ "flags": [
764
+ "coverage-formatters",
765
+ "junit"
766
+ ]
767
+ }
763
768
  ],
764
- "name": "manifest",
765
- "summary": "Full file path for manifest (package.xml) of components to preview.",
769
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
766
770
  "hasDynamicHelp": false,
767
771
  "multiple": false,
768
772
  "type": "option"
769
773
  },
770
- "metadata": {
771
- "char": "m",
772
- "exclusive": [
773
- "manifest",
774
- "source-dir"
775
- ],
776
- "name": "metadata",
777
- "summary": "Metadata component names to preview.",
778
- "hasDynamicHelp": false,
779
- "multiple": true,
780
- "type": "option"
781
- },
782
- "source-dir": {
783
- "char": "d",
784
- "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.",
785
- "exclusive": [
786
- "manifest",
787
- "metadata"
788
- ],
789
- "name": "source-dir",
790
- "summary": "Path to the local source files to preview.",
774
+ "wait": {
775
+ "char": "w",
776
+ "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\".",
777
+ "name": "wait",
778
+ "summary": "Number of minutes to wait for command to complete and display results.",
791
779
  "hasDynamicHelp": false,
792
- "multiple": true,
793
- "type": "option"
794
- },
795
- "target-org": {
796
- "char": "o",
797
- "description": "Overrides your default org.",
798
- "name": "target-org",
799
- "noCacheDefault": true,
800
- "required": true,
801
- "summary": "Login username or alias for the target org.",
802
- "hasDynamicHelp": true,
780
+ "helpValue": "<minutes>",
803
781
  "multiple": false,
804
782
  "type": "option"
805
- },
806
- "concise": {
807
- "name": "concise",
808
- "summary": "Show only the changes that will be deployed; omits files that are forceignored.",
809
- "allowNo": false,
810
- "type": "boolean"
811
783
  }
812
784
  },
813
785
  "hasDynamicHelp": true,
814
786
  "hiddenAliases": [],
815
- "id": "project:deploy:preview",
787
+ "id": "project:deploy:report",
816
788
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
817
789
  "pluginName": "@salesforce/plugin-deploy-retrieve",
818
790
  "pluginType": "core",
819
791
  "strict": true,
820
- "summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
792
+ "summary": "Check or poll for the status of a deploy operation.",
821
793
  "enableJsonFlag": true,
822
- "requiresProject": true,
823
794
  "isESM": true,
824
795
  "relativePath": [
825
796
  "lib",
826
797
  "commands",
827
798
  "project",
828
799
  "deploy",
829
- "preview.js"
800
+ "report.js"
830
801
  ],
831
802
  "aliasPermutations": [
832
- "deploy:metadata:preview",
833
- "metadata:deploy:preview",
834
- "metadata:preview:deploy",
835
- "deploy:preview:metadata",
836
- "preview:deploy:metadata",
837
- "preview:metadata:deploy"
803
+ "deploy:metadata:report",
804
+ "metadata:deploy:report",
805
+ "metadata:report:deploy",
806
+ "deploy:report:metadata",
807
+ "report:deploy:metadata",
808
+ "report:metadata:deploy"
838
809
  ],
839
810
  "permutations": [
840
- "project:deploy:preview",
841
- "deploy:project:preview",
842
- "deploy:preview:project",
843
- "project:preview:deploy",
844
- "preview:project:deploy",
845
- "preview:deploy:project"
811
+ "project:deploy:report",
812
+ "deploy:project:report",
813
+ "deploy:report:project",
814
+ "project:report:deploy",
815
+ "report:project:deploy",
816
+ "report:deploy:project"
846
817
  ]
847
818
  },
848
- "project:deploy:quick": {
819
+ "project:deploy:resume": {
849
820
  "aliases": [
850
- "deploy:metadata:quick"
821
+ "deploy:metadata:resume"
851
822
  ],
852
823
  "args": {},
853
824
  "deprecateAliases": true,
854
- "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.",
825
+ "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.",
855
826
  "examples": [
856
- "Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
857
- "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"
827
+ "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
828
+ "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
858
829
  ],
859
830
  "flags": {
860
831
  "json": {
@@ -864,49 +835,29 @@
864
835
  "allowNo": false,
865
836
  "type": "boolean"
866
837
  },
867
- "async": {
868
- "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\".",
869
- "exclusive": [
870
- "wait"
871
- ],
872
- "name": "async",
873
- "summary": "Run the command asynchronously.",
874
- "allowNo": false,
875
- "type": "boolean"
876
- },
877
838
  "concise": {
878
839
  "exclusive": [
879
840
  "verbose"
880
841
  ],
881
842
  "name": "concise",
882
- "summary": "Show concise output of the deploy result.",
843
+ "summary": "Show concise output of the deploy operation result.",
883
844
  "allowNo": false,
884
845
  "type": "boolean"
885
846
  },
886
847
  "job-id": {
887
848
  "char": "i",
888
- "description": "The job ID is valid for 10 days from when you started the validation.",
849
+ "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.",
889
850
  "name": "job-id",
890
- "summary": "Job ID of the deployment you want to quick deploy.",
851
+ "summary": "Job ID of the deploy operation you want to resume.",
891
852
  "hasDynamicHelp": false,
892
853
  "multiple": false,
893
854
  "type": "option"
894
855
  },
895
- "target-org": {
896
- "char": "o",
897
- "description": "Overrides your default org.",
898
- "name": "target-org",
899
- "noCacheDefault": true,
900
- "summary": "Login username or alias for the target org.",
901
- "hasDynamicHelp": true,
902
- "multiple": false,
903
- "type": "option"
904
- },
905
856
  "use-most-recent": {
906
857
  "char": "r",
907
- "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find a job ID.",
858
+ "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 operation was more than 3 days ago, this flag won't find a job ID.",
908
859
  "name": "use-most-recent",
909
- "summary": "Use the job ID of the most recently validated deployment.",
860
+ "summary": "Use the job ID of the most recent deploy operation.",
910
861
  "allowNo": false,
911
862
  "type": "boolean"
912
863
  },
@@ -915,156 +866,25 @@
915
866
  "concise"
916
867
  ],
917
868
  "name": "verbose",
918
- "summary": "Show verbose output of the deploy result.",
869
+ "summary": "Show verbose output of the deploy operation result.",
919
870
  "allowNo": false,
920
871
  "type": "boolean"
921
872
  },
922
873
  "wait": {
923
874
  "char": "w",
924
- "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\".",
925
- "exclusive": [
926
- "async"
927
- ],
875
+ "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\".",
928
876
  "name": "wait",
929
877
  "summary": "Number of minutes to wait for the command to complete and display results.",
930
- "default": {
931
- "quantity": 33,
932
- "unit": 0
933
- },
934
878
  "hasDynamicHelp": false,
935
879
  "helpValue": "<minutes>",
936
880
  "multiple": false,
937
881
  "type": "option"
938
882
  },
939
- "api-version": {
940
- "char": "a",
941
- "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
942
- "name": "api-version",
943
- "summary": "Target API version for the deploy.",
944
- "hasDynamicHelp": false,
945
- "multiple": false,
946
- "type": "option"
947
- }
948
- },
949
- "hasDynamicHelp": true,
950
- "hiddenAliases": [],
951
- "id": "project:deploy:quick",
952
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
953
- "pluginName": "@salesforce/plugin-deploy-retrieve",
954
- "pluginType": "core",
955
- "strict": true,
956
- "summary": "Quickly deploy a validated deployment to an org.",
957
- "enableJsonFlag": true,
958
- "errorCodes": {
959
- "header": "ERROR CODES",
960
- "body": [
961
- {
962
- "name": "Succeeded (0)",
963
- "description": "The deploy succeeded."
964
- },
965
- {
966
- "name": "Canceled (1)",
967
- "description": "The deploy was canceled."
968
- },
969
- {
970
- "name": "Failed (1)",
971
- "description": "The deploy failed."
972
- },
973
- {
974
- "name": "SucceededPartial (68)",
975
- "description": "The deploy partially succeeded."
976
- },
977
- {
978
- "name": "InProgress (69)",
979
- "description": "The deploy is in progress."
980
- },
981
- {
982
- "name": "Pending (69)",
983
- "description": "The deploy is pending."
984
- },
985
- {
986
- "name": "Canceling (69)",
987
- "description": "The deploy is being canceled."
988
- }
989
- ]
990
- },
991
- "isESM": true,
992
- "relativePath": [
993
- "lib",
994
- "commands",
995
- "project",
996
- "deploy",
997
- "quick.js"
998
- ],
999
- "aliasPermutations": [
1000
- "deploy:metadata:quick",
1001
- "metadata:deploy:quick",
1002
- "metadata:quick:deploy",
1003
- "deploy:quick:metadata",
1004
- "quick:deploy:metadata",
1005
- "quick:metadata:deploy"
1006
- ],
1007
- "permutations": [
1008
- "project:deploy:quick",
1009
- "deploy:project:quick",
1010
- "deploy:quick:project",
1011
- "project:quick:deploy",
1012
- "quick:project:deploy",
1013
- "quick:deploy:project"
1014
- ]
1015
- },
1016
- "project:deploy:report": {
1017
- "aliases": [
1018
- "deploy:metadata:report"
1019
- ],
1020
- "args": {},
1021
- "deprecateAliases": true,
1022
- "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.",
1023
- "examples": [
1024
- "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1025
- "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
1026
- "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"
1027
- ],
1028
- "flags": {
1029
- "json": {
1030
- "description": "Format output as json.",
1031
- "helpGroup": "GLOBAL",
1032
- "name": "json",
1033
- "allowNo": false,
1034
- "type": "boolean"
1035
- },
1036
- "target-org": {
1037
- "char": "o",
1038
- "description": "Overrides your default org.",
1039
- "name": "target-org",
1040
- "noCacheDefault": true,
1041
- "summary": "Login username or alias for the target org.",
1042
- "hasDynamicHelp": true,
1043
- "multiple": false,
1044
- "type": "option"
1045
- },
1046
- "job-id": {
1047
- "char": "i",
1048
- "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.",
1049
- "name": "job-id",
1050
- "summary": "Job ID of the deploy operation you want to check the status of.",
1051
- "hasDynamicHelp": false,
1052
- "multiple": false,
1053
- "type": "option"
1054
- },
1055
- "use-most-recent": {
1056
- "char": "r",
1057
- "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 operation was more than 3 days ago, this flag won't find a job ID.",
1058
- "name": "use-most-recent",
1059
- "summary": "Use the job ID of the most recent deploy operation.",
1060
- "allowNo": false,
1061
- "type": "boolean"
1062
- },
1063
- "coverage-formatters": {
1064
- "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1065
- "helpGroup": "Test",
1066
- "name": "coverage-formatters",
1067
- "summary": "Format of the code coverage results.",
883
+ "coverage-formatters": {
884
+ "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
885
+ "helpGroup": "Test",
886
+ "name": "coverage-formatters",
887
+ "summary": "Format of the code coverage results.",
1068
888
  "hasDynamicHelp": false,
1069
889
  "multiple": true,
1070
890
  "options": [
@@ -1105,62 +925,102 @@
1105
925
  "hasDynamicHelp": false,
1106
926
  "multiple": false,
1107
927
  "type": "option"
1108
- },
1109
- "wait": {
1110
- "char": "w",
1111
- "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\".",
1112
- "name": "wait",
1113
- "summary": "Number of minutes to wait for command to complete and display results.",
1114
- "hasDynamicHelp": false,
1115
- "helpValue": "<minutes>",
1116
- "multiple": false,
1117
- "type": "option"
1118
928
  }
1119
929
  },
1120
- "hasDynamicHelp": true,
930
+ "hasDynamicHelp": false,
1121
931
  "hiddenAliases": [],
1122
- "id": "project:deploy:report",
932
+ "id": "project:deploy:resume",
1123
933
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1124
934
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1125
935
  "pluginType": "core",
1126
936
  "strict": true,
1127
- "summary": "Check or poll for the status of a deploy operation.",
937
+ "summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
1128
938
  "enableJsonFlag": true,
939
+ "envVariablesSection": {
940
+ "header": "ENVIRONMENT VARIABLES",
941
+ "body": [
942
+ {
943
+ "name": "SF_USE_PROGRESS_BAR",
944
+ "description": "Set to false to disable the progress bar when running the metadata deploy command."
945
+ }
946
+ ]
947
+ },
948
+ "errorCodes": {
949
+ "header": "ERROR CODES",
950
+ "body": [
951
+ {
952
+ "name": "Succeeded (0)",
953
+ "description": "The deploy succeeded."
954
+ },
955
+ {
956
+ "name": "Canceled (1)",
957
+ "description": "The deploy was canceled."
958
+ },
959
+ {
960
+ "name": "Failed (1)",
961
+ "description": "The deploy failed."
962
+ },
963
+ {
964
+ "name": "SucceededPartial (68)",
965
+ "description": "The deploy partially succeeded."
966
+ },
967
+ {
968
+ "name": "InProgress (69)",
969
+ "description": "The deploy is in progress."
970
+ },
971
+ {
972
+ "name": "Pending (69)",
973
+ "description": "The deploy is pending."
974
+ },
975
+ {
976
+ "name": "Canceling (69)",
977
+ "description": "The deploy is being canceled."
978
+ }
979
+ ]
980
+ },
1129
981
  "isESM": true,
1130
982
  "relativePath": [
1131
983
  "lib",
1132
984
  "commands",
1133
985
  "project",
1134
986
  "deploy",
1135
- "report.js"
987
+ "resume.js"
1136
988
  ],
1137
989
  "aliasPermutations": [
1138
- "deploy:metadata:report",
1139
- "metadata:deploy:report",
1140
- "metadata:report:deploy",
1141
- "deploy:report:metadata",
1142
- "report:deploy:metadata",
1143
- "report:metadata:deploy"
990
+ "deploy:metadata:resume",
991
+ "metadata:deploy:resume",
992
+ "metadata:resume:deploy",
993
+ "deploy:resume:metadata",
994
+ "resume:deploy:metadata",
995
+ "resume:metadata:deploy"
1144
996
  ],
1145
997
  "permutations": [
1146
- "project:deploy:report",
1147
- "deploy:project:report",
1148
- "deploy:report:project",
1149
- "project:report:deploy",
1150
- "report:project:deploy",
1151
- "report:deploy:project"
998
+ "project:deploy:resume",
999
+ "deploy:project:resume",
1000
+ "deploy:resume:project",
1001
+ "project:resume:deploy",
1002
+ "resume:project:deploy",
1003
+ "resume:deploy:project"
1152
1004
  ]
1153
1005
  },
1154
- "project:deploy:resume": {
1006
+ "project:deploy:start": {
1155
1007
  "aliases": [
1156
- "deploy:metadata:resume"
1008
+ "deploy:metadata"
1157
1009
  ],
1158
1010
  "args": {},
1159
1011
  "deprecateAliases": true,
1160
- "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.",
1012
+ "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.",
1161
1013
  "examples": [
1162
- "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1163
- "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1014
+ "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1015
+ "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",
1016
+ "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",
1017
+ "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1018
+ "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",
1019
+ "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",
1020
+ "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",
1021
+ "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\"",
1022
+ "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
1023
+ "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"
1164
1024
  ],
1165
1025
  "flags": {
1166
1026
  "json": {
@@ -1170,246 +1030,51 @@
1170
1030
  "allowNo": false,
1171
1031
  "type": "boolean"
1172
1032
  },
1033
+ "api-version": {
1034
+ "char": "a",
1035
+ "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
1036
+ "name": "api-version",
1037
+ "summary": "Target API version for the deploy.",
1038
+ "hasDynamicHelp": false,
1039
+ "multiple": false,
1040
+ "type": "option"
1041
+ },
1042
+ "async": {
1043
+ "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\".",
1044
+ "exclusive": [
1045
+ "wait"
1046
+ ],
1047
+ "name": "async",
1048
+ "summary": "Run the command asynchronously.",
1049
+ "allowNo": false,
1050
+ "type": "boolean"
1051
+ },
1173
1052
  "concise": {
1174
1053
  "exclusive": [
1175
1054
  "verbose"
1176
1055
  ],
1177
1056
  "name": "concise",
1178
- "summary": "Show concise output of the deploy operation result.",
1057
+ "summary": "Show concise output of the deploy result.",
1179
1058
  "allowNo": false,
1180
1059
  "type": "boolean"
1181
1060
  },
1182
- "job-id": {
1183
- "char": "i",
1184
- "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.",
1185
- "name": "job-id",
1186
- "summary": "Job ID of the deploy operation you want to resume.",
1187
- "hasDynamicHelp": false,
1188
- "multiple": false,
1189
- "type": "option"
1190
- },
1191
- "use-most-recent": {
1192
- "char": "r",
1193
- "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 operation was more than 3 days ago, this flag won't find a job ID.",
1194
- "name": "use-most-recent",
1195
- "summary": "Use the job ID of the most recent deploy operation.",
1061
+ "dry-run": {
1062
+ "name": "dry-run",
1063
+ "summary": "Validate deploy and run Apex tests but don’t save to the org.",
1196
1064
  "allowNo": false,
1197
1065
  "type": "boolean"
1198
1066
  },
1199
- "verbose": {
1200
- "exclusive": [
1201
- "concise"
1202
- ],
1203
- "name": "verbose",
1204
- "summary": "Show verbose output of the deploy operation result.",
1205
- "allowNo": false,
1206
- "type": "boolean"
1207
- },
1208
- "wait": {
1209
- "char": "w",
1210
- "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\".",
1211
- "name": "wait",
1212
- "summary": "Number of minutes to wait for the command to complete and display results.",
1213
- "hasDynamicHelp": false,
1214
- "helpValue": "<minutes>",
1215
- "multiple": false,
1216
- "type": "option"
1217
- },
1218
- "coverage-formatters": {
1219
- "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1220
- "helpGroup": "Test",
1221
- "name": "coverage-formatters",
1222
- "summary": "Format of the code coverage results.",
1223
- "hasDynamicHelp": false,
1224
- "multiple": true,
1225
- "options": [
1226
- "clover",
1227
- "cobertura",
1228
- "html-spa",
1229
- "html",
1230
- "json",
1231
- "json-summary",
1232
- "lcovonly",
1233
- "none",
1234
- "teamcity",
1235
- "text",
1236
- "text-summary"
1237
- ],
1238
- "type": "option"
1239
- },
1240
- "junit": {
1241
- "helpGroup": "Test",
1242
- "name": "junit",
1243
- "summary": "Output JUnit test results.",
1244
- "allowNo": false,
1245
- "type": "boolean"
1246
- },
1247
- "results-dir": {
1248
- "helpGroup": "Test",
1249
- "name": "results-dir",
1250
- "relationships": [
1251
- {
1252
- "type": "some",
1253
- "flags": [
1254
- "coverage-formatters",
1255
- "junit"
1256
- ]
1257
- }
1258
- ],
1259
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1260
- "hasDynamicHelp": false,
1261
- "multiple": false,
1262
- "type": "option"
1263
- }
1264
- },
1265
- "hasDynamicHelp": false,
1266
- "hiddenAliases": [],
1267
- "id": "project:deploy:resume",
1268
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1269
- "pluginName": "@salesforce/plugin-deploy-retrieve",
1270
- "pluginType": "core",
1271
- "strict": true,
1272
- "summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
1273
- "enableJsonFlag": true,
1274
- "envVariablesSection": {
1275
- "header": "ENVIRONMENT VARIABLES",
1276
- "body": [
1277
- {
1278
- "name": "SF_USE_PROGRESS_BAR",
1279
- "description": "Set to false to disable the progress bar when running the metadata deploy command."
1280
- }
1281
- ]
1282
- },
1283
- "errorCodes": {
1284
- "header": "ERROR CODES",
1285
- "body": [
1286
- {
1287
- "name": "Succeeded (0)",
1288
- "description": "The deploy succeeded."
1289
- },
1290
- {
1291
- "name": "Canceled (1)",
1292
- "description": "The deploy was canceled."
1293
- },
1294
- {
1295
- "name": "Failed (1)",
1296
- "description": "The deploy failed."
1297
- },
1298
- {
1299
- "name": "SucceededPartial (68)",
1300
- "description": "The deploy partially succeeded."
1301
- },
1302
- {
1303
- "name": "InProgress (69)",
1304
- "description": "The deploy is in progress."
1305
- },
1306
- {
1307
- "name": "Pending (69)",
1308
- "description": "The deploy is pending."
1309
- },
1310
- {
1311
- "name": "Canceling (69)",
1312
- "description": "The deploy is being canceled."
1313
- }
1314
- ]
1315
- },
1316
- "isESM": true,
1317
- "relativePath": [
1318
- "lib",
1319
- "commands",
1320
- "project",
1321
- "deploy",
1322
- "resume.js"
1323
- ],
1324
- "aliasPermutations": [
1325
- "deploy:metadata:resume",
1326
- "metadata:deploy:resume",
1327
- "metadata:resume:deploy",
1328
- "deploy:resume:metadata",
1329
- "resume:deploy:metadata",
1330
- "resume:metadata:deploy"
1331
- ],
1332
- "permutations": [
1333
- "project:deploy:resume",
1334
- "deploy:project:resume",
1335
- "deploy:resume:project",
1336
- "project:resume:deploy",
1337
- "resume:project:deploy",
1338
- "resume:deploy:project"
1339
- ]
1340
- },
1341
- "project:deploy:start": {
1342
- "aliases": [
1343
- "deploy:metadata"
1344
- ],
1345
- "args": {},
1346
- "deprecateAliases": true,
1347
- "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 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 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.",
1348
- "examples": [
1349
- "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1350
- "Deploy the source files in a directory to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch",
1351
- "Deploy a specific Apex class and the objects whose source is in a directory (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects",
1352
- "Deploy all Apex classes:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1353
- "Deploy a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
1354
- "Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\":\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'",
1355
- "Deploy all custom objects and Apex classes (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
1356
- "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\"",
1357
- "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
1358
- "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"
1359
- ],
1360
- "flags": {
1361
- "json": {
1362
- "description": "Format output as json.",
1363
- "helpGroup": "GLOBAL",
1364
- "name": "json",
1365
- "allowNo": false,
1366
- "type": "boolean"
1367
- },
1368
- "api-version": {
1369
- "char": "a",
1370
- "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
1371
- "name": "api-version",
1372
- "summary": "Target API version for the deploy.",
1373
- "hasDynamicHelp": false,
1374
- "multiple": false,
1375
- "type": "option"
1376
- },
1377
- "async": {
1378
- "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\".",
1379
- "exclusive": [
1380
- "wait"
1381
- ],
1382
- "name": "async",
1383
- "summary": "Run the command asynchronously.",
1384
- "allowNo": false,
1385
- "type": "boolean"
1386
- },
1387
- "concise": {
1388
- "exclusive": [
1389
- "verbose"
1390
- ],
1391
- "name": "concise",
1392
- "summary": "Show concise output of the deploy result.",
1393
- "allowNo": false,
1394
- "type": "boolean"
1395
- },
1396
- "dry-run": {
1397
- "name": "dry-run",
1398
- "summary": "Validate deploy and run Apex tests but don’t save to the org.",
1399
- "allowNo": false,
1400
- "type": "boolean"
1401
- },
1402
- "ignore-conflicts": {
1403
- "char": "c",
1404
- "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.",
1405
- "name": "ignore-conflicts",
1406
- "summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
1067
+ "ignore-conflicts": {
1068
+ "char": "c",
1069
+ "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.",
1070
+ "name": "ignore-conflicts",
1071
+ "summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
1407
1072
  "allowNo": false,
1408
1073
  "type": "boolean"
1409
1074
  },
1410
1075
  "ignore-errors": {
1411
1076
  "char": "r",
1412
- "description": "When deploying to a production org, keep this flag set to false (default value). When set to true, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
1077
+ "description": "Never use this flag when deploying to a production org. If you specify it, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
1413
1078
  "name": "ignore-errors",
1414
1079
  "summary": "Ignore any errors and don’t roll back deployment.",
1415
1080
  "allowNo": false,
@@ -1417,7 +1082,7 @@
1417
1082
  },
1418
1083
  "ignore-warnings": {
1419
1084
  "char": "g",
1420
- "description": "If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.",
1085
+ "description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
1421
1086
  "name": "ignore-warnings",
1422
1087
  "summary": "Ignore warnings and allow a deployment to complete successfully.",
1423
1088
  "allowNo": false,
@@ -1447,7 +1112,7 @@
1447
1112
  ],
1448
1113
  "helpGroup": "Source Format",
1449
1114
  "name": "metadata",
1450
- "summary": "Metadata component names to deploy. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
1115
+ "summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
1451
1116
  "hasDynamicHelp": false,
1452
1117
  "multiple": true,
1453
1118
  "type": "option"
@@ -1578,7 +1243,7 @@
1578
1243
  ],
1579
1244
  "helpGroup": "Delete",
1580
1245
  "name": "pre-destructive-changes",
1581
- "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1246
+ "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
1582
1247
  "hasDynamicHelp": false,
1583
1248
  "multiple": false,
1584
1249
  "type": "option"
@@ -1736,11 +1401,12 @@
1736
1401
  ],
1737
1402
  "args": {},
1738
1403
  "deprecateAliases": true,
1739
- "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.",
1404
+ "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.",
1740
1405
  "examples": [
1741
1406
  "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.",
1742
- "Validate the deployment of all source files in a directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir path/to/source",
1743
- "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 path/to/source --async --test-level RunAllTestsInOrg --target-org my-prod-org",
1407
+ "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",
1408
+ "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",
1409
+ "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",
1744
1410
  "Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
1745
1411
  ],
1746
1412
  "flags": {
@@ -1885,7 +1551,7 @@
1885
1551
  },
1886
1552
  "ignore-warnings": {
1887
1553
  "char": "g",
1888
- "description": "If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.",
1554
+ "description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
1889
1555
  "name": "ignore-warnings",
1890
1556
  "summary": "Ignore warnings and allow a deployment to complete successfully.",
1891
1557
  "allowNo": false,
@@ -2072,6 +1738,341 @@
2072
1738
  "validate:deploy:project"
2073
1739
  ]
2074
1740
  },
1741
+ "project:delete:source": {
1742
+ "aliases": [
1743
+ "force:source:delete"
1744
+ ],
1745
+ "args": {},
1746
+ "deprecateAliases": true,
1747
+ "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.",
1748
+ "examples": [
1749
+ "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",
1750
+ "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",
1751
+ "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",
1752
+ "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"
1753
+ ],
1754
+ "flags": {
1755
+ "json": {
1756
+ "description": "Format output as json.",
1757
+ "helpGroup": "GLOBAL",
1758
+ "name": "json",
1759
+ "allowNo": false,
1760
+ "type": "boolean"
1761
+ },
1762
+ "api-version": {
1763
+ "aliases": [
1764
+ "apiversion"
1765
+ ],
1766
+ "deprecateAliases": true,
1767
+ "description": "Override the api version used for api requests made by this command",
1768
+ "name": "api-version",
1769
+ "hasDynamicHelp": false,
1770
+ "multiple": false,
1771
+ "type": "option"
1772
+ },
1773
+ "loglevel": {
1774
+ "deprecated": {
1775
+ "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."
1776
+ },
1777
+ "hidden": true,
1778
+ "name": "loglevel",
1779
+ "hasDynamicHelp": false,
1780
+ "multiple": false,
1781
+ "type": "option"
1782
+ },
1783
+ "target-org": {
1784
+ "aliases": [
1785
+ "targetusername",
1786
+ "u"
1787
+ ],
1788
+ "char": "o",
1789
+ "deprecateAliases": true,
1790
+ "name": "target-org",
1791
+ "noCacheDefault": true,
1792
+ "required": true,
1793
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1794
+ "hasDynamicHelp": true,
1795
+ "multiple": false,
1796
+ "type": "option"
1797
+ },
1798
+ "check-only": {
1799
+ "aliases": [
1800
+ "checkonly"
1801
+ ],
1802
+ "char": "c",
1803
+ "deprecateAliases": true,
1804
+ "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.",
1805
+ "name": "check-only",
1806
+ "summary": "Validate delete command but don't delete anything from the org or the local project.",
1807
+ "allowNo": false,
1808
+ "type": "boolean"
1809
+ },
1810
+ "wait": {
1811
+ "char": "w",
1812
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
1813
+ "name": "wait",
1814
+ "summary": "Number of minutes to wait for the command to finish.",
1815
+ "default": {
1816
+ "quantity": 33,
1817
+ "unit": 0
1818
+ },
1819
+ "hasDynamicHelp": false,
1820
+ "multiple": false,
1821
+ "type": "option"
1822
+ },
1823
+ "tests": {
1824
+ "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\"",
1825
+ "helpGroup": "Test",
1826
+ "name": "tests",
1827
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1828
+ "hasDynamicHelp": false,
1829
+ "multiple": true,
1830
+ "type": "option"
1831
+ },
1832
+ "test-level": {
1833
+ "aliases": [
1834
+ "testlevel"
1835
+ ],
1836
+ "char": "l",
1837
+ "deprecateAliases": true,
1838
+ "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.",
1839
+ "helpGroup": "Test",
1840
+ "name": "test-level",
1841
+ "summary": "Deployment Apex testing level.",
1842
+ "hasDynamicHelp": false,
1843
+ "multiple": false,
1844
+ "options": [
1845
+ "NoTestRun",
1846
+ "RunSpecifiedTests",
1847
+ "RunLocalTests",
1848
+ "RunAllTestsInOrg"
1849
+ ],
1850
+ "type": "option"
1851
+ },
1852
+ "no-prompt": {
1853
+ "aliases": [
1854
+ "noprompt"
1855
+ ],
1856
+ "char": "r",
1857
+ "deprecateAliases": true,
1858
+ "name": "no-prompt",
1859
+ "summary": "Don't prompt for delete confirmation.",
1860
+ "allowNo": false,
1861
+ "type": "boolean"
1862
+ },
1863
+ "metadata": {
1864
+ "char": "m",
1865
+ "description": "If you specify this parameter, don’t specify --source-dir.",
1866
+ "name": "metadata",
1867
+ "summary": "Metadata components to delete.",
1868
+ "delimiter": ",",
1869
+ "hasDynamicHelp": false,
1870
+ "multiple": true,
1871
+ "type": "option"
1872
+ },
1873
+ "source-dir": {
1874
+ "aliases": [
1875
+ "sourcepath"
1876
+ ],
1877
+ "char": "p",
1878
+ "deprecateAliases": true,
1879
+ "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.",
1880
+ "name": "source-dir",
1881
+ "summary": "Source file paths to delete.",
1882
+ "delimiter": ",",
1883
+ "hasDynamicHelp": false,
1884
+ "multiple": true,
1885
+ "type": "option"
1886
+ },
1887
+ "track-source": {
1888
+ "aliases": [
1889
+ "tracksource"
1890
+ ],
1891
+ "char": "t",
1892
+ "deprecateAliases": true,
1893
+ "exclusive": [
1894
+ "check-only"
1895
+ ],
1896
+ "name": "track-source",
1897
+ "summary": "If the delete succeeds, update the source tracking information.",
1898
+ "allowNo": false,
1899
+ "type": "boolean"
1900
+ },
1901
+ "force-overwrite": {
1902
+ "aliases": [
1903
+ "forceoverwrite"
1904
+ ],
1905
+ "char": "f",
1906
+ "dependsOn": [
1907
+ "track-source"
1908
+ ],
1909
+ "deprecateAliases": true,
1910
+ "name": "force-overwrite",
1911
+ "summary": "Ignore conflict warnings and overwrite changes to the org.",
1912
+ "allowNo": false,
1913
+ "type": "boolean"
1914
+ },
1915
+ "verbose": {
1916
+ "name": "verbose",
1917
+ "summary": "Verbose output of the delete result.",
1918
+ "allowNo": false,
1919
+ "type": "boolean"
1920
+ }
1921
+ },
1922
+ "hasDynamicHelp": true,
1923
+ "hiddenAliases": [],
1924
+ "id": "project:delete:source",
1925
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1926
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
1927
+ "pluginType": "core",
1928
+ "strict": true,
1929
+ "summary": "Delete source from your project and from a non-source-tracked org.",
1930
+ "enableJsonFlag": true,
1931
+ "requiresProject": true,
1932
+ "isESM": true,
1933
+ "relativePath": [
1934
+ "lib",
1935
+ "commands",
1936
+ "project",
1937
+ "delete",
1938
+ "source.js"
1939
+ ],
1940
+ "aliasPermutations": [
1941
+ "force:source:delete",
1942
+ "source:force:delete",
1943
+ "source:delete:force",
1944
+ "force:delete:source",
1945
+ "delete:force:source",
1946
+ "delete:source:force"
1947
+ ],
1948
+ "permutations": [
1949
+ "project:delete:source",
1950
+ "delete:project:source",
1951
+ "delete:source:project",
1952
+ "project:source:delete",
1953
+ "source:project:delete",
1954
+ "source:delete:project"
1955
+ ]
1956
+ },
1957
+ "project:delete:tracking": {
1958
+ "aliases": [
1959
+ "force:source:tracking:clear"
1960
+ ],
1961
+ "args": {},
1962
+ "deprecateAliases": true,
1963
+ "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.",
1964
+ "examples": [
1965
+ "Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
1966
+ ],
1967
+ "flags": {
1968
+ "json": {
1969
+ "description": "Format output as json.",
1970
+ "helpGroup": "GLOBAL",
1971
+ "name": "json",
1972
+ "allowNo": false,
1973
+ "type": "boolean"
1974
+ },
1975
+ "api-version": {
1976
+ "aliases": [
1977
+ "apiversion"
1978
+ ],
1979
+ "deprecateAliases": true,
1980
+ "description": "Override the api version used for api requests made by this command",
1981
+ "name": "api-version",
1982
+ "hasDynamicHelp": false,
1983
+ "multiple": false,
1984
+ "type": "option"
1985
+ },
1986
+ "loglevel": {
1987
+ "deprecated": {
1988
+ "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."
1989
+ },
1990
+ "hidden": true,
1991
+ "name": "loglevel",
1992
+ "hasDynamicHelp": false,
1993
+ "multiple": false,
1994
+ "type": "option"
1995
+ },
1996
+ "target-org": {
1997
+ "aliases": [
1998
+ "targetusername",
1999
+ "u"
2000
+ ],
2001
+ "char": "o",
2002
+ "deprecateAliases": true,
2003
+ "name": "target-org",
2004
+ "noCacheDefault": true,
2005
+ "required": true,
2006
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2007
+ "hasDynamicHelp": true,
2008
+ "multiple": false,
2009
+ "type": "option"
2010
+ },
2011
+ "no-prompt": {
2012
+ "aliases": [
2013
+ "noprompt"
2014
+ ],
2015
+ "char": "p",
2016
+ "deprecateAliases": true,
2017
+ "name": "no-prompt",
2018
+ "summary": "Don't prompt for source tracking override confirmation.",
2019
+ "allowNo": false,
2020
+ "type": "boolean"
2021
+ }
2022
+ },
2023
+ "hasDynamicHelp": true,
2024
+ "hiddenAliases": [],
2025
+ "id": "project:delete:tracking",
2026
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2027
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2028
+ "pluginType": "core",
2029
+ "strict": true,
2030
+ "summary": "Delete all local source tracking information.",
2031
+ "enableJsonFlag": true,
2032
+ "requiresProject": true,
2033
+ "isESM": true,
2034
+ "relativePath": [
2035
+ "lib",
2036
+ "commands",
2037
+ "project",
2038
+ "delete",
2039
+ "tracking.js"
2040
+ ],
2041
+ "aliasPermutations": [
2042
+ "force:source:tracking:clear",
2043
+ "source:force:tracking:clear",
2044
+ "source:tracking:force:clear",
2045
+ "source:tracking:clear:force",
2046
+ "force:tracking:source:clear",
2047
+ "tracking:force:source:clear",
2048
+ "tracking:source:force:clear",
2049
+ "tracking:source:clear:force",
2050
+ "force:tracking:clear:source",
2051
+ "tracking:force:clear:source",
2052
+ "tracking:clear:force:source",
2053
+ "tracking:clear:source:force",
2054
+ "force:source:clear:tracking",
2055
+ "source:force:clear:tracking",
2056
+ "source:clear:force:tracking",
2057
+ "source:clear:tracking:force",
2058
+ "force:clear:source:tracking",
2059
+ "clear:force:source:tracking",
2060
+ "clear:source:force:tracking",
2061
+ "clear:source:tracking:force",
2062
+ "force:clear:tracking:source",
2063
+ "clear:force:tracking:source",
2064
+ "clear:tracking:force:source",
2065
+ "clear:tracking:source:force"
2066
+ ],
2067
+ "permutations": [
2068
+ "project:delete:tracking",
2069
+ "delete:project:tracking",
2070
+ "delete:tracking:project",
2071
+ "project:tracking:delete",
2072
+ "tracking:project:delete",
2073
+ "tracking:delete:project"
2074
+ ]
2075
+ },
2075
2076
  "project:generate:manifest": {
2076
2077
  "aliases": [
2077
2078
  "force:source:manifest:create"
@@ -2570,15 +2571,15 @@
2570
2571
  ],
2571
2572
  "args": {},
2572
2573
  "deprecateAliases": true,
2573
- "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 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 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.",
2574
+ "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.",
2574
2575
  "examples": [
2575
- "Retrieve remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
2576
- "Retrieve the source files in a directory from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch",
2577
- "Retrieve a specific Apex class and the objects whose source is in a directory (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects",
2578
- "Retrieve all Apex classes:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
2579
- "Retrieve a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
2576
+ "Retrieve all remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
2577
+ "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",
2578
+ "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",
2579
+ "Retrieve all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
2580
+ "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",
2580
2581
  "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*'",
2581
- "Retrieve all custom objects and Apex classes (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
2582
+ "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",
2582
2583
  "Retrieve all metadata components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
2583
2584
  "Retrieve metadata from a package:\n<%= config.bin %> <%= command.id %> --package-name MyPackageName",
2584
2585
  "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",
@@ -2630,7 +2631,7 @@
2630
2631
  "source-dir"
2631
2632
  ],
2632
2633
  "name": "metadata",
2633
- "summary": "Metadata component names to retrieve. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
2634
+ "summary": "Metadata component names to retrieve. Wildcards (`*`) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
2634
2635
  "hasDynamicHelp": false,
2635
2636
  "multiple": true,
2636
2637
  "type": "option"
@@ -2815,5 +2816,5 @@
2815
2816
  ]
2816
2817
  }
2817
2818
  },
2818
- "version": "3.2.23"
2819
+ "version": "3.2.25"
2819
2820
  }