salesforcecli · WillieRuemmele · May 28, 2024 · May 28, 2024
@@ -6,19 +6,19 @@ Convert metadata retrieved via Metadata API into the source format used in Sales
 
 To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using this command.
 
-To convert files from the source format back to the metadata format, run "<%= config.bin %> project convert source".
+To convert files from the source format back to the metadata format, run "sf project convert source".
 
 To convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
 
 # examples
 
 - Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:
 
-  $ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata
+  $ sf <%= command.id %> --root-dir path/to/metadata
 
 - Similar to previous example, but writes converted files to the specified output directory:
 
-  $ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir
+  $ sf <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir
 
 # flags.root-dir.summary
 

@@ -4,9 +4,9 @@ Convert source-formatted files into metadata that you can deploy using Metadata
 
 # description
 
-To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using "<%= config.bin %> project deploy".
+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".
 
-To convert Metadata API–formatted files into the source format, run "<%= config.bin %> project convert mdapi".
+To convert Metadata API–formatted files into the source format, run "sf project convert mdapi".
 
 To specify a package name that includes spaces, enclose the name in single quotes.
 
@@ -16,11 +16,11 @@ To convert multiple components, either set multiple --metadata <name> flags or a
 
 - Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:
 
-  $ <%= config.bin %> <%= command.id %> --root-dir path/to/source
+  $ sf <%= command.id %> --root-dir path/to/source
 
 - Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:
 
-  $ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'
+  $ sf <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'
 
 # flags.api-version.summary
 

@@ -4,7 +4,7 @@ Delete source from your project and from a non-source-tracked org.
 
 # 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".
+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".
 
 When you run this command, both the local source file and the metadata component in the org are deleted.
 
@@ -14,19 +14,19 @@ To delete multiple metadata components, either set multiple --metadata <name> fl
 
 - Delete all local Apex source files and all Apex classes from the org with alias "my-scratch":
 
-  <%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch
+  sf <%= command.id %> --metadata ApexClass --target-org my-scratch
 
 - Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:
 
-  <%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt
+  sf <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt
 
 - 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:
 
-  <%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source
+  sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source
 
 - Delete the Apex source files in a directory and the corresponding components from your default org:
 
-  <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes
+  sf <%= command.id %> --source-dir force-app/main/default/classes
 
 # flags.source-dir.summary
 
@@ -70,7 +70,7 @@ IMPORTANT: Where possible, we changed noninclusive terms to align with our compa
 
 Validates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.
 
-If 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.
+If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.
 
 If 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.
 

@@ -10,23 +10,23 @@ Resets local and remote source tracking so that Salesforce CLI no longer registe
 
 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:
 
-    <%= config.bin %> data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch
+    sf data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch
 
 # resetExample
 
 - Reset source tracking for the org with alias "my-scratch":
 
-  $ <%= config.bin %> <%= command.id %> --target-org my-scratch
+  $ sf <%= command.id %> --target-org my-scratch
 
 - Reset source tracking to revision number 30 for your default org:
 
-  $ <%= config.bin %> <%= command.id %> --revision 30
+  $ sf <%= command.id %> --revision 30
 
 # deleteExample
 
 - Delete local source tracking for the org with alias "my-scratch":
 
-  $ <%= config.bin %> <%= command.id %> --target-org my-scratch
+  $ sf <%= command.id %> --target-org my-scratch
 
 # deleteSummary
 

@@ -8,12 +8,12 @@ Deploy has been queued for cancellation.
 
 # info.AsyncDeployCancel
 
-Run "%s project deploy cancel --job-id %s" to cancel the deploy.
+Run "sf project deploy cancel --job-id %s" to cancel the deploy.
 
 # info.AsyncDeployStatus
 
-Run "%s project deploy report --job-id %s" to get the latest status.
+Run "sf project deploy report --job-id %s" to get the latest status.
 
 # info.AsyncDeployResume
 
-Run "%s project deploy resume --job-id %s" to resume watching the deploy.
+Run "sf project deploy resume --job-id %s" to resume watching the deploy.
@@ -12,11 +12,11 @@ Run this command by either passing it a job ID or specifying the --use-most-rece
 
 - Cancel a deploy operation using a job ID:
 
-      <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
+      sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
 
 - Cancel the most recent deploy operation:
 
-      <%= config.bin %> <%= command.id %> --use-most-recent
+      sf <%= command.id %> --use-most-recent
 
 # flags.job-id.summary
 
@@ -26,10 +26,10 @@ Job ID of the deploy operation you want to cancel.
 
 These commands return a job ID if they time out or you specified the --async flag:
 
-- <%= config.bin %> project deploy start
-- <%= config.bin %> project deploy validate
-- <%= config.bin %> project deploy quick
-- <%= config.bin %> project deploy cancel
+- sf project deploy start
+- sf project deploy validate
+- sf project deploy quick
+- sf project deploy cancel
 
 The job ID is valid for 10 days from when you started the deploy operation.
 
@@ -47,15 +47,15 @@ Number of minutes to wait for the command to complete and display results.
 
 # flags.wait.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".
+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".
 
 # flags.async.summary
 
 Run the command asynchronously.
 
 # flags.async.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".
+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".
 
 # error.CannotCancelDeploy
 

@@ -8,53 +8,53 @@ You must run this command from within a project.
 
 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.
 
-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.
+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.
 
 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.
 
 # examples
 
 - Deploy local changes not in the org; uses your default org:
 
-      <%= config.bin %> <%= command.id %>
+      sf <%= command.id %>
 
 - 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:
 
-      <%= config.bin %> <%= command.id %>  --source-dir force-app --target-org my-scratch --concise
+      sf <%= command.id %>  --source-dir force-app --target-org my-scratch --concise
 
 - 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:
 
-      <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
-      <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
+      sf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
+      sf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
 
 - Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
 
-      <%= config.bin %> <%= command.id %> --metadata ApexClass
+      sf <%= command.id %> --metadata ApexClass
 
 - 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!):
 
-      <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
+      sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
 
 - 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):
 
-      <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings
+      sf <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings
 
 - Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
 
-      <%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass
-      <%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass
+      sf <%= command.id %> --metadata CustomObject ApexClass
+      sf <%= command.id %> --metadata CustomObject --metadata ApexClass
 
 - Deploy all Apex classes and a profile that has a space in its name:
 
-      <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata "Profile:My Profile"
+      sf <%= command.id %> --metadata ApexClass --metadata "Profile:My Profile"
 
 - Deploy all components listed in a manifest:
 
-      <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
+      sf <%= command.id %> --manifest path/to/package.xml
 
 - Run the tests that aren’t in any managed packages as part of a deployment:
 
-      <%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests
+      sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests
 
 # flags.target-org.summary
 
@@ -114,7 +114,7 @@ Number of minutes to wait for command to complete and display results.
 
 # flags.wait.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".
+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".
 
 # flags.manifest.summary
 
@@ -176,7 +176,7 @@ Run the command asynchronously.
 
 # flags.async.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".
+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".
 
 # flags.metadata-dir.summary
 
@@ -201,7 +201,7 @@ You must specify tests using the --tests flag if the --test-level flag is set to
 
 # error.ClientTimeout
 
-The command has timed out, although the deployment is still running. Use "%s project deploy resume" to resume watching the deployment.
+The command has timed out, although the deployment is still running. Use "sf project deploy resume" to resume watching the deployment.
 
 # error.Conflicts
 
@@ -211,15 +211,15 @@ There are changes in the org that conflict with the local changes you're trying
 
 - To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.
 
-- To overwrite the local changes, run the "%s project retrieve start" command with the --ignore-conflicts flag.
+- To overwrite the local changes, run the "sf project retrieve start" command with the --ignore-conflicts flag.
 
 # error.nothingToDeploy
 
 No local changes to deploy.
 
 # error.nothingToDeploy.Actions
 
-- To see conflicts and ignored files, run "%s project deploy preview" with any of the manifest, directory, or metadata flags.
+- To see conflicts and ignored files, run "sf project deploy preview" with any of the manifest, directory, or metadata flags.
 
 # error.InvalidDeployId