generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
SF-CLI-BOT
committed
Nov 9, 2021
1 parent
b00a59a
commit c8f878e
Showing
3 changed files
with
108 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -80,7 +80,7 @@ $ npm install -g @salesforce/plugin-source | |
$ sfdx COMMAND | ||
running command... | ||
$ sfdx (-v|--version|version) | ||
@salesforce/plugin-source/1.3.0 linux-x64 node-v12.22.7 | ||
@salesforce/plugin-source/1.3.1 linux-x64 node-v12.22.7 | ||
$ sfdx --help [COMMAND] | ||
USAGE | ||
$ sfdx COMMAND | ||
|
@@ -91,6 +91,8 @@ USAGE | |
# Commands | ||
|
||
<!-- commands --> | ||
* [`sfdx force:mdapi:describemetadata [-f <filepath>] [-u <string>] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapidescribemetadata--f-filepath--u-string--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) | ||
* [`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]`](#sfdx-forcemdapilistmetadata--m-string--f-filepath---folder-string--u-string--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) | ||
* [`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]`](#sfdx-forcesourcebetapull--f--w-minutes--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) | ||
* [`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]`](#sfdx-forcesourcebetapush--f--w-minutes--g--u-string---apiversion-string---quiet---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) | ||
* [`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]`](#sfdx-forcesourcebetastatus--l---r--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) | ||
|
@@ -105,6 +107,89 @@ USAGE | |
* [`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]`](#sfdx-forcesourceopen--f-filepath--r--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) | ||
* [`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]`](#sfdx-forcesourceretrieve--p-array---x-filepath---m-array--w-minutes--n-array--u-string--a-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) | ||
|
||
## `sfdx force:mdapi:describemetadata [-f <filepath>] [-u <string>] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
display the metadata types enabled for your org | ||
|
||
``` | ||
display the metadata types enabled for your org | ||
USAGE | ||
$ sfdx force:mdapi:describemetadata [-f <filepath>] [-u <string>] [-a <string>] [--json] [--loglevel | ||
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
OPTIONS | ||
-a, --apiversion=apiversion API version to use | ||
-f, --resultfile=resultfile path to the file where results are | ||
stored | ||
-u, --targetusername=targetusername username or alias for the target | ||
org; overrides default target org | ||
--json format output as json | ||
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for | ||
this command invocation | ||
EXAMPLES | ||
$ sfdx force:mdapi:describemetadata -a 43.0 | ||
$ sfdx force:mdapi:describemetadata -u [email protected] | ||
$ sfdx force:mdapi:describemetadata -f /path/to/outputfilename.txt | ||
$ sfdx force:mdapi:describemetadata -u [email protected] -f /path/to/outputfilename.txt | ||
``` | ||
|
||
_See code: [src/commands/force/mdapi/describemetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/mdapi/describemetadata.ts)_ | ||
|
||
## `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]` | ||
|
||
display properties of metadata components of a specified type | ||
|
||
``` | ||
display properties of metadata components of a specified type | ||
USAGE | ||
$ 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] | ||
OPTIONS | ||
-a, --apiversion=apiversion API version to use | ||
-f, --resultfile=resultfile path to the file where results are | ||
stored | ||
-m, --metadatatype=metadatatype (required) metadata type to be | ||
retrieved, such as CustomObject; | ||
metadata type value is | ||
case-sensitive | ||
-u, --targetusername=targetusername username or alias for the target | ||
org; overrides default target org | ||
--folder=folder folder associated with the | ||
component; required for components | ||
that use folders; folder names are | ||
case-sensitive | ||
--json format output as json | ||
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for | ||
this command invocation | ||
EXAMPLES | ||
$ sfdx force:mdapi:listmetadata -m CustomObject | ||
$ sfdx force:mdapi:listmetadata -m CustomObject -a 43.0 | ||
$ sfdx force:mdapi:listmetadata -m CustomObject -u [email protected] | ||
$ sfdx force:mdapi:listmetadata -m CustomObject -f /path/to/outputfilename.txt | ||
$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername | ||
$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -a 43.0 | ||
$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -u [email protected] | ||
$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -f /path/to/outputfilename.txt | ||
$ sfdx force:mdapi:listmetadata -m CustomObject -u [email protected] -f /path/to/outputfilename.txt | ||
``` | ||
|
||
_See code: [src/commands/force/mdapi/listmetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/mdapi/listmetadata.ts)_ | ||
|
||
## `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]` | ||
|
||
pull source from the scratch org to the project | ||
|
@@ -138,7 +223,7 @@ OPTIONS | |
[default: warn] logging level for this command invocation | ||
``` | ||
|
||
_See code: [src/commands/force/source/beta/pull.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/beta/pull.ts)_ | ||
_See code: [src/commands/force/source/beta/pull.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/pull.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -179,7 +264,7 @@ OPTIONS | |
minimize json and sdtout output on success | ||
``` | ||
|
||
_See code: [src/commands/force/source/beta/push.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/beta/push.ts)_ | ||
_See code: [src/commands/force/source/beta/push.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/push.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -217,7 +302,7 @@ EXAMPLES | |
sfdx force:source:status -a -u [email protected] --json | ||
``` | ||
|
||
_See code: [src/commands/force/source/beta/status.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/beta/status.ts)_ | ||
_See code: [src/commands/force/source/beta/status.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/status.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -256,7 +341,7 @@ DESCRIPTION | |
and remote files as changed, and any files with the same name are listed as conflicts. | ||
``` | ||
|
||
_See code: [src/commands/force/source/beta/tracking/clear.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/beta/tracking/clear.ts)_ | ||
_See code: [src/commands/force/source/beta/tracking/clear.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/tracking/clear.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -306,7 +391,7 @@ DESCRIPTION | |
$ sfdx force:data:soql:query -q "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" -t | ||
``` | ||
|
||
_See code: [src/commands/force/source/beta/tracking/reset.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/beta/tracking/reset.ts)_ | ||
_See code: [src/commands/force/source/beta/tracking/reset.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/beta/tracking/reset.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -328,7 +413,7 @@ USAGE | |
OPTIONS | ||
-d, --outputdir=outputdir [default: | ||
metadataPackage_1635451490517] | ||
metadataPackage_1636499010974] | ||
output directory to store the | ||
Metadata API–formatted files in | ||
|
@@ -366,7 +451,7 @@ EXAMPLES | |
$ sfdx force:source:convert -r path/to/source -d path/to/outputdir -n 'My Package' | ||
``` | ||
|
||
_See code: [src/commands/force/source/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/convert.ts)_ | ||
_See code: [src/commands/force/source/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/convert.ts)_ | ||
|
||
## `sfdx ` | ||
|
||
|
@@ -422,7 +507,7 @@ EXAMPLES | |
$ sfdx force:source:delete -p path/to/source | ||
``` | ||
|
||
_See code: [src/commands/force/source/delete.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/delete.ts)_ | ||
_See code: [src/commands/force/source/delete.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/delete.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -551,7 +636,7 @@ EXAMPLES | |
$ sfdx force:source:deploy --manifest package.xml --postdestructivechanges destructiveChangesPost.xml | ||
``` | ||
|
||
_See code: [src/commands/force/source/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/deploy.ts)_ | ||
_See code: [src/commands/force/source/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/deploy.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -606,7 +691,7 @@ EXAMPLES | |
$ sfdx force:source:deploy:report | ||
``` | ||
|
||
_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/deploy/cancel.ts)_ | ||
_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/deploy/cancel.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -656,7 +741,7 @@ EXAMPLES | |
$ sfdx force:source:deploy:report | ||
``` | ||
|
||
_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/deploy/report.ts)_ | ||
_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/deploy/report.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -735,7 +820,7 @@ EXAMPLES | |
$ sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest | ||
``` | ||
|
||
_See code: [src/commands/force/source/manifest/create.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/manifest/create.ts)_ | ||
_See code: [src/commands/force/source/manifest/create.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/manifest/create.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -785,7 +870,7 @@ EXAMPLES | |
$ sfdx force:source:open -f path/to/source -u [email protected] | ||
``` | ||
|
||
_See code: [src/commands/force/source/open.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/open.ts)_ | ||
_See code: [src/commands/force/source/open.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/open.ts)_ | ||
|
||
## `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]` | ||
|
||
|
@@ -873,5 +958,5 @@ EXAMPLES | |
$ sfdx force:source:retrieve -n MyPackageName -x path/to/package.xml | ||
``` | ||
|
||
_See code: [src/commands/force/source/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.0/src/commands/force/source/retrieve.ts)_ | ||
_See code: [src/commands/force/source/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.3.1/src/commands/force/source/retrieve.ts)_ | ||
<!-- commandsstop --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters