@salesforce/plugin-deploy-retrieve 3.8.4 → 3.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/README.md +47 -45
  2. package/lib/commands/project/convert/source-behavior.d.ts +4 -4
  3. package/lib/commands/project/convert/source.d.ts +5 -5
  4. package/lib/commands/project/delete/tracking.d.ts +4 -4
  5. package/lib/commands/project/deploy/cancel.d.ts +5 -5
  6. package/lib/commands/project/deploy/preview.d.ts +6 -6
  7. package/lib/commands/project/deploy/quick.d.ts +8 -8
  8. package/lib/commands/project/deploy/report.d.ts +7 -7
  9. package/lib/commands/project/deploy/resume.d.ts +8 -8
  10. package/lib/commands/project/deploy/start.d.ts +23 -23
  11. package/lib/commands/project/deploy/validate.d.ts +20 -20
  12. package/lib/commands/project/generate/manifest.d.ts +9 -9
  13. package/lib/commands/project/list/ignored.d.ts +1 -1
  14. package/lib/commands/project/reset/tracking.d.ts +5 -5
  15. package/lib/commands/project/retrieve/preview.d.ts +3 -3
  16. package/lib/formatters/asyncDeployCancelResultFormatter.js +2 -1
  17. package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
  18. package/lib/formatters/asyncDeployResultFormatter.js +2 -1
  19. package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
  20. package/lib/formatters/deleteResultFormatter.js +6 -7
  21. package/lib/formatters/deleteResultFormatter.js.map +1 -1
  22. package/lib/formatters/deployCancelResultFormatter.js +4 -2
  23. package/lib/formatters/deployCancelResultFormatter.js.map +1 -1
  24. package/lib/formatters/deployReportResultFormatter.js +2 -1
  25. package/lib/formatters/deployReportResultFormatter.js.map +1 -1
  26. package/lib/formatters/deployResultFormatter.js +4 -3
  27. package/lib/formatters/deployResultFormatter.js.map +1 -1
  28. package/lib/formatters/metadataConvertResultFormatter.js +3 -2
  29. package/lib/formatters/metadataConvertResultFormatter.js.map +1 -1
  30. package/lib/formatters/metadataRetrieveResultFormatter.js +2 -1
  31. package/lib/formatters/metadataRetrieveResultFormatter.js.map +1 -1
  32. package/lib/formatters/retrieveResultFormatter.js +1 -1
  33. package/lib/formatters/retrieveResultFormatter.js.map +1 -1
  34. package/lib/formatters/sourceConvertResultFormatter.js +2 -1
  35. package/lib/formatters/sourceConvertResultFormatter.js.map +1 -1
  36. package/lib/formatters/testResultsFormatter.js +3 -2
  37. package/lib/formatters/testResultsFormatter.js.map +1 -1
  38. package/lib/utils/conflicts.js +2 -1
  39. package/lib/utils/conflicts.js.map +1 -1
  40. package/lib/utils/flags.d.ts +6 -6
  41. package/lib/utils/previewOutput.js +2 -1
  42. package/lib/utils/previewOutput.js.map +1 -1
  43. package/lib/utils/progressBar.js +3 -3
  44. package/lib/utils/progressBar.js.map +1 -1
  45. package/messages/convert.mdapi.md +2 -2
  46. package/messages/convert.source.md +4 -4
  47. package/messages/delete.source.md +5 -5
  48. package/messages/delete.tracking.md +4 -4
  49. package/messages/deploy.metadata.cancel.md +8 -8
  50. package/messages/deploy.metadata.md +15 -15
  51. package/messages/deploy.metadata.preview.md +7 -7
  52. package/messages/deploy.metadata.quick.md +6 -6
  53. package/messages/deploy.metadata.report.md +7 -7
  54. package/messages/deploy.metadata.resume.md +7 -7
  55. package/messages/deploy.metadata.validate.md +9 -9
  56. package/messages/list.ignored.md +3 -3
  57. package/messages/manifest.generate.md +4 -4
  58. package/messages/retrieve.metadata.preview.md +4 -4
  59. package/messages/retrieve.start.md +16 -16
  60. package/oclif.manifest.json +508 -508
  61. package/package.json +8 -8
@@ -4,12 +4,12 @@
4
4
  * Licensed under the BSD 3-Clause license.
5
5
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
6
6
  */
7
- import { envVars as env, EnvironmentVariable, Lifecycle, Messages } from '@salesforce/core';
7
+ import { envVars as env, EnvironmentVariable, Lifecycle, Messages, Logger } from '@salesforce/core';
8
8
  import { Progress } from '@salesforce/sf-plugins-core';
9
- import { ux } from '@oclif/core';
10
9
  Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
11
10
  const mdTransferMessages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'metadata.transfer');
12
11
  const showBar = Boolean(process.env.TERM !== 'dumb' && process.stdin.isTTY && env.getBoolean(EnvironmentVariable.SF_USE_PROGRESS_BAR, true));
12
+ const logger = await Logger.child('deploy-progress');
13
13
  export class DeployProgress extends Progress {
14
14
  deploy;
15
15
  static OPTIONS = {
@@ -70,7 +70,7 @@ export class DeployProgress extends Progress {
70
70
  status = mdTransferMessages.getMessage(data.status);
71
71
  }
72
72
  catch (e) {
73
- ux.debug(`data.status message lookup failed for: ${data.status}`);
73
+ logger.debug(`data.status message lookup failed for: ${data.status}`);
74
74
  status = 'Waiting';
75
75
  }
76
76
  this.update(0, { errorInfo, testInfo, status });
@@ -1 +1 @@
1
- {"version":3,"file":"progressBar.js","sourceRoot":"","sources":["../../src/utils/progressBar.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,mBAAmB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5F,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAEvD,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEjC,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,kBAAkB,GAAG,QAAQ,CAAC,YAAY,CAAC,oCAAoC,EAAE,mBAAmB,CAAC,CAAC;AAE5G,MAAM,OAAO,GAAG,OAAO,CACrB,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,CAAC,UAAU,CAAC,mBAAmB,CAAC,mBAAmB,EAAE,IAAI,CAAC,CACpH,CAAC;AAEF,MAAM,OAAO,cAAe,SAAQ,QAAQ;IAaf;IAZnB,MAAM,CAAC,OAAO,GAAG;QACvB,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE,gBAAgB,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,iEAAiE;QAClH,eAAe,EAAE,QAAQ;QACzB,iBAAiB,EAAE,QAAQ;QAC3B,QAAQ,EAAE,IAAI;QACd,sDAAsD;QACtD,6EAA6E;QAC7E,WAAW,EAAE,IAAI;KAClB,CAAC;IACM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE5C,YAA2B,MAAyB,EAAE,WAAW,GAAG,KAAK;QACvE,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC;QADK,WAAM,GAAN,MAAM,CAAmB;IAEpD,CAAC;IAEM,KAAK;QACV,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;QAE9F,kCAAkC;QAClC,IAAI,CAAC,SAAS,CAAC,EAAE,CAA2B,0BAA0B,EAAE,CAAC,KAA+B,EAAE,EAAE,CAC1G,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CACpD,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAE1D,0EAA0E;QAC1E,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAExC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAY,EAAE,EAAE;YACnC,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,sBAAsB,CAAC,IAA8B;QAC3D,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE;YACb,MAAM,EAAE,uBAAuB;YAC/B,YAAY,EAAE,gBAAgB,QAAQ,GAAG,SAAS,IAAI,QAAQ,EAAE;SACjE,CAAC,CAAC;IACL,CAAC;IAEO,cAAc,CAAC,IAA6B;QAClD,0FAA0F;QAC1F,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB;YACpC,CAAC,CAAC,MAAM,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,SAChE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,EAChE,EAAE;YACJ,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEnG,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE;gBACzC,SAAS,EAAE,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE;gBAC3F,MAAM,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;gBAClD,QAAQ;aACT,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,MAAM,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtD,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,EAAE,CAAC,KAAK,CAAC,0CAA0C,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;gBAClE,MAAM,GAAG,SAAS,CAAC;YACrB,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC"}
1
+ {"version":3,"file":"progressBar.js","sourceRoot":"","sources":["../../src/utils/progressBar.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,mBAAmB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAEpG,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAGvD,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,kBAAkB,GAAG,QAAQ,CAAC,YAAY,CAAC,oCAAoC,EAAE,mBAAmB,CAAC,CAAC;AAE5G,MAAM,OAAO,GAAG,OAAO,CACrB,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,CAAC,UAAU,CAAC,mBAAmB,CAAC,mBAAmB,EAAE,IAAI,CAAC,CACpH,CAAC;AAEF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AAErD,MAAM,OAAO,cAAe,SAAQ,QAAQ;IAaf;IAZnB,MAAM,CAAC,OAAO,GAAG;QACvB,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE,gBAAgB,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,iEAAiE;QAClH,eAAe,EAAE,QAAQ;QACzB,iBAAiB,EAAE,QAAQ;QAC3B,QAAQ,EAAE,IAAI;QACd,sDAAsD;QACtD,6EAA6E;QAC7E,WAAW,EAAE,IAAI;KAClB,CAAC;IACM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE5C,YAA2B,MAAyB,EAAE,WAAW,GAAG,KAAK;QACvE,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC;QADK,WAAM,GAAN,MAAM,CAAmB;IAEpD,CAAC;IAEM,KAAK;QACV,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;QAE9F,kCAAkC;QAClC,IAAI,CAAC,SAAS,CAAC,EAAE,CAA2B,0BAA0B,EAAE,CAAC,KAA+B,EAAE,EAAE,CAC1G,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CACpD,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAE1D,0EAA0E;QAC1E,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAExC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAY,EAAE,EAAE;YACnC,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,sBAAsB,CAAC,IAA8B;QAC3D,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE;YACb,MAAM,EAAE,uBAAuB;YAC/B,YAAY,EAAE,gBAAgB,QAAQ,GAAG,SAAS,IAAI,QAAQ,EAAE;SACjE,CAAC,CAAC;IACL,CAAC;IAEO,cAAc,CAAC,IAA6B;QAClD,0FAA0F;QAC1F,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB;YACpC,CAAC,CAAC,MAAM,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,SAChE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,EAChE,EAAE;YACJ,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEnG,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE;gBACzC,SAAS,EAAE,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE;gBAC3F,MAAM,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;gBAClD,QAAQ;aACT,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,MAAM,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtD,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,CAAC,KAAK,CAAC,0CAA0C,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;gBACtE,MAAM,GAAG,SAAS,CAAC;YACrB,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC"}
@@ -14,11 +14,11 @@ To convert multiple metadata components, either set multiple --metadata <name> f
14
14
 
15
15
  - Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:
16
16
 
17
- $ sf <%= command.id %> --root-dir path/to/metadata
17
+ $ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata
18
18
 
19
19
  - Similar to previous example, but writes converted files to the specified output directory:
20
20
 
21
- $ sf <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir
21
+ $ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir
22
22
 
23
23
  # flags.root-dir.summary
24
24
 
@@ -4,9 +4,9 @@ Convert source-formatted files into metadata that you can deploy using Metadata
4
4
 
5
5
  # description
6
6
 
7
- To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using "sf project deploy".
7
+ To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using "<%= config.bin %> project deploy".
8
8
 
9
- To convert Metadata API–formatted files into the source format, run "sf project convert mdapi".
9
+ To convert Metadata API–formatted files into the source format, run "<%= config.bin %> project convert mdapi".
10
10
 
11
11
  To specify a package name that includes spaces, enclose the name in single quotes.
12
12
 
@@ -16,11 +16,11 @@ To convert multiple components, either set multiple --metadata <name> flags or a
16
16
 
17
17
  - Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:
18
18
 
19
- $ sf <%= command.id %> --root-dir path/to/source
19
+ $ <%= config.bin %> <%= command.id %> --root-dir path/to/source
20
20
 
21
21
  - Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:
22
22
 
23
- $ sf <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'
23
+ $ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'
24
24
 
25
25
  # flags.api-version.summary
26
26
 
@@ -4,7 +4,7 @@ Delete source from your project and from a non-source-tracked org.
4
4
 
5
5
  # description
6
6
 
7
- Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, "sf project deploy start".
7
+ 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".
8
8
 
9
9
  When you run this command, both the local source file and the metadata component in the org are deleted.
10
10
 
@@ -14,19 +14,19 @@ To delete multiple metadata components, either set multiple --metadata <name> fl
14
14
 
15
15
  - Delete all local Apex source files and all Apex classes from the org with alias "my-scratch":
16
16
 
17
- sf <%= command.id %> --metadata ApexClass --target-org my-scratch
17
+ <%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch
18
18
 
19
19
  - Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:
20
20
 
21
- sf <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt
21
+ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt
22
22
 
23
23
  - 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:
24
24
 
25
- sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source
25
+ <%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source
26
26
 
27
27
  - Delete the Apex source files in a directory and the corresponding components from your default org:
28
28
 
29
- sf <%= command.id %> --source-dir force-app/main/default/classes
29
+ <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes
30
30
 
31
31
  # flags.source-dir.summary
32
32
 
@@ -10,23 +10,23 @@ Resets local and remote source tracking so that Salesforce CLI no longer registe
10
10
 
11
11
  Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:
12
12
 
13
- sf data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch
13
+ <%= config.bin %> data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch
14
14
 
15
15
  # resetExample
16
16
 
17
17
  - Reset source tracking for the org with alias "my-scratch":
18
18
 
19
- $ sf <%= command.id %> --target-org my-scratch
19
+ $ <%= config.bin %> <%= command.id %> --target-org my-scratch
20
20
 
21
21
  - Reset source tracking to revision number 30 for your default org:
22
22
 
23
- $ sf <%= command.id %> --revision 30
23
+ $ <%= config.bin %> <%= command.id %> --revision 30
24
24
 
25
25
  # deleteExample
26
26
 
27
27
  - Delete local source tracking for the org with alias "my-scratch":
28
28
 
29
- $ sf <%= command.id %> --target-org my-scratch
29
+ $ <%= config.bin %> <%= command.id %> --target-org my-scratch
30
30
 
31
31
  # deleteSummary
32
32
 
@@ -12,11 +12,11 @@ Run this command by either passing it a job ID or specifying the --use-most-rece
12
12
 
13
13
  - Cancel a deploy operation using a job ID:
14
14
 
15
- sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
15
+ <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
16
16
 
17
17
  - Cancel the most recent deploy operation:
18
18
 
19
- sf <%= command.id %> --use-most-recent
19
+ <%= config.bin %> <%= command.id %> --use-most-recent
20
20
 
21
21
  # flags.job-id.summary
22
22
 
@@ -26,10 +26,10 @@ Job ID of the deploy operation you want to cancel.
26
26
 
27
27
  These commands return a job ID if they time out or you specified the --async flag:
28
28
 
29
- - sf project deploy start
30
- - sf project deploy validate
31
- - sf project deploy quick
32
- - sf project deploy cancel
29
+ - <%= config.bin %> project deploy start
30
+ - <%= config.bin %> project deploy validate
31
+ - <%= config.bin %> project deploy quick
32
+ - <%= config.bin %> project deploy cancel
33
33
 
34
34
  The job ID is valid for 10 days from when you started the deploy operation.
35
35
 
@@ -47,7 +47,7 @@ Number of minutes to wait for the command to complete and display results.
47
47
 
48
48
  # flags.wait.description
49
49
 
50
- If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "sf project deploy report".
50
+ 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".
51
51
 
52
52
  # flags.async.summary
53
53
 
@@ -55,7 +55,7 @@ Run the command asynchronously.
55
55
 
56
56
  # flags.async.description
57
57
 
58
- The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "sf project deploy report".
58
+ 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".
59
59
 
60
60
  # error.CannotCancelDeploy
61
61
 
@@ -8,7 +8,7 @@ You must run this command from within a project.
8
8
 
9
9
  Metadata 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.
10
10
 
11
- If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create scratch|sandbox" commands.
11
+ If 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.
12
12
 
13
13
  To 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.
14
14
 
@@ -16,28 +16,28 @@ To deploy multiple metadata components, either set multiple --metadata <name> fl
16
16
 
17
17
  - Deploy local changes not in the org; uses your default org:
18
18
 
19
- sf <%= command.id %>
19
+ <%= config.bin %> <%= command.id %>
20
20
 
21
21
  - 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:
22
22
 
23
- sf <%= command.id %> --source-dir force-app --target-org my-scratch --concise
23
+ <%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise
24
24
 
25
25
  - 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:
26
26
 
27
- sf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28
- sf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
27
+ <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28
+ <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
29
29
 
30
30
  - Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
31
31
 
32
- sf <%= command.id %> --metadata ApexClass
32
+ <%= config.bin %> <%= command.id %> --metadata ApexClass
33
33
 
34
34
  - 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!):
35
35
 
36
- sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
36
+ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
37
37
 
38
38
  - 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):
39
39
 
40
- sf <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings
40
+ <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings
41
41
 
42
42
  - Deploy a custom object called ExcitingObject that's in the SBQQ namespace:
43
43
 
@@ -49,20 +49,20 @@ To deploy multiple metadata components, either set multiple --metadata <name> fl
49
49
 
50
50
  - Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
51
51
 
52
- sf <%= command.id %> --metadata CustomObject ApexClass
53
- sf <%= command.id %> --metadata CustomObject --metadata ApexClass
52
+ <%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass
53
+ <%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass
54
54
 
55
55
  - Deploy all Apex classes and a profile that has a space in its name:
56
56
 
57
- sf <%= command.id %> --metadata ApexClass --metadata "Profile:My Profile"
57
+ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata "Profile:My Profile"
58
58
 
59
59
  - Deploy all components listed in a manifest:
60
60
 
61
- sf <%= command.id %> --manifest path/to/package.xml
61
+ <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
62
62
 
63
63
  - Run the tests that aren’t in any managed packages as part of a deployment:
64
64
 
65
- sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests
65
+ <%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests
66
66
 
67
67
  # flags.pre-destructive-changes.summary
68
68
 
@@ -114,7 +114,7 @@ Number of minutes to wait for command to complete and display results.
114
114
 
115
115
  # flags.wait.description
116
116
 
117
- If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run "sf project deploy resume". To check the status of the deployment, run "sf project deploy report".
117
+ 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".
118
118
 
119
119
  # flags.manifest.summary
120
120
 
@@ -176,7 +176,7 @@ Run the command asynchronously.
176
176
 
177
177
  # flags.async.description
178
178
 
179
- The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run "sf project deploy resume". To check the status of the deployment, run "sf project deploy report".
179
+ 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".
180
180
 
181
181
  # flags.metadata-dir.summary
182
182
 
@@ -6,31 +6,31 @@ Preview a deployment to see what will deploy to the org, the potential conflicts
6
6
 
7
7
  You must run this command from within a project.
8
8
 
9
- The command outputs a table that describes what will happen if you run the "sf project deploy start" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.
9
+ The 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.
10
10
 
11
- If your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create scratch|sandbox" commands.
11
+ If 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.
12
12
 
13
13
  To 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.
14
14
 
15
15
  # examples
16
16
 
17
- - NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for "sf project deploy start" for more examples that you can adapt for previewing.
17
+ - 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.
18
18
 
19
19
  - Preview the deployment of source files in a directory, such as force-app, to your default org:
20
20
 
21
- sf <%= command.id %> --source-dir force-app
21
+ <%= config.bin %> <%= command.id %> --source-dir force-app
22
22
 
23
23
  - Preview the deployment of all Apex classes to an org with alias "my-scratch":
24
24
 
25
- sf <%= command.id %> --metadata ApexClass --target-org my-scratch
25
+ <%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch
26
26
 
27
27
  - Preview deployment of a specific Apex class:
28
28
 
29
- sf <%= command.id %> --metadata ApexClass:MyApexClass
29
+ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass
30
30
 
31
31
  - Preview deployment of all components listed in a manifest:
32
32
 
33
- sf <%= command.id %> --manifest path/to/package.xml
33
+ <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
34
34
 
35
35
  # flags.only-ignored.summary
36
36
 
@@ -4,23 +4,23 @@ Quickly deploy a validated deployment to an org.
4
4
 
5
5
  # description
6
6
 
7
- Before you run this command, first create a validated deployment with the "sf project deploy validate" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.
7
+ 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.
8
8
 
9
9
  Executing 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.
10
10
 
11
11
  This 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.
12
12
 
13
- Note: 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.
13
+ Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. Use "<%= config.bin %> project deploy start" instead.
14
14
 
15
15
  # examples
16
16
 
17
17
  - Run a quick deploy to your default org using a job ID:
18
18
 
19
- sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
19
+ <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
20
20
 
21
21
  - Asynchronously run a quick deploy of the most recently validated deployment to an org with alias "my-prod-org":
22
22
 
23
- sf <%= command.id %> --async --use-most-recent --target-org my-prod-org
23
+ <%= config.bin %> <%= command.id %> --async --use-most-recent --target-org my-prod-org
24
24
 
25
25
  # flags.job-id.summary
26
26
 
@@ -52,7 +52,7 @@ Number of minutes to wait for the command to complete and display results.
52
52
 
53
53
  # flags.wait.description
54
54
 
55
- If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run "sf project deploy resume". To check the status of the deploy, run "sf project deploy report".
55
+ 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".
56
56
 
57
57
  # flags.verbose.summary
58
58
 
@@ -68,7 +68,7 @@ Run the command asynchronously.
68
68
 
69
69
  # flags.async.description
70
70
 
71
- The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run "sf project deploy resume". To check the status of the deploy, run "sf project deploy report".
71
+ 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".
72
72
 
73
73
  # error.CannotQuickDeploy
74
74
 
@@ -16,15 +16,15 @@ This command doesn't update source tracking information.
16
16
 
17
17
  - Check the status using a job ID:
18
18
 
19
- sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
19
+ <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
20
20
 
21
21
  - Check the status of the most recent deploy operation:
22
22
 
23
- sf <%= command.id %> --use-most-recent
23
+ <%= config.bin %> <%= command.id %> --use-most-recent
24
24
 
25
25
  - Poll for the status using a job ID and target org:
26
26
 
27
- sf <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30
27
+ <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30
28
28
 
29
29
  # flags.job-id.summary
30
30
 
@@ -34,10 +34,10 @@ Job ID of the deploy operation you want to check the status of.
34
34
 
35
35
  These commands return a job ID if they time out or you specified the --async flag:
36
36
 
37
- - sf project deploy start
38
- - sf project deploy validate
39
- - sf project deploy quick
40
- - sf project deploy cancel
37
+ - <%= config.bin %> project deploy start
38
+ - <%= config.bin %> project deploy validate
39
+ - <%= config.bin %> project deploy quick
40
+ - <%= config.bin %> project deploy cancel
41
41
 
42
42
  The job ID is valid for 10 days from when you started the deploy operation.
43
43
 
@@ -12,11 +12,11 @@ Run this command by either passing it a job ID or specifying the --use-most-rece
12
12
 
13
13
  - Resume watching a deploy operation using a job ID:
14
14
 
15
- sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
15
+ <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
16
16
 
17
17
  - Resume watching the most recent deploy operation:
18
18
 
19
- sf <%= command.id %> --use-most-recent
19
+ <%= config.bin %> <%= command.id %> --use-most-recent
20
20
 
21
21
  # flags.job-id.summary
22
22
 
@@ -26,10 +26,10 @@ Job ID of the deploy operation you want to resume.
26
26
 
27
27
  These commands return a job ID if they time out or you specified the --async flag:
28
28
 
29
- - sf project deploy start
30
- - sf project deploy validate
31
- - sf project deploy quick
32
- - sf project deploy cancel
29
+ - <%= config.bin %> project deploy start
30
+ - <%= config.bin %> project deploy validate
31
+ - <%= config.bin %> project deploy quick
32
+ - <%= config.bin %> project deploy cancel
33
33
 
34
34
  The job ID is valid for 10 days from when you started the deploy operation.
35
35
 
@@ -47,7 +47,7 @@ Number of minutes to wait for the command to complete and display results.
47
47
 
48
48
  # flags.wait.description
49
49
 
50
- If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy operation, run this command again. To check the status of the deploy operation, run "sf project deploy report".
50
+ 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".
51
51
 
52
52
  # flags.verbose.summary
53
53
 
@@ -4,7 +4,7 @@ Validate a metadata deployment without actually executing it.
4
4
 
5
5
  # description
6
6
 
7
- Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to "sf project deploy start", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the "sf project deploy quick" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.
7
+ 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.
8
8
 
9
9
  You must run this command from within a project.
10
10
 
@@ -12,27 +12,27 @@ This command doesn't support source-tracking. When you quick deploy with the res
12
12
 
13
13
  To 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.
14
14
 
15
- Note: 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.
15
+ Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use "<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests" instead.
16
16
 
17
17
  # examples
18
18
 
19
- - NOTE: These examples focus on validating large deployments. See the help for "sf project deploy start" for examples of deploying smaller sets of metadata which you can also use to validate.
19
+ - 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.
20
20
 
21
21
  - Validate the deployment of all source files in the "force-app" directory to the default org:
22
22
 
23
- sf <%= command.id %> --source-dir force-app
23
+ <%= config.bin %> <%= command.id %> --source-dir force-app
24
24
 
25
25
  - Validate the deployment of all source files in two directories: "force-app" and "force-app-utils":
26
26
 
27
- sf <%= command.id %> --source-dir force-app --source-dir force-app-utils
27
+ <%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils
28
28
 
29
29
  - Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately returns the job ID:
30
30
 
31
- sf <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org
31
+ <%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org
32
32
 
33
33
  - Validate the deployment of all components listed in a manifest:
34
34
 
35
- sf <%= command.id %> --manifest path/to/package.xml
35
+ <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
36
36
 
37
37
  # flags.metadata.summary
38
38
 
@@ -68,7 +68,7 @@ Number of minutes to wait for the command to complete and display results.
68
68
 
69
69
  # flags.wait.description
70
70
 
71
- If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume watching the validation, run "sf project deploy resume". To check the status of the validation, run "sf project deploy report".
71
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume watching the validation, run "<%= config.bin %> project deploy resume". To check the status of the validation, run "<%= config.bin %> project deploy report".
72
72
 
73
73
  # flags.manifest.summary
74
74
 
@@ -104,7 +104,7 @@ Run the command asynchronously.
104
104
 
105
105
  # flags.async.description
106
106
 
107
- The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume watching the validation, run "sf project deploy resume". To check the status of the validation, run "sf project deploy report".
107
+ The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume watching the validation, run "<%= config.bin %> project deploy resume". To check the status of the validation, run "<%= config.bin %> project deploy report".
108
108
 
109
109
  # flags.metadata-dir.summary
110
110
 
@@ -10,15 +10,15 @@ When deploying or retrieving metadata between your local project and an org, you
10
10
 
11
11
  - List all the files in all package directories that are ignored:
12
12
 
13
- sf <%= command.id %>
13
+ <%= config.bin %> <%= command.id %>
14
14
 
15
15
  - List all the files in a specific directory that are ignored:
16
16
 
17
- sf <%= command.id %> --source-dir force-app
17
+ <%= config.bin %> <%= command.id %> --source-dir force-app
18
18
 
19
19
  - Check if a particular file is ignored:
20
20
 
21
- sf <%= command.id %> --source-dir package.xml
21
+ <%= config.bin %> <%= command.id %> --source-dir package.xml
22
22
 
23
23
  # flags.source-dir.summary
24
24
 
@@ -23,19 +23,19 @@ To include multiple metadata components, either set multiple --metadata <name> f
23
23
 
24
24
  - Create a manifest for deploying or retrieving all Apex classes and custom objects:
25
25
 
26
- $ sf <%= command.id %> --metadata ApexClass --metadata CustomObject
26
+ $ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject
27
27
 
28
28
  - Create a manifest for deleting the specified Apex class:
29
29
 
30
- $ sf <%= command.id %> --metadata ApexClass:MyApexClass --type destroy
30
+ $ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy
31
31
 
32
32
  - Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:
33
33
 
34
- $ sf <%= command.id %> --source-dir force-app --name myNewManifest
34
+ $ <%= config.bin %> <%= command.id %> --source-dir force-app --name myNewManifest
35
35
 
36
36
  - Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:
37
37
 
38
- $ sf <%= command.id %> --from-org test@myorg.com --include-packages unlocked
38
+ $ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked
39
39
 
40
40
  # flags.include-packages.summary
41
41
 
@@ -6,19 +6,19 @@ Preview a retrieval to see what will be retrieved from the org, the potential co
6
6
 
7
7
  You must run this command from within a project.
8
8
 
9
- The command outputs a table that describes what will happen if you run the "sf project retrieve start" command. The table lists the metadata components that will be retrieved and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be retrieved because they're included in your .forceignore file.
9
+ The command outputs a table that describes what will happen if you run the "<%= config.bin %> project retrieve start" command. The table lists the metadata components that will be retrieved and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be retrieved because they're included in your .forceignore file.
10
10
 
11
- If your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create scratch|sandbox" commands.
11
+ If 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.
12
12
 
13
13
  # examples
14
14
 
15
15
  - Preview the retrieve of all changes from your default org:
16
16
 
17
- sf <%= command.id %>
17
+ <%= config.bin %> <%= command.id %>
18
18
 
19
19
  - Preview the retrieve when ignoring any conflicts from an org with alias "my-scratch":
20
20
 
21
- sf <%= command.id %> --ignore-conflicts --target-org my-scratch
21
+ <%= config.bin %> <%= command.id %> --ignore-conflicts --target-org my-scratch
22
22
 
23
23
  # flags.ignore-conflicts.summary
24
24