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 16, 2021
1 parent
9dcc3e7
commit d716542
Showing
3 changed files
with
74 additions
and
18 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.4.2 linux-x64 node-v12.22.7 | ||
@salesforce/plugin-source/1.4.3 linux-x64 node-v12.22.7 | ||
$ sfdx --help [COMMAND] | ||
USAGE | ||
$ sfdx COMMAND | ||
|
@@ -91,6 +91,7 @@ USAGE | |
# Commands | ||
|
||
<!-- commands --> | ||
* [`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]`](#sfdx-forcemdapideploycancel--w-minutes--i-id--u-string---apiversion-string---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]`](#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) | ||
|
@@ -107,6 +108,54 @@ 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:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
cancel a metadata deployment | ||
|
||
``` | ||
cancel a metadata deployment | ||
Use this command to cancel a specified asynchronous metadata deployment. You can also specify a wait time (in minutes) to check for updates to the canceled deploy status. | ||
USAGE | ||
$ 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] | ||
OPTIONS | ||
-i, --jobid=jobid job ID of the deployment you want to | ||
cancel; defaults to your most recent | ||
CLI deployment if not specified | ||
-u, --targetusername=targetusername username or alias for the target | ||
org; overrides default target org | ||
-w, --wait=wait [default: 33 minutes] wait time for | ||
command to finish in minutes | ||
--apiversion=apiversion override the api version used for | ||
api requests made by this command | ||
--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 | ||
DESCRIPTION | ||
Use this command to cancel a specified asynchronous metadata deployment. You can also specify a wait time (in minutes) | ||
to check for updates to the canceled deploy status. | ||
EXAMPLES | ||
Deploy a directory of files to the org | ||
$ sfdx force:mdapi:deploy -d <directory> | ||
Now cancel this deployment and wait two minutes | ||
$ sfdx force:mdapi:deploy:cancel -w 2 | ||
If you have multiple deployments in progress and want to cancel a specific one, specify the job ID | ||
$ sfdx force:mdapi:deploy:cancel -i <jobid> | ||
Check the status of the cancel job | ||
$ sfdx force:mdapi:deploy:report | ||
``` | ||
|
||
_See code: [src/commands/force/mdapi/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/src/commands/force/mdapi/deploy/cancel.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]` | ||
|
||
display details about the metadata types enabled for your org | ||
|
@@ -149,7 +198,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.4.2/src/commands/force/mdapi/describemetadata.ts)_ | ||
_See code: [src/commands/force/mdapi/describemetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -205,7 +254,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.4.2/src/commands/force/mdapi/listmetadata.ts)_ | ||
_See code: [src/commands/force/mdapi/listmetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -240,7 +289,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.4.2/src/commands/force/source/beta/pull.ts)_ | ||
_See code: [src/commands/force/source/beta/pull.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -281,7 +330,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.4.2/src/commands/force/source/beta/push.ts)_ | ||
_See code: [src/commands/force/source/beta/push.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -319,7 +368,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.4.2/src/commands/force/source/beta/status.ts)_ | ||
_See code: [src/commands/force/source/beta/status.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -358,7 +407,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.4.2/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.4.3/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]` | ||
|
||
|
@@ -408,7 +457,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.4.2/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.4.3/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]` | ||
|
||
|
@@ -430,7 +479,7 @@ USAGE | |
OPTIONS | ||
-d, --outputdir=outputdir [default: | ||
metadataPackage_1637007302184] | ||
metadataPackage_1637100105638] | ||
output directory to store the | ||
Metadata API–formatted files in | ||
|
@@ -468,7 +517,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.4.2/src/commands/force/source/convert.ts)_ | ||
_See code: [src/commands/force/source/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/src/commands/force/source/convert.ts)_ | ||
|
||
## `sfdx ` | ||
|
||
|
@@ -524,7 +573,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.4.2/src/commands/force/source/delete.ts)_ | ||
_See code: [src/commands/force/source/delete.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -653,7 +702,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.4.2/src/commands/force/source/deploy.ts)_ | ||
_See code: [src/commands/force/source/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -708,7 +757,7 @@ EXAMPLES | |
$ sfdx force:source:deploy:report | ||
``` | ||
|
||
_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)_ | ||
_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -758,7 +807,7 @@ EXAMPLES | |
$ sfdx force:source:deploy:report | ||
``` | ||
|
||
_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)_ | ||
_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -837,7 +886,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.4.2/src/commands/force/source/manifest/create.ts)_ | ||
_See code: [src/commands/force/source/manifest/create.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -887,7 +936,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.4.2/src/commands/force/source/open.ts)_ | ||
_See code: [src/commands/force/source/open.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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]` | ||
|
||
|
@@ -975,5 +1024,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.4.2/src/commands/force/source/retrieve.ts)_ | ||
_See code: [src/commands/force/source/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.4.3/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