|
1 | 1 | # description |
2 | 2 |
|
3 | | -Use this information to identify the syntax needed for a <name> element in package.xml. The most recent API version is |
4 | | -the default, or you can specify an older version. |
| 3 | +The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml). |
5 | 4 |
|
6 | | -The default target username is the admin user for the default scratch org. The username must have the Modify All Data |
7 | | -permission or the Modify Metadata permission (Beta). For more information about permissions, see Salesforce Help. |
| 5 | +The username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission. |
8 | 6 |
|
9 | 7 | # summary |
10 | 8 |
|
11 | | -display details about the metadata types enabled for your org |
| 9 | +Display details about the metadata types that are enabled for your org. |
12 | 10 |
|
13 | 11 | # examples |
14 | 12 |
|
15 | | -- $ <%= config.bin %> <%= command.id %> -a 43.0 |
| 13 | +- Display information about all known and enabled metadata types in the org with alias "my-dev-org" using API version 57.0: |
16 | 14 |
|
17 | | -- $ <%= config.bin %> <%= command.id %> - o [email protected] |
| 15 | + $ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org |
18 | 16 |
|
19 | | -- $ <%= config.bin %> <%= command.id %> -f /path/to/outputfilename.txt |
| 17 | +- Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file: |
20 | 18 |
|
21 | | -- $ <%= config.bin %> <%= command.id %> - o [email protected] -f /path/to/outputfilename.txt |
| 19 | + $ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known |
22 | 20 |
|
23 | | -# flags.api-version |
| 21 | +# flags.api-version.summary |
24 | 22 |
|
25 | | -API version to use |
| 23 | +API version to use; default is the most recent API version. |
26 | 24 |
|
27 | | -# flags.output-file |
| 25 | +# flags.output-file.summary |
28 | 26 |
|
29 | | -path to the file where results are stored |
| 27 | +Pathname of the file in which to write the results. |
30 | 28 |
|
31 | | -# flags.filterknown |
| 29 | +# flags.filter-known.summary |
32 | 30 |
|
33 | | -filter metadata known by the CLI |
34 | | - |
35 | | -# flagsLong.apiversion |
36 | | - |
37 | | -The API version to use. The default is the latest API version |
| 31 | +Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI. |
38 | 32 |
|
39 | | -# flagsLong.output-file |
40 | | - |
41 | | -The path to the file where the results of the command are stored. Directing the output to a file makes it easier to |
42 | | -extract relevant information for your package.xml manifest file. The default output destination is the console. |
| 33 | +filter metadata known by the CLI |
43 | 34 |
|
44 | | -# flagsLong.filterknown |
| 35 | +# flags.output-file.description |
45 | 36 |
|
46 | | -Filters all the known metadata from the result such that all that is left are the types not yet fully supported by the |
47 | | -CLI. |
| 37 | +Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the terminal or command window console. |
0 commit comments