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
May 18, 2022
1 parent
45f0635
commit 33ad08a
Showing
3 changed files
with
42 additions
and
40 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 |
---|---|---|
|
@@ -75,7 +75,7 @@ $ npm install -g @salesforce/plugin-source | |
$ sfdx COMMAND | ||
running command... | ||
$ sfdx (-v|--version|version) | ||
@salesforce/plugin-source/1.9.7 linux-x64 node-v14.19.3 | ||
@salesforce/plugin-source/1.9.8 linux-x64 node-v14.19.3 | ||
$ sfdx --help [COMMAND] | ||
USAGE | ||
$ sfdx COMMAND | ||
|
@@ -159,7 +159,7 @@ EXAMPLES | |
$ sfdx force:mdapi:convert -r path/to/metadata -d path/to/outputdir | ||
``` | ||
|
||
_See code: [src/commands/force/mdapi/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/mdapi/convert.ts)_ | ||
_See code: [src/commands/force/mdapi/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/mdapi/convert.ts)_ | ||
|
||
## `sfdx force:mdapi:deploy [-d <directory>] [-w <minutes>] [-q <id> | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g | -c] [-f <filepath>] [-s] [--soapdeploy] [--purgeondelete] [-u <string>] [--apiversion <string>] [--verbose] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -235,18 +235,18 @@ ALIASES | |
EXAMPLES | ||
Return a job ID you can use to check the deploy status: | ||
sfdx force:mdapi:deploy -d some/path | ||
$ sfdx force:mdapi:deploy -d some/path | ||
Deploy and poll for 1000 minutes: | ||
sfdx force:mdapi:deploy -d some/path -w 1000 | ||
$ sfdx force:mdapi:deploy -d some/path -w 1000 | ||
Deploy a ZIP file: | ||
sfdx force:mdapi:deploy -f stuff.zip | ||
$ sfdx force:mdapi:deploy -f stuff.zip | ||
Validate a deployment so the ID can be used for a quick deploy: | ||
sfdx force:mdapi:deploy -d some/path -w 1000 -c --testlevel RunAllTestsInOrg | ||
$ sfdx force:mdapi:deploy -d some/path -w 1000 -c --testlevel RunAllTestsInOrg | ||
Quick deploy using a previously validated deployment: | ||
sfdx force:mdapi:deploy -q MyValidatedId | ||
$ sfdx force:mdapi:deploy -q MyValidatedId | ||
``` | ||
|
||
_See code: [src/commands/force/mdapi/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/mdapi/deploy.ts)_ | ||
_See code: [src/commands/force/mdapi/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/mdapi/deploy.ts)_ | ||
|
||
## `sfdx force:mdapi:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -291,7 +291,7 @@ EXAMPLES | |
$ sfdx force:mdapi:deploy:report | ||
``` | ||
|
||
_See code: [src/commands/force/mdapi/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/mdapi/deploy/cancel.ts)_ | ||
_See code: [src/commands/force/mdapi/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/mdapi/deploy/cancel.ts)_ | ||
|
||
## `sfdx force:mdapi:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -334,12 +334,12 @@ ALIASES | |
EXAMPLES | ||
Check the status of the most recent deployment | ||
sfdx force:mdapi:deploy:report | ||
$ sfdx force:mdapi:deploy:report | ||
Check the status of a deploy with job ID 1234 and wait for 10 minutes for the result: | ||
sfdx force:mdapi:deploy:report -i 1234 -w 10 | ||
$ sfdx force:mdapi:deploy:report -i 1234 -w 10 | ||
``` | ||
|
||
_See code: [src/commands/force/mdapi/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/mdapi/deploy/report.ts)_ | ||
_See code: [src/commands/force/mdapi/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/mdapi/deploy/report.ts)_ | ||
|
||
## `sfdx force:mdapi:describemetadata [-f <filepath>] [-u <string>] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -378,7 +378,7 @@ EXAMPLES | |
$ 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.9.7/src/commands/force/mdapi/describemetadata.ts)_ | ||
_See code: [src/commands/force/mdapi/describemetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/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]` | ||
|
||
|
@@ -431,7 +431,7 @@ EXAMPLES | |
$ 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.9.7/src/commands/force/mdapi/listmetadata.ts)_ | ||
_See code: [src/commands/force/mdapi/listmetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/mdapi/listmetadata.ts)_ | ||
|
||
## `sfdx force:mdapi:retrieve -r <directory> [-k <filepath> | -d <directory> | -p <array>] [-s] [-n <string>] [-z] [-w <minutes>] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -492,16 +492,16 @@ ALIASES | |
EXAMPLES | ||
Retrieve metadata in the default project directory into the target directory: | ||
sfdx force:mdapi:retrieve -r path/to/retrieve/dir | ||
$ sfdx force:mdapi:retrieve -r path/to/retrieve/dir | ||
Retrieve metadata defined in the specified manifest into the target directory: | ||
sfdx force:mdapi:retrieve -r path/to/retrieve/dir -k package.xml | ||
$ sfdx force:mdapi:retrieve -r path/to/retrieve/dir -k package.xml | ||
Retrieve metadata defined by the specified directory, name the retrieved zipfile and extract all contents | ||
sfdx force:mdapi:retrieve -d path/to/apexClasses -r path/to/retrieve/dir --unzip --zipfilename apexClasses.zip | ||
$ sfdx force:mdapi:retrieve -d path/to/apexClasses -r path/to/retrieve/dir --unzip --zipfilename apexClasses.zip | ||
Enqueue a retrieve request but do not wait for the metadata to be retrieved: | ||
sfdx force:mdapi:retrieve -r path/to/retrieve/dir --wait 0 | ||
$ sfdx force:mdapi:retrieve -r path/to/retrieve/dir --wait 0 | ||
``` | ||
|
||
_See code: [src/commands/force/mdapi/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/mdapi/retrieve.ts)_ | ||
_See code: [src/commands/force/mdapi/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/mdapi/retrieve.ts)_ | ||
|
||
## `sfdx force:mdapi:retrieve:report [-r <directory>] [-i <id>] [-n <string>] [-z] [-w <minutes>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -562,7 +562,7 @@ EXAMPLES | |
sfdx force:mdapi:retrieve:report -i retrieveId -r path/to/retrieve/dir --unzip --zipfilename apexClasses.zip | ||
``` | ||
|
||
_See code: [src/commands/force/mdapi/retrieve/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/mdapi/retrieve/report.ts)_ | ||
_See code: [src/commands/force/mdapi/retrieve/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/mdapi/retrieve/report.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]` | ||
|
||
|
@@ -575,7 +575,7 @@ USAGE | |
OPTIONS | ||
-d, --outputdir=outputdir [default: | ||
metadataPackage_1652814400379] | ||
metadataPackage_1652908054521] | ||
output directory to store the | ||
Metadata API–formatted files in | ||
|
@@ -613,7 +613,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.9.7/src/commands/force/source/convert.ts)_ | ||
_See code: [src/commands/force/source/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/convert.ts)_ | ||
|
||
## `sfdx force:source:delete [-w <minutes>] [-l NoTestRun|RunLocalTests|RunAllTestsInOrg] [-r] [-m <array>] [-p <array>] [-f [-t | -c]] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -677,7 +677,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.9.7/src/commands/force/source/delete.ts)_ | ||
_See code: [src/commands/force/source/delete.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/delete.ts)_ | ||
|
||
## `sfdx force:source:deploy [--soapdeploy] [-w <minutes>] [--purgeondelete -x <filepath>] [-q <id> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g | -t] [-m <array>] [-p <array>] [--predestructivechanges <filepath> ] [--postdestructivechanges <filepath> ] [-f ] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -807,7 +807,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.9.7/src/commands/force/source/deploy.ts)_ | ||
_See code: [src/commands/force/source/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/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]` | ||
|
||
|
@@ -856,7 +856,7 @@ EXAMPLES | |
$ sfdx force:source:deploy:report | ||
``` | ||
|
||
_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/source/deploy/cancel.ts)_ | ||
_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/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]` | ||
|
||
|
@@ -903,7 +903,7 @@ EXAMPLES | |
$ sfdx force:source:deploy:report | ||
``` | ||
|
||
_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/source/deploy/report.ts)_ | ||
_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/deploy/report.ts)_ | ||
|
||
## `sfdx force:source:ignored:list [-p <filepath>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -925,7 +925,7 @@ OPTIONS | |
this command invocation | ||
``` | ||
|
||
_See code: [src/commands/force/source/ignored/list.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/source/ignored/list.ts)_ | ||
_See code: [src/commands/force/source/ignored/list.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/ignored/list.ts)_ | ||
|
||
## `sfdx force:source:manifest:create [-m <array>] [-p <array>] [-n <string> | -t pre|post|destroy|package] [-c <array> --fromorg <string>] [-o <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -1000,7 +1000,7 @@ EXAMPLES | |
$ sfdx force:source:manifest:create --fromorg [email protected] --includepackages unlocked | ||
``` | ||
|
||
_See code: [src/commands/force/source/manifest/create.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/source/manifest/create.ts)_ | ||
_See code: [src/commands/force/source/manifest/create.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/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]` | ||
|
||
|
@@ -1044,7 +1044,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.9.7/src/commands/force/source/open.ts)_ | ||
_See code: [src/commands/force/source/open.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/open.ts)_ | ||
|
||
## `sfdx force:source:pull [-f] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -1080,7 +1080,7 @@ ALIASES | |
$ sfdx force:source:beta:pull | ||
``` | ||
|
||
_See code: [src/commands/force/source/pull.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/source/pull.ts)_ | ||
_See code: [src/commands/force/source/pull.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/pull.ts)_ | ||
|
||
## `sfdx force:source:push [-f] [-w <minutes>] [-g] [-u <string>] [--apiversion <string>] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -1122,7 +1122,7 @@ ALIASES | |
$ sfdx force:source:beta:push | ||
``` | ||
|
||
_See code: [src/commands/force/source/push.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/source/push.ts)_ | ||
_See code: [src/commands/force/source/push.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/push.ts)_ | ||
|
||
## `sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-f -t] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -1212,7 +1212,7 @@ 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.9.7/src/commands/force/source/retrieve.ts)_ | ||
_See code: [src/commands/force/source/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/retrieve.ts)_ | ||
|
||
## `sfdx force:source:status [-l | -r] [-u <string>] [--apiversion <string>] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -1249,13 +1249,13 @@ ALIASES | |
$ sfdx force:source:beta:status | ||
EXAMPLES | ||
sfdx force:source:status -l | ||
sfdx force:source:status -r | ||
sfdx force:source:status -a | ||
sfdx force:source:status -a -u [email protected] --json | ||
$ sfdx force:source:status -l | ||
$ sfdx force:source:status -r | ||
$ sfdx force:source:status -a | ||
$ sfdx force:source:status -a -u [email protected] --json | ||
``` | ||
|
||
_See code: [src/commands/force/source/status.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/source/status.ts)_ | ||
_See code: [src/commands/force/source/status.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/status.ts)_ | ||
|
||
## `sfdx force:source:tracking:clear [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -1291,7 +1291,7 @@ ALIASES | |
$ sfdx force:source:beta:tracking:clear | ||
``` | ||
|
||
_See code: [src/commands/force/source/tracking/clear.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/source/tracking/clear.ts)_ | ||
_See code: [src/commands/force/source/tracking/clear.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/tracking/clear.ts)_ | ||
|
||
## `sfdx force:source:tracking:reset [-r <integer>] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
|
@@ -1335,6 +1335,6 @@ ALIASES | |
$ sfdx force:source:beta:tracking:reset | ||
``` | ||
|
||
_See code: [src/commands/force/source/tracking/reset.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.7/src/commands/force/source/tracking/reset.ts)_ | ||
_See code: [src/commands/force/source/tracking/reset.ts](https://github.com/salesforcecli/plugin-source/blob/v1.9.8/src/commands/force/source/tracking/reset.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