@@ -36,9 +36,37 @@ Found 38 metadata type to check.
3636Error (2): Some metadata types are not supported.
3737```
3838
39+ ### Example Use Cases
40+
41+ Is the Metadata Type "CustomHelpMenuSection" supported for a 2GP Managed Package?
42+
43+ ``` shell
44+ sf metadata-coverage check -m CustomHelpMenuSection --2gp-managed
45+ ```
46+
47+ ... or maybe in the upcoming release?
48+
49+ ``` shell
50+ sf metadata-coverage check -m CustomHelpMenuSection --2gp-managed --api-version 65.0
51+ ```
52+
53+ Can I create an Unlocked Package from my source directory?
54+
55+ ``` shell
56+ sf metadata-coverage check --source-dir force-app --2gp-unlocked
57+ ```
58+
59+ Can I convert my 1GP Managed Package to a 2GP Managed Package?
60+
61+ ``` shell
62+ sf project retrieve start --package-name MyPkg --target-metadata-dir src --unzip --target-org my-pkg-org
63+ sf metadata-coverage check --manifest src/unpackaged/package.xml --2gp-managed
64+ ```
65+
66+ ### Commands
67+
3968<!-- commands -->
4069* [ ` sf metadata-coverage check ` ] ( #sf-metadata-coverage-check )
41- * [ ` sf metadata-coverage download ` ] ( #sf-metadata-coverage-download )
4270
4371## ` sf metadata-coverage check `
4472
@@ -87,63 +115,8 @@ EXAMPLES
87115```
88116
89117_ See code: [ lib/commands/metadata-coverage/check.js] ( https://github.com/amtrack/sf-plugin-metadata-coverage/blob/main/src/commands/metadata-coverage/check.ts ) _
90-
91- ## ` sf metadata-coverage download `
92-
93- Explicitly download a Metadata Coverage Report.
94-
95- ```
96- USAGE
97- $ sf metadata-coverage download [--json] [--flags-dir <value>] [--api-version <value>]
98-
99- FLAGS
100- --api-version=<value> The API version of the Metadata Coverage Report to use.
101-
102- GLOBAL FLAGS
103- --flags-dir=<value> Import flag values from a directory.
104- --json Format output as json.
105-
106- DESCRIPTION
107- Explicitly download a Metadata Coverage Report.
108-
109- By default it downloads the Metadata Coverage Report for the version of the sfdx-project.json > sourceApiVersion.
110-
111- EXAMPLES
112- $ sf metadata-coverage download
113-
114- $ sf metadata-coverage download --api-version 65.0
115- ```
116-
117- _ See code: [ lib/commands/metadata-coverage/download.js] ( https://github.com/amtrack/sf-plugin-metadata-coverage/blob/main/src/commands/metadata-coverage/download.ts ) _
118118<!-- commandsstop -->
119119
120- ### Example Use Cases
121-
122- Is the Metadata Type "CustomHelpMenuSection" supported for a 2GP Managed Package?
123-
124- ``` shell
125- sf metadata-coverage check -m CustomHelpMenuSection --2gp-managed
126- ```
127-
128- ... or maybe in the upcoming release?
129-
130- ``` shell
131- sf metadata-coverage check -m CustomHelpMenuSection --2gp-managed --api-version 65.0
132- ```
133-
134- Can I create an Unlocked Package from my source directory?
135-
136- ``` shell
137- sf metadata-coverage check --source-dir force-app --2gp-unlocked
138- ```
139-
140- Can I convert my 1GP Managed Package to a 2GP Managed Package?
141-
142- ``` shell
143- sf project retrieve start --package-name MyPkg --target-metadata-dir src --unzip --target-org my-pkg-org
144- sf metadata-coverage check --manifest src/unpackaged/package.xml --2gp-managed
145- ```
146-
147120## Development
148121
149122After cloning this repository, install the dependencies:
0 commit comments