@@ -117,11 +117,11 @@ EXAMPLES
117117 $ sf deploy --interactive
118118```
119119
120- _ See code: [ src/commands/deploy.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.5.5 /src/commands/deploy.ts ) _
120+ _ See code: [ src/commands/deploy.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.6.0 /src/commands/deploy.ts ) _
121121
122122## ` sf deploy metadata `
123123
124- Deploy metadata in source format to an org from your local project.
124+ Deploy metadata to an org from your local project.
125125
126126```
127127USAGE
@@ -154,10 +154,14 @@ GLOBAL FLAGS
154154 --json Format output as json.
155155
156156DESCRIPTION
157- Deploy metadata in source format to an org from your local project.
157+ Deploy metadata to an org from your local project.
158158
159159 You must run this command from within a project.
160160
161+ Metadata components are deployed in source format by default. Deploy them in metadata format by specifying the
162+ --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you
163+ want to deploy.
164+
161165 If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
162166 org, never allow source tracking. You can also use the "--no-track-source" flag when you create a scratch or sandbox
163167 org to disable source tracking.
@@ -728,7 +732,7 @@ FLAG DESCRIPTIONS
728732
729733## ` sf retrieve metadata `
730734
731- Retrieve metadata in source format from an org to your local project.
735+ Retrieve metadata from an org to your local project.
732736
733737```
734738USAGE
@@ -743,7 +747,7 @@ FLAGS
743747 -m, --metadata=<value>... Metadata component names to retrieve.
744748 -n, --package-name=<value>... Package names to retrieve.
745749 -o, --target-org=<value> Login username or alias for the target org.
746- -t, --target-metadata-dir=<value> Directory root for the retrieved files.
750+ -t, --target-metadata-dir=<value> Directory that will contain the retrieved metadata format files or ZIP .
747751 -w, --wait=<value> Number of minutes to wait for the command to complete and display results to the
748752 terminal window.
749753 -x, --manifest=<value> File path for the manifest (package.xml) that specifies the components to retrieve.
@@ -755,10 +759,13 @@ GLOBAL FLAGS
755759 --json Format output as json.
756760
757761DESCRIPTION
758- Retrieve metadata in source format from an org to your local project.
762+ Retrieve metadata from an org to your local project.
759763
760764 You must run this command from within a project.
761765
766+ Metadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the
767+ --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.
768+
762769 If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
763770 org, never allow source tracking. You can also use the "--no-track-source" flag when you create a scratch or sandbox
764771 org to disable source tracking.
@@ -807,11 +814,12 @@ EXAMPLES
807814 $ sf retrieve metadata --package-name Package1 "PackageName With Spaces" Package3
808815 $ sf retrieve metadata --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
809816
810- Retrieve using Metadata API
817+ Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP
818+ file in the "output" directory:
811819
812820 $ sf retrieve metadata --source-dir force-app --target-metadata-dir output
813821
814- Retrieve using Metadata API and automatically unzip the contents
822+ Retrieve in metadata format and automatically extract the contents into the "output" directory:
815823
816824 $ sf retrieve metadata --source-dir force-app --target-metadata-dir output --unzip
817825
0 commit comments