@@ -80,7 +80,7 @@ $ npm install -g @salesforce/plugin-source
8080$ sfdx COMMAND
8181running command...
8282$ sfdx (-v| --version| version)
83- @salesforce/plugin-source/1.4.1 linux-x64 node-v12.22.7
83+ @salesforce/plugin-source/1.4.2 linux-x64 node-v12.22.7
8484$ sfdx --help [COMMAND]
8585USAGE
8686 $ sfdx COMMAND
@@ -109,10 +109,13 @@ USAGE
109109
110110## ` sfdx force:mdapi:describemetadata [-f <filepath>] [-u <string>] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
111111
112- display the metadata types enabled for your org
112+ display details about the metadata types enabled for your org
113113
114114```
115- display the metadata types enabled for your org
115+ display details about the metadata types enabled for your org
116+ Use this information to identify the syntax needed for a <name> element in package.xml. The most recent API version is the default, or you can specify an older version.
117+
118+ The default target username is the admin user for the default scratch org. The username must have the Modify All Data permission or the Modify Metadata permission (Beta). For more information about permissions, see Salesforce Help.
116119
117120USAGE
118121 $ sfdx force:mdapi:describemetadata [-f <filepath>] [-u <string>] [-a <string>] [--json] [--loglevel
@@ -132,21 +135,29 @@ OPTIONS
132135 --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
133136 this command invocation
134137
138+ DESCRIPTION
139+ Use this information to identify the syntax needed for a <name> element in package.xml. The most recent API version is
140+ the default, or you can specify an older version.
141+
142+ The default target username is the admin user for the default scratch org. The username must have the Modify All Data
143+ permission or the Modify Metadata permission (Beta). For more information about permissions, see Salesforce Help.
144+
135145EXAMPLES
136146 $ sfdx force:mdapi:describemetadata -a 43.0
137147 $ sfdx force:mdapi:describemetadata -u [email protected] 138148 $ sfdx force:mdapi:describemetadata -f /path/to/outputfilename.txt
139149 $ sfdx force:mdapi:describemetadata -u [email protected] -f /path/to/outputfilename.txt 140150```
141151
142- _ See code: [ src/commands/force/mdapi/describemetadata.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/mdapi/describemetadata.ts ) _
152+ _ See code: [ src/commands/force/mdapi/describemetadata.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/mdapi/describemetadata.ts ) _
143153
144154## ` sfdx force:mdapi:listmetadata -m <string> [-f <filepath>] [--folder <string>] [-u <string>] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
145155
146156display properties of metadata components of a specified type
147157
148158```
149159display properties of metadata components of a specified type
160+ This command is useful when you want to identify individual components in your manifest file or if you want a high-level view of particular components in your organization. For example, you could use this target to return a list of names of all Layout components in your org, then use this information in a retrieve operation that returns a subset of these components.
150161
151162USAGE
152163 $ sfdx force:mdapi:listmetadata -m <string> [-f <filepath>] [--folder <string>] [-u <string>] [-a <string>] [--json]
@@ -176,6 +187,12 @@ OPTIONS
176187 --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
177188 this command invocation
178189
190+ DESCRIPTION
191+ This command is useful when you want to identify individual components in your manifest file or if you want a
192+ high-level view of particular components in your organization. For example, you could use this target to return a list
193+ of names of all Layout components in your org, then use this information in a retrieve operation that returns a subset
194+ of these components.
195+
179196EXAMPLES
180197 $ sfdx force:mdapi:listmetadata -m CustomObject
181198 $ sfdx force:mdapi:listmetadata -m CustomObject -a 43.0
@@ -188,7 +205,7 @@ EXAMPLES
188205 $ sfdx force:mdapi:listmetadata -m CustomObject -u [email protected] -f /path/to/outputfilename.txt 189206```
190207
191- _ See code: [ src/commands/force/mdapi/listmetadata.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/mdapi/listmetadata.ts ) _
208+ _ See code: [ src/commands/force/mdapi/listmetadata.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/mdapi/listmetadata.ts ) _
192209
193210## ` sfdx force:source:beta:pull [-f] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
194211
@@ -223,7 +240,7 @@ OPTIONS
223240 [default: warn] logging level for this command invocation
224241```
225242
226- _ See code: [ src/commands/force/source/beta/pull.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/beta/pull.ts ) _
243+ _ See code: [ src/commands/force/source/beta/pull.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/beta/pull.ts ) _
227244
228245## ` sfdx force:source:beta:push [-f] [-w <minutes>] [-g] [-u <string>] [--apiversion <string>] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
229246
@@ -264,7 +281,7 @@ OPTIONS
264281 minimize json and sdtout output on success
265282```
266283
267- _ See code: [ src/commands/force/source/beta/push.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/beta/push.ts ) _
284+ _ See code: [ src/commands/force/source/beta/push.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/beta/push.ts ) _
268285
269286## ` sfdx force:source:beta:status [-l | -r] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
270287
@@ -302,7 +319,7 @@ EXAMPLES
302319 sfdx force:source:status -a -u [email protected] --json 303320```
304321
305- _ See code: [ src/commands/force/source/beta/status.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/beta/status.ts ) _
322+ _ See code: [ src/commands/force/source/beta/status.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/beta/status.ts ) _
306323
307324## ` sfdx force:source:beta:tracking:clear [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
308325
@@ -341,7 +358,7 @@ DESCRIPTION
341358 and remote files as changed, and any files with the same name are listed as conflicts.
342359```
343360
344- _ See code: [ src/commands/force/source/beta/tracking/clear.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/beta/tracking/clear.ts ) _
361+ _ See code: [ src/commands/force/source/beta/tracking/clear.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/beta/tracking/clear.ts ) _
345362
346363## ` sfdx force:source:beta:tracking:reset [-r <integer>] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
347364
@@ -391,7 +408,7 @@ DESCRIPTION
391408 $ sfdx force:data:soql:query -q "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" -t
392409```
393410
394- _ See code: [ src/commands/force/source/beta/tracking/reset.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/beta/tracking/reset.ts ) _
411+ _ See code: [ src/commands/force/source/beta/tracking/reset.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/beta/tracking/reset.ts ) _
395412
396413## ` sfdx force:source:convert [-r <directory>] [-d <directory>] [-n <string>] [-p <array> | -x <string> | -m <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
397414
@@ -413,7 +430,7 @@ USAGE
413430
414431OPTIONS
415432 -d, --outputdir=outputdir [default:
416- metadataPackage_1636652278921 ]
433+ metadataPackage_1637007302184 ]
417434 output directory to store the
418435 Metadata API–formatted files in
419436
@@ -451,7 +468,7 @@ EXAMPLES
451468 $ sfdx force:source:convert -r path/to/source -d path/to/outputdir -n 'My Package'
452469```
453470
454- _ See code: [ src/commands/force/source/convert.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/convert.ts ) _
471+ _ See code: [ src/commands/force/source/convert.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/convert.ts ) _
455472
456473## ` sfdx `
457474
@@ -507,7 +524,7 @@ EXAMPLES
507524 $ sfdx force:source:delete -p path/to/source
508525```
509526
510- _ See code: [ src/commands/force/source/delete.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/delete.ts ) _
527+ _ See code: [ src/commands/force/source/delete.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/delete.ts ) _
511528
512529## ` sfdx force:source:deploy [--soapdeploy] [-w <minutes>] [-q <id> | -x <filepath> | -m <array> | -p <array> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g] [--predestructivechanges <filepath> ] [--postdestructivechanges <filepath> ] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
513530
@@ -636,7 +653,7 @@ EXAMPLES
636653 $ sfdx force:source:deploy --manifest package.xml --postdestructivechanges destructiveChangesPost.xml
637654```
638655
639- _ See code: [ src/commands/force/source/deploy.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/deploy.ts ) _
656+ _ See code: [ src/commands/force/source/deploy.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/deploy.ts ) _
640657
641658## ` sfdx force:source:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
642659
@@ -691,7 +708,7 @@ EXAMPLES
691708 $ sfdx force:source:deploy:report
692709```
693710
694- _ See code: [ src/commands/force/source/deploy/cancel.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/deploy/cancel.ts ) _
711+ _ See code: [ src/commands/force/source/deploy/cancel.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/deploy/cancel.ts ) _
695712
696713## ` sfdx force:source:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
697714
@@ -741,7 +758,7 @@ EXAMPLES
741758 $ sfdx force:source:deploy:report
742759```
743760
744- _ See code: [ src/commands/force/source/deploy/report.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/deploy/report.ts ) _
761+ _ See code: [ src/commands/force/source/deploy/report.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/deploy/report.ts ) _
745762
746763## ` sfdx force:source:manifest:create [-m <array> | -p <array>] [-n <string> | -t pre|post|destroy|package] [-o <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
747764
@@ -820,7 +837,7 @@ EXAMPLES
820837 $ sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest
821838```
822839
823- _ See code: [ src/commands/force/source/manifest/create.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/manifest/create.ts ) _
840+ _ See code: [ src/commands/force/source/manifest/create.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/manifest/create.ts ) _
824841
825842## ` sfdx force:source:open -f <filepath> [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
826843
@@ -870,7 +887,7 @@ EXAMPLES
870887 $ sfdx force:source:open -f path/to/source -u [email protected] 871888```
872889
873- _ See code: [ src/commands/force/source/open.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/open.ts ) _
890+ _ See code: [ src/commands/force/source/open.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/open.ts ) _
874891
875892## ` sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
876893
@@ -958,5 +975,5 @@ EXAMPLES
958975 $ sfdx force:source:retrieve -n MyPackageName -x path/to/package.xml
959976```
960977
961- _ See code: [ src/commands/force/source/retrieve.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.1 /src/commands/force/source/retrieve.ts ) _
978+ _ See code: [ src/commands/force/source/retrieve.ts] ( https://github.com/salesforcecli/plugin-source/blob/v1.4.2 /src/commands/force/source/retrieve.ts ) _
962979<!-- commandsstop -->
0 commit comments