|
1 | 1 | # summary
|
2 | 2 |
|
3 |
| -Retrieve metadata in source format from an org to your local project. |
| 3 | +Retrieve metadata from an org to your local project. |
4 | 4 |
|
5 | 5 | # description
|
6 | 6 |
|
7 | 7 | You must run this command from within a project.
|
8 | 8 |
|
| 9 | +Metadata 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. |
| 10 | + |
9 | 11 | If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production org, never allow source tracking. You can also use the "--no-track-source" flag when you create a scratch or sandbox org to disable source tracking.
|
10 | 12 |
|
11 | 13 | To 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.
|
@@ -51,11 +53,11 @@ To retrieve multiple metadata components, either use multiple --metadata <name>
|
51 | 53 | <%= config.bin %> <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3
|
52 | 54 | <%= config.bin %> <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
|
53 | 55 |
|
54 |
| -- Retrieve using Metadata API |
| 56 | +- Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the "output" directory: |
55 | 57 |
|
56 | 58 | <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output
|
57 | 59 |
|
58 |
| -- Retrieve using Metadata API and automatically unzip the contents |
| 60 | +- Retrieve in metadata format and automatically extract the contents into the "output" directory: |
59 | 61 |
|
60 | 62 | <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip
|
61 | 63 |
|
@@ -125,7 +127,7 @@ Indicates that the zip file points to a directory structure for a single package
|
125 | 127 |
|
126 | 128 | # flags.target-metadata-dir.summary
|
127 | 129 |
|
128 |
| -Directory root for the retrieved files. |
| 130 | +Directory that will contain the retrieved metadata format files or ZIP. |
129 | 131 |
|
130 | 132 | # flags.unzip.summary
|
131 | 133 |
|
|
0 commit comments